mistapi

package
v0.4.22 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 13, 2024 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var NewAndAuth = https.NewAndAuth

NewAndAuth creates a new AndAuth.

View Source 
var NewAuth = https.NewAuth

NewAuth creates a new Auth.

View Source 
var NewHttpConfiguration = https.NewHttpConfiguration

NewHttpConfiguration creates a new HttpConfiguration.

View Source 
var NewLoggerConfiguration = logger.NewLoggerConfiguration

NewLoggerConfiguration creates a new LoggerConfiguration.

View Source 
var NewOrAuth = https.NewOrAuth

NewOrAuth creates a new OrAuth.

View Source 
var NewRetryConfiguration = https.NewRetryConfiguration

NewRetryConfiguration creates a new RetryConfiguration.

View Source 
var NewSdkLogger = logger.NewSdkLogger

NewSdkLogger creates a new SdkLogger.

View Source 
var WithBackoffFactor = https.WithBackoffFactor

WithBackoffFactor sets the BackoffFactor.

View Source 
var WithExcludeRequestHeaders = logger.WithExcludeRequestHeaders

WithExcludeRequestHeaders creates a new hExcludeRequestHeaders.

View Source 
var WithExcludeResponseHeaders = logger.WithExcludeResponseHeaders

WithExcludeResponseHeaders creates a new hExcludeResponseHeaders.

View Source 
var WithHttpMethodsToRetry = https.WithHttpMethodsToRetry

WithHttpMethodsToRetry sets the HttpMethodsToRetry.

View Source 
var WithHttpStatusCodesToRetry = https.WithHttpStatusCodesToRetry

WithHttpStatusCodesToRetry sets the HttpStatusCodesToRetry.

View Source 
var WithIncludeQueryInPath = logger.WithIncludeQueryInPath

WithIncludeQueryInPath creates a new hIncludeQueryInPath.

View Source 
var WithIncludeRequestHeaders = logger.WithIncludeRequestHeaders

WithIncludeRequestHeaders creates a new hIncludeRequestHeaders.

View Source 
var WithIncludeResponseHeaders = logger.WithIncludeResponseHeaders

WithIncludeResponseHeaders creates a new hIncludeResponseHeaders.

View Source 
var WithLevel = logger.WithLevel

WithLevel creates a new hLevel.

View Source 
var WithLogger = logger.WithLogger

WithLogger creates a new hLogger.

View Source 
var WithMaskSensitiveHeaders = logger.WithMaskSensitiveHeaders

WithMaskSensitiveHeaders creates a new hMaskSensitiveHeaders.

View Source 
var WithMaxRetryAttempts = https.WithMaxRetryAttempts

WithMaxRetryAttempts sets the MaxRetryAttempts.

View Source 
var WithMaximumRetryWaitTime = https.WithMaximumRetryWaitTime

WithMaximumRetryWaitTime sets the MaximumRetryWaitTime.

View Source 
var WithRequestBody = logger.WithRequestBody

WithRequestBody creates a new hRequestBody.

View Source 
var WithRequestConfiguration = logger.WithRequestConfiguration

WithRequestConfiguration creates a new hRequestConfiguration.

View Source 
var WithRequestHeaders = logger.WithRequestHeaders

WithRequestHeaders creates a new hRequestHeaders.

View Source 
var WithResponseBody = logger.WithResponseBody

WithResponseBody creates a new hResponseBody.

View Source 
var WithResponseConfiguration = logger.WithResponseConfiguration

WithResponseConfiguration creates a new hResponseConfiguration.

View Source 
var WithResponseHeaders = logger.WithResponseHeaders

WithResponseHeaders creates a new hResponseHeaders.

View Source 
var WithRetryConfiguration = https.WithRetryConfiguration

WithRetryConfiguration sets the RetryConfiguration.

View Source 
var WithRetryInterval = https.WithRetryInterval

WithRetryInterval sets the RetryInterval.

View Source 
var WithRetryOnTimeout = https.WithRetryOnTimeout

WithRetryOnTimeout sets the RetryOnTimeout.

View Source 
var WithTimeout = https.WithTimeout

WithTimeout sets the Timeout.

View Source 
var WithTransport = https.WithTransport

WithTransport sets the Transport.

View Source 
var WithWhitelistRequestHeaders = logger.WithWhitelistRequestHeaders

WithWhitelistRequestHeaders creates a new hWhitelistRequestHeaders.

View Source 
var WithWhitelistResponseHeaders = logger.WithWhitelistResponseHeaders

WithWhitelistResponseHeaders creates a new hWhitelistResponseHeaders.

Functions

func NewBaseController 

func NewBaseController(cb callBuilderFactory) *baseController

NewBaseController creates a new instance of baseController. It takes a callBuilderFactory as a parameter and returns a pointer to the baseController.

Types

type Admins 

type Admins struct {
	// contains filtered or unexported fields
}

Admins represents a controller struct.

func NewAdmins 

func NewAdmins(baseController baseController) *Admins

NewAdmins creates a new instance of Admins. It takes a baseController as a parameter and returns a pointer to the Admins.

func (*Admins) GetAdminRegistrationInfo 

func (a *Admins) GetAdminRegistrationInfo(
	ctx context.Context,
	recaptchaFlavor *models.RecaptchaFlavorEnum) (
	models.ApiResponse[models.Recaptcha],
	error)

GetAdminRegistrationInfo takes context, recaptchaFlavor as parameters and returns an models.ApiResponse with models.Recaptcha data and an error if there was an issue with the request or response. Get Registration Information

func (*Admins) RegisterNewAdmin 

func (a *Admins) RegisterNewAdmin(
	ctx context.Context,
	body *models.AdminInvite) (
	*http.Response,
	error)

RegisterNewAdmin takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Register a new admin and his/her org An email will also be sent to the user with a link to `/verify/register?token={token}` ### reCAPTCHA Google reCAPTCHA is the choice to prevent bot registration It needs this &lt;script src='https://www.google.com/recaptcha/api.js' &gt;&lt;/script&gt; and this &lt;div&gt; in the desired place ```html <div class="g-recaptcha" data_sitekey="6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd"></div> ``` Use GET /api/v1/register/recaptcha to read the current setting. Response example: ```json { "flavor": "google", "required": true, "sitekey": "6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd" } ``` ### hCaptcha Alternative to reCAPTCHA is hCaptcha to prevent bot registration It needs this script &lt;script src='https://js.hcaptcha.com/1/api.js' async defer &gt;&lt;/script&gt; and this &lt;div&gt; in the desired place ```html <div class="h-recaptcha" data_sitekey="6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd"></div> ``` Use GET /api/v1/register/recaptcha?recaptcha_flavor=hcaptcha to read the current setting for hcaptcha with reply. Response example: ```json { "flavor": "hcaptcha", "required": true, "sitekey": "6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd" }" ```

func (*Admins) VerifyAdminInvite 

func (a *Admins) VerifyAdminInvite(
	ctx context.Context,
	token string) (
	*http.Response,
	error)

VerifyAdminInvite takes context, token as parameters and returns an *Response and an error if there was an issue with the request or response. **Note**: another call to ```GET /api/v1/self``` is required to see the new set of privileges

func (*Admins) VerifyRegistration 

func (a *Admins) VerifyRegistration(
	ctx context.Context,
	token string) (
	models.ApiResponse[models.ResponseVerifyTokenSuccess],
	error)

VerifyRegistration takes context, token as parameters and returns an models.ApiResponse with models.ResponseVerifyTokenSuccess data and an error if there was an issue with the request or response. Verify registration

type AdminsLogin 

type AdminsLogin struct {
	// contains filtered or unexported fields
}

AdminsLogin represents a controller struct.

func NewAdminsLogin 

func NewAdminsLogin(baseController baseController) *AdminsLogin

NewAdminsLogin creates a new instance of AdminsLogin. It takes a baseController as a parameter and returns a pointer to the AdminsLogin.

func (*AdminsLogin) Login 

func (a *AdminsLogin) Login(
	ctx context.Context,
	body *models.Login) (
	models.ApiResponse[models.ResponseLoginSuccess],
	error)

Login takes context, body as parameters and returns an models.ApiResponse with models.ResponseLoginSuccess data and an error if there was an issue with the request or response. Log in with email/password. When 2FA is enabled, there are two ways to login: 1. login with two_factor token (with Google Authenticator, etc) 2. login with email/password, generate the token, and use /login/two_factor with the token

func (*AdminsLogin) TwoFactor 

func (a *AdminsLogin) TwoFactor(
	ctx context.Context,
	body *models.TwoFactorString) (
	*http.Response,
	error)

TwoFactor takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Send 2FA Code

type AdminsLoginOAuth2 

type AdminsLoginOAuth2 struct {
	// contains filtered or unexported fields
}

AdminsLoginOAuth2 represents a controller struct.

func NewAdminsLoginOAuth2 

func NewAdminsLoginOAuth2(baseController baseController) *AdminsLoginOAuth2

NewAdminsLoginOAuth2 creates a new instance of AdminsLoginOAuth2. It takes a baseController as a parameter and returns a pointer to the AdminsLoginOAuth2.

func (*AdminsLoginOAuth2) GetOauth2AuthorizationUrlForLogin 

func (a *AdminsLoginOAuth2) GetOauth2AuthorizationUrlForLogin(
	ctx context.Context,
	provider string,
	forward *string) (
	models.ApiResponse[models.ResponseLoginOauthUrl],
	error)

GetOauth2AuthorizationUrlForLogin takes context, provider, forward as parameters and returns an models.ApiResponse with models.ResponseLoginOauthUrl data and an error if there was an issue with the request or response. Obtain Authorization URL for Login

func (*AdminsLoginOAuth2) LoginOauth2 

func (a *AdminsLoginOAuth2) LoginOauth2(
	ctx context.Context,
	provider string,
	body *models.CodeString) (
	*http.Response,
	error)

LoginOauth2 takes context, provider, body as parameters and returns an *Response and an error if there was an issue with the request or response. Login via OAuth2

func (*AdminsLoginOAuth2) UnlinkOauth2Provider 

func (a *AdminsLoginOAuth2) UnlinkOauth2Provider(
	ctx context.Context,
	provider string) (
	*http.Response,
	error)

UnlinkOauth2Provider takes context, provider as parameters and returns an *Response and an error if there was an issue with the request or response. Unlink OAuth2 Provider

type AdminsLogout 

type AdminsLogout struct {
	// contains filtered or unexported fields
}

AdminsLogout represents a controller struct.

func NewAdminsLogout 

func NewAdminsLogout(baseController baseController) *AdminsLogout

NewAdminsLogout creates a new instance of AdminsLogout. It takes a baseController as a parameter and returns a pointer to the AdminsLogout.

func (*AdminsLogout) Logout 

func (a *AdminsLogout) Logout(ctx context.Context) (
	models.ApiResponse[models.ResponseLogout],
	error)

Logout takes context as parameters and returns an models.ApiResponse with models.ResponseLogout data and an error if there was an issue with the request or response. Logout

type AdminsLookup 

type AdminsLookup struct {
	// contains filtered or unexported fields
}

AdminsLookup represents a controller struct.

func NewAdminsLookup 

func NewAdminsLookup(baseController baseController) *AdminsLookup

NewAdminsLookup creates a new instance of AdminsLookup. It takes a baseController as a parameter and returns a pointer to the AdminsLookup.

func (*AdminsLookup) Lookup 

func (a *AdminsLookup) Lookup(
	ctx context.Context,
	body *models.EmailString) (
	models.ApiResponse[models.ResponseLoginLookup],
	error)

Lookup takes context, body as parameters and returns an models.ApiResponse with models.ResponseLoginLookup data and an error if there was an issue with the request or response. Login Lookup

type AdminsRecoverPassword 

type AdminsRecoverPassword struct {
	// contains filtered or unexported fields
}

AdminsRecoverPassword represents a controller struct.

func NewAdminsRecoverPassword 

func NewAdminsRecoverPassword(baseController baseController) *AdminsRecoverPassword

NewAdminsRecoverPassword creates a new instance of AdminsRecoverPassword. It takes a baseController as a parameter and returns a pointer to the AdminsRecoverPassword.

func (*AdminsRecoverPassword) RecoverPassword 

func (a *AdminsRecoverPassword) RecoverPassword(
	ctx context.Context,
	body *models.Recover) (
	*http.Response,
	error)

RecoverPassword takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Recover Password An email will also be sent to the user with a link to https://manage.mist.com/verify/recover?token=:token

func (*AdminsRecoverPassword) VerifyRecoverPasssword 

func (a *AdminsRecoverPassword) VerifyRecoverPasssword(
	ctx context.Context,
	token string) (
	*http.Response,
	error)

VerifyRecoverPasssword takes context, token as parameters and returns an *Response and an error if there was an issue with the request or response. Verify Recover Password With correct verification, the user will be authenticated. UI can then prompt for new password

type ApiTokenCredentials 

type ApiTokenCredentials struct {
	// contains filtered or unexported fields
}

ApiTokenCredentials represents the credentials required for `apiToken` authentication.

func NewApiTokenCredentials 

func NewApiTokenCredentials(authorization string) ApiTokenCredentials

NewApiTokenCredentials creates a new instance of ApiTokenCredentials with provided parameters.

func (ApiTokenCredentials) Authenticator 

func (a ApiTokenCredentials) Authenticator() https.HttpInterceptor

Authenticator function returns HttpInterceptor function that provides authentication for API calls.

func (ApiTokenCredentials) Authorization 

func (a ApiTokenCredentials) Authorization() string

Authorization returns the authorization associated with the ApiTokenCredentials.

func (ApiTokenCredentials) Validate 

func (a ApiTokenCredentials) Validate() error

Validate function returns validation error associated with the ApiTokenCredentials.

func (ApiTokenCredentials) WithAuthorization 

func (a ApiTokenCredentials) WithAuthorization(authorization string) ApiTokenCredentials

WithAuthorization sets authorization in ApiTokenCredentials.

type BasicAuthCredentials 

type BasicAuthCredentials struct {
	// contains filtered or unexported fields
}

BasicAuthCredentials represents the credentials required for `basicAuth` authentication.

func NewBasicAuthCredentials 

func NewBasicAuthCredentials(
	username string,
	password string) BasicAuthCredentials

NewBasicAuthCredentials creates a new instance of BasicAuthCredentials with provided parameters.

func (BasicAuthCredentials) Authenticator 

func (b BasicAuthCredentials) Authenticator() https.HttpInterceptor

Authenticator function returns HttpInterceptor function that provides authentication for API calls.

func (BasicAuthCredentials) Password 

func (b BasicAuthCredentials) Password() string

Password returns the password associated with the BasicAuthCredentials.

func (BasicAuthCredentials) Username 

func (b BasicAuthCredentials) Username() string

Username returns the username associated with the BasicAuthCredentials.

func (BasicAuthCredentials) Validate 

func (b BasicAuthCredentials) Validate() error

Validate function returns validation error associated with the BasicAuthCredentials.

func (BasicAuthCredentials) WithPassword 

func (b BasicAuthCredentials) WithPassword(password string) BasicAuthCredentials

WithPassword sets password in BasicAuthCredentials.

func (BasicAuthCredentials) WithUsername 

func (b BasicAuthCredentials) WithUsername(username string) BasicAuthCredentials

WithUsername sets username in BasicAuthCredentials.

type ClientInterface 

type ClientInterface interface {
	Configuration() Configuration
	CloneWithConfiguration(options ...ConfigurationOptions) ClientInterface
	Admins() *Admins
	AdminsLogin() *AdminsLogin
	AdminsLogout() *AdminsLogout
	AdminsRecoverPassword() *AdminsRecoverPassword
	AdminsLookup() *AdminsLookup
	AdminsLoginOAuth2() *AdminsLoginOAuth2
	Installer() *Installer
	MSPs() *MSPs
	MSPsAdmins() *MSPsAdmins
	OrgsSecIntelProfiles() *OrgsSecIntelProfiles
	SitesSecIntelProfiles() *SitesSecIntelProfiles
	MSPsInventory() *MSPsInventory
	MSPsLogs() *MSPsLogs
	MSPsLicenses() *MSPsLicenses
	MSPsMarvis() *MSPsMarvis
	MSPsOrgGroups() *MSPsOrgGroups
	MSPsOrgs() *MSPsOrgs
	MSPsSLEs() *MSPsSLEs
	MSPsSSORoles() *MSPsSSORoles
	MSPsSSO() *MSPsSSO
	MSPsTickets() *MSPsTickets
	Orgs() *Orgs
	OrgsAdmins() *OrgsAdmins
	OrgsAlarms() *OrgsAlarms
	OrgsAlarmTemplates() *OrgsAlarmTemplates
	OrgsAPTemplates() *OrgsAPTemplates
	OrgsAPITokens() *OrgsAPITokens
	OrgsAssets() *OrgsAssets
	OrgsAssetFilters() *OrgsAssetFilters
	OrgsCert() *OrgsCert
	OrgsAntivirusProfiles() *OrgsAntivirusProfiles
	OrgsClientsMarvis() *OrgsClientsMarvis
	OrgsClientsNAC() *OrgsClientsNAC
	OrgsClientsWan() *OrgsClientsWan
	OrgsClientsWired() *OrgsClientsWired
	OrgsClientsWireless() *OrgsClientsWireless
	OrgsClientsSDK() *OrgsClientsSDK
	OrgsCradlepoint() *OrgsCradlepoint
	OrgsCRL() *OrgsCRL
	OrgsDeviceProfiles() *OrgsDeviceProfiles
	OrgsDevices() *OrgsDevices
	OrgsDevicesSSR() *OrgsDevicesSSR
	OrgsEVPNTopologies() *OrgsEVPNTopologies
	OrgsDevicesOthers() *OrgsDevicesOthers
	OrgsSettingZscaler() *OrgsSettingZscaler
	OrgsSCEP() *OrgsSCEP
	OrgsGatewayTemplates() *OrgsGatewayTemplates
	OrgsGuests() *OrgsGuests
	OrgsIDPProfiles() *OrgsIDPProfiles
	OrgsInventory() *OrgsInventory
	OrgsJSE() *OrgsJSE
	OrgsJSI() *OrgsJSI
	OrgsLicenses() *OrgsLicenses
	OrgsLinkedApplications() *OrgsLinkedApplications
	OrgsLogs() *OrgsLogs
	OrgsMarvis() *OrgsMarvis
	OrgsMaps() *OrgsMaps
	OrgsMxClusters() *OrgsMxClusters
	OrgsMxEdges() *OrgsMxEdges
	OrgsMxTunnels() *OrgsMxTunnels
	OrgsNACIDP() *OrgsNACIDP
	OrgsNACTags() *OrgsNACTags
	OrgsNACPortals() *OrgsNACPortals
	OrgsNACCRL() *OrgsNACCRL
	OrgsStats() *OrgsStats
	OrgsStatsAssets() *OrgsStatsAssets
	OrgsStatsBGPPeers() *OrgsStatsBGPPeers
	OrgsStatsDevices() *OrgsStatsDevices
	OrgsStatsMxEdges() *OrgsStatsMxEdges
	OrgsStatsOtherDevices() *OrgsStatsOtherDevices
	OrgsStatsPorts() *OrgsStatsPorts
	OrgsStatsSites() *OrgsStatsSites
	OrgsStatsTunnels() *OrgsStatsTunnels
	OrgsStatsVPNPeers() *OrgsStatsVPNPeers
	OrgsNACRules() *OrgsNACRules
	OrgsNetworkTemplates() *OrgsNetworkTemplates
	OrgsNetworks() *OrgsNetworks
	OrgsPremiumAnalytics() *OrgsPremiumAnalytics
	OrgsPsks() *OrgsPsks
	OrgsPskPortals() *OrgsPskPortals
	OrgsRFTemplates() *OrgsRFTemplates
	OrgsSDKInvites() *OrgsSDKInvites
	OrgsSDKTemplates() *OrgsSDKTemplates
	OrgsSecPolicies() *OrgsSecPolicies
	OrgsServices() *OrgsServices
	OrgsServicePolicies() *OrgsServicePolicies
	OrgsSetting() *OrgsSetting
	OrgsSitegroups() *OrgsSitegroups
	OrgsSites() *OrgsSites
	OrgsSiteTemplates() *OrgsSiteTemplates
	OrgsSLEs() *OrgsSLEs
	OrgsSSORoles() *OrgsSSORoles
	OrgsSSO() *OrgsSSO
	OrgsSubscriptions() *OrgsSubscriptions
	OrgsWLANTemplates() *OrgsWLANTemplates
	OrgsTickets() *OrgsTickets
	OrgsUserMACs() *OrgsUserMACs
	OrgsVars() *OrgsVars
	OrgsVPNs() *OrgsVPNs
	OrgsWebhooks() *OrgsWebhooks
	OrgsWlans() *OrgsWlans
	OrgsWxRules() *OrgsWxRules
	OrgsWxTags() *OrgsWxTags
	OrgsWxTunnels() *OrgsWxTunnels
	Sites() *Sites
	SitesAlarms() *SitesAlarms
	SitesAPTemplates() *SitesAPTemplates
	SitesApplications() *SitesApplications
	SitesAnomaly() *SitesAnomaly
	SitesAssetFilters() *SitesAssetFilters
	SitesAssets() *SitesAssets
	SitesBeacons() *SitesBeacons
	SitesClientsNAC() *SitesClientsNAC
	SitesClientsWan() *SitesClientsWan
	SitesClientsWired() *SitesClientsWired
	SitesClientsWireless() *SitesClientsWireless
	SitesDevices() *SitesDevices
	SitesDevicesWireless() *SitesDevicesWireless
	SitesDevicesOthers() *SitesDevicesOthers
	SitesDevicesWired() *SitesDevicesWired
	SitesDevicesWiredVirtualChassis() *SitesDevicesWiredVirtualChassis
	SitesDevicesWANCluster() *SitesDevicesWANCluster
	SitesDeviceProfiles() *SitesDeviceProfiles
	SitesEvents() *SitesEvents
	SitesEVPNTopologies() *SitesEVPNTopologies
	SitesGatewayTemplates() *SitesGatewayTemplates
	SitesGuests() *SitesGuests
	SitesInsights() *SitesInsights
	SitesJSE() *SitesJSE
	SitesLicenses() *SitesLicenses
	SitesLocation() *SitesLocation
	SitesMaps() *SitesMaps
	SitesMapsAutoPlacement() *SitesMapsAutoPlacement
	SitesMapsAutoZone() *SitesMapsAutoZone
	SitesMxEdges() *SitesMxEdges
	SitesNetworkTemplates() *SitesNetworkTemplates
	SitesNetworks() *SitesNetworks
	SitesPsks() *SitesPsks
	SitesRFTemplates() *SitesRFTemplates
	SitesRfdiags() *SitesRfdiags
	SitesRogues() *SitesRogues
	SitesRRM() *SitesRRM
	SitesRSSIZones() *SitesRSSIZones
	SitesServices() *SitesServices
	SitesServicePolicies() *SitesServicePolicies
	SitesSetting() *SitesSetting
	SitesSiteTemplates() *SitesSiteTemplates
	SitesSkyatp() *SitesSkyatp
	SitesSLEs() *SitesSLEs
	SitesSyntheticTests() *SitesSyntheticTests
	SitesUISettings() *SitesUISettings
	SitesVBeacons() *SitesVBeacons
	SitesVPNs() *SitesVPNs
	SitesWANUsages() *SitesWANUsages
	SitesWebhooks() *SitesWebhooks
	SitesWlans() *SitesWlans
	SitesWxRules() *SitesWxRules
	SitesWxTags() *SitesWxTags
	SitesWxTunnels() *SitesWxTunnels
	SitesZones() *SitesZones
	SitesStats() *SitesStats
	SitesStatsApps() *SitesStatsApps
	SitesStatsAssets() *SitesStatsAssets
	SitesStatsBeacons() *SitesStatsBeacons
	SitesStatsBGPPeers() *SitesStatsBGPPeers
	SitesStatsCalls() *SitesStatsCalls
	SitesStatsClientsWireless() *SitesStatsClientsWireless
	SitesStatsClientsSDK() *SitesStatsClientsSDK
	SitesStatsDevices() *SitesStatsDevices
	SitesStatsMxEdges() *SitesStatsMxEdges
	SitesStatsPorts() *SitesStatsPorts
	SitesStatsWxRules() *SitesStatsWxRules
	SitesStatsZones() *SitesStatsZones
	SitesStatsDiscoveredSwitches() *SitesStatsDiscoveredSwitches
	ConstantsDefinitions() *ConstantsDefinitions
	ConstantsEvents() *ConstantsEvents
	ConstantsModels() *ConstantsModels
	SelfAccount() *SelfAccount
	SelfAPIToken() *SelfAPIToken
	SelfOAuth2() *SelfOAuth2
	SelfMFA() *SelfMFA
	SelfAlarms() *SelfAlarms
	SelfAuditLogs() *SelfAuditLogs
	UtilitiesCommon() *UtilitiesCommon
	UtilitiesWAN() *UtilitiesWAN
	UtilitiesLAN() *UtilitiesLAN
	UtilitiesWiFi() *UtilitiesWiFi
	UtilitiesPCAPs() *UtilitiesPCAPs
	UtilitiesLocation() *UtilitiesLocation
	UtilitiesMxEdge() *UtilitiesMxEdge
	UtilitiesUpgrade() *UtilitiesUpgrade
	UserAgent() *string
}

Client is an interface representing the main client for accessing configuration and controllers.

func NewClient 

func NewClient(configuration Configuration) ClientInterface

NewClient is the constructor for creating a new client instance. It takes a Configuration object as a parameter and returns the Client interface.

type Configuration 

type Configuration struct {
	// contains filtered or unexported fields
}

Configuration holds configuration settings.

func CreateConfiguration 

func CreateConfiguration(options ...ConfigurationOptions) Configuration

CreateConfiguration creates a new Configuration with the provided options.

func CreateConfigurationFromEnvironment 

func CreateConfigurationFromEnvironment(options ...ConfigurationOptions) Configuration

CreateConfigurationFromEnvironment creates a new Configuration with default settings. It also configures various Configuration options.

func DefaultConfiguration 

func DefaultConfiguration() Configuration

DefaultConfiguration returns the default Configuration.

func (Configuration) ApiTokenCredentials 

func (c Configuration) ApiTokenCredentials() ApiTokenCredentials

ApiTokenCredentials returns the apiTokenCredentials from the Configuration.

func (Configuration) BasicAuthCredentials 

func (c Configuration) BasicAuthCredentials() BasicAuthCredentials

BasicAuthCredentials returns the basicAuthCredentials from the Configuration.

func (Configuration) CsrfTokenCredentials 

func (c Configuration) CsrfTokenCredentials() CsrfTokenCredentials

CsrfTokenCredentials returns the csrfTokenCredentials from the Configuration.

func (Configuration) Environment 

func (c Configuration) Environment() Environment

Environment returns the environment from the Configuration.

func (Configuration) HttpConfiguration 

func (c Configuration) HttpConfiguration() HttpConfiguration

HttpConfiguration returns the httpConfiguration from the Configuration.

type ConfigurationOptions 

type ConfigurationOptions func(*Configuration)

ConfigurationOptions represents a function type that can be used to apply options to the Configuration struct.

func WithApiTokenCredentials 

func WithApiTokenCredentials(apiTokenCredentials ApiTokenCredentials) ConfigurationOptions

WithApiTokenCredentials is an option that sets the ApiTokenCredentials in the Configuration.

func WithBasicAuthCredentials 

func WithBasicAuthCredentials(basicAuthCredentials BasicAuthCredentials) ConfigurationOptions

WithBasicAuthCredentials is an option that sets the BasicAuthCredentials in the Configuration.

func WithCsrfTokenCredentials 

func WithCsrfTokenCredentials(csrfTokenCredentials CsrfTokenCredentials) ConfigurationOptions

WithCsrfTokenCredentials is an option that sets the CsrfTokenCredentials in the Configuration.

func WithEnvironment 

func WithEnvironment(environment Environment) ConfigurationOptions

WithEnvironment is an option that sets the Environment in the Configuration.

func WithHttpConfiguration 

func WithHttpConfiguration(httpConfiguration HttpConfiguration) ConfigurationOptions

WithHttpConfiguration is an option that sets the HttpConfiguration in the Configuration.

func WithLoggerConfiguration 

func WithLoggerConfiguration(options ...LoggerOptions) ConfigurationOptions

WithLoggerConfiguration is an option that sets the LoggerConfiguration in the Configuration.

type ConstantsDefinitions 

type ConstantsDefinitions struct {
	// contains filtered or unexported fields
}

ConstantsDefinitions represents a controller struct.

func NewConstantsDefinitions 

func NewConstantsDefinitions(baseController baseController) *ConstantsDefinitions

NewConstantsDefinitions creates a new instance of ConstantsDefinitions. It takes a baseController as a parameter and returns a pointer to the ConstantsDefinitions.

func (*ConstantsDefinitions) GetLicenseTypes added in v0.3.7 

func (c *ConstantsDefinitions) GetLicenseTypes(ctx context.Context) (
	models.ApiResponse[[]models.ConstLicenseType],
	error)

GetLicenseTypes takes context as parameters and returns an models.ApiResponse with []models.ConstLicenseType data and an error if there was an issue with the request or response. Get License Types

func (*ConstantsDefinitions) ListAlarmDefinitions 

func (c *ConstantsDefinitions) ListAlarmDefinitions(ctx context.Context) (
	models.ApiResponse[[]models.ConstAlarmDefinition],
	error)

ListAlarmDefinitions takes context as parameters and returns an models.ApiResponse with []models.ConstAlarmDefinition data and an error if there was an issue with the request or response. Get List of brief definitions of all the supported alarm types. The example field contains an example payload as you would recieve in the alarm webhook output. HA cluster node names will be specified in the `node` field, if applicable.'

func (*ConstantsDefinitions) ListApChannels added in v0.3.7 

func (c *ConstantsDefinitions) ListApChannels(
	ctx context.Context,
	countryCode *string) (
	models.ApiResponse[models.ConstApChannel],
	error)

ListApChannels takes context, countryCode as parameters and returns an models.ApiResponse with models.ConstApChannel data and an error if there was an issue with the request or response. Get List of List of Available channels per country code

func (*ConstantsDefinitions) ListApLedDefinition 

func (c *ConstantsDefinitions) ListApLedDefinition(ctx context.Context) (
	models.ApiResponse[[]models.ConstApLed],
	error)

ListApLedDefinition takes context as parameters and returns an models.ApiResponse with []models.ConstApLed data and an error if there was an issue with the request or response. Get List of AP LED definition

func (*ConstantsDefinitions) ListAppCategoryDefinitions 

func (c *ConstantsDefinitions) ListAppCategoryDefinitions(ctx context.Context) (
	models.ApiResponse[[]models.ConstAppCategoryDefinition],
	error)

ListAppCategoryDefinitions takes context as parameters and returns an models.ApiResponse with []models.ConstAppCategoryDefinition data and an error if there was an issue with the request or response. Get List of definitions of all the supported Application Categories. The example field contains an example payload as you would recieve in the alarm webhook output.

func (*ConstantsDefinitions) ListAppSubCategoryDefinitions 

func (c *ConstantsDefinitions) ListAppSubCategoryDefinitions(ctx context.Context) (
	models.ApiResponse[[]models.ConstAppSubcategoryDefinition],
	error)

ListAppSubCategoryDefinitions takes context as parameters and returns an models.ApiResponse with []models.ConstAppSubcategoryDefinition data and an error if there was an issue with the request or response. Get List of definitions of all the supported Application sub-categories. The example field contains an example payload as you would recieve in the alarm webhook output.

func (*ConstantsDefinitions) ListApplications added in v0.2.36 

func (c *ConstantsDefinitions) ListApplications(ctx context.Context) (
	models.ApiResponse[[]models.ConstApplicationDefinition],
	error)

ListApplications takes context as parameters and returns an models.ApiResponse with []models.ConstApplicationDefinition data and an error if there was an issue with the request or response. Get List of a list of applications that Juniper-Mist APs recognize

func (*ConstantsDefinitions) ListCountryCodes added in v0.2.36 

func (c *ConstantsDefinitions) ListCountryCodes(
	ctx context.Context,
	extend *bool) (
	models.ApiResponse[[]models.ConstCountry],
	error)

ListCountryCodes takes context, extend as parameters and returns an models.ApiResponse with []models.ConstCountry data and an error if there was an issue with the request or response. Get List of available Country Codes

func (*ConstantsDefinitions) ListGatewayApplications added in v0.2.36 

func (c *ConstantsDefinitions) ListGatewayApplications(ctx context.Context) (
	models.ApiResponse[[]models.ConstGatewayApplicationsDefinition],
	error)

ListGatewayApplications takes context as parameters and returns an models.ApiResponse with []models.ConstGatewayApplicationsDefinition data and an error if there was an issue with the request or response. Get the full list of applications that we recognize

func (*ConstantsDefinitions) ListInsightMetrics added in v0.3.7 

func (c *ConstantsDefinitions) ListInsightMetrics(ctx context.Context) (
	models.ApiResponse[map[string]models.ConstInsightMetricsProperty],
	error)

ListInsightMetrics takes context as parameters and returns an models.ApiResponse with map[string]models.ConstInsightMetricsProperty data and an error if there was an issue with the request or response. List Insight Metrics

func (*ConstantsDefinitions) ListMarvisClientVersions added in v0.4.0 

func (c *ConstantsDefinitions) ListMarvisClientVersions(ctx context.Context) (
	models.ApiResponse[[]models.ConstMarvisClientVersion],
	error)

ListMarvisClientVersions takes context as parameters and returns an models.ApiResponse with []models.ConstMarvisClientVersion data and an error if there was an issue with the request or response. Get List of the available Marvis Client Versions.

func (*ConstantsDefinitions) ListSiteLanguages added in v0.3.7 

func (c *ConstantsDefinitions) ListSiteLanguages(ctx context.Context) (
	models.ApiResponse[[]models.ConstLanguage],
	error)

ListSiteLanguages takes context as parameters and returns an models.ApiResponse with []models.ConstLanguage data and an error if there was an issue with the request or response. Get List of Languages

func (*ConstantsDefinitions) ListStates added in v0.3.17 

func (c *ConstantsDefinitions) ListStates(
	ctx context.Context,
	countryCode string) (
	models.ApiResponse[[]models.ConstState],
	error)

ListStates takes context, countryCode as parameters and returns an models.ApiResponse with []models.ConstState data and an error if there was an issue with the request or response. Get List of ISO States based on country code

func (*ConstantsDefinitions) ListTrafficTypes added in v0.2.36 

func (c *ConstantsDefinitions) ListTrafficTypes(ctx context.Context) (
	models.ApiResponse[[]models.ConstTrafficType],
	error)

ListTrafficTypes takes context as parameters and returns an models.ApiResponse with []models.ConstTrafficType data and an error if there was an issue with the request or response. Get List of identified traffic

func (*ConstantsDefinitions) ListWebhookTopics added in v0.4.0 

func (c *ConstantsDefinitions) ListWebhookTopics(ctx context.Context) (
	models.ApiResponse[[]models.ConstWebhookTopic],
	error)

ListWebhookTopics takes context as parameters and returns an models.ApiResponse with []models.ConstWebhookTopic data and an error if there was an issue with the request or response. Get List of the available Webhook Topics.

type ConstantsEvents 

type ConstantsEvents struct {
	// contains filtered or unexported fields
}

ConstantsEvents represents a controller struct.

func NewConstantsEvents 

func NewConstantsEvents(baseController baseController) *ConstantsEvents

NewConstantsEvents creates a new instance of ConstantsEvents. It takes a baseController as a parameter and returns a pointer to the ConstantsEvents.

func (*ConstantsEvents) ListClientEventsDefinitions 

func (c *ConstantsEvents) ListClientEventsDefinitions(ctx context.Context) (
	models.ApiResponse[[]models.ConstEvent],
	error)

ListClientEventsDefinitions takes context as parameters and returns an models.ApiResponse with []models.ConstEvent data and an error if there was an issue with the request or response. Get List of List of available Client Events

func (*ConstantsEvents) ListDeviceEventsDefinitions 

func (c *ConstantsEvents) ListDeviceEventsDefinitions(ctx context.Context) (
	models.ApiResponse[[]models.ConstEvent],
	error)

ListDeviceEventsDefinitions takes context as parameters and returns an models.ApiResponse with []models.ConstEvent data and an error if there was an issue with the request or response. Get list of available Device Events

func (*ConstantsEvents) ListMxEdgeEventsDefinitions 

func (c *ConstantsEvents) ListMxEdgeEventsDefinitions(ctx context.Context) (
	models.ApiResponse[[]models.ConstEvent],
	error)

ListMxEdgeEventsDefinitions takes context as parameters and returns an models.ApiResponse with []models.ConstEvent data and an error if there was an issue with the request or response. Get List of available MX Edge Events

func (*ConstantsEvents) ListNacEventsDefinitions 

func (c *ConstantsEvents) ListNacEventsDefinitions(ctx context.Context) (
	models.ApiResponse[[]models.ConstNacEvent],
	error)

ListNacEventsDefinitions takes context as parameters and returns an models.ApiResponse with []models.ConstNacEvent data and an error if there was an issue with the request or response. Get List of List of available NAC Client Events

func (*ConstantsEvents) ListOtherDeviceEventsDefinitions 

func (c *ConstantsEvents) ListOtherDeviceEventsDefinitions(ctx context.Context) (
	models.ApiResponse[[]models.ConstEvent],
	error)

ListOtherDeviceEventsDefinitions takes context as parameters and returns an models.ApiResponse with []models.ConstEvent data and an error if there was an issue with the request or response. Supported Events Type

func (*ConstantsEvents) ListSystemEventsDefinitions 

func (c *ConstantsEvents) ListSystemEventsDefinitions(ctx context.Context) (
	models.ApiResponse[[]models.ConstEvent],
	error)

ListSystemEventsDefinitions takes context as parameters and returns an models.ApiResponse with []models.ConstEvent data and an error if there was an issue with the request or response. Get List of List of available System Events

type ConstantsModels 

type ConstantsModels struct {
	// contains filtered or unexported fields
}

ConstantsModels represents a controller struct.

func NewConstantsModels 

func NewConstantsModels(baseController baseController) *ConstantsModels

NewConstantsModels creates a new instance of ConstantsModels. It takes a baseController as a parameter and returns a pointer to the ConstantsModels.

func (*ConstantsModels) GetGatewayDefaultConfig added in v0.3.7 

func (c *ConstantsModels) GetGatewayDefaultConfig(
	ctx context.Context,
	model string,
	ha *string) (
	models.ApiResponse[interface{}],
	error)

GetGatewayDefaultConfig takes context, model, ha as parameters and returns an models.ApiResponse with interface{} data and an error if there was an issue with the request or response. Generate Default Gateway Config

func (*ConstantsModels) ListDeviceModels 

func (c *ConstantsModels) ListDeviceModels(ctx context.Context) (
	models.ApiResponse[[]models.ConstDeviceModel],
	error)

ListDeviceModels takes context as parameters and returns an models.ApiResponse with []models.ConstDeviceModel data and an error if there was an issue with the request or response. Get list of AP device models for the Mist Site

func (*ConstantsModels) ListMxEdgeModels 

func (c *ConstantsModels) ListMxEdgeModels(ctx context.Context) (
	models.ApiResponse[[]models.ConstMxedgeModel],
	error)

ListMxEdgeModels takes context as parameters and returns an models.ApiResponse with []models.ConstMxedgeModel data and an error if there was an issue with the request or response. Get List of available Mx Edge models

func (*ConstantsModels) ListSupportedOtherDeviceModels 

func (c *ConstantsModels) ListSupportedOtherDeviceModels(ctx context.Context) (
	models.ApiResponse[[]models.ConstOtherDeviceModel],
	error)

ListSupportedOtherDeviceModels takes context as parameters and returns an models.ApiResponse with []models.ConstOtherDeviceModel data and an error if there was an issue with the request or response. Supported OtherDevice Models

type CsrfTokenCredentials 

type CsrfTokenCredentials struct {
	// contains filtered or unexported fields
}

CsrfTokenCredentials represents the credentials required for `csrfToken` authentication.

func NewCsrfTokenCredentials 

func NewCsrfTokenCredentials(xCSRFToken string) CsrfTokenCredentials

NewCsrfTokenCredentials creates a new instance of CsrfTokenCredentials with provided parameters.

func (CsrfTokenCredentials) Authenticator 

func (c CsrfTokenCredentials) Authenticator() https.HttpInterceptor

Authenticator function returns HttpInterceptor function that provides authentication for API calls.

func (CsrfTokenCredentials) Validate 

func (c CsrfTokenCredentials) Validate() error

Validate function returns validation error associated with the CsrfTokenCredentials.

func (CsrfTokenCredentials) WithXCSRFToken 

func (c CsrfTokenCredentials) WithXCSRFToken(xCSRFToken string) CsrfTokenCredentials

WithXCSRFToken sets xCSRFToken in CsrfTokenCredentials.

func (CsrfTokenCredentials) XCSRFToken 

func (c CsrfTokenCredentials) XCSRFToken() string

XCSRFToken returns the xCSRFToken associated with the CsrfTokenCredentials.

type Environment 

type Environment string

Environment represents available environments. 

const (
	MIST_GLOBAL_01 Environment = "Mist Global 01"
	MIST_GLOBAL_02 Environment = "Mist Global 02"
	MIST_GLOBAL_03 Environment = "Mist Global 03"
	MIST_GLOBAL_04 Environment = "Mist Global 04"
	MIST_EMEA_01   Environment = "Mist EMEA 01"
	MIST_EMEA_02   Environment = "Mist EMEA 02"
	MIST_EMEA_03   Environment = "Mist EMEA 03"
	MIST_APAC_01   Environment = "Mist APAC 01"
	AWS_STAGING    Environment = "AWS Staging"
)

type HttpConfiguration 

type HttpConfiguration = https.HttpConfiguration

HttpConfiguration holds the configuration options for the client.

func CreateHttpConfiguration 

func CreateHttpConfiguration(options ...HttpConfigurationOptions) HttpConfiguration

CreateHttpConfiguration creates a new HttpConfiguration with the provided options.

func DefaultHttpConfiguration 

func DefaultHttpConfiguration() HttpConfiguration

DefaultHttpConfiguration returns the default HttpConfiguration for HTTP requests. It also configures various HttpConfiguration options.

type HttpConfigurationOptions 

type HttpConfigurationOptions = https.HttpConfigurationOptions

HttpConfigurationOptions is a function type that modifies the HttpConfiguration.

type Installer 

type Installer struct {
	// contains filtered or unexported fields
}

Installer represents a controller struct.

func NewInstaller 

func NewInstaller(baseController baseController) *Installer

NewInstaller creates a new instance of Installer. It takes a baseController as a parameter and returns a pointer to the Installer.

func (*Installer) AddInstallerDeviceImage 

func (i *Installer) AddInstallerDeviceImage(
	ctx context.Context,
	orgId uuid.UUID,
	imageName string,
	deviceMac string,
	autoDeviceprofileAssignment *bool,
	csv *models.FileWrapper,
	file *models.FileWrapper,
	json *models.MapImportJson) (
	*http.Response,
	error)

AddInstallerDeviceImage takes context, orgId, imageName, deviceMac, autoDeviceprofileAssignment, csv, file, json as parameters and returns an *Response and an error if there was an issue with the request or response. Add image

func (*Installer) ClaimInstallerDevices 

func (i *Installer) ClaimInstallerDevices(
	ctx context.Context,
	orgId uuid.UUID,
	body []string) (
	models.ApiResponse[models.ResponseInventory],
	error)

ClaimInstallerDevices takes context, orgId, body as parameters and returns an models.ApiResponse with models.ResponseInventory data and an error if there was an issue with the request or response. This mirrors `POST /api/v1/orgs/{org_id}/inventory` (see Inventory API)

func (*Installer) CreateInstallerMap 

func (i *Installer) CreateInstallerMap(
	ctx context.Context,
	orgId uuid.UUID,
	siteName string,
	mapId uuid.UUID,
	body *models.Map) (
	models.ApiResponse[models.Map],
	error)

CreateInstallerMap takes context, orgId, siteName, mapId, body as parameters and returns an models.ApiResponse with models.Map data and an error if there was an issue with the request or response. Create a MAP

func (*Installer) CreateInstallerVirtualChassis 

func (i *Installer) CreateInstallerVirtualChassis(
	ctx context.Context,
	orgId uuid.UUID,
	fpc0Mac string,
	body *models.VirtualChassisConfig) (
	models.ApiResponse[models.ResponseVirtualChassisConfig],
	error)

CreateInstallerVirtualChassis takes context, orgId, fpc0Mac, body as parameters and returns an models.ApiResponse with models.ResponseVirtualChassisConfig data and an error if there was an issue with the request or response. For models (e.g. EX3400 and up) having dedicated VC ports, it is easier to form a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new VC and update the inventory. In case that the user would like to choose the dedicated switch as a VC master. Or for EX2300-C-12P and EX2300-C-12T which doesn’t have dedicated VC ports, below are procedures to automate the VC creation: 1. Power on the switch that is choosen as the VC master first. And the powering on the other member switches. 2. Claim or adopt all these switches under the same organization’s Inventory 3. Assign these switches into the same Site 4. Invoke vc command on the switch choosen to be the VC master. For EX2300-C-12P, VC ports will be created automatically. 5. Connect the cables to the VC ports for these switches 6. Wait for the VC to be formed. The Org’s inventory will be updated for the new VC.

func (*Installer) CreateOrUpdateInstallerSites 

func (i *Installer) CreateOrUpdateInstallerSites(
	ctx context.Context,
	orgId uuid.UUID,
	siteName string,
	body *models.InstallerSite) (
	*http.Response,
	error)

CreateOrUpdateInstallerSites takes context, orgId, siteName, body as parameters and returns an *Response and an error if there was an issue with the request or response. Often the Installers are asked to assign Devices to Sites. The Sites can either be pre-created or created/modified by the Installer. If this is an update, the same grace period also applies.

func (*Installer) DeleteInstallerDeviceImage 

func (i *Installer) DeleteInstallerDeviceImage(
	ctx context.Context,
	orgId uuid.UUID,
	imageName string,
	deviceMac string) (
	*http.Response,
	error)

DeleteInstallerDeviceImage takes context, orgId, imageName, deviceMac as parameters and returns an *Response and an error if there was an issue with the request or response. delete image

func (*Installer) DeleteInstallerMap 

func (i *Installer) DeleteInstallerMap(
	ctx context.Context,
	orgId uuid.UUID,
	siteName string,
	mapId uuid.UUID) (
	*http.Response,
	error)

DeleteInstallerMap takes context, orgId, siteName, mapId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Map

func (*Installer) GetInstallerDeviceVirtualChassis 

func (i *Installer) GetInstallerDeviceVirtualChassis(
	ctx context.Context,
	orgId uuid.UUID,
	fpc0Mac string) (
	models.ApiResponse[models.ResponseVirtualChassisConfig],
	error)

GetInstallerDeviceVirtualChassis takes context, orgId, fpc0Mac as parameters and returns an models.ApiResponse with models.ResponseVirtualChassisConfig data and an error if there was an issue with the request or response. Get VC Status The API returns a combined view of the VC status which includes topology and stats

func (*Installer) ImportInstallerMap 

func (i *Installer) ImportInstallerMap(
	ctx context.Context,
	orgId uuid.UUID,
	siteName string,
	autoDeviceprofileAssignment *bool,
	csv *models.FileWrapper,
	file *models.FileWrapper,
	json *models.MapImportJson) (
	models.ApiResponse[models.ResponseMapImport],
	error)

ImportInstallerMap takes context, orgId, siteName, autoDeviceprofileAssignment, csv, file, json as parameters and returns an models.ApiResponse with models.ResponseMapImport data and an error if there was an issue with the request or response. Import data from files is a multipart POST which has an file, an optional json, and an optional csv, to create floorplan, assign & place ap if name or mac matches

func (*Installer) ListInstallerAlarmTemplates 

func (i *Installer) ListInstallerAlarmTemplates(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.InstallersItem],
	error)

ListInstallerAlarmTemplates takes context, orgId as parameters and returns an models.ApiResponse with []models.InstallersItem data and an error if there was an issue with the request or response. Get List of alarm templates

func (*Installer) ListInstallerDeviceProfiles 

func (i *Installer) ListInstallerDeviceProfiles(
	ctx context.Context,
	orgId uuid.UUID,
	mType *models.DeviceTypeEnum) (
	models.ApiResponse[[]models.InstallersItem],
	error)

ListInstallerDeviceProfiles takes context, orgId, mType as parameters and returns an models.ApiResponse with []models.InstallersItem data and an error if there was an issue with the request or response. Get List of Device Profiles

func (*Installer) ListInstallerListOfRenctlyClaimedDevices 

func (i *Installer) ListInstallerListOfRenctlyClaimedDevices(
	ctx context.Context,
	orgId uuid.UUID,
	model *string,
	siteName *string,
	siteId *uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.InstallerDevice],
	error)

ListInstallerListOfRenctlyClaimedDevices takes context, orgId, model, siteName, siteId, limit, page as parameters and returns an models.ApiResponse with []models.InstallerDevice data and an error if there was an issue with the request or response. Get List of recently claimed devices

func (*Installer) ListInstallerMaps 

func (i *Installer) ListInstallerMaps(
	ctx context.Context,
	orgId uuid.UUID,
	siteName string) (
	models.ApiResponse[[]models.Map],
	error)

ListInstallerMaps takes context, orgId, siteName as parameters and returns an models.ApiResponse with []models.Map data and an error if there was an issue with the request or response. Get List of Maps

func (*Installer) ListInstallerRfTemplatesNames 

func (i *Installer) ListInstallerRfTemplatesNames(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.InstallersItem],
	error)

ListInstallerRfTemplatesNames takes context, orgId as parameters and returns an models.ApiResponse with []models.InstallersItem data and an error if there was an issue with the request or response. Get List of RF Templates

func (*Installer) ListInstallerSiteGroups 

func (i *Installer) ListInstallerSiteGroups(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.InstallersItem],
	error)

ListInstallerSiteGroups takes context, orgId as parameters and returns an models.ApiResponse with []models.InstallersItem data and an error if there was an issue with the request or response. Get List of Site Groups

func (*Installer) ListInstallerSites 

func (i *Installer) ListInstallerSites(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.InstallerSite],
	error)

ListInstallerSites takes context, orgId as parameters and returns an models.ApiResponse with []models.InstallerSite data and an error if there was an issue with the request or response. Get List of Sites

func (*Installer) OptimizeInstallerRrm 

func (i *Installer) OptimizeInstallerRrm(
	ctx context.Context,
	siteName string) (
	*http.Response,
	error)

OptimizeInstallerRrm takes context, siteName as parameters and returns an *Response and an error if there was an issue with the request or response. After installation is considered complete (APs are placed on maps, all powered up), you can trigger an optimize operation where RRM will kick in (and maybe other things in the future) before it’s automatically scheduled.

func (*Installer) ProvisionInstallerDevices 

func (i *Installer) ProvisionInstallerDevices(
	ctx context.Context,
	orgId uuid.UUID,
	deviceMac string,
	body *models.InstallerProvisionDevice) (
	*http.Response,
	error)

ProvisionInstallerDevices takes context, orgId, deviceMac, body as parameters and returns an *Response and an error if there was an issue with the request or response. Provision or Replace a device If replacing_mac is in the request payload, other attributes are ignored, we attempt to replace existing device (with mac replacing_mac) with the inventory device being configured. The replacement device must be in the inventory but not assigned, and the replacing_mac device must be assigned to a site, and satisfy grace period requirements. The Device replaced will become unassigned.

func (*Installer) StartInstallerLocateDevice 

func (i *Installer) StartInstallerLocateDevice(
	ctx context.Context,
	orgId uuid.UUID,
	deviceMac string) (
	*http.Response,
	error)

StartInstallerLocateDevice takes context, orgId, deviceMac as parameters and returns an *Response and an error if there was an issue with the request or response. Locate a Device by blinking it’s LED, it’s a persisted state that has to be stopped by calling Stop Locating API

func (*Installer) StopInstallerLocateDevice 

func (i *Installer) StopInstallerLocateDevice(
	ctx context.Context,
	orgId uuid.UUID,
	deviceMac string) (
	*http.Response,
	error)

StopInstallerLocateDevice takes context, orgId, deviceMac as parameters and returns an *Response and an error if there was an issue with the request or response. Stop it

func (*Installer) UnassignInstallerRecentlyClaimedDevice 

func (i *Installer) UnassignInstallerRecentlyClaimedDevice(
	ctx context.Context,
	orgId uuid.UUID,
	deviceMac string) (
	*http.Response,
	error)

UnassignInstallerRecentlyClaimedDevice takes context, orgId, deviceMac as parameters and returns an *Response and an error if there was an issue with the request or response. Unassign recently claimed devices

func (*Installer) UpdateInstallerMap 

func (i *Installer) UpdateInstallerMap(
	ctx context.Context,
	orgId uuid.UUID,
	siteName string,
	mapId uuid.UUID,
	body *models.Map) (
	models.ApiResponse[models.Map],
	error)

UpdateInstallerMap takes context, orgId, siteName, mapId, body as parameters and returns an models.ApiResponse with models.Map data and an error if there was an issue with the request or response. Update map

func (*Installer) UpdateInstallerVirtualChassisMember 

func (i *Installer) UpdateInstallerVirtualChassisMember(
	ctx context.Context,
	orgId uuid.UUID,
	fpc0Mac string,
	body *models.VirtualChassisUpdate) (
	models.ApiResponse[models.ResponseVirtualChassisConfig],
	error)

UpdateInstallerVirtualChassisMember takes context, orgId, fpc0Mac, body as parameters and returns an models.ApiResponse with models.ResponseVirtualChassisConfig data and an error if there was an issue with the request or response. The VC creation and adding member switch API will update the device’ s virtual chassis config which is applied after VC is formed to create JUNOS pre-provisioned virtual chassis configuration. ## Change to use preprovisioned VC To switch the VC to use preprovisioned VC, enable preprovisioned in virtual_chassis config. Both vc_role master and backup will be matched to routing-engine role in Junos preprovisioned VC config. In this config, fpc0 has to be the same as the mac of device_id. Use renumber if you want to replace fpc0 which involves device_id change. Notice: to configure preprovisioned VC, every member of the VC must be in the inventory. ## Add new members For models (e.g. EX4300 and up) having dedicated VC ports, it is easier to add new member switches into a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new members and update the inventory. For EX2300 VC, adding new members requires to follow the procedures below: 1. Powering on the new member switches and ensuring cables are not connected to any VC ports. 2. Claim or adopt all new member switches under the VC’s organization Inventory 3. Assign all new member switches to the same Site as the VC 4. Invoke vc command to add switches to the VC. 5. Connect the cables to the VC ports for these switches 6. After a while, the Org’s Inventory shows this new switches has been added into the VC. ## Removing member switch To remove a member switch from the VC, following the procedures below: 1. Ensuring the VC is connected to the cloud first 2. Unplug the cable from the VC port of the switch 3. Waiting for the VC state (vc_state) of this switch is changed to not-present 4. Invoke update_vc with remove to remove this switch from the VC 5. The Org’s Inventory shows the switch is removed. Please notice that member ID 0 (fpc0) cannot be removed. When a VC has two switches left, unpluging the cable may result in the situation that fpc0 becomes a line card (LC). When this situation is happened, please re-plug in the cable, wait for both switches becoming present (show virtual-chassis) and then removing the cable again. ## Renumber a member switch When a member switch doesn’ t work properly and needed to be replaced, the renumber API could be used. The following two types of renumber are supported: 1. Replace a non-fpc0 member switch 2. Replace fpc0. When fpc0 is relaced, PAPI device config and JUNOS config will be both updated. For renumber to work, the following procedures are needed: 1. Ensuring the VC is connected to the cloud and the state of the member switch to be replaced must be non present. 2. Adding the new member switch to the VC 3. Waiting for the VC state (vc_state) of this VC to be updated to API server 4. Invoke vc with renumber to replace the new member switch from fpc X to ## Perprovision VC members By specifying “preprovision” op, you can convert the current VC to pre-provisioned mode, update VC members as well as specify vc_ports when adding new members for device models without dedicated vc ports. Use renumber for fpc0 replacement which involves device_id change. Note: 1. vc_ports is used for adding new members and not needed if * the device model has dedicated vc ports, or * no new member is added 2. New VC members to be added should exist in the same Site as the VC Update Device’s VC config can achieve similar purpose by directly modifying current virtual_chassis config. However, it cannot fulfill requests to enabling vc_ports on new members that are yet to belong to current VC.

type Level 

type Level = logger.Level

Level holds the configuration options for the client.

type LoggerConfiguration 

type LoggerConfiguration = logger.LoggerConfiguration

LoggerConfiguration holds the configuration options for the client.

type LoggerInterface 

type LoggerInterface = logger.LoggerInterface

LoggerInterface holds the configuration options for the client.

type LoggerOptions 

type LoggerOptions = logger.LoggerOptions

LoggerOptions holds the configuration options for the client.

type MSPs 

type MSPs struct {
	// contains filtered or unexported fields
}

MSPs represents a controller struct.

func NewMSPs 

func NewMSPs(baseController baseController) *MSPs

NewMSPs creates a new instance of MSPs. It takes a baseController as a parameter and returns a pointer to the MSPs.

func (*MSPs) CreateMsp 

func (m *MSPs) CreateMsp(
	ctx context.Context,
	body *models.Msp) (
	models.ApiResponse[models.Msp],
	error)

CreateMsp takes context, body as parameters and returns an models.ApiResponse with models.Msp data and an error if there was an issue with the request or response. Create MSP account

func (*MSPs) DeleteMsp 

func (m *MSPs) DeleteMsp(
	ctx context.Context,
	mspId uuid.UUID) (
	*http.Response,
	error)

DeleteMsp takes context, mspId as parameters and returns an *Response and an error if there was an issue with the request or response. Deleting MSP removes the MSP and OrgGroup under the MSP as well as all privileges associated with them. It does not remove any Org or Admins

func (*MSPs) GetMspDetails 

func (m *MSPs) GetMspDetails(
	ctx context.Context,
	mspId uuid.UUID) (
	models.ApiResponse[models.Msp],
	error)

GetMspDetails takes context, mspId as parameters and returns an models.ApiResponse with models.Msp data and an error if there was an issue with the request or response. Get MSP Detail

func (*MSPs) SearchMspOrgGroup 

func (m *MSPs) SearchMspOrgGroup(
	ctx context.Context,
	mspId uuid.UUID,
	mType models.MspSearchTypeEnum,
	q *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseSearch],
	error)

SearchMspOrgGroup takes context, mspId, mType, q, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseSearch data and an error if there was an issue with the request or response. Search in MSP Orgs

func (*MSPs) UpdateMsp 

func (m *MSPs) UpdateMsp(
	ctx context.Context,
	mspId uuid.UUID,
	body *models.Msp) (
	models.ApiResponse[models.Msp],
	error)

UpdateMsp takes context, mspId, body as parameters and returns an models.ApiResponse with models.Msp data and an error if there was an issue with the request or response. Update MSP

type MSPsAdmins 

type MSPsAdmins struct {
	// contains filtered or unexported fields
}

MSPsAdmins represents a controller struct.

func NewMSPsAdmins 

func NewMSPsAdmins(baseController baseController) *MSPsAdmins

NewMSPsAdmins creates a new instance of MSPsAdmins. It takes a baseController as a parameter and returns a pointer to the MSPsAdmins.

func (*MSPsAdmins) GetMspAdmin 

func (m *MSPsAdmins) GetMspAdmin(
	ctx context.Context,
	mspId uuid.UUID,
	adminId uuid.UUID) (
	models.ApiResponse[models.Admin],
	error)

GetMspAdmin takes context, mspId, adminId as parameters and returns an models.ApiResponse with models.Admin data and an error if there was an issue with the request or response. Get MSP Admins

func (*MSPsAdmins) InviteMspAdmin 

func (m *MSPsAdmins) InviteMspAdmin(
	ctx context.Context,
	mspId uuid.UUID,
	body *models.Admin) (
	models.ApiResponse[models.Admin],
	error)

InviteMspAdmin takes context, mspId, body as parameters and returns an models.ApiResponse with models.Admin data and an error if there was an issue with the request or response. Invite MSP Admin **Note**: An email will also be sent to the user with a link to https://manage.mist.com/verify/invite?token=:token

func (*MSPsAdmins) ListMspAdmins 

func (m *MSPsAdmins) ListMspAdmins(
	ctx context.Context,
	mspId uuid.UUID) (
	models.ApiResponse[[]models.Admin],
	error)

ListMspAdmins takes context, mspId as parameters and returns an models.ApiResponse with []models.Admin data and an error if there was an issue with the request or response. Get List of MSP Admins

func (*MSPsAdmins) RevokeMspAdmin 

func (m *MSPsAdmins) RevokeMspAdmin(
	ctx context.Context,
	mspId uuid.UUID,
	adminId uuid.UUID) (
	*http.Response,
	error)

RevokeMspAdmin takes context, mspId, adminId as parameters and returns an *Response and an error if there was an issue with the request or response. This removes all privileges this admin has against the MSP. This goes deep all the way to the sites

func (*MSPsAdmins) UninviteMspAdmin 

func (m *MSPsAdmins) UninviteMspAdmin(
	ctx context.Context,
	mspId uuid.UUID,
	inviteId uuid.UUID) (
	*http.Response,
	error)

UninviteMspAdmin takes context, mspId, inviteId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete admin invite

func (*MSPsAdmins) UpdateMspAdmin 

func (m *MSPsAdmins) UpdateMspAdmin(
	ctx context.Context,
	mspId uuid.UUID,
	adminId uuid.UUID,
	body *models.Admin) (
	models.ApiResponse[models.Admin],
	error)

UpdateMspAdmin takes context, mspId, adminId, body as parameters and returns an models.ApiResponse with models.Admin data and an error if there was an issue with the request or response. Update MSP Admin

func (*MSPsAdmins) UpdateMspAdminInvite 

func (m *MSPsAdmins) UpdateMspAdminInvite(
	ctx context.Context,
	mspId uuid.UUID,
	inviteId uuid.UUID,
	body *models.Admin) (
	models.ApiResponse[models.Admin],
	error)

UpdateMspAdminInvite takes context, mspId, inviteId, body as parameters and returns an models.ApiResponse with models.Admin data and an error if there was an issue with the request or response. Update MSP admin invite

type MSPsInventory 

type MSPsInventory struct {
	// contains filtered or unexported fields
}

MSPsInventory represents a controller struct.

func NewMSPsInventory 

func NewMSPsInventory(baseController baseController) *MSPsInventory

NewMSPsInventory creates a new instance of MSPsInventory. It takes a baseController as a parameter and returns a pointer to the MSPsInventory.

func (*MSPsInventory) GetMspInventoryByMac 

func (m *MSPsInventory) GetMspInventoryByMac(
	ctx context.Context,
	mspId uuid.UUID,
	deviceMac string) (
	models.ApiResponse[models.ResponseMspInventoryDevice],
	error)

GetMspInventoryByMac takes context, mspId, deviceMac as parameters and returns an models.ApiResponse with models.ResponseMspInventoryDevice data and an error if there was an issue with the request or response. Get Inventoy By device MAC address

type MSPsLicenses 

type MSPsLicenses struct {
	// contains filtered or unexported fields
}

MSPsLicenses represents a controller struct.

func NewMSPsLicenses 

func NewMSPsLicenses(baseController baseController) *MSPsLicenses

NewMSPsLicenses creates a new instance of MSPsLicenses. It takes a baseController as a parameter and returns a pointer to the MSPsLicenses.

func (*MSPsLicenses) ClaimMspLicence 

func (m *MSPsLicenses) ClaimMspLicence(
	ctx context.Context,
	mspId uuid.UUID,
	body *models.CodeString) (
	models.ApiResponse[models.ResponseClaimLicense],
	error)

ClaimMspLicence takes context, mspId, body as parameters and returns an models.ApiResponse with models.ResponseClaimLicense data and an error if there was an issue with the request or response. Claim an Order by Activation Code

func (*MSPsLicenses) ListMspLicenses 

func (m *MSPsLicenses) ListMspLicenses(
	ctx context.Context,
	mspId uuid.UUID) (
	models.ApiResponse[models.License],
	error)

ListMspLicenses takes context, mspId as parameters and returns an models.ApiResponse with models.License data and an error if there was an issue with the request or response. Get List of Msp Licenses

func (*MSPsLicenses) ListMspOrgLicenses 

func (m *MSPsLicenses) ListMspOrgLicenses(
	ctx context.Context,
	mspId uuid.UUID) (
	models.ApiResponse[models.License],
	error)

ListMspOrgLicenses takes context, mspId as parameters and returns an models.ApiResponse with models.License data and an error if there was an issue with the request or response. Get List of MSP Licences

func (*MSPsLicenses) MoveOrDeleteMspLicenseToAnotherOrg 

func (m *MSPsLicenses) MoveOrDeleteMspLicenseToAnotherOrg(
	ctx context.Context,
	mspId uuid.UUID,
	body *models.MspLicenseAction) (
	*http.Response,
	error)

MoveOrDeleteMspLicenseToAnotherOrg takes context, mspId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Move or Delete MSP Licenses 

type MSPsLogo struct {
	// contains filtered or unexported fields
}

MSPsLogo represents a controller struct. 

func NewMSPsLogo(baseController baseController) *MSPsLogo

NewMSPsLogo creates a new instance of MSPsLogo. It takes a baseController as a parameter and returns a pointer to the MSPsLogo. 

func (m *MSPsLogo) DeleteMspLogo(
	ctx context.Context,
	mspId uuid.UUID) (
	*http.Response,
	error)

DeleteMspLogo takes context, mspId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete MSP Logo 

func (m *MSPsLogo) PostMspLogo(
	ctx context.Context,
	mspId uuid.UUID,
	body *models.MspLogo) (
	*http.Response,
	error)

PostMspLogo takes context, mspId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Upload Logo (only for advanced msp tier)

type MSPsLogs 

type MSPsLogs struct {
	// contains filtered or unexported fields
}

MSPsLogs represents a controller struct.

func NewMSPsLogs 

func NewMSPsLogs(baseController baseController) *MSPsLogs

NewMSPsLogs creates a new instance of MSPsLogs. It takes a baseController as a parameter and returns a pointer to the MSPsLogs.

func (*MSPsLogs) CountMspAuditLogs added in v0.2.18 

func (m *MSPsLogs) CountMspAuditLogs(
	ctx context.Context,
	mspId uuid.UUID,
	distinct *models.MspLogsCountDistinctEnum) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountMspAuditLogs takes context, mspId, distinct as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Audit Logs

func (*MSPsLogs) ListMspAuditLogs added in v0.2.18 

func (m *MSPsLogs) ListMspAuditLogs(
	ctx context.Context,
	mspId uuid.UUID,
	siteId *string,
	adminName *string,
	message *string,
	sort *models.ListMspLogsSortEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseLogSearch],
	error)

ListMspAuditLogs takes context, mspId, siteId, adminName, message, sort, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponseLogSearch data and an error if there was an issue with the request or response. Get list of change logs for the current MSP

type MSPsMarvis 

type MSPsMarvis struct {
	// contains filtered or unexported fields
}

MSPsMarvis represents a controller struct.

func NewMSPsMarvis 

func NewMSPsMarvis(baseController baseController) *MSPsMarvis

NewMSPsMarvis creates a new instance of MSPsMarvis. It takes a baseController as a parameter and returns a pointer to the MSPsMarvis.

func (*MSPsMarvis) CountMspsMarvisActions 

func (m *MSPsMarvis) CountMspsMarvisActions(
	ctx context.Context,
	mspId uuid.UUID,
	distinct *models.MspMarvisSuggestionsCountDistinctEnum,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseCountMarvisActions],
	error)

CountMspsMarvisActions takes context, mspId, distinct, limit, page as parameters and returns an models.ApiResponse with models.ResponseCountMarvisActions data and an error if there was an issue with the request or response. Count Marvis actions

type MSPsOrgGroups 

type MSPsOrgGroups struct {
	// contains filtered or unexported fields
}

MSPsOrgGroups represents a controller struct.

func NewMSPsOrgGroups 

func NewMSPsOrgGroups(baseController baseController) *MSPsOrgGroups

NewMSPsOrgGroups creates a new instance of MSPsOrgGroups. It takes a baseController as a parameter and returns a pointer to the MSPsOrgGroups.

func (*MSPsOrgGroups) CreateMspOrgGroup 

func (m *MSPsOrgGroups) CreateMspOrgGroup(
	ctx context.Context,
	mspId uuid.UUID,
	body *models.Orggroup) (
	models.ApiResponse[models.Orggroup],
	error)

CreateMspOrgGroup takes context, mspId, body as parameters and returns an models.ApiResponse with models.Orggroup data and an error if there was an issue with the request or response. Create MSP Org Group

func (*MSPsOrgGroups) DeleteMspOrgGroup 

func (m *MSPsOrgGroups) DeleteMspOrgGroup(
	ctx context.Context,
	mspId uuid.UUID,
	orggroupId uuid.UUID) (
	*http.Response,
	error)

DeleteMspOrgGroup takes context, mspId, orggroupId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete MSP Org Group

func (*MSPsOrgGroups) GetMspOrgGroup 

func (m *MSPsOrgGroups) GetMspOrgGroup(
	ctx context.Context,
	mspId uuid.UUID,
	orggroupId uuid.UUID) (
	models.ApiResponse[models.Orggroup],
	error)

GetMspOrgGroup takes context, mspId, orggroupId as parameters and returns an models.ApiResponse with models.Orggroup data and an error if there was an issue with the request or response. Get MSP Org Group Details

func (*MSPsOrgGroups) ListMspOrgGroups 

func (m *MSPsOrgGroups) ListMspOrgGroups(
	ctx context.Context,
	mspId uuid.UUID) (
	models.ApiResponse[[]models.Orggroup],
	error)

ListMspOrgGroups takes context, mspId as parameters and returns an models.ApiResponse with []models.Orggroup data and an error if there was an issue with the request or response. Get List of MSP Org Groups

func (*MSPsOrgGroups) UpdateMspOrgGroup 

func (m *MSPsOrgGroups) UpdateMspOrgGroup(
	ctx context.Context,
	mspId uuid.UUID,
	orggroupId uuid.UUID,
	body *models.Orggroup) (
	models.ApiResponse[models.Orggroup],
	error)

UpdateMspOrgGroup takes context, mspId, orggroupId, body as parameters and returns an models.ApiResponse with models.Orggroup data and an error if there was an issue with the request or response. Update MSP Org Group

type MSPsOrgs 

type MSPsOrgs struct {
	// contains filtered or unexported fields
}

MSPsOrgs represents a controller struct.

func NewMSPsOrgs 

func NewMSPsOrgs(baseController baseController) *MSPsOrgs

NewMSPsOrgs creates a new instance of MSPsOrgs. It takes a baseController as a parameter and returns a pointer to the MSPsOrgs.

func (*MSPsOrgs) CreateMspOrg 

func (m *MSPsOrgs) CreateMspOrg(
	ctx context.Context,
	mspId uuid.UUID,
	body *models.Org) (
	models.ApiResponse[models.Org],
	error)

CreateMspOrg takes context, mspId, body as parameters and returns an models.ApiResponse with models.Org data and an error if there was an issue with the request or response. Create an Org under MSP

func (*MSPsOrgs) DeleteMspOrg 

func (m *MSPsOrgs) DeleteMspOrg(
	ctx context.Context,
	mspId uuid.UUID,
	orgId uuid.UUID) (
	*http.Response,
	error)

DeleteMspOrg takes context, mspId, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. delete MSP Org

func (*MSPsOrgs) GetMspOrg 

func (m *MSPsOrgs) GetMspOrg(
	ctx context.Context,
	mspId uuid.UUID,
	orgId uuid.UUID) (
	models.ApiResponse[models.Org],
	error)

GetMspOrg takes context, mspId, orgId as parameters and returns an models.ApiResponse with models.Org data and an error if there was an issue with the request or response. Get MSP Org Details

func (*MSPsOrgs) ListMspOrgStats 

func (m *MSPsOrgs) ListMspOrgStats(
	ctx context.Context,
	mspId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.StatsOrg],
	error)

ListMspOrgStats takes context, mspId, limit, page as parameters and returns an models.ApiResponse with []models.StatsOrg data and an error if there was an issue with the request or response. Get List of MSP Orgs Stats

func (*MSPsOrgs) ListMspOrgs 

func (m *MSPsOrgs) ListMspOrgs(
	ctx context.Context,
	mspId uuid.UUID) (
	models.ApiResponse[[]models.Org],
	error)

ListMspOrgs takes context, mspId as parameters and returns an models.ApiResponse with []models.Org data and an error if there was an issue with the request or response. Get List of MSP Orgs

func (*MSPsOrgs) ManageMspOrgs 

func (m *MSPsOrgs) ManageMspOrgs(
	ctx context.Context,
	mspId uuid.UUID,
	body *models.MspOrgChange) (
	*http.Response,
	error)

ManageMspOrgs takes context, mspId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Assign or Unassign Orgs to an MSP account

func (*MSPsOrgs) SearchMspOrgs 

func (m *MSPsOrgs) SearchMspOrgs(
	ctx context.Context,
	mspId uuid.UUID,
	name *string,
	orgId *uuid.UUID,
	subInsufficient *bool,
	trialEnabled *bool,
	usageTypes []string,
	limit *int) (
	models.ApiResponse[models.ResponseOrgSearch],
	error)

SearchMspOrgs takes context, mspId, name, orgId, subInsufficient, trialEnabled, usageTypes, limit as parameters and returns an models.ApiResponse with models.ResponseOrgSearch data and an error if there was an issue with the request or response. Search Org in MSP

func (*MSPsOrgs) UpdateMspOrg 

func (m *MSPsOrgs) UpdateMspOrg(
	ctx context.Context,
	mspId uuid.UUID,
	orgId uuid.UUID,
	body *models.Org) (
	models.ApiResponse[models.Org],
	error)

UpdateMspOrg takes context, mspId, orgId, body as parameters and returns an models.ApiResponse with models.Org data and an error if there was an issue with the request or response. Update MSP Org

type MSPsSLEs 

type MSPsSLEs struct {
	// contains filtered or unexported fields
}

MSPsSLEs represents a controller struct.

func NewMSPsSLEs 

func NewMSPsSLEs(baseController baseController) *MSPsSLEs

NewMSPsSLEs creates a new instance of MSPsSLEs. It takes a baseController as a parameter and returns a pointer to the MSPsSLEs.

func (*MSPsSLEs) GetMspSle 

func (m *MSPsSLEs) GetMspSle(
	ctx context.Context,
	mspId uuid.UUID,
	metric string,
	sle *string,
	duration *string,
	interval *string,
	start *int,
	end *int) (
	models.ApiResponse[models.InsightMetrics],
	error)

GetMspSle takes context, mspId, metric, sle, duration, interval, start, end as parameters and returns an models.ApiResponse with models.InsightMetrics data and an error if there was an issue with the request or response. Get MSP SLEs (all/worst Orgs ...)

type MSPsSSO 

type MSPsSSO struct {
	// contains filtered or unexported fields
}

MSPsSSO represents a controller struct.

func NewMSPsSSO 

func NewMSPsSSO(baseController baseController) *MSPsSSO

NewMSPsSSO creates a new instance of MSPsSSO. It takes a baseController as a parameter and returns a pointer to the MSPsSSO.

func (*MSPsSSO) CreateMspSso 

func (m *MSPsSSO) CreateMspSso(
	ctx context.Context,
	mspId uuid.UUID,
	body *models.Sso) (
	models.ApiResponse[models.Sso],
	error)

CreateMspSso takes context, mspId, body as parameters and returns an models.ApiResponse with models.Sso data and an error if there was an issue with the request or response. Create MSP SSO profile

func (*MSPsSSO) DeleteMspSso 

func (m *MSPsSSO) DeleteMspSso(
	ctx context.Context,
	mspId uuid.UUID,
	ssoId uuid.UUID) (
	*http.Response,
	error)

DeleteMspSso takes context, mspId, ssoId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete MSP SSO Config

func (*MSPsSSO) DownloadMspSamlMetadata added in v0.4.0 

func (m *MSPsSSO) DownloadMspSamlMetadata(
	ctx context.Context,
	mspId uuid.UUID,
	ssoId uuid.UUID) (
	models.ApiResponse[[]byte],
	error)

DownloadMspSamlMetadata takes context, mspId, ssoId as parameters and returns an models.ApiResponse with []byte data and an error if there was an issue with the request or response. Download MSP SAML Metadata Example of metadata.xml: ```xml <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/5hdF5g/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"> <md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"> <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/logout" /> <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat> <md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/login" index="0" isDefault="true"/> <md:AttributeConsumingService index="0"> <md:ServiceName xml:lang="en-US">Mist</md:ServiceName> <md:RequestedAttribute Name="Role" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="true"/> <md:RequestedAttribute Name="FirstName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/> <md:RequestedAttribute Name="LastName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/> </md:AttributeConsumingService> </md:SPSSODescriptor> </md:EntityDescriptor> ```

func (*MSPsSSO) GetMspSamlMetadata added in v0.4.0 

func (m *MSPsSSO) GetMspSamlMetadata(
	ctx context.Context,
	mspId uuid.UUID,
	ssoId uuid.UUID) (
	models.ApiResponse[models.SamlMetadata],
	error)

GetMspSamlMetadata takes context, mspId, ssoId as parameters and returns an models.ApiResponse with models.SamlMetadata data and an error if there was an issue with the request or response. Get MSP SAML Metadata

func (*MSPsSSO) GetMspSso 

func (m *MSPsSSO) GetMspSso(
	ctx context.Context,
	mspId uuid.UUID,
	ssoId uuid.UUID) (
	models.ApiResponse[models.Sso],
	error)

GetMspSso takes context, mspId, ssoId as parameters and returns an models.ApiResponse with models.Sso data and an error if there was an issue with the request or response. Get MSP SSO Config

func (*MSPsSSO) ListMspSsoLatestFailures 

func (m *MSPsSSO) ListMspSsoLatestFailures(
	ctx context.Context,
	mspId uuid.UUID,
	ssoId uuid.UUID) (
	models.ApiResponse[models.ResponseSsoFailureSearch],
	error)

ListMspSsoLatestFailures takes context, mspId, ssoId as parameters and returns an models.ApiResponse with models.ResponseSsoFailureSearch data and an error if there was an issue with the request or response. Get List of MSP SSO Latest Failures

func (*MSPsSSO) ListMspSsos 

func (m *MSPsSSO) ListMspSsos(
	ctx context.Context,
	mspId uuid.UUID) (
	models.ApiResponse[[]models.Sso],
	error)

ListMspSsos takes context, mspId as parameters and returns an models.ApiResponse with []models.Sso data and an error if there was an issue with the request or response. List MSP SSO Configs

func (*MSPsSSO) UpdateMspSso 

func (m *MSPsSSO) UpdateMspSso(
	ctx context.Context,
	mspId uuid.UUID,
	ssoId uuid.UUID,
	body *models.Sso) (
	models.ApiResponse[models.Sso],
	error)

UpdateMspSso takes context, mspId, ssoId, body as parameters and returns an models.ApiResponse with models.Sso data and an error if there was an issue with the request or response. Update MSP SSO config

type MSPsSSORoles 

type MSPsSSORoles struct {
	// contains filtered or unexported fields
}

MSPsSSORoles represents a controller struct.

func NewMSPsSSORoles 

func NewMSPsSSORoles(baseController baseController) *MSPsSSORoles

NewMSPsSSORoles creates a new instance of MSPsSSORoles. It takes a baseController as a parameter and returns a pointer to the MSPsSSORoles.

func (*MSPsSSORoles) CreateMspSsoRole 

func (m *MSPsSSORoles) CreateMspSsoRole(
	ctx context.Context,
	mspId uuid.UUID,
	body *models.SsoRoleMsp) (
	models.ApiResponse[models.SsoRoleMsp],
	error)

CreateMspSsoRole takes context, mspId, body as parameters and returns an models.ApiResponse with models.SsoRoleMsp data and an error if there was an issue with the request or response. Create MSP Role

func (*MSPsSSORoles) DeleteMspSsoRole 

func (m *MSPsSSORoles) DeleteMspSsoRole(
	ctx context.Context,
	mspId uuid.UUID,
	ssoroleId uuid.UUID) (
	*http.Response,
	error)

DeleteMspSsoRole takes context, mspId, ssoroleId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete MSP SSO Roles

func (*MSPsSSORoles) ListMspSsoRoles 

func (m *MSPsSSORoles) ListMspSsoRoles(
	ctx context.Context,
	mspId uuid.UUID) (
	models.ApiResponse[[]models.SsoRoleOrg],
	error)

ListMspSsoRoles takes context, mspId as parameters and returns an models.ApiResponse with []models.SsoRoleOrg data and an error if there was an issue with the request or response. Get List of MSP SSO Roles

func (*MSPsSSORoles) UpdateMspSsoRole 

func (m *MSPsSSORoles) UpdateMspSsoRole(
	ctx context.Context,
	mspId uuid.UUID,
	ssoroleId uuid.UUID,
	body *models.SsoRoleMsp) (
	models.ApiResponse[models.SsoRoleMsp],
	error)

UpdateMspSsoRole takes context, mspId, ssoroleId, body as parameters and returns an models.ApiResponse with models.SsoRoleMsp data and an error if there was an issue with the request or response. Update SSO Role

type MSPsTickets 

type MSPsTickets struct {
	// contains filtered or unexported fields
}

MSPsTickets represents a controller struct.

func NewMSPsTickets 

func NewMSPsTickets(baseController baseController) *MSPsTickets

NewMSPsTickets creates a new instance of MSPsTickets. It takes a baseController as a parameter and returns a pointer to the MSPsTickets.

func (*MSPsTickets) CountMspTickets 

func (m *MSPsTickets) CountMspTickets(
	ctx context.Context,
	mspId uuid.UUID,
	distinct *models.MspTicketsCountDistinctEnum) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountMspTickets takes context, mspId, distinct as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count tickets

func (*MSPsTickets) ListMspTickets 

func (m *MSPsTickets) ListMspTickets(
	ctx context.Context,
	mspId uuid.UUID,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[[]models.Ticket],
	error)

ListMspTickets takes context, mspId, start, end, duration as parameters and returns an models.ApiResponse with []models.Ticket data and an error if there was an issue with the request or response. Get List of Tickets of a MSP

type Orgs 

type Orgs struct {
	// contains filtered or unexported fields
}

Orgs represents a controller struct.

func NewOrgs 

func NewOrgs(baseController baseController) *Orgs

NewOrgs creates a new instance of Orgs. It takes a baseController as a parameter and returns a pointer to the Orgs.

func (*Orgs) CloneOrg 

func (o *Orgs) CloneOrg(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.NameString) (
	models.ApiResponse[models.Org],
	error)

CloneOrg takes context, orgId, body as parameters and returns an models.ApiResponse with models.Org data and an error if there was an issue with the request or response. Create an Org by cloning from another one. Org Settings, Templates, Wxlan Tags, Wxlan Tunnels, Wxlan Rules, Org Wlans will be copied. Sites and Site Groups will not be copied, and therefore, the copied template will not be applied to any site/sitegroups.

func (*Orgs) CreateOrg 

func (o *Orgs) CreateOrg(
	ctx context.Context,
	body *models.Org) (
	models.ApiResponse[models.Org],
	error)

CreateOrg takes context, body as parameters and returns an models.ApiResponse with models.Org data and an error if there was an issue with the request or response. Org admin can invite people to manage the org. Furthermore, he can dictate the level of security those accounts are. The check is enforced when the invited admin tries to “accept” the invitation and every time the admin tries to login

func (*Orgs) DeleteOrg 

func (o *Orgs) DeleteOrg(
	ctx context.Context,
	orgId uuid.UUID) (
	*http.Response,
	error)

DeleteOrg takes context, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org

func (*Orgs) GetOrg 

func (o *Orgs) GetOrg(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.Org],
	error)

GetOrg takes context, orgId as parameters and returns an models.ApiResponse with models.Org data and an error if there was an issue with the request or response. Get Organization information

func (*Orgs) SearchOrgEvents 

func (o *Orgs) SearchOrgEvents(
	ctx context.Context,
	orgId uuid.UUID,
	mType *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.ResponseEventsOrgsSearch],
	error)

SearchOrgEvents takes context, orgId, mType, start, end, duration, limit as parameters and returns an models.ApiResponse with models.ResponseEventsOrgsSearch data and an error if there was an issue with the request or response. Search Org events Supported Event Types: - CRADLEPOINT_SYNC_FAILED - ORG_CA_CERT_ADDED - ORG_CA_CERT_REGENERATED

func (*Orgs) UpdateOrg 

func (o *Orgs) UpdateOrg(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Org) (
	models.ApiResponse[models.Org],
	error)

UpdateOrg takes context, orgId, body as parameters and returns an models.ApiResponse with models.Org data and an error if there was an issue with the request or response. Update Org

type OrgsAPITokens 

type OrgsAPITokens struct {
	// contains filtered or unexported fields
}

OrgsAPITokens represents a controller struct.

func NewOrgsAPITokens 

func NewOrgsAPITokens(baseController baseController) *OrgsAPITokens

NewOrgsAPITokens creates a new instance of OrgsAPITokens. It takes a baseController as a parameter and returns a pointer to the OrgsAPITokens.

func (*OrgsAPITokens) CreateOrgApiToken 

func (o *OrgsAPITokens) CreateOrgApiToken(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.OrgApitoken) (
	models.ApiResponse[models.OrgApitoken],
	error)

CreateOrgApiToken takes context, orgId, body as parameters and returns an models.ApiResponse with models.OrgApitoken data and an error if there was an issue with the request or response. Create Org API Token Note that the token key is only available during creation time.

func (*OrgsAPITokens) DeleteOrgApiToken 

func (o *OrgsAPITokens) DeleteOrgApiToken(
	ctx context.Context,
	orgId uuid.UUID,
	apitokenId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgApiToken takes context, orgId, apitokenId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org API Token

func (*OrgsAPITokens) GetOrgApiToken 

func (o *OrgsAPITokens) GetOrgApiToken(
	ctx context.Context,
	orgId uuid.UUID,
	apitokenId uuid.UUID) (
	models.ApiResponse[models.OrgApitoken],
	error)

GetOrgApiToken takes context, orgId, apitokenId as parameters and returns an models.ApiResponse with models.OrgApitoken data and an error if there was an issue with the request or response. Get Org API Token

func (*OrgsAPITokens) ListOrgApiTokens 

func (o *OrgsAPITokens) ListOrgApiTokens(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.OrgApitoken],
	error)

ListOrgApiTokens takes context, orgId as parameters and returns an models.ApiResponse with []models.OrgApitoken data and an error if there was an issue with the request or response. Get List of Org API Tokens

func (*OrgsAPITokens) UpdateOrgApiToken 

func (o *OrgsAPITokens) UpdateOrgApiToken(
	ctx context.Context,
	orgId uuid.UUID,
	apitokenId uuid.UUID,
	body *models.OrgApitoken) (
	*http.Response,
	error)

UpdateOrgApiToken takes context, orgId, apitokenId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Update Org API Token

type OrgsAPTemplates 

type OrgsAPTemplates struct {
	// contains filtered or unexported fields
}

OrgsAPTemplates represents a controller struct.

func NewOrgsAPTemplates 

func NewOrgsAPTemplates(baseController baseController) *OrgsAPTemplates

NewOrgsAPTemplates creates a new instance of OrgsAPTemplates. It takes a baseController as a parameter and returns a pointer to the OrgsAPTemplates.

func (*OrgsAPTemplates) CreateOrgAptemplate 

func (o *OrgsAPTemplates) CreateOrgAptemplate(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.ApTemplate) (
	models.ApiResponse[models.ApTemplate],
	error)

CreateOrgAptemplate takes context, orgId, body as parameters and returns an models.ApiResponse with models.ApTemplate data and an error if there was an issue with the request or response. Create Org AP Template

func (*OrgsAPTemplates) DeleteOrgAptemplate 

func (o *OrgsAPTemplates) DeleteOrgAptemplate(
	ctx context.Context,
	orgId uuid.UUID,
	aptemplateId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgAptemplate takes context, orgId, aptemplateId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete existing AP Template

func (*OrgsAPTemplates) GetOrgAptemplate 

func (o *OrgsAPTemplates) GetOrgAptemplate(
	ctx context.Context,
	orgId uuid.UUID,
	aptemplateId uuid.UUID) (
	models.ApiResponse[models.ApTemplate],
	error)

GetOrgAptemplate takes context, orgId, aptemplateId as parameters and returns an models.ApiResponse with models.ApTemplate data and an error if there was an issue with the request or response. Get AP Template

func (*OrgsAPTemplates) ListOrgAptemplates 

func (o *OrgsAPTemplates) ListOrgAptemplates(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.ApTemplate],
	error)

ListOrgAptemplates takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.ApTemplate data and an error if there was an issue with the request or response. Get List of Org AP Templates

func (*OrgsAPTemplates) UpdateOrgAptemplate 

func (o *OrgsAPTemplates) UpdateOrgAptemplate(
	ctx context.Context,
	orgId uuid.UUID,
	aptemplateId uuid.UUID,
	body *models.ApTemplate) (
	models.ApiResponse[models.ApTemplate],
	error)

UpdateOrgAptemplate takes context, orgId, aptemplateId, body as parameters and returns an models.ApiResponse with models.ApTemplate data and an error if there was an issue with the request or response. Update AP Template

type OrgsAdmins 

type OrgsAdmins struct {
	// contains filtered or unexported fields
}

OrgsAdmins represents a controller struct.

func NewOrgsAdmins 

func NewOrgsAdmins(baseController baseController) *OrgsAdmins

NewOrgsAdmins creates a new instance of OrgsAdmins. It takes a baseController as a parameter and returns a pointer to the OrgsAdmins.

func (*OrgsAdmins) InviteOrgAdmin 

func (o *OrgsAdmins) InviteOrgAdmin(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Admin) (
	*http.Response,
	error)

InviteOrgAdmin takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. If the request is successful, an email will also be sent to the user with a link to ```https://manage.mist.com/verify/invite?token=:token&expire=1459632743&org=OrgName```

func (*OrgsAdmins) ListOrgAdmins 

func (o *OrgsAdmins) ListOrgAdmins(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.Admin],
	error)

ListOrgAdmins takes context, orgId as parameters and returns an models.ApiResponse with []models.Admin data and an error if there was an issue with the request or response. Get List of people who can manage the Site/Org under the Org

func (*OrgsAdmins) RevokeOrgAdmin 

func (o *OrgsAdmins) RevokeOrgAdmin(
	ctx context.Context,
	orgId uuid.UUID,
	adminId uuid.UUID) (
	*http.Response,
	error)

RevokeOrgAdmin takes context, orgId, adminId as parameters and returns an *Response and an error if there was an issue with the request or response. This removes all privileges this admin has against the org

func (*OrgsAdmins) UninviteOrgAdmin 

func (o *OrgsAdmins) UninviteOrgAdmin(
	ctx context.Context,
	orgId uuid.UUID,
	inviteId uuid.UUID) (
	*http.Response,
	error)

UninviteOrgAdmin takes context, orgId, inviteId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Admin Invite

func (*OrgsAdmins) UpdateOrgAdmin 

func (o *OrgsAdmins) UpdateOrgAdmin(
	ctx context.Context,
	orgId uuid.UUID,
	adminId uuid.UUID,
	body *models.Admin) (
	models.ApiResponse[models.Admin],
	error)

UpdateOrgAdmin takes context, orgId, adminId, body as parameters and returns an models.ApiResponse with models.Admin data and an error if there was an issue with the request or response. Invite Org Admin

func (*OrgsAdmins) UpdateOrgAdminInvite 

func (o *OrgsAdmins) UpdateOrgAdminInvite(
	ctx context.Context,
	orgId uuid.UUID,
	inviteId uuid.UUID,
	body *models.Admin) (
	*http.Response,
	error)

UpdateOrgAdminInvite takes context, orgId, inviteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Update Admin Invite

type OrgsAlarmTemplates 

type OrgsAlarmTemplates struct {
	// contains filtered or unexported fields
}

OrgsAlarmTemplates represents a controller struct.

func NewOrgsAlarmTemplates 

func NewOrgsAlarmTemplates(baseController baseController) *OrgsAlarmTemplates

NewOrgsAlarmTemplates creates a new instance of OrgsAlarmTemplates. It takes a baseController as a parameter and returns a pointer to the OrgsAlarmTemplates.

func (*OrgsAlarmTemplates) CreateOrgAlarmTemplate 

func (o *OrgsAlarmTemplates) CreateOrgAlarmTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.AlarmTemplate) (
	models.ApiResponse[models.AlarmTemplate],
	error)

CreateOrgAlarmTemplate takes context, orgId, body as parameters and returns an models.ApiResponse with models.AlarmTemplate data and an error if there was an issue with the request or response. Available rules can be found in Orgs>Consts>getAlarmDefs The delivery dict is only required if different from the template delivery settings.

func (*OrgsAlarmTemplates) DeleteOrgAlarmTemplate 

func (o *OrgsAlarmTemplates) DeleteOrgAlarmTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	alarmtemplateId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgAlarmTemplate takes context, orgId, alarmtemplateId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Alarm Template

func (*OrgsAlarmTemplates) GetOrgAlarmTemplate 

func (o *OrgsAlarmTemplates) GetOrgAlarmTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	alarmtemplateId uuid.UUID) (
	models.ApiResponse[models.AlarmTemplate],
	error)

GetOrgAlarmTemplate takes context, orgId, alarmtemplateId as parameters and returns an models.ApiResponse with models.AlarmTemplate data and an error if there was an issue with the request or response. Get Org Alarm Template Details

func (*OrgsAlarmTemplates) ListOrgAlarmTemplates 

func (o *OrgsAlarmTemplates) ListOrgAlarmTemplates(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.AlarmTemplate],
	error)

ListOrgAlarmTemplates takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.AlarmTemplate data and an error if there was an issue with the request or response. Get List of Org Alarm Templates

func (*OrgsAlarmTemplates) ListOrgSuppressedAlarms 

func (o *OrgsAlarmTemplates) ListOrgSuppressedAlarms(
	ctx context.Context,
	orgId uuid.UUID,
	scope *models.SuppressedAlarmScopeEnum) (
	models.ApiResponse[models.ResponseOrgSuppressAlarm],
	error)

ListOrgSuppressedAlarms takes context, orgId, scope as parameters and returns an models.ApiResponse with models.ResponseOrgSuppressAlarm data and an error if there was an issue with the request or response. Get List of Org Alarms Currently Suppressed

func (*OrgsAlarmTemplates) SuppressOrgAlarm 

func (o *OrgsAlarmTemplates) SuppressOrgAlarm(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.SuppressedAlarm) (
	*http.Response,
	error)

SuppressOrgAlarm takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. In certain situations, for example, scheduled maintenance, you may want to suspend alarms to be triggered against Sites for a period of time.

func (*OrgsAlarmTemplates) UnsuppressOrgSuppressedAlarms 

func (o *OrgsAlarmTemplates) UnsuppressOrgSuppressedAlarms(
	ctx context.Context,
	orgId uuid.UUID) (
	*http.Response,
	error)

UnsuppressOrgSuppressedAlarms takes context, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. Un-Suppress Suppressed Alarms

func (*OrgsAlarmTemplates) UpdateOrgAlarmTemplate 

func (o *OrgsAlarmTemplates) UpdateOrgAlarmTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	alarmtemplateId uuid.UUID,
	body *models.AlarmTemplate) (
	models.ApiResponse[models.AlarmTemplate],
	error)

UpdateOrgAlarmTemplate takes context, orgId, alarmtemplateId, body as parameters and returns an models.ApiResponse with models.AlarmTemplate data and an error if there was an issue with the request or response. Update Org Alarm Template

type OrgsAlarms 

type OrgsAlarms struct {
	// contains filtered or unexported fields
}

OrgsAlarms represents a controller struct.

func NewOrgsAlarms 

func NewOrgsAlarms(baseController baseController) *OrgsAlarms

NewOrgsAlarms creates a new instance of OrgsAlarms. It takes a baseController as a parameter and returns a pointer to the OrgsAlarms.

func (*OrgsAlarms) AckOrgAlarm 

func (o *OrgsAlarms) AckOrgAlarm(
	ctx context.Context,
	orgId uuid.UUID,
	alarmId uuid.UUID,
	body *models.NoteString) (
	*http.Response,
	error)

AckOrgAlarm takes context, orgId, alarmId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Ack Org Alarm

func (*OrgsAlarms) AckOrgAllAlarms 

func (o *OrgsAlarms) AckOrgAllAlarms(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.NoteString) (
	*http.Response,
	error)

AckOrgAllAlarms takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Ack all Org Alarms **N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.

func (*OrgsAlarms) AckOrgMultipleAlarms 

func (o *OrgsAlarms) AckOrgMultipleAlarms(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Alarms) (
	*http.Response,
	error)

AckOrgMultipleAlarms takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Ack multiple Org Alarms

func (*OrgsAlarms) CountOrgAlarms 

func (o *OrgsAlarms) CountOrgAlarms(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgAlarms takes context, orgId, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Alarms

func (*OrgsAlarms) SearchOrgAlarms 

func (o *OrgsAlarms) SearchOrgAlarms(
	ctx context.Context,
	orgId uuid.UUID,
	siteId *uuid.UUID,
	mType *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.AlarmSearchResult],
	error)

SearchOrgAlarms takes context, orgId, siteId, mType, start, end, duration, limit as parameters and returns an models.ApiResponse with models.AlarmSearchResult data and an error if there was an issue with the request or response. Search Org Alarms

func (*OrgsAlarms) UnackOrgAllArlarms 

func (o *OrgsAlarms) UnackOrgAllArlarms(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.NoteString) (
	*http.Response,
	error)

UnackOrgAllArlarms takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Unack all Org Alarms **N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.

func (*OrgsAlarms) UnackOrgMultipleAlarms 

func (o *OrgsAlarms) UnackOrgMultipleAlarms(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Alarms) (
	*http.Response,
	error)

UnackOrgMultipleAlarms takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Unack multiple Org Alarms

type OrgsAntivirusProfiles added in v0.2.38 

type OrgsAntivirusProfiles struct {
	// contains filtered or unexported fields
}

OrgsAntivirusProfiles represents a controller struct.

func NewOrgsAntivirusProfiles added in v0.2.38 

func NewOrgsAntivirusProfiles(baseController baseController) *OrgsAntivirusProfiles

NewOrgsAntivirusProfiles creates a new instance of OrgsAntivirusProfiles. It takes a baseController as a parameter and returns a pointer to the OrgsAntivirusProfiles.

func (*OrgsAntivirusProfiles) CreateOrgAntivirusProfile added in v0.2.38 

func (o *OrgsAntivirusProfiles) CreateOrgAntivirusProfile(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Avprofile) (
	models.ApiResponse[models.Avprofile],
	error)

CreateOrgAntivirusProfile takes context, orgId, body as parameters and returns an models.ApiResponse with models.Avprofile data and an error if there was an issue with the request or response. Create getOrgServices Antivirus Profile

func (*OrgsAntivirusProfiles) DeleteOrgAntivirusProfile added in v0.2.38 

func (o *OrgsAntivirusProfiles) DeleteOrgAntivirusProfile(
	ctx context.Context,
	orgId uuid.UUID,
	avprofilesId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgAntivirusProfile takes context, orgId, avprofilesId as parameters and returns an *Response and an error if there was an issue with the request or response. deleteOrgAntivirusProfile

func (*OrgsAntivirusProfiles) GetOrgAntivirusProfile added in v0.2.38 

func (o *OrgsAntivirusProfiles) GetOrgAntivirusProfile(
	ctx context.Context,
	orgId uuid.UUID,
	avprofilesId uuid.UUID) (
	models.ApiResponse[models.Avprofile],
	error)

GetOrgAntivirusProfile takes context, orgId, avprofilesId as parameters and returns an models.ApiResponse with models.Avprofile data and an error if there was an issue with the request or response. Get Org Antivirus Profile

func (*OrgsAntivirusProfiles) ListOrgAntivirusProfiles added in v0.2.38 

func (o *OrgsAntivirusProfiles) ListOrgAntivirusProfiles(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Avprofile],
	error)

ListOrgAntivirusProfiles takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Avprofile data and an error if there was an issue with the request or response. Get List of Antivirus Profiles

func (*OrgsAntivirusProfiles) UpdateOrgAntivirusProfile added in v0.2.38 

func (o *OrgsAntivirusProfiles) UpdateOrgAntivirusProfile(
	ctx context.Context,
	orgId uuid.UUID,
	avprofilesId uuid.UUID,
	body *models.Avprofile) (
	models.ApiResponse[models.Avprofile],
	error)

UpdateOrgAntivirusProfile takes context, orgId, avprofilesId, body as parameters and returns an models.ApiResponse with models.Avprofile data and an error if there was an issue with the request or response. update Org Antivirus Profile

type OrgsAssetFilters 

type OrgsAssetFilters struct {
	// contains filtered or unexported fields
}

OrgsAssetFilters represents a controller struct.

func NewOrgsAssetFilters 

func NewOrgsAssetFilters(baseController baseController) *OrgsAssetFilters

NewOrgsAssetFilters creates a new instance of OrgsAssetFilters. It takes a baseController as a parameter and returns a pointer to the OrgsAssetFilters.

func (*OrgsAssetFilters) CreateOrgAssetFilters 

func (o *OrgsAssetFilters) CreateOrgAssetFilters(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.AssetFilter) (
	models.ApiResponse[models.AssetFilter],
	error)

CreateOrgAssetFilters takes context, orgId, body as parameters and returns an models.ApiResponse with models.AssetFilter data and an error if there was an issue with the request or response. Create Asset Filter Creates a single BLE asset filter for the given site. Any subset of filter properties can be included in the filter. A matching asset must meet the conditions of all given filter properties (logical ‘AND’).

func (*OrgsAssetFilters) DeleteOrgAssetFilter 

func (o *OrgsAssetFilters) DeleteOrgAssetFilter(
	ctx context.Context,
	orgId uuid.UUID,
	assetfilterId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgAssetFilter takes context, orgId, assetfilterId as parameters and returns an *Response and an error if there was an issue with the request or response. Deletes an existing BLE asset filter for the given site.

func (*OrgsAssetFilters) GetOrgAssetFilter 

func (o *OrgsAssetFilters) GetOrgAssetFilter(
	ctx context.Context,
	orgId uuid.UUID,
	assetfilterId uuid.UUID) (
	models.ApiResponse[models.AssetFilter],
	error)

GetOrgAssetFilter takes context, orgId, assetfilterId as parameters and returns an models.ApiResponse with models.AssetFilter data and an error if there was an issue with the request or response. Get Org Asset Filter Details

func (*OrgsAssetFilters) ListOrgAssetFilters 

func (o *OrgsAssetFilters) ListOrgAssetFilters(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.AssetFilter],
	error)

ListOrgAssetFilters takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.AssetFilter data and an error if there was an issue with the request or response. Get List of Org BLE asset filters. Each asset filter in the list operates independently. For a filter object to match an asset, all of the filter properties must match (logical ‘AND’ of each filter property). For example, the “Visitor Tags” filter below will match an asset when both the “ibeacon\_uuid” and “ibeacon_major” properties match the asset. All non-matching assets are ignored.

func (*OrgsAssetFilters) UpdateOrgAssetFilters 

func (o *OrgsAssetFilters) UpdateOrgAssetFilters(
	ctx context.Context,
	orgId uuid.UUID,
	assetfilterId uuid.UUID,
	body *models.AssetFilter) (
	models.ApiResponse[models.AssetFilter],
	error)

UpdateOrgAssetFilters takes context, orgId, assetfilterId, body as parameters and returns an models.ApiResponse with models.AssetFilter data and an error if there was an issue with the request or response. Updates an existing BLE asset filter for the given site.

type OrgsAssets 

type OrgsAssets struct {
	// contains filtered or unexported fields
}

OrgsAssets represents a controller struct.

func NewOrgsAssets 

func NewOrgsAssets(baseController baseController) *OrgsAssets

NewOrgsAssets creates a new instance of OrgsAssets. It takes a baseController as a parameter and returns a pointer to the OrgsAssets.

func (*OrgsAssets) CreateOrgAsset 

func (o *OrgsAssets) CreateOrgAsset(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Asset) (
	models.ApiResponse[models.Asset],
	error)

CreateOrgAsset takes context, orgId, body as parameters and returns an models.ApiResponse with models.Asset data and an error if there was an issue with the request or response. Create Org Asset

func (*OrgsAssets) DeleteOrgAsset 

func (o *OrgsAssets) DeleteOrgAsset(
	ctx context.Context,
	orgId uuid.UUID,
	assetId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgAsset takes context, orgId, assetId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Asset

func (*OrgsAssets) GetOrgAsset 

func (o *OrgsAssets) GetOrgAsset(
	ctx context.Context,
	orgId uuid.UUID,
	assetId uuid.UUID) (
	models.ApiResponse[models.Asset],
	error)

GetOrgAsset takes context, orgId, assetId as parameters and returns an models.ApiResponse with models.Asset data and an error if there was an issue with the request or response. Get Org Asset Details

func (*OrgsAssets) ImportOrgAssets 

func (o *OrgsAssets) ImportOrgAssets(
	ctx context.Context,
	orgId uuid.UUID,
	file *models.FileWrapper) (
	*http.Response,
	error)

ImportOrgAssets takes context, orgId, file as parameters and returns an *Response and an error if there was an issue with the request or response. Impert Org Assets. It can be done via a CSV file or a JSON payload. #### CSV File Format ```csv name,mac "asset_name",5c5b53010101 ```

func (*OrgsAssets) ListOrgAssets 

func (o *OrgsAssets) ListOrgAssets(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Asset],
	error)

ListOrgAssets takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Asset data and an error if there was an issue with the request or response. Get List of Org Assets

func (*OrgsAssets) UpdateOrgAsset 

func (o *OrgsAssets) UpdateOrgAsset(
	ctx context.Context,
	orgId uuid.UUID,
	assetId uuid.UUID,
	body *models.Asset) (
	models.ApiResponse[models.Asset],
	error)

UpdateOrgAsset takes context, orgId, assetId, body as parameters and returns an models.ApiResponse with models.Asset data and an error if there was an issue with the request or response. Update Org Asset

type OrgsCRL 

type OrgsCRL struct {
	// contains filtered or unexported fields
}

OrgsCRL represents a controller struct.

func NewOrgsCRL 

func NewOrgsCRL(baseController baseController) *OrgsCRL

NewOrgsCRL creates a new instance of OrgsCRL. It takes a baseController as a parameter and returns a pointer to the OrgsCRL.

func (*OrgsCRL) GetOrgCrlFile 

func (o *OrgsCRL) GetOrgCrlFile(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]byte],
	error)

GetOrgCrlFile takes context, orgId as parameters and returns an models.ApiResponse with []byte data and an error if there was an issue with the request or response. Get Org CRL File

type OrgsCert 

type OrgsCert struct {
	// contains filtered or unexported fields
}

OrgsCert represents a controller struct.

func NewOrgsCert 

func NewOrgsCert(baseController baseController) *OrgsCert

NewOrgsCert creates a new instance of OrgsCert. It takes a baseController as a parameter and returns a pointer to the OrgsCert.

func (*OrgsCert) ClearOrgCertificates 

func (o *OrgsCert) ClearOrgCertificates(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.ResponseCertificate],
	error)

ClearOrgCertificates takes context, orgId as parameters and returns an models.ApiResponse with models.ResponseCertificate data and an error if there was an issue with the request or response. Clear Org Certificates

func (*OrgsCert) GetOrgCertificates 

func (o *OrgsCert) GetOrgCertificates(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.ResponseCertificate],
	error)

GetOrgCertificates takes context, orgId as parameters and returns an models.ApiResponse with models.ResponseCertificate data and an error if there was an issue with the request or response. Get Org Certificates

func (*OrgsCert) GetOrgSslProxyCert added in v0.2.38 

func (o *OrgsCert) GetOrgSslProxyCert(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.OrgSslProxyCert],
	error)

GetOrgSslProxyCert takes context, orgId as parameters and returns an models.ApiResponse with models.OrgSslProxyCert data and an error if there was an issue with the request or response. Get Org SSL proxy Certificates

func (*OrgsCert) TruncateOrgCrlFile 

func (o *OrgsCert) TruncateOrgCrlFile(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.DaysNumber) (
	*http.Response,
	error)

TruncateOrgCrlFile takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. By default, all certs used by recently unclaimed devices within 9 month will be included in CRL. If the list grows too big, you can truncate it

type OrgsClientsMarvis 

type OrgsClientsMarvis struct {
	// contains filtered or unexported fields
}

OrgsClientsMarvis represents a controller struct.

func NewOrgsClientsMarvis 

func NewOrgsClientsMarvis(baseController baseController) *OrgsClientsMarvis

NewOrgsClientsMarvis creates a new instance of OrgsClientsMarvis. It takes a baseController as a parameter and returns a pointer to the OrgsClientsMarvis.

func (*OrgsClientsMarvis) CreateOrgMarvisClientInvites 

func (o *OrgsClientsMarvis) CreateOrgMarvisClientInvites(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.MarvisClient) (
	models.ApiResponse[models.MarvisClient],
	error)

CreateOrgMarvisClientInvites takes context, orgId, body as parameters and returns an models.ApiResponse with models.MarvisClient data and an error if there was an issue with the request or response. Create Org Marvis Client Invites

func (*OrgsClientsMarvis) DeleteOrgMarvisClientInvite 

func (o *OrgsClientsMarvis) DeleteOrgMarvisClientInvite(
	ctx context.Context,
	orgId uuid.UUID,
	marvisinviteId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgMarvisClientInvite takes context, orgId, marvisinviteId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Marvis Client Invite

func (*OrgsClientsMarvis) GetOrgMarvisClientInvites 

func (o *OrgsClientsMarvis) GetOrgMarvisClientInvites(
	ctx context.Context,
	orgId uuid.UUID,
	marvisinviteId uuid.UUID) (
	models.ApiResponse[models.MarvisClient],
	error)

GetOrgMarvisClientInvites takes context, orgId, marvisinviteId as parameters and returns an models.ApiResponse with models.MarvisClient data and an error if there was an issue with the request or response. Get Org Marvis Client Invite

func (*OrgsClientsMarvis) ListOrgMarvisClientInvites 

func (o *OrgsClientsMarvis) ListOrgMarvisClientInvites(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.MarvisClient],
	error)

ListOrgMarvisClientInvites takes context, orgId as parameters and returns an models.ApiResponse with []models.MarvisClient data and an error if there was an issue with the request or response. List Org Marvis Client Invites

func (*OrgsClientsMarvis) UpdateOrgMarvisClientInvite 

func (o *OrgsClientsMarvis) UpdateOrgMarvisClientInvite(
	ctx context.Context,
	orgId uuid.UUID,
	marvisinviteId uuid.UUID,
	body *models.MarvisClient) (
	models.ApiResponse[models.MarvisClient],
	error)

UpdateOrgMarvisClientInvite takes context, orgId, marvisinviteId, body as parameters and returns an models.ApiResponse with models.MarvisClient data and an error if there was an issue with the request or response. Update Org Marvis Client Invite

type OrgsClientsNAC 

type OrgsClientsNAC struct {
	// contains filtered or unexported fields
}

OrgsClientsNAC represents a controller struct.

func NewOrgsClientsNAC 

func NewOrgsClientsNAC(baseController baseController) *OrgsClientsNAC

NewOrgsClientsNAC creates a new instance of OrgsClientsNAC. It takes a baseController as a parameter and returns a pointer to the OrgsClientsNAC.

func (*OrgsClientsNAC) CountOrgNacClientEvents 

func (o *OrgsClientsNAC) CountOrgNacClientEvents(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgNacClientEventsCountDistinctEnum,
	mType *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgNacClientEvents takes context, orgId, distinct, mType, start, end, duration, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of NAC Client-Events

func (*OrgsClientsNAC) CountOrgNacClients 

func (o *OrgsClientsNAC) CountOrgNacClients(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgNacClientsCountDistinctEnum,
	lastNacruleId *string,
	nacruleMatched *bool,
	authType *string,
	lastVlanId *string,
	lastNasVendor *string,
	idpId *string,
	lastSsid *string,
	lastUsername *string,
	timestamp *float64,
	siteId *string,
	lastAp *string,
	mac *string,
	lastStatus *string,
	mType *string,
	mdmComplianceStatus *string,
	mdmProvider *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgNacClients takes context, orgId, distinct, lastNacruleId, nacruleMatched, authType, lastVlanId, lastNasVendor, idpId, lastSsid, lastUsername, timestamp, siteId, lastAp, mac, lastStatus, mType, mdmComplianceStatus, mdmProvider, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of NAC Clients

func (*OrgsClientsNAC) SearchOrgNacClientEvents 

func (o *OrgsClientsNAC) SearchOrgNacClientEvents(
	ctx context.Context,
	orgId uuid.UUID,
	mType *string,
	nacruleId *uuid.UUID,
	nacruleMatched *bool,
	dryrunNacruleId *string,
	dryrunNacruleMatched *bool,
	authType *string,
	vlan *int,
	nasVendor *string,
	bssid *string,
	idpId *uuid.UUID,
	idpRole *string,
	idpUsername *string,
	respAttrs []string,
	ssid *string,
	username *string,
	siteId *string,
	ap *string,
	randomMac *bool,
	mac *string,
	timestamp *float64,
	usermacLabel *string,
	text *string,
	nasIp *string,
	sort *string,
	ingressVlan *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.ResponseEventsNacClientSearch],
	error)

SearchOrgNacClientEvents takes context, orgId, mType, nacruleId, nacruleMatched, dryrunNacruleId, dryrunNacruleMatched, authType, vlan, nasVendor, bssid, idpId, idpRole, idpUsername, respAttrs, ssid, username, siteId, ap, randomMac, mac, timestamp, usermacLabel, text, nasIp, sort, ingressVlan, start, end, duration, limit as parameters and returns an models.ApiResponse with models.ResponseEventsNacClientSearch data and an error if there was an issue with the request or response. Search NAC Client Events

func (*OrgsClientsNAC) SearchOrgNacClients 

func (o *OrgsClientsNAC) SearchOrgNacClients(
	ctx context.Context,
	orgId uuid.UUID,
	nacruleId *string,
	nacruleMatched *bool,
	authType *string,
	vlan *string,
	nasVendor *string,
	idpId *string,
	ssid *string,
	username *string,
	timestamp *float64,
	siteId *string,
	ap *string,
	mac *string,
	status *string,
	mType *string,
	mdmCompliance *string,
	mdmProvider *string,
	sort *string,
	ingressVlan *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseClientNacSearch],
	error)

SearchOrgNacClients takes context, orgId, nacruleId, nacruleMatched, authType, vlan, nasVendor, idpId, ssid, username, timestamp, siteId, ap, mac, status, mType, mdmCompliance, mdmProvider, sort, ingressVlan, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponseClientNacSearch data and an error if there was an issue with the request or response. Search Org NAC Clients

type OrgsClientsSDK 

type OrgsClientsSDK struct {
	// contains filtered or unexported fields
}

OrgsClientsSDK represents a controller struct.

func NewOrgsClientsSDK 

func NewOrgsClientsSDK(baseController baseController) *OrgsClientsSDK

NewOrgsClientsSDK creates a new instance of OrgsClientsSDK. It takes a baseController as a parameter and returns a pointer to the OrgsClientsSDK.

func (*OrgsClientsSDK) UpdateSdkClient 

func (o *OrgsClientsSDK) UpdateSdkClient(
	ctx context.Context,
	orgId uuid.UUID,
	sdkclientId uuid.UUID,
	body *models.NameString) (
	*http.Response,
	error)

UpdateSdkClient takes context, orgId, sdkclientId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Update SDK Client

type OrgsClientsWan 

type OrgsClientsWan struct {
	// contains filtered or unexported fields
}

OrgsClientsWan represents a controller struct.

func NewOrgsClientsWan 

func NewOrgsClientsWan(baseController baseController) *OrgsClientsWan

NewOrgsClientsWan creates a new instance of OrgsClientsWan. It takes a baseController as a parameter and returns a pointer to the OrgsClientsWan.

func (*OrgsClientsWan) CountOrgWanClientEvents 

func (o *OrgsClientsWan) CountOrgWanClientEvents(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgWanClientsEventsCountDistinctEnum,
	mType *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgWanClientEvents takes context, orgId, distinct, mType, start, end, duration, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Org WAN Client-Events

func (*OrgsClientsWan) CountOrgWanClients 

func (o *OrgsClientsWan) CountOrgWanClients(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgWanClientsCountDistinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgWanClients takes context, orgId, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org WAN Clients

func (*OrgsClientsWan) SearchOrgWanClientEvents 

func (o *OrgsClientsWan) SearchOrgWanClientEvents(
	ctx context.Context,
	orgId uuid.UUID,
	mType *string,
	mac *string,
	hostname *string,
	ip *string,
	mfg *string,
	nacruleId *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.SearchEventsWanClient],
	error)

SearchOrgWanClientEvents takes context, orgId, mType, mac, hostname, ip, mfg, nacruleId, start, end, duration, limit as parameters and returns an models.ApiResponse with models.SearchEventsWanClient data and an error if there was an issue with the request or response. Search Org WAN Client Events

func (*OrgsClientsWan) SearchOrgWanClients 

func (o *OrgsClientsWan) SearchOrgWanClients(
	ctx context.Context,
	orgId uuid.UUID,
	mac *string,
	hostname *string,
	ip *string,
	network *string,
	ipSrc *string,
	mfg *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.SearchWanClient],
	error)

SearchOrgWanClients takes context, orgId, mac, hostname, ip, network, ipSrc, mfg, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.SearchWanClient data and an error if there was an issue with the request or response. Search Org WAN Clients

type OrgsClientsWired 

type OrgsClientsWired struct {
	// contains filtered or unexported fields
}

OrgsClientsWired represents a controller struct.

func NewOrgsClientsWired 

func NewOrgsClientsWired(baseController baseController) *OrgsClientsWired

NewOrgsClientsWired creates a new instance of OrgsClientsWired. It takes a baseController as a parameter and returns a pointer to the OrgsClientsWired.

func (*OrgsClientsWired) CountOrgWiredClients 

func (o *OrgsClientsWired) CountOrgWiredClients(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgWiredClientsCountDistinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgWiredClients takes context, orgId, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Clients Note: For list of avaialable `type` values, please refer to [listClientEventsDefinitions]($e/Constants%20Events/listClientEventsDefinitions)

func (*OrgsClientsWired) SearchOrgWiredClients 

func (o *OrgsClientsWired) SearchOrgWiredClients(
	ctx context.Context,
	orgId uuid.UUID,
	siteId *string,
	deviceMac *string,
	mac *string,
	portId *string,
	vlan *int,
	ipAddress *string,
	manufacture *string,
	text *string,
	nacruleId *string,
	dhcpHostname *string,
	dhcpFqdn *string,
	dhcpClientIdentifier *string,
	dhcpVendorClassIdentifier *string,
	dhcpRequestParams *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.SearchWiredClient],
	error)

SearchOrgWiredClients takes context, orgId, siteId, deviceMac, mac, portId, vlan, ipAddress, manufacture, text, nacruleId, dhcpHostname, dhcpFqdn, dhcpClientIdentifier, dhcpVendorClassIdentifier, dhcpRequestParams, limit, start, end, duration as parameters and returns an models.ApiResponse with models.SearchWiredClient data and an error if there was an issue with the request or response. Search for Wired Clients in org Note: For list of avaialable `type` values, please refer to [listClientEventsDefinitions]($e/Constants%20Events/listClientEventsDefinitions)

type OrgsClientsWireless 

type OrgsClientsWireless struct {
	// contains filtered or unexported fields
}

OrgsClientsWireless represents a controller struct.

func NewOrgsClientsWireless 

func NewOrgsClientsWireless(baseController baseController) *OrgsClientsWireless

NewOrgsClientsWireless creates a new instance of OrgsClientsWireless. It takes a baseController as a parameter and returns a pointer to the OrgsClientsWireless.

func (*OrgsClientsWireless) CountOrgWirelessClients 

func (o *OrgsClientsWireless) CountOrgWirelessClients(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgClientsCountDistinctEnum,
	mac *string,
	hostname *string,
	device *string,
	os *string,
	model *string,
	ap *string,
	vlan *string,
	ssid *string,
	ipAddress *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgWirelessClients takes context, orgId, distinct, mac, hostname, device, os, model, ap, vlan, ssid, ipAddress, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Wireless Clients

func (*OrgsClientsWireless) CountOrgWirelessClientsSessions 

func (o *OrgsClientsWireless) CountOrgWirelessClientsSessions(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgClientSessionsCountDistinctEnum,
	ap *string,
	band *models.Dot11BandEnum,
	clientFamily *string,
	clientManufacture *string,
	clientModel *string,
	clientOs *string,
	ssid *string,
	wlanId *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgWirelessClientsSessions takes context, orgId, distinct, ap, band, clientFamily, clientManufacture, clientModel, clientOs, ssid, wlanId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Wireless Clients Sessions

func (*OrgsClientsWireless) SearchOrgWirelessClientEvents 

func (o *OrgsClientsWireless) SearchOrgWirelessClientEvents(
	ctx context.Context,
	orgId uuid.UUID,
	mType *string,
	reasonCode *int,
	ssid *string,
	ap *string,
	proto *models.Dot11ProtoEnum,
	band *models.Dot11BandEnum,
	wlanId *string,
	nacruleId *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseEventsSearch],
	error)

SearchOrgWirelessClientEvents takes context, orgId, mType, reasonCode, ssid, ap, proto, band, wlanId, nacruleId, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseEventsSearch data and an error if there was an issue with the request or response. Get Org Clients Events

func (*OrgsClientsWireless) SearchOrgWirelessClientSessions 

func (o *OrgsClientsWireless) SearchOrgWirelessClientSessions(
	ctx context.Context,
	orgId uuid.UUID,
	ap *string,
	band *models.Dot11BandEnum,
	clientFamily *string,
	clientManufacture *string,
	clientModel *string,
	clientUsername *string,
	clientOs *string,
	ssid *string,
	wlanId *string,
	pskId *string,
	pskName *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.SearchWirelssClientSession],
	error)

SearchOrgWirelessClientSessions takes context, orgId, ap, band, clientFamily, clientManufacture, clientModel, clientUsername, clientOs, ssid, wlanId, pskId, pskName, limit, start, end, duration as parameters and returns an models.ApiResponse with models.SearchWirelssClientSession data and an error if there was an issue with the request or response. Search Org Wireless Clients Sessions

func (*OrgsClientsWireless) SearchOrgWirelessClients 

func (o *OrgsClientsWireless) SearchOrgWirelessClients(
	ctx context.Context,
	orgId uuid.UUID,
	siteId *string,
	mac *string,
	ipAddress *string,
	hostname *string,
	band *string,
	device *string,
	os *string,
	model *string,
	ap *string,
	pskId *string,
	pskName *string,
	username *string,
	vlan *string,
	ssid *string,
	text *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseClientSearch],
	error)

SearchOrgWirelessClients takes context, orgId, siteId, mac, ipAddress, hostname, band, device, os, model, ap, pskId, pskName, username, vlan, ssid, text, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseClientSearch data and an error if there was an issue with the request or response. Search Org Wireless Clients

type OrgsCradlepoint 

type OrgsCradlepoint struct {
	// contains filtered or unexported fields
}

OrgsCradlepoint represents a controller struct.

func NewOrgsCradlepoint 

func NewOrgsCradlepoint(baseController baseController) *OrgsCradlepoint

NewOrgsCradlepoint creates a new instance of OrgsCradlepoint. It takes a baseController as a parameter and returns a pointer to the OrgsCradlepoint.

func (*OrgsCradlepoint) DeleteOrgCradlepointConnection 

func (o *OrgsCradlepoint) DeleteOrgCradlepointConnection(
	ctx context.Context,
	orgId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgCradlepointConnection takes context, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. This deletes the Cradlepoint integration in Mist

func (*OrgsCradlepoint) SetupOrgCradlepointConnectionToMist 

func (o *OrgsCradlepoint) SetupOrgCradlepointConnectionToMist(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.AccountCradlepointConfig) (
	*http.Response,
	error)

SetupOrgCradlepointConnectionToMist takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. This sets up cradlepoint webhooks to send events to Mist

func (*OrgsCradlepoint) SyncOrgCradlepointRouters 

func (o *OrgsCradlepoint) SyncOrgCradlepointRouters(
	ctx context.Context,
	orgId uuid.UUID) (
	*http.Response,
	error)

SyncOrgCradlepointRouters takes context, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. This syncs cradlepoint devices with Mist. We’ll also attempt to use the LLDP data from cradlepoint to identify the linkage against Mist Site / Device

func (*OrgsCradlepoint) UpdateOrgCradlepointConnectionToMist 

func (o *OrgsCradlepoint) UpdateOrgCradlepointConnectionToMist(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.AccountCradlepointConfig) (
	*http.Response,
	error)

UpdateOrgCradlepointConnectionToMist takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. This updates the Cradlepoint integration settings in Mist

type OrgsDeviceProfiles 

type OrgsDeviceProfiles struct {
	// contains filtered or unexported fields
}

OrgsDeviceProfiles represents a controller struct.

func NewOrgsDeviceProfiles 

func NewOrgsDeviceProfiles(baseController baseController) *OrgsDeviceProfiles

NewOrgsDeviceProfiles creates a new instance of OrgsDeviceProfiles. It takes a baseController as a parameter and returns a pointer to the OrgsDeviceProfiles.

func (*OrgsDeviceProfiles) AssignOrgDeviceProfile 

func (o *OrgsDeviceProfiles) AssignOrgDeviceProfile(
	ctx context.Context,
	orgId uuid.UUID,
	deviceprofileId uuid.UUID,
	body *models.MacAddresses) (
	models.ApiResponse[models.ResponseAssignSuccess],
	error)

AssignOrgDeviceProfile takes context, orgId, deviceprofileId, body as parameters and returns an models.ApiResponse with models.ResponseAssignSuccess data and an error if there was an issue with the request or response. Assign Org Device Profile to Devices

func (*OrgsDeviceProfiles) CreateOrgDeviceProfiles 

func (o *OrgsDeviceProfiles) CreateOrgDeviceProfiles(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Deviceprofile) (
	models.ApiResponse[models.Deviceprofile],
	error)

CreateOrgDeviceProfiles takes context, orgId, body as parameters and returns an models.ApiResponse with models.Deviceprofile data and an error if there was an issue with the request or response. Create Device Profile

func (*OrgsDeviceProfiles) DeleteOrgDeviceProfile 

func (o *OrgsDeviceProfiles) DeleteOrgDeviceProfile(
	ctx context.Context,
	orgId uuid.UUID,
	deviceprofileId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgDeviceProfile takes context, orgId, deviceprofileId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Device Profile

func (*OrgsDeviceProfiles) GetOrgDeviceProfile 

func (o *OrgsDeviceProfiles) GetOrgDeviceProfile(
	ctx context.Context,
	orgId uuid.UUID,
	deviceprofileId uuid.UUID) (
	models.ApiResponse[models.Deviceprofile],
	error)

GetOrgDeviceProfile takes context, orgId, deviceprofileId as parameters and returns an models.ApiResponse with models.Deviceprofile data and an error if there was an issue with the request or response. Get Org device Profile Details

func (*OrgsDeviceProfiles) ListOrgDeviceProfiles 

func (o *OrgsDeviceProfiles) ListOrgDeviceProfiles(
	ctx context.Context,
	orgId uuid.UUID,
	mType *models.DeviceTypeEnum,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Deviceprofile],
	error)

ListOrgDeviceProfiles takes context, orgId, mType, limit, page as parameters and returns an models.ApiResponse with []models.Deviceprofile data and an error if there was an issue with the request or response. Get List of Org Device Profiles

func (*OrgsDeviceProfiles) UnassignOrgDeviceProfile added in v0.2.7 

func (o *OrgsDeviceProfiles) UnassignOrgDeviceProfile(
	ctx context.Context,
	orgId uuid.UUID,
	deviceprofileId uuid.UUID,
	body *models.MacAddresses) (
	models.ApiResponse[models.ResponseAssignSuccess],
	error)

UnassignOrgDeviceProfile takes context, orgId, deviceprofileId, body as parameters and returns an models.ApiResponse with models.ResponseAssignSuccess data and an error if there was an issue with the request or response. Unassign Org Device Profile from Devices

func (*OrgsDeviceProfiles) UpdateOrgDeviceProfile 

func (o *OrgsDeviceProfiles) UpdateOrgDeviceProfile(
	ctx context.Context,
	orgId uuid.UUID,
	deviceprofileId uuid.UUID,
	body *models.Deviceprofile) (
	models.ApiResponse[models.Deviceprofile],
	error)

UpdateOrgDeviceProfile takes context, orgId, deviceprofileId, body as parameters and returns an models.ApiResponse with models.Deviceprofile data and an error if there was an issue with the request or response. Update Org Device Profile

type OrgsDevices 

type OrgsDevices struct {
	// contains filtered or unexported fields
}

OrgsDevices represents a controller struct.

func NewOrgsDevices 

func NewOrgsDevices(baseController baseController) *OrgsDevices

NewOrgsDevices creates a new instance of OrgsDevices. It takes a baseController as a parameter and returns a pointer to the OrgsDevices.

func (*OrgsDevices) CountOrgDeviceEvents 

func (o *OrgsDevices) CountOrgDeviceEvents(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgDevicesEventsCountDistinctEnum,
	siteId *string,
	ap *string,
	apfw *string,
	model *string,
	text *string,
	timestamp *string,
	mType *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgDeviceEvents takes context, orgId, distinct, siteId, ap, apfw, model, text, timestamp, mType, limit, start, end, duration as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Devices Events

func (*OrgsDevices) CountOrgDeviceLastConfigs 

func (o *OrgsDevices) CountOrgDeviceLastConfigs(
	ctx context.Context,
	orgId uuid.UUID,
	mType *models.DeviceTypeEnum,
	distinct *models.OrgDevicesLastConfigsCountDistinctEnum,
	start *int,
	end *int,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgDeviceLastConfigs takes context, orgId, mType, distinct, start, end, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Counts the number of entries in device config history for distinct field with given filters

func (*OrgsDevices) CountOrgDevices 

func (o *OrgsDevices) CountOrgDevices(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgDevicesCountDistinctEnum,
	hostname *string,
	siteId *string,
	model *string,
	managed *string,
	mac *string,
	version *string,
	ipAddress *string,
	mxtunnelStatus *models.CountOrgDevicesMxtunnelStatusEnum,
	mxedgeId *string,
	lldpSystemName *string,
	lldpSystemDesc *string,
	lldpPortId *string,
	lldpMgmtAddr *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgDevices takes context, orgId, distinct, hostname, siteId, model, managed, mac, version, ipAddress, mxtunnelStatus, mxedgeId, lldpSystemName, lldpSystemDesc, lldpPortId, lldpMgmtAddr, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Devices

func (*OrgsDevices) GetOrgJuniperDevicesCommand 

func (o *OrgsDevices) GetOrgJuniperDevicesCommand(
	ctx context.Context,
	orgId uuid.UUID,
	siteId *string) (
	models.ApiResponse[models.ResponseDeviceConfigCmd],
	error)

GetOrgJuniperDevicesCommand takes context, orgId, siteId as parameters and returns an models.ApiResponse with models.ResponseDeviceConfigCmd data and an error if there was an issue with the request or response. Get Org Juniper Devices command Juniper devices can be managed/adopted by Mist. Currently outbound-ssh + netconf is used. A few lines of CLI commands are generated per-Org, allowing the Juniper devices to phone home to Mist.

func (*OrgsDevices) ListOrgApsMacs 

func (o *OrgsDevices) ListOrgApsMacs(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.ApRadioMac],
	error)

ListOrgApsMacs takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.ApRadioMac data and an error if there was an issue with the request or response. For some scenarios like E911 or security systems, the BSSIDs are required to identify which AP the client is connecting to. Then the location of the AP can be used as the approximate location of the client. Each radio MAC can have 16 BSSIDs (enumerate the last octet from 0-F)

func (*OrgsDevices) ListOrgDevices 

func (o *OrgsDevices) ListOrgDevices(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.ResponseOrgDevices],
	error)

ListOrgDevices takes context, orgId as parameters and returns an models.ApiResponse with models.ResponseOrgDevices data and an error if there was an issue with the request or response. Get List of Org Devices

func (*OrgsDevices) SearchOrgDeviceEvents 

func (o *OrgsDevices) SearchOrgDeviceEvents(
	ctx context.Context,
	orgId uuid.UUID,
	mac *string,
	model *string,
	deviceType *models.DeviceTypeWithAllEnum,
	text *string,
	timestamp *string,
	mType *string,
	lastBy *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseDeviceEventsSearch],
	error)

SearchOrgDeviceEvents takes context, orgId, mac, model, deviceType, text, timestamp, mType, lastBy, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseDeviceEventsSearch data and an error if there was an issue with the request or response. Search Org Devices Events

func (*OrgsDevices) SearchOrgDeviceLastConfigs 

func (o *OrgsDevices) SearchOrgDeviceLastConfigs(
	ctx context.Context,
	orgId uuid.UUID,
	mType *models.DeviceTypeEnum,
	mac *string,
	name *string,
	version *string,
	start *int,
	end *int,
	limit *int,
	duration *string) (
	models.ApiResponse[models.ResponseConfigHistorySearch],
	error)

SearchOrgDeviceLastConfigs takes context, orgId, mType, mac, name, version, start, end, limit, duration as parameters and returns an models.ApiResponse with models.ResponseConfigHistorySearch data and an error if there was an issue with the request or response. Search Device Last Configs

func (*OrgsDevices) SearchOrgDevices 

func (o *OrgsDevices) SearchOrgDevices(
	ctx context.Context,
	orgId uuid.UUID,
	hostname *string,
	siteId *string,
	model *string,
	mac *string,
	version *string,
	extIp *string,
	powerConstrained *bool,
	ipAddress *string,
	mxtunnelStatus *models.SearchOrgDevicesMxtunnelStatusEnum,
	mxedgeId *string,
	mxedgeIds *string,
	lldpSystemName *string,
	lldpSystemDesc *string,
	lldpPortId *string,
	lldpMgmtAddr *string,
	lldpPowerAllocated *int,
	lldpPowerDraw *int,
	band24Bandwidth *int,
	band5Bandwidth *int,
	band6Bandwidth *int,
	band24Channel *int,
	band5Channel *int,
	band6Channel *int,
	band24Power *int,
	band5Power *int,
	band6Power *int,
	eth0PortSpeed *int,
	mType *models.DeviceTypeEnum,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseDeviceSearch],
	error)

SearchOrgDevices takes context, orgId, hostname, siteId, model, mac, version, extIp, powerConstrained, ipAddress, mxtunnelStatus, mxedgeId, mxedgeIds, lldpSystemName, lldpSystemDesc, lldpPortId, lldpMgmtAddr, lldpPowerAllocated, lldpPowerDraw, band24Bandwidth, band5Bandwidth, band6Bandwidth, band24Channel, band5Channel, band6Channel, band24Power, band5Power, band6Power, eth0PortSpeed, mType, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseDeviceSearch data and an error if there was an issue with the request or response. Search Org Devices

type OrgsDevicesOthers 

type OrgsDevicesOthers struct {
	// contains filtered or unexported fields
}

OrgsDevicesOthers represents a controller struct.

func NewOrgsDevicesOthers 

func NewOrgsDevicesOthers(baseController baseController) *OrgsDevicesOthers

NewOrgsDevicesOthers creates a new instance of OrgsDevicesOthers. It takes a baseController as a parameter and returns a pointer to the OrgsDevicesOthers.

func (*OrgsDevicesOthers) CountOrgOtherDeviceEvents 

func (o *OrgsDevicesOthers) CountOrgOtherDeviceEvents(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgOtherdevicesEventsCountDistinctEnum,
	mType *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgOtherDeviceEvents takes context, orgId, distinct, mType, start, end, duration, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org OtherDevices Events

func (*OrgsDevicesOthers) DeleteOrgOtherDevice 

func (o *OrgsDevicesOthers) DeleteOrgOtherDevice(
	ctx context.Context,
	orgId uuid.UUID,
	deviceMac string) (
	*http.Response,
	error)

DeleteOrgOtherDevice takes context, orgId, deviceMac as parameters and returns an *Response and an error if there was an issue with the request or response. Delete OtherDevice

func (*OrgsDevicesOthers) GetOrgOtherDevice 

func (o *OrgsDevicesOthers) GetOrgOtherDevice(
	ctx context.Context,
	orgId uuid.UUID,
	deviceMac string) (
	models.ApiResponse[models.DeviceOther],
	error)

GetOrgOtherDevice takes context, orgId, deviceMac as parameters and returns an models.ApiResponse with models.DeviceOther data and an error if there was an issue with the request or response. Get Org other device (3rd party device)

func (*OrgsDevicesOthers) ListOrgOtherDevices 

func (o *OrgsDevicesOthers) ListOrgOtherDevices(
	ctx context.Context,
	orgId uuid.UUID,
	vendor *string,
	mac *string,
	serial *string,
	model *string,
	name *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.DeviceOther],
	error)

ListOrgOtherDevices takes context, orgId, vendor, mac, serial, model, name, limit, page as parameters and returns an models.ApiResponse with []models.DeviceOther data and an error if there was an issue with the request or response. Get List of Org other devices (3rd party devices)

func (*OrgsDevicesOthers) RebootOrgOtherDevice 

func (o *OrgsDevicesOthers) RebootOrgOtherDevice(
	ctx context.Context,
	orgId uuid.UUID,
	deviceMac string) (
	*http.Response,
	error)

RebootOrgOtherDevice takes context, orgId, deviceMac as parameters and returns an *Response and an error if there was an issue with the request or response. Reboot OtherDevice

func (*OrgsDevicesOthers) SearchOrgOtherDeviceEvents 

func (o *OrgsDevicesOthers) SearchOrgOtherDeviceEvents(
	ctx context.Context,
	orgId uuid.UUID,
	siteId *string,
	mac *string,
	deviceMac *string,
	model *string,
	vendor *string,
	mType *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.ResponseEventsOtherDevicesSearch],
	error)

SearchOrgOtherDeviceEvents takes context, orgId, siteId, mac, deviceMac, model, vendor, mType, start, end, duration, limit as parameters and returns an models.ApiResponse with models.ResponseEventsOtherDevicesSearch data and an error if there was an issue with the request or response. Search Org OtherDevices Events

func (*OrgsDevicesOthers) UpdateOrgOtherDevice 

func (o *OrgsDevicesOthers) UpdateOrgOtherDevice(
	ctx context.Context,
	orgId uuid.UUID,
	deviceMac string,
	body *models.OtherDeviceUpdate) (
	*http.Response,
	error)

UpdateOrgOtherDevice takes context, orgId, deviceMac, body as parameters and returns an *Response and an error if there was an issue with the request or response. If the Site / Device cannot be identified, a manual association can be made

func (*OrgsDevicesOthers) UpdateOrgOtherDevices 

func (o *OrgsDevicesOthers) UpdateOrgOtherDevices(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.OtherDeviceUpdateMulti) (
	*http.Response,
	error)

UpdateOrgOtherDevices takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Assign or unassign OtherDevices to and from a site.

type OrgsDevicesSSR 

type OrgsDevicesSSR struct {
	// contains filtered or unexported fields
}

OrgsDevicesSSR represents a controller struct.

func NewOrgsDevicesSSR 

func NewOrgsDevicesSSR(baseController baseController) *OrgsDevicesSSR

NewOrgsDevicesSSR creates a new instance of OrgsDevicesSSR. It takes a baseController as a parameter and returns a pointer to the OrgsDevicesSSR.

func (*OrgsDevicesSSR) GetOrg128TRegistrationCommands 

func (o *OrgsDevicesSSR) GetOrg128TRegistrationCommands(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.ReponseRouter128tRegisterCmd],
	error)

GetOrg128TRegistrationCommands takes context, orgId as parameters and returns an models.ApiResponse with models.ReponseRouter128tRegisterCmd data and an error if there was an issue with the request or response. 128T devices can be managed/adopted by Mist.

type OrgsEVPNTopologies 

type OrgsEVPNTopologies struct {
	// contains filtered or unexported fields
}

OrgsEVPNTopologies represents a controller struct.

func NewOrgsEVPNTopologies 

func NewOrgsEVPNTopologies(baseController baseController) *OrgsEVPNTopologies

NewOrgsEVPNTopologies creates a new instance of OrgsEVPNTopologies. It takes a baseController as a parameter and returns a pointer to the OrgsEVPNTopologies.

func (*OrgsEVPNTopologies) CreateOrgEvpnTopology 

func (o *OrgsEVPNTopologies) CreateOrgEvpnTopology(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.EvpnTopology) (
	models.ApiResponse[models.EvpnTopology],
	error)

CreateOrgEvpnTopology takes context, orgId, body as parameters and returns an models.ApiResponse with models.EvpnTopology data and an error if there was an issue with the request or response. While all the `evpn_id` / `downlink_ips` can be specifidd by hand, the easiest way is to call the `build_vpn_topology` API, allowing you to examine the diff, and update it yourself. You can also simply call it with `overwrite=true` which will apply the updates for you. **Notes:** 1. You can use `core` / `distribution` / `access` to create a CLOS topology 2. You can also use `core` / `distribution` to form a 2-tier EVPN topology where ESI-Lag is configured distribution to connect to access switches 3. In a small/medium campus, `collapsed-core` can be used where core switches are the inter-connected to do EVPN 4. The API uses a few pre-defined parameters and best-practices to generate the configs. It can be customized by using `evpn_options` in Site Setting / Network Template. (e.g. a different subnet for the underlay) #### Collapsed Core In a small-medium campus, EVPN can also be enabled only at the core switches (up to 4) by assigning all participating switches with `collapsed-core role`. When there are more than 2 switches, a ring-like topology will be formed. #### ESI-Lag If the access switchess does not have EVPN support, you can take advantage of EVPN by setting up ESI-Lag on distribution switches #### Leaf / Access / Collapsed-Core For leaf nodes in a EVPN topology, you’d have to configure the IPs for networks that would participate in EVPN. Optionally, VRFs to isolate traffic from one tenant verus another

func (*OrgsEVPNTopologies) DeleteOrgEvpnTopology 

func (o *OrgsEVPNTopologies) DeleteOrgEvpnTopology(
	ctx context.Context,
	orgId uuid.UUID,
	evpnTopologyId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgEvpnTopology takes context, orgId, evpnTopologyId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete the Org EVPN Topology

func (*OrgsEVPNTopologies) GetOrgEvpnTopology added in v0.4.7 

func (o *OrgsEVPNTopologies) GetOrgEvpnTopology(
	ctx context.Context,
	orgId uuid.UUID,
	evpnTopologyId uuid.UUID) (
	models.ApiResponse[models.EvpnTopology],
	error)

GetOrgEvpnTopology takes context, orgId, evpnTopologyId as parameters and returns an models.ApiResponse with models.EvpnTopology data and an error if there was an issue with the request or response. Get One EVPN Topology Detail

func (*OrgsEVPNTopologies) ListOrgEvpnTopologies 

func (o *OrgsEVPNTopologies) ListOrgEvpnTopologies(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.EvpnTopology],
	error)

ListOrgEvpnTopologies takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.EvpnTopology data and an error if there was an issue with the request or response. Get List of the existing Org EVPN topologies

func (*OrgsEVPNTopologies) UpdateOrgEvpnTopology 

func (o *OrgsEVPNTopologies) UpdateOrgEvpnTopology(
	ctx context.Context,
	orgId uuid.UUID,
	evpnTopologyId uuid.UUID,
	body *models.EvpnTopology) (
	models.ApiResponse[models.EvpnTopology],
	error)

UpdateOrgEvpnTopology takes context, orgId, evpnTopologyId, body as parameters and returns an models.ApiResponse with models.EvpnTopology data and an error if there was an issue with the request or response. Update the EVPN Topolgy

type OrgsGatewayTemplates 

type OrgsGatewayTemplates struct {
	// contains filtered or unexported fields
}

OrgsGatewayTemplates represents a controller struct.

func NewOrgsGatewayTemplates 

func NewOrgsGatewayTemplates(baseController baseController) *OrgsGatewayTemplates

NewOrgsGatewayTemplates creates a new instance of OrgsGatewayTemplates. It takes a baseController as a parameter and returns a pointer to the OrgsGatewayTemplates.

func (*OrgsGatewayTemplates) CreateOrgGatewayTemplate 

func (o *OrgsGatewayTemplates) CreateOrgGatewayTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.GatewayTemplate) (
	models.ApiResponse[models.GatewayTemplate],
	error)

CreateOrgGatewayTemplate takes context, orgId, body as parameters and returns an models.ApiResponse with models.GatewayTemplate data and an error if there was an issue with the request or response. Create Org Gateway Template

func (*OrgsGatewayTemplates) DeleteOrgGatewayTemplate 

func (o *OrgsGatewayTemplates) DeleteOrgGatewayTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	gatewaytemplateId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgGatewayTemplate takes context, orgId, gatewaytemplateId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Organization Gateway Template

func (*OrgsGatewayTemplates) GetOrgGatewayTemplate 

func (o *OrgsGatewayTemplates) GetOrgGatewayTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	gatewaytemplateId uuid.UUID) (
	models.ApiResponse[models.GatewayTemplate],
	error)

GetOrgGatewayTemplate takes context, orgId, gatewaytemplateId as parameters and returns an models.ApiResponse with models.GatewayTemplate data and an error if there was an issue with the request or response. Get Organization Gateway Template details

func (*OrgsGatewayTemplates) ListOrgGatewayTemplates 

func (o *OrgsGatewayTemplates) ListOrgGatewayTemplates(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.GatewayTemplate],
	error)

ListOrgGatewayTemplates takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.GatewayTemplate data and an error if there was an issue with the request or response. Get List of Org Gateway Templates

func (*OrgsGatewayTemplates) UpdateOrgGatewayTemplate 

func (o *OrgsGatewayTemplates) UpdateOrgGatewayTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	gatewaytemplateId uuid.UUID,
	body *models.GatewayTemplate) (
	models.ApiResponse[models.GatewayTemplate],
	error)

UpdateOrgGatewayTemplate takes context, orgId, gatewaytemplateId, body as parameters and returns an models.ApiResponse with models.GatewayTemplate data and an error if there was an issue with the request or response. Update Organization Gateway Template

type OrgsGuests 

type OrgsGuests struct {
	// contains filtered or unexported fields
}

OrgsGuests represents a controller struct.

func NewOrgsGuests 

func NewOrgsGuests(baseController baseController) *OrgsGuests

NewOrgsGuests creates a new instance of OrgsGuests. It takes a baseController as a parameter and returns a pointer to the OrgsGuests.

func (*OrgsGuests) CountOrgGuestAuthorizations 

func (o *OrgsGuests) CountOrgGuestAuthorizations(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgGuestsCountDistinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgGuestAuthorizations takes context, orgId, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Authorized Guest

func (*OrgsGuests) DeleteOrgGuestAuthorization 

func (o *OrgsGuests) DeleteOrgGuestAuthorization(
	ctx context.Context,
	orgId uuid.UUID,
	guestMac string) (
	*http.Response,
	error)

DeleteOrgGuestAuthorization takes context, orgId, guestMac as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Guest Authorization

func (*OrgsGuests) GetOrgGuestAuthorization 

func (o *OrgsGuests) GetOrgGuestAuthorization(
	ctx context.Context,
	orgId uuid.UUID,
	guestMac string) (
	models.ApiResponse[models.Guest],
	error)

GetOrgGuestAuthorization takes context, orgId, guestMac as parameters and returns an models.ApiResponse with models.Guest data and an error if there was an issue with the request or response. Get Guest Authorization

func (*OrgsGuests) ListOrgGuestAuthorizations 

func (o *OrgsGuests) ListOrgGuestAuthorizations(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.Guest],
	error)

ListOrgGuestAuthorizations takes context, orgId as parameters and returns an models.ApiResponse with []models.Guest data and an error if there was an issue with the request or response. Get List of Org Guest Authorizations

func (*OrgsGuests) SearchOrgGuestAuthorization 

func (o *OrgsGuests) SearchOrgGuestAuthorization(
	ctx context.Context,
	orgId uuid.UUID,
	wlanId *string,
	authMethod *string,
	ssid *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseGuestSearch],
	error)

SearchOrgGuestAuthorization takes context, orgId, wlanId, authMethod, ssid, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseGuestSearch data and an error if there was an issue with the request or response. Search Authorized Guest

func (*OrgsGuests) UpdateOrgGuestAuthorization 

func (o *OrgsGuests) UpdateOrgGuestAuthorization(
	ctx context.Context,
	orgId uuid.UUID,
	guestMac string,
	body *models.GuestOrg) (
	models.ApiResponse[models.Guest],
	error)

UpdateOrgGuestAuthorization takes context, orgId, guestMac, body as parameters and returns an models.ApiResponse with models.Guest data and an error if there was an issue with the request or response. Update Guest Authorization

type OrgsIDPProfiles 

type OrgsIDPProfiles struct {
	// contains filtered or unexported fields
}

OrgsIDPProfiles represents a controller struct.

func NewOrgsIDPProfiles 

func NewOrgsIDPProfiles(baseController baseController) *OrgsIDPProfiles

NewOrgsIDPProfiles creates a new instance of OrgsIDPProfiles. It takes a baseController as a parameter and returns a pointer to the OrgsIDPProfiles.

func (*OrgsIDPProfiles) CreateOrgIdpProfile 

func (o *OrgsIDPProfiles) CreateOrgIdpProfile(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.IdpProfile) (
	models.ApiResponse[models.IdpProfile],
	error)

CreateOrgIdpProfile takes context, orgId, body as parameters and returns an models.ApiResponse with models.IdpProfile data and an error if there was an issue with the request or response. Create Org IDP Profile

func (*OrgsIDPProfiles) DeleteOrgIdpProfile 

func (o *OrgsIDPProfiles) DeleteOrgIdpProfile(
	ctx context.Context,
	orgId uuid.UUID,
	idpprofileId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgIdpProfile takes context, orgId, idpprofileId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org IDP Profile

func (*OrgsIDPProfiles) GetOrgIdpProfile 

func (o *OrgsIDPProfiles) GetOrgIdpProfile(
	ctx context.Context,
	orgId uuid.UUID,
	idpprofileId uuid.UUID) (
	models.ApiResponse[models.IdpProfile],
	error)

GetOrgIdpProfile takes context, orgId, idpprofileId as parameters and returns an models.ApiResponse with models.IdpProfile data and an error if there was an issue with the request or response. Get Org IDP Profile

func (*OrgsIDPProfiles) ListOrgIdpProfiles 

func (o *OrgsIDPProfiles) ListOrgIdpProfiles(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.IdpProfile],
	error)

ListOrgIdpProfiles takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.IdpProfile data and an error if there was an issue with the request or response. get the list of Org IDP Profiles

func (*OrgsIDPProfiles) UpdateOrgIdpProfile 

func (o *OrgsIDPProfiles) UpdateOrgIdpProfile(
	ctx context.Context,
	orgId uuid.UUID,
	idpprofileId uuid.UUID,
	body *models.IdpProfile) (
	models.ApiResponse[models.IdpProfile],
	error)

UpdateOrgIdpProfile takes context, orgId, idpprofileId, body as parameters and returns an models.ApiResponse with models.IdpProfile data and an error if there was an issue with the request or response. Update Org IDP Profile

type OrgsInventory 

type OrgsInventory struct {
	// contains filtered or unexported fields
}

OrgsInventory represents a controller struct.

func NewOrgsInventory 

func NewOrgsInventory(baseController baseController) *OrgsInventory

NewOrgsInventory creates a new instance of OrgsInventory. It takes a baseController as a parameter and returns a pointer to the OrgsInventory.

func (*OrgsInventory) AddOrgInventory 

func (o *OrgsInventory) AddOrgInventory(
	ctx context.Context,
	orgId uuid.UUID,
	body []string) (
	models.ApiResponse[models.ResponseInventory],
	error)

AddOrgInventory takes context, orgId, body as parameters and returns an models.ApiResponse with models.ResponseInventory data and an error if there was an issue with the request or response. Add Device to Org Inventory with the device claim codes

func (*OrgsInventory) CountOrgInventory added in v0.4.0 

func (o *OrgsInventory) CountOrgInventory(
	ctx context.Context,
	orgId uuid.UUID,
	mType *models.DeviceTypeEnum,
	distinct *models.InventoryCountDistinctEnum,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgInventory takes context, orgId, mType, distinct, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count in the Org Inventory

func (*OrgsInventory) CreateOrgGatewayHaCluster added in v0.2.25 

func (o *OrgsInventory) CreateOrgGatewayHaCluster(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.HaClusterConfig) (
	*http.Response,
	error)

CreateOrgGatewayHaCluster takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Create HA Cluster from unassigned Gateways

func (*OrgsInventory) DeleteOrgGatewayHaCluster added in v0.2.25 

func (o *OrgsInventory) DeleteOrgGatewayHaCluster(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.HaClusterDelete) (
	*http.Response,
	error)

DeleteOrgGatewayHaCluster takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Delete HA Cluster After HA cluster deleted, both of the nodes will be unassigned.

func (*OrgsInventory) GetOrgInventory 

func (o *OrgsInventory) GetOrgInventory(
	ctx context.Context,
	orgId uuid.UUID,
	serial *string,
	model *string,
	mType *models.DeviceTypeEnum,
	mac *string,
	siteId *string,
	vcMac *string,
	vc *bool,
	unassigned *bool,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Inventory],
	error)

GetOrgInventory takes context, orgId, serial, model, mType, mac, siteId, vcMac, vc, unassigned, limit, page as parameters and returns an models.ApiResponse with []models.Inventory data and an error if there was an issue with the request or response. Get Org Inventory ### VC (Virtual-Chassis) Management Ideally VC should be managed as a single device - where - one managed entity where config / monitoring is anchored against (with a stable identify MAC) - all members appears in the inventory In our implementation, we strive to achieve that without manual user configurations by 1. during claim or adoption a VC, we require FPC0 to exist and will use its MAC as identify for the entire chassis 2. other VC members will be automatically populated when they’re all present The perceivable result is 1. from `/sites/:site_id/stats/devices/:fpc0_mac` API, you’d see the VC where module_stat contains the VC members 2. from `/orgs/:org_id/inventory?vc=true` API, you’d see all VC members with vc_mac pointing to the FPC0

func (*OrgsInventory) ReevaluateOrgAutoAssignment 

func (o *OrgsInventory) ReevaluateOrgAutoAssignment(
	ctx context.Context,
	orgId uuid.UUID) (
	*http.Response,
	error)

ReevaluateOrgAutoAssignment takes context, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. Reevaluate Auto Assignment

func (*OrgsInventory) ReplaceOrgDevices 

func (o *OrgsInventory) ReplaceOrgDevices(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.ReplaceDevice) (
	models.ApiResponse[models.ResponseOrgInventoryChange],
	error)

ReplaceOrgDevices takes context, orgId, body as parameters and returns an models.ApiResponse with models.ResponseOrgInventoryChange data and an error if there was an issue with the request or response. It’s a common request we get from the customers. When a AP HW has problem and need a replacement, they would want to copy the existing attributes (Device Config) of this old AP to the new one. It can be done by providing the MAC of a device that’s currently in the inventory but not assigned. The Device replaced will become unassigned. This API also supports replacement of Mist Edges. This API copies device agnostic attributes from old Mist edge to new one. Mist manufactured Mist Edges will be reset to factory settings but will still be in Inventory.Brownfield or VM’s will be deleted from Inventory **Note:** For Gateway devices only like-for-like replacements (can only replace a SRX320 with a SRX320 and not some otehr model) are allowed.

func (*OrgsInventory) SearchOrgInventory added in v0.4.0 

func (o *OrgsInventory) SearchOrgInventory(
	ctx context.Context,
	orgId uuid.UUID,
	mType *models.DeviceTypeEnum,
	mac *string,
	vcMac *string,
	masterMac *string,
	siteId *string,
	serial *string,
	master *string,
	sku *string,
	version *string,
	status *string,
	text *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.InventorySearch],
	error)

SearchOrgInventory takes context, orgId, mType, mac, vcMac, masterMac, siteId, serial, master, sku, version, status, text, limit, page as parameters and returns an models.ApiResponse with models.InventorySearch data and an error if there was an issue with the request or response. Search in the Org Inventory

func (*OrgsInventory) UpdateOrgInventoryAssignment 

func (o *OrgsInventory) UpdateOrgInventoryAssignment(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.InventoryUpdate) (
	models.ApiResponse[models.ResponseOrgInventoryChange],
	error)

UpdateOrgInventoryAssignment takes context, orgId, body as parameters and returns an models.ApiResponse with models.ResponseOrgInventoryChange data and an error if there was an issue with the request or response. Update Org Inventory

type OrgsJSE 

type OrgsJSE struct {
	// contains filtered or unexported fields
}

OrgsJSE represents a controller struct.

func NewOrgsJSE 

func NewOrgsJSE(baseController baseController) *OrgsJSE

NewOrgsJSE creates a new instance of OrgsJSE. It takes a baseController as a parameter and returns a pointer to the OrgsJSE.

func (*OrgsJSE) DeleteOrgJsecCredential 

func (o *OrgsJSE) DeleteOrgJsecCredential(
	ctx context.Context,
	orgId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgJsecCredential takes context, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete JSE credential

func (*OrgsJSE) GetOrgJseInfo 

func (o *OrgsJSE) GetOrgJseInfo(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.AccountJseInfo],
	error)

GetOrgJseInfo takes context, orgId as parameters and returns an models.ApiResponse with models.AccountJseInfo data and an error if there was an issue with the request or response. Retrieves the list of JSE orgs associated with the account.

func (*OrgsJSE) GetOrgJsecCredential 

func (o *OrgsJSE) GetOrgJsecCredential(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.AccountJseInfo],
	error)

GetOrgJsecCredential takes context, orgId as parameters and returns an models.ApiResponse with models.AccountJseInfo data and an error if there was an issue with the request or response. Get Org JSE Credential

func (*OrgsJSE) SetupOrgJsecCredential 

func (o *OrgsJSE) SetupOrgJsecCredential(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.AccountJseConfig) (
	models.ApiResponse[models.AccountJseInfo],
	error)

SetupOrgJsecCredential takes context, orgId, body as parameters and returns an models.ApiResponse with models.AccountJseInfo data and an error if there was an issue with the request or response. in JSE UI: 1. Create custom role with Read access to service_location and RW access to site and IPSec profile APIs. 2. Create a user with the above custom role. - email: john@abc.com 3. Activate the user in the JSE account. 4. Create the service locations on the JSE account.

type OrgsJSI 

type OrgsJSI struct {
	// contains filtered or unexported fields
}

OrgsJSI represents a controller struct.

func NewOrgsJSI 

func NewOrgsJSI(baseController baseController) *OrgsJSI

NewOrgsJSI creates a new instance of OrgsJSI. It takes a baseController as a parameter and returns a pointer to the OrgsJSI.

func (*OrgsJSI) AdoptOrgJsiDevice 

func (o *OrgsJSI) AdoptOrgJsiDevice(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.ResponseDeviceConfigCmd],
	error)

AdoptOrgJsiDevice takes context, orgId as parameters and returns an models.ApiResponse with models.ResponseDeviceConfigCmd data and an error if there was an issue with the request or response. Adopt JSI devices

func (*OrgsJSI) CreateOrgJsiDeviceShellSession 

func (o *OrgsJSI) CreateOrgJsiDeviceShellSession(
	ctx context.Context,
	orgId uuid.UUID,
	deviceMac string) (
	models.ApiResponse[models.WebsocketSessionWithUrl],
	error)

CreateOrgJsiDeviceShellSession takes context, orgId, deviceMac as parameters and returns an models.ApiResponse with models.WebsocketSessionWithUrl data and an error if there was an issue with the request or response. Create Shell Session

func (*OrgsJSI) ListOrgJsiDevices 

func (o *OrgsJSI) ListOrgJsiDevices(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int,
	model *string,
	serial *string,
	mac *string) (
	models.ApiResponse[[]models.JseDevice],
	error)

ListOrgJsiDevices takes context, orgId, limit, page, model, serial, mac as parameters and returns an models.ApiResponse with []models.JseDevice data and an error if there was an issue with the request or response. Get List of Org devices that connected to JSI

func (*OrgsJSI) ListOrgJsiPastPurchases 

func (o *OrgsJSI) ListOrgJsiPastPurchases(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int,
	model *string,
	serial *string) (
	models.ApiResponse[[]models.JseInventoryItem],
	error)

ListOrgJsiPastPurchases takes context, orgId, limit, page, model, serial as parameters and returns an models.ApiResponse with []models.JseInventoryItem data and an error if there was an issue with the request or response. Get List of all devices purchased from the accounts associated with the Org

type OrgsLicenses 

type OrgsLicenses struct {
	// contains filtered or unexported fields
}

OrgsLicenses represents a controller struct.

func NewOrgsLicenses 

func NewOrgsLicenses(baseController baseController) *OrgsLicenses

NewOrgsLicenses creates a new instance of OrgsLicenses. It takes a baseController as a parameter and returns a pointer to the OrgsLicenses.

func (*OrgsLicenses) ClaimOrgLicense 

func (o *OrgsLicenses) ClaimOrgLicense(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.ClaimActivation) (
	models.ApiResponse[models.ResponseClaimLicense],
	error)

ClaimOrgLicense takes context, orgId, body as parameters and returns an models.ApiResponse with models.ResponseClaimLicense data and an error if there was an issue with the request or response. Claim Org licenses / activation codes

func (*OrgsLicenses) GetOrgLicencesBySite 

func (o *OrgsLicenses) GetOrgLicencesBySite(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.LicenseUsageOrg],
	error)

GetOrgLicencesBySite takes context, orgId as parameters and returns an models.ApiResponse with []models.LicenseUsageOrg data and an error if there was an issue with the request or response. Get Licenses Usage by Sites This shows license usage (i.e. needed) based on the features enabled for the site.

func (*OrgsLicenses) GetOrgLicencesSummary 

func (o *OrgsLicenses) GetOrgLicencesSummary(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.License],
	error)

GetOrgLicencesSummary takes context, orgId as parameters and returns an models.ApiResponse with models.License data and an error if there was an issue with the request or response. Get the list of licenses

func (*OrgsLicenses) GetOrgLicenseAsyncClaimStatus added in v0.4.17 

func (o *OrgsLicenses) GetOrgLicenseAsyncClaimStatus(
	ctx context.Context,
	orgId uuid.UUID,
	detail *bool) (
	models.ApiResponse[models.ResponseAsyncLicense],
	error)

GetOrgLicenseAsyncClaimStatus takes context, orgId, detail as parameters and returns an models.ApiResponse with models.ResponseAsyncLicense data and an error if there was an issue with the request or response. Get Processing Status for Async Claim

func (*OrgsLicenses) MoveOrDeleteOrgLicenseToAnotherOrg 

func (o *OrgsLicenses) MoveOrDeleteOrgLicenseToAnotherOrg(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.OrgLicenseAction) (
	*http.Response,
	error)

MoveOrDeleteOrgLicenseToAnotherOrg takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Move, Undo Move or Delete Org License to Another Org If the admin has admin privilege against the `org_id` and `dst_org_id`, he can move some of the licenses to another Org. Given that: 1. the specified license is currently active 2. there’s enough licenses left in the specified license (by subscription_id) 3. there will still be enough entitled licenses for the type of license after the amendment

type OrgsLinkedApplications 

type OrgsLinkedApplications struct {
	// contains filtered or unexported fields
}

OrgsLinkedApplications represents a controller struct.

func NewOrgsLinkedApplications 

func NewOrgsLinkedApplications(baseController baseController) *OrgsLinkedApplications

NewOrgsLinkedApplications creates a new instance of OrgsLinkedApplications. It takes a baseController as a parameter and returns a pointer to the OrgsLinkedApplications.

func (*OrgsLinkedApplications) AddOrgOauthAppAccounts 

func (o *OrgsLinkedApplications) AddOrgOauthAppAccounts(
	ctx context.Context,
	orgId uuid.UUID,
	appName models.OauthAppNameEnum,
	body *models.AccountOauthAdd) (
	models.ApiResponse[models.ResponseOauthAppLink],
	error)

AddOrgOauthAppAccounts takes context, orgId, appName, body as parameters and returns an models.ApiResponse with models.ResponseOauthAppLink data and an error if there was an issue with the request or response. Add Jamf, VMware Authorization With Mist Portal

func (*OrgsLinkedApplications) DeleteOrgOauthAppAuthorization 

func (o *OrgsLinkedApplications) DeleteOrgOauthAppAuthorization(
	ctx context.Context,
	orgId uuid.UUID,
	appName models.OauthAppNameEnum,
	accountId string) (
	*http.Response,
	error)

DeleteOrgOauthAppAuthorization takes context, orgId, appName, accountId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Level OAuth Application Authorization With Mist Portal

func (*OrgsLinkedApplications) GetOrgOauthAppLinkedStatus 

func (o *OrgsLinkedApplications) GetOrgOauthAppLinkedStatus(
	ctx context.Context,
	orgId uuid.UUID,
	appName models.OauthAppNameEnum,
	forward string) (
	models.ApiResponse[models.ResponseOauthAppLink],
	error)

GetOrgOauthAppLinkedStatus takes context, orgId, appName, forward as parameters and returns an models.ApiResponse with models.ResponseOauthAppLink data and an error if there was an issue with the request or response. Get Org Level OAuth Application Linked Status

func (*OrgsLinkedApplications) LinkOrgToJuniperJuniperAccount 

func (o *OrgsLinkedApplications) LinkOrgToJuniperJuniperAccount(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.AccountJuniperConfig) (
	models.ApiResponse[models.AccountJuniperInfo],
	error)

LinkOrgToJuniperJuniperAccount takes context, orgId, body as parameters and returns an models.ApiResponse with models.AccountJuniperInfo data and an error if there was an issue with the request or response. Link Juniper Accounts

func (*OrgsLinkedApplications) UnlinkOrgFromJuniperCustomerId 

func (o *OrgsLinkedApplications) UnlinkOrgFromJuniperCustomerId(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.AccountJuniperInfo) (
	*http.Response,
	error)

UnlinkOrgFromJuniperCustomerId takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Unlink Juniper Customer ID `linked_by` field is only required if there are duplicate account_names.

func (*OrgsLinkedApplications) UpdateOrgOauthAppAccounts 

func (o *OrgsLinkedApplications) UpdateOrgOauthAppAccounts(
	ctx context.Context,
	orgId uuid.UUID,
	appName models.OauthAppNameEnum,
	body *models.AccountOauthConfig) (
	*http.Response,
	error)

UpdateOrgOauthAppAccounts takes context, orgId, appName, body as parameters and returns an *Response and an error if there was an issue with the request or response. Update Zoom, Teams, Intune Authorization. Request Payload, These Field And Values Will Be Specific To Each Of The Third Party Apps Accounts.

type OrgsLogs 

type OrgsLogs struct {
	// contains filtered or unexported fields
}

OrgsLogs represents a controller struct.

func NewOrgsLogs 

func NewOrgsLogs(baseController baseController) *OrgsLogs

NewOrgsLogs creates a new instance of OrgsLogs. It takes a baseController as a parameter and returns a pointer to the OrgsLogs.

func (*OrgsLogs) CountOrgAuditLogs added in v0.2.18 

func (o *OrgsLogs) CountOrgAuditLogs(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgLogsCountDistinctEnum,
	adminId *string,
	adminName *string,
	siteId *string,
	message *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgAuditLogs takes context, orgId, distinct, adminId, adminName, siteId, message, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Audit Logs

func (*OrgsLogs) ListOrgAuditLogs added in v0.2.18 

func (o *OrgsLogs) ListOrgAuditLogs(
	ctx context.Context,
	orgId uuid.UUID,
	siteId *string,
	adminName *string,
	message *string,
	sort *models.ListOrgLogsSortEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseLogSearch],
	error)

ListOrgAuditLogs takes context, orgId, siteId, adminName, message, sort, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponseLogSearch data and an error if there was an issue with the request or response. Get List of change logs for the current Org

type OrgsMaps 

type OrgsMaps struct {
	// contains filtered or unexported fields
}

OrgsMaps represents a controller struct.

func NewOrgsMaps 

func NewOrgsMaps(baseController baseController) *OrgsMaps

NewOrgsMaps creates a new instance of OrgsMaps. It takes a baseController as a parameter and returns a pointer to the OrgsMaps.

func (*OrgsMaps) ImportOrgMapToSite 

func (o *OrgsMaps) ImportOrgMapToSite(
	ctx context.Context,
	orgId uuid.UUID,
	siteName string,
	autoDeviceprofileAssignment *bool,
	csv *models.FileWrapper,
	file *models.FileWrapper,
	json *models.MapImportJson) (
	models.ApiResponse[models.ResponseMapImport],
	error)

ImportOrgMapToSite takes context, orgId, siteName, autoDeviceprofileAssignment, csv, file, json as parameters and returns an models.ApiResponse with models.ResponseMapImport data and an error if there was an issue with the request or response. Import data from files is a multipart POST which has a file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches #### Request ``` "json": a JSON string describing your upload "file": a binary file ```

func (*OrgsMaps) ImportOrgMaps 

func (o *OrgsMaps) ImportOrgMaps(
	ctx context.Context,
	orgId uuid.UUID,
	autoDeviceprofileAssignment *bool,
	csv *models.FileWrapper,
	file *models.FileWrapper,
	json *models.MapOrgImportFileJson) (
	models.ApiResponse[models.ResponseMapImport],
	error)

ImportOrgMaps takes context, orgId, autoDeviceprofileAssignment, csv, file, json as parameters and returns an models.ApiResponse with models.ResponseMapImport data and an error if there was an issue with the request or response. Import data from files is a multipart POST which has a file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches ### CSV File Format ```csv Vendor AP name,Mist AP Mac US Office AP-2 - 5c:5b:35:00:00:02,5c5b35000002 ```

type OrgsMarvis 

type OrgsMarvis struct {
	// contains filtered or unexported fields
}

OrgsMarvis represents a controller struct.

func NewOrgsMarvis 

func NewOrgsMarvis(baseController baseController) *OrgsMarvis

NewOrgsMarvis creates a new instance of OrgsMarvis. It takes a baseController as a parameter and returns a pointer to the OrgsMarvis.

func (*OrgsMarvis) TroubleshootOrg 

func (o *OrgsMarvis) TroubleshootOrg(
	ctx context.Context,
	orgId uuid.UUID,
	mac *string,
	siteId *uuid.UUID,
	start *int,
	end *int,
	mType *models.TroubleshootTypeEnum) (
	models.ApiResponse[models.ResponseTroubleshoot],
	error)

TroubleshootOrg takes context, orgId, mac, siteId, start, end, mType as parameters and returns an models.ApiResponse with models.ResponseTroubleshoot data and an error if there was an issue with the request or response. Troubleshoot sites, devices, clients, and wired clientsfor maximum of last 7 days from current time. See search APIs for device information: - [search Device]($e/Orgs%20Devices/searchOrgDevices) - [search Wireless Client]($e/Orgs%20Clients%20-%20Wireless/searchOrgWirelessClients) - [search Wired Client]($e/Orgs%20Clients%20-%20Wired/searchOrgWiredClients) - [search Wan Client]($e/Orgs%20Clients%20-%20Wan/searchOrgWanClients) **NOTE**: requires Marvis subscription license

type OrgsMxClusters 

type OrgsMxClusters struct {
	// contains filtered or unexported fields
}

OrgsMxClusters represents a controller struct.

func NewOrgsMxClusters 

func NewOrgsMxClusters(baseController baseController) *OrgsMxClusters

NewOrgsMxClusters creates a new instance of OrgsMxClusters. It takes a baseController as a parameter and returns a pointer to the OrgsMxClusters.

func (*OrgsMxClusters) CreateOrgMxEdgeCluster 

func (o *OrgsMxClusters) CreateOrgMxEdgeCluster(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Mxcluster) (
	models.ApiResponse[models.Mxcluster],
	error)

CreateOrgMxEdgeCluster takes context, orgId, body as parameters and returns an models.ApiResponse with models.Mxcluster data and an error if there was an issue with the request or response. Create MxCluster

func (*OrgsMxClusters) DeleteOrgMxEdgeCluster 

func (o *OrgsMxClusters) DeleteOrgMxEdgeCluster(
	ctx context.Context,
	orgId uuid.UUID,
	mxclusterId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgMxEdgeCluster takes context, orgId, mxclusterId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org MXEdge Cluster

func (*OrgsMxClusters) GetOrgMxEdgeCluster 

func (o *OrgsMxClusters) GetOrgMxEdgeCluster(
	ctx context.Context,
	orgId uuid.UUID,
	mxclusterId uuid.UUID) (
	models.ApiResponse[models.Mxcluster],
	error)

GetOrgMxEdgeCluster takes context, orgId, mxclusterId as parameters and returns an models.ApiResponse with models.Mxcluster data and an error if there was an issue with the request or response. Get Org MxEdge Cluster Details

func (*OrgsMxClusters) ListOrgMxEdgeClusters 

func (o *OrgsMxClusters) ListOrgMxEdgeClusters(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Mxcluster],
	error)

ListOrgMxEdgeClusters takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Mxcluster data and an error if there was an issue with the request or response. Get List of Org MxEdge Clusters

func (*OrgsMxClusters) UpdateOrgMxEdgeCluster 

func (o *OrgsMxClusters) UpdateOrgMxEdgeCluster(
	ctx context.Context,
	orgId uuid.UUID,
	mxclusterId uuid.UUID,
	body *models.Mxcluster) (
	models.ApiResponse[models.Mxcluster],
	error)

UpdateOrgMxEdgeCluster takes context, orgId, mxclusterId, body as parameters and returns an models.ApiResponse with models.Mxcluster data and an error if there was an issue with the request or response. Update Org MxEdge Cluster

type OrgsMxEdges 

type OrgsMxEdges struct {
	// contains filtered or unexported fields
}

OrgsMxEdges represents a controller struct.

func NewOrgsMxEdges 

func NewOrgsMxEdges(baseController baseController) *OrgsMxEdges

NewOrgsMxEdges creates a new instance of OrgsMxEdges. It takes a baseController as a parameter and returns a pointer to the OrgsMxEdges.

func (*OrgsMxEdges) AddOrgMxEdgeImage 

func (o *OrgsMxEdges) AddOrgMxEdgeImage(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId uuid.UUID,
	imageNumber int,
	body *models.ImageImport) (
	*http.Response,
	error)

AddOrgMxEdgeImage takes context, orgId, mxedgeId, imageNumber, body as parameters and returns an *Response and an error if there was an issue with the request or response. Attach up to 3 images to a mxedge

func (*OrgsMxEdges) AssignOrgMxEdgeToSite 

func (o *OrgsMxEdges) AssignOrgMxEdgeToSite(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.MxedgesAssign) (
	models.ApiResponse[models.ResponseAssignSuccess],
	error)

AssignOrgMxEdgeToSite takes context, orgId, body as parameters and returns an models.ApiResponse with models.ResponseAssignSuccess data and an error if there was an issue with the request or response. Assign Org MxEdge to Site

func (*OrgsMxEdges) BounceOrgMxEdgeDataPorts 

func (o *OrgsMxEdges) BounceOrgMxEdgeDataPorts(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId uuid.UUID,
	body *models.UtilsTuntermBouncePort) (
	*http.Response,
	error)

BounceOrgMxEdgeDataPorts takes context, orgId, mxedgeId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Bounce TunTerm Data Ports

func (*OrgsMxEdges) ClaimOrgMxEdge 

func (o *OrgsMxEdges) ClaimOrgMxEdge(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.CodeString) (
	models.ApiResponse[models.ResponseClaimMxEdge],
	error)

ClaimOrgMxEdge takes context, orgId, body as parameters and returns an models.ApiResponse with models.ResponseClaimMxEdge data and an error if there was an issue with the request or response. For a Mist Edge in default state, it will show a random claim code like `135-546-673` which you can “claim” it into your Org

func (*OrgsMxEdges) ControlOrgMxEdgeServices 

func (o *OrgsMxEdges) ControlOrgMxEdgeServices(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId uuid.UUID,
	name models.MxedgeServiceNameEnum,
	action models.MxedgeServiceActionEnum) (
	*http.Response,
	error)

ControlOrgMxEdgeServices takes context, orgId, mxedgeId, name, action as parameters and returns an *Response and an error if there was an issue with the request or response. Control Services on a Mist Edge

func (*OrgsMxEdges) CountOrgMxEdges 

func (o *OrgsMxEdges) CountOrgMxEdges(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgMxedgeCountDistinctEnum,
	mxedgeId *string,
	siteId *string,
	mxclusterId *string,
	model *string,
	distro *string,
	tuntermVersion *string,
	sort *string,
	stats *bool,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgMxEdges takes context, orgId, distinct, mxedgeId, siteId, mxclusterId, model, distro, tuntermVersion, sort, stats, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Mist Edges

func (*OrgsMxEdges) CountOrgSiteMxEdgeEvents 

func (o *OrgsMxEdges) CountOrgSiteMxEdgeEvents(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgMxedgeEventsCountDistinctEnum,
	mxedgeId *string,
	mxclusterId *string,
	mType *string,
	service *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgSiteMxEdgeEvents takes context, orgId, distinct, mxedgeId, mxclusterId, mType, service, start, end, duration, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Mist Edge Events

func (*OrgsMxEdges) CreateOrgMxEdge 

func (o *OrgsMxEdges) CreateOrgMxEdge(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Mxedge) (
	models.ApiResponse[models.Mxedge],
	error)

CreateOrgMxEdge takes context, orgId, body as parameters and returns an models.ApiResponse with models.Mxedge data and an error if there was an issue with the request or response. Create MxEdge

func (*OrgsMxEdges) DeleteOrgMxEdge 

func (o *OrgsMxEdges) DeleteOrgMxEdge(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgMxEdge takes context, orgId, mxedgeId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org MxEdge

func (*OrgsMxEdges) DeleteOrgMxEdgeImage 

func (o *OrgsMxEdges) DeleteOrgMxEdgeImage(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId uuid.UUID,
	imageNumber int) (
	*http.Response,
	error)

DeleteOrgMxEdgeImage takes context, orgId, mxedgeId, imageNumber as parameters and returns an *Response and an error if there was an issue with the request or response. Remove MxEdge Image

func (*OrgsMxEdges) GetOrgMxEdge 

func (o *OrgsMxEdges) GetOrgMxEdge(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId uuid.UUID) (
	models.ApiResponse[models.Mxedge],
	error)

GetOrgMxEdge takes context, orgId, mxedgeId as parameters and returns an models.ApiResponse with models.Mxedge data and an error if there was an issue with the request or response. Get Org MxEdge details

func (*OrgsMxEdges) GetOrgMxEdgeUpgradeInfo 

func (o *OrgsMxEdges) GetOrgMxEdgeUpgradeInfo(
	ctx context.Context,
	orgId uuid.UUID,
	channel *models.GetOrgMxedgeUpgradeInfoChannelEnum) (
	models.ApiResponse[[]models.MxedgeUpgradeInfoItems],
	error)

GetOrgMxEdgeUpgradeInfo takes context, orgId, channel as parameters and returns an models.ApiResponse with []models.MxedgeUpgradeInfoItems data and an error if there was an issue with the request or response. Get Mist Edge Upgrade Information

func (*OrgsMxEdges) ListOrgMxEdges 

func (o *OrgsMxEdges) ListOrgMxEdges(
	ctx context.Context,
	orgId uuid.UUID,
	forSites *models.MxedgeForSiteEnum,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Mxedge],
	error)

ListOrgMxEdges takes context, orgId, forSites, limit, page as parameters and returns an models.ApiResponse with []models.Mxedge data and an error if there was an issue with the request or response. Get List of Org MxEdges

func (*OrgsMxEdges) RestartOrgMxEdge 

func (o *OrgsMxEdges) RestartOrgMxEdge(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId uuid.UUID) (
	*http.Response,
	error)

RestartOrgMxEdge takes context, orgId, mxedgeId as parameters and returns an *Response and an error if there was an issue with the request or response. In the case where a Mist Edge is replaced, you would need to unregister it. Which disconnects the currently the connected Mist Edge and allow another to register.

func (*OrgsMxEdges) SearchOrgMistEdgeEvents 

func (o *OrgsMxEdges) SearchOrgMistEdgeEvents(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId *string,
	mxclusterId *string,
	mType *string,
	service *string,
	component *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.ResponseMxedgeEventsSearch],
	error)

SearchOrgMistEdgeEvents takes context, orgId, mxedgeId, mxclusterId, mType, service, component, start, end, duration, limit as parameters and returns an models.ApiResponse with models.ResponseMxedgeEventsSearch data and an error if there was an issue with the request or response. Search Org Mist Edge Events

func (*OrgsMxEdges) SearchOrgMxEdges 

func (o *OrgsMxEdges) SearchOrgMxEdges(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId *string,
	siteId *string,
	mxclusterId *string,
	model *string,
	distro *string,
	tuntermVersion *string,
	sort *string,
	stats *bool,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseMxedgeSearch],
	error)

SearchOrgMxEdges takes context, orgId, mxedgeId, siteId, mxclusterId, model, distro, tuntermVersion, sort, stats, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponseMxedgeSearch data and an error if there was an issue with the request or response. Search Org Mist Edges

func (*OrgsMxEdges) UnassignOrgMxEdgeFromSite 

func (o *OrgsMxEdges) UnassignOrgMxEdgeFromSite(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.MxedgesUnassign) (
	models.ApiResponse[models.ResponseAssignSuccess],
	error)

UnassignOrgMxEdgeFromSite takes context, orgId, body as parameters and returns an models.ApiResponse with models.ResponseAssignSuccess data and an error if there was an issue with the request or response. Unassign Org MxEdge from Site

func (*OrgsMxEdges) UnregisterOrgMxEdge 

func (o *OrgsMxEdges) UnregisterOrgMxEdge(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId uuid.UUID) (
	*http.Response,
	error)

UnregisterOrgMxEdge takes context, orgId, mxedgeId as parameters and returns an *Response and an error if there was an issue with the request or response. In the case where a Mist Edge is replaced, you would need to unregister it. Which disconnects the currently the connected Mist Edge and allow another to register.

func (*OrgsMxEdges) UpdateOrgMxEdge 

func (o *OrgsMxEdges) UpdateOrgMxEdge(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId uuid.UUID,
	body *models.Mxedge) (
	models.ApiResponse[models.Mxedge],
	error)

UpdateOrgMxEdge takes context, orgId, mxedgeId, body as parameters and returns an models.ApiResponse with models.Mxedge data and an error if there was an issue with the request or response. Update Org MxEdge

func (*OrgsMxEdges) UploadOrgMxEdgeSupportFiles 

func (o *OrgsMxEdges) UploadOrgMxEdgeSupportFiles(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId uuid.UUID) (
	*http.Response,
	error)

UploadOrgMxEdgeSupportFiles takes context, orgId, mxedgeId as parameters and returns an *Response and an error if there was an issue with the request or response. Support / Upload Mist Edge support files

type OrgsMxTunnels 

type OrgsMxTunnels struct {
	// contains filtered or unexported fields
}

OrgsMxTunnels represents a controller struct.

func NewOrgsMxTunnels 

func NewOrgsMxTunnels(baseController baseController) *OrgsMxTunnels

NewOrgsMxTunnels creates a new instance of OrgsMxTunnels. It takes a baseController as a parameter and returns a pointer to the OrgsMxTunnels.

func (*OrgsMxTunnels) CreateOrgMxTunnel 

func (o *OrgsMxTunnels) CreateOrgMxTunnel(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Mxtunnel) (
	models.ApiResponse[models.Mxtunnel],
	error)

CreateOrgMxTunnel takes context, orgId, body as parameters and returns an models.ApiResponse with models.Mxtunnel data and an error if there was an issue with the request or response. Create MxTunnel

func (*OrgsMxTunnels) DeleteOrgMxTunnel 

func (o *OrgsMxTunnels) DeleteOrgMxTunnel(
	ctx context.Context,
	orgId uuid.UUID,
	mxtunnelId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgMxTunnel takes context, orgId, mxtunnelId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org MxTunnel

func (*OrgsMxTunnels) GetOrgMxTunnel 

func (o *OrgsMxTunnels) GetOrgMxTunnel(
	ctx context.Context,
	orgId uuid.UUID,
	mxtunnelId uuid.UUID) (
	models.ApiResponse[models.Mxtunnel],
	error)

GetOrgMxTunnel takes context, orgId, mxtunnelId as parameters and returns an models.ApiResponse with models.Mxtunnel data and an error if there was an issue with the request or response. Get Org MxTunnel Details

func (*OrgsMxTunnels) ListOrgMxTunnels 

func (o *OrgsMxTunnels) ListOrgMxTunnels(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Mxtunnel],
	error)

ListOrgMxTunnels takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Mxtunnel data and an error if there was an issue with the request or response. Get List of Org MxTunnels

func (*OrgsMxTunnels) UpdateOrgMxTunnel 

func (o *OrgsMxTunnels) UpdateOrgMxTunnel(
	ctx context.Context,
	orgId uuid.UUID,
	mxtunnelId uuid.UUID,
	body *models.Mxtunnel) (
	models.ApiResponse[models.Mxtunnel],
	error)

UpdateOrgMxTunnel takes context, orgId, mxtunnelId, body as parameters and returns an models.ApiResponse with models.Mxtunnel data and an error if there was an issue with the request or response. Update Org MxTunnel

type OrgsNACCRL 

type OrgsNACCRL struct {
	// contains filtered or unexported fields
}

OrgsNACCRL represents a controller struct.

func NewOrgsNACCRL 

func NewOrgsNACCRL(baseController baseController) *OrgsNACCRL

NewOrgsNACCRL creates a new instance of OrgsNACCRL. It takes a baseController as a parameter and returns a pointer to the OrgsNACCRL.

func (*OrgsNACCRL) DeleteOrgNacCrl 

func (o *OrgsNACCRL) DeleteOrgNacCrl(
	ctx context.Context,
	orgId uuid.UUID,
	naccrlId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgNacCrl takes context, orgId, naccrlId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete NAC Org CRL file is a DELETE request to delete CRL file identified by its ID (ID assigned on file upload/creation)

func (*OrgsNACCRL) GetOrgNacCrl 

func (o *OrgsNACCRL) GetOrgNacCrl(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.ResponseNacCrlFiles],
	error)

GetOrgNacCrl takes context, orgId as parameters and returns an models.ApiResponse with models.ResponseNacCrlFiles data and an error if there was an issue with the request or response. Returns all uploaded CRL file IDs with names for the orgI

func (*OrgsNACCRL) ImportOrgNacCrl 

func (o *OrgsNACCRL) ImportOrgNacCrl(
	ctx context.Context,
	orgId uuid.UUID,
	file *models.FileWrapper,
	json *string) (
	models.ApiResponse[models.NacCrlFile],
	error)

ImportOrgNacCrl takes context, orgId, file, json as parameters and returns an models.ApiResponse with models.NacCrlFile data and an error if there was an issue with the request or response. The Import NAC Org CRL File endpoint allows users to manually upload a Certificate Revocation List (CRL) file in either PEM or DER format. This is a multipart POST request. We support one file upload per issuer, and re-uploads for the same issuer will overwrite the existing file.

type OrgsNACIDP 

type OrgsNACIDP struct {
	// contains filtered or unexported fields
}

OrgsNACIDP represents a controller struct.

func NewOrgsNACIDP 

func NewOrgsNACIDP(baseController baseController) *OrgsNACIDP

NewOrgsNACIDP creates a new instance of OrgsNACIDP. It takes a baseController as a parameter and returns a pointer to the OrgsNACIDP.

func (*OrgsNACIDP) ValidateOrgIdpCredential 

func (o *OrgsNACIDP) ValidateOrgIdpCredential(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.UsernamePassword) (
	models.ApiResponse[models.WebsocketSession],
	error)

ValidateOrgIdpCredential takes context, orgId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. IDP Credential Validation. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ``` json { "subscribe": "orgs/:org_id/mist_nac/test_idp" } ``` ### Response (no idp can be found) ``` json { "event": "data", "channel": "/orgs/:org_id/mist_nac/test_idp", "status": "data": { "status": "failure", "error": "No matching IDP found" } } ``` ### Response OK ``` json { "event": "data", "channel": "/orgs/:org_id/mist_nac/test_idp", "status": "data": { "status": "success", "idp_id": "915793c0-1355-4e98-b1c0-23df2227b357", "idp_type": "ldap", // more attributes will be added later } } ``` ### Response Invalid Credentials ``` json { "event": "data", "channel": "/orgs/:org_id/mist_nac/test_idp", "status": "data": { "status": "failure", "error": "Invalid Credentials", "idp_id": "915793c0-1355-4e98-b1c0-23df2227b357", "idp_type": "ldap", } } ```

type OrgsNACPortals 

type OrgsNACPortals struct {
	// contains filtered or unexported fields
}

OrgsNACPortals represents a controller struct.

func NewOrgsNACPortals 

func NewOrgsNACPortals(baseController baseController) *OrgsNACPortals

NewOrgsNACPortals creates a new instance of OrgsNACPortals. It takes a baseController as a parameter and returns a pointer to the OrgsNACPortals.

func (*OrgsNACPortals) CreateOrgNacPortal 

func (o *OrgsNACPortals) CreateOrgNacPortal(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.NacPortal) (
	models.ApiResponse[models.NacPortal],
	error)

CreateOrgNacPortal takes context, orgId, body as parameters and returns an models.ApiResponse with models.NacPortal data and an error if there was an issue with the request or response. Create Org NAC Portal

func (*OrgsNACPortals) DeleteOrgNacPortal 

func (o *OrgsNACPortals) DeleteOrgNacPortal(
	ctx context.Context,
	orgId uuid.UUID,
	nacportalId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgNacPortal takes context, orgId, nacportalId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org NAC Portal

func (*OrgsNACPortals) DeleteOrgNacPortalImage added in v0.2.38 

func (o *OrgsNACPortals) DeleteOrgNacPortalImage(
	ctx context.Context,
	orgId uuid.UUID,
	nacportalId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgNacPortalImage takes context, orgId, nacportalId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete background image for NAC Portal If image is not uploaded or is deleted, NAC Portal will use default image.

func (*OrgsNACPortals) DownloadOrgNacPortalSamlMetadata added in v0.4.0 

func (o *OrgsNACPortals) DownloadOrgNacPortalSamlMetadata(
	ctx context.Context,
	orgId uuid.UUID,
	nacportalId uuid.UUID) (
	models.ApiResponse[[]byte],
	error)

DownloadOrgNacPortalSamlMetadata takes context, orgId, nacportalId as parameters and returns an models.ApiResponse with []byte data and an error if there was an issue with the request or response. Download Org NAC Portal SAML Metdata Example of metadata.xml: ```xml <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/5hdF5g/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"> <md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"> <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/logout" /> <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat> <md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/login" index="0" isDefault="true"/> <md:AttributeConsumingService index="0"> <md:ServiceName xml:lang="en-US">Mist</md:ServiceName> <md:RequestedAttribute Name="Role" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="true"/> <md:RequestedAttribute Name="FirstName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/> <md:RequestedAttribute Name="LastName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/> </md:AttributeConsumingService> </md:SPSSODescriptor> </md:EntityDescriptor> ```

func (*OrgsNACPortals) GetOrgNacPortal 

func (o *OrgsNACPortals) GetOrgNacPortal(
	ctx context.Context,
	orgId uuid.UUID,
	nacportalId uuid.UUID) (
	models.ApiResponse[models.NacPortal],
	error)

GetOrgNacPortal takes context, orgId, nacportalId as parameters and returns an models.ApiResponse with models.NacPortal data and an error if there was an issue with the request or response. Get Org NAC Portal

func (*OrgsNACPortals) GetOrgNacPortalSamlMetadata added in v0.4.0 

func (o *OrgsNACPortals) GetOrgNacPortalSamlMetadata(
	ctx context.Context,
	orgId uuid.UUID,
	nacportalId uuid.UUID) (
	models.ApiResponse[models.SamlMetadata],
	error)

GetOrgNacPortalSamlMetadata takes context, orgId, nacportalId as parameters and returns an models.ApiResponse with models.SamlMetadata data and an error if there was an issue with the request or response. Get Org NAC Portal SAML Metadata

func (*OrgsNACPortals) ListOrgNacPortalSsoLatestFailures 

func (o *OrgsNACPortals) ListOrgNacPortalSsoLatestFailures(
	ctx context.Context,
	orgId uuid.UUID,
	nacportalId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseSsoFailureSearch],
	error)

ListOrgNacPortalSsoLatestFailures takes context, orgId, nacportalId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponseSsoFailureSearch data and an error if there was an issue with the request or response. Get List of Org NAC Portal SSO Latest Failures

func (*OrgsNACPortals) ListOrgNacPortals 

func (o *OrgsNACPortals) ListOrgNacPortals(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.NacPortal],
	error)

ListOrgNacPortals takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.NacPortal data and an error if there was an issue with the request or response. List Org NAC Portals

func (*OrgsNACPortals) UpdateOrgNacPortal 

func (o *OrgsNACPortals) UpdateOrgNacPortal(
	ctx context.Context,
	orgId uuid.UUID,
	nacportalId uuid.UUID,
	body *models.NacPortal) (
	models.ApiResponse[models.NacPortal],
	error)

UpdateOrgNacPortal takes context, orgId, nacportalId, body as parameters and returns an models.ApiResponse with models.NacPortal data and an error if there was an issue with the request or response. Update Org NAC Portal

func (*OrgsNACPortals) UpdateOrgNacPortalTempalte added in v0.2.38 

func (o *OrgsNACPortals) UpdateOrgNacPortalTempalte(
	ctx context.Context,
	orgId uuid.UUID,
	nacportalId uuid.UUID,
	body *models.NacPortalTemplate) (
	*http.Response,
	error)

UpdateOrgNacPortalTempalte takes context, orgId, nacportalId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Update Org NAC Portal Template

func (*OrgsNACPortals) UploadOrgNacPortalImage added in v0.2.38 

func (o *OrgsNACPortals) UploadOrgNacPortalImage(
	ctx context.Context,
	orgId uuid.UUID,
	nacportalId uuid.UUID,
	file *models.FileWrapper,
	json *string) (
	*http.Response,
	error)

UploadOrgNacPortalImage takes context, orgId, nacportalId, file, json as parameters and returns an *Response and an error if there was an issue with the request or response. Upload background image for NAC Portal

type OrgsNACRules 

type OrgsNACRules struct {
	// contains filtered or unexported fields
}

OrgsNACRules represents a controller struct.

func NewOrgsNACRules 

func NewOrgsNACRules(baseController baseController) *OrgsNACRules

NewOrgsNACRules creates a new instance of OrgsNACRules. It takes a baseController as a parameter and returns a pointer to the OrgsNACRules.

func (*OrgsNACRules) CreateOrgNacRule 

func (o *OrgsNACRules) CreateOrgNacRule(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.NacRule) (
	models.ApiResponse[models.NacRule],
	error)

CreateOrgNacRule takes context, orgId, body as parameters and returns an models.ApiResponse with models.NacRule data and an error if there was an issue with the request or response. create Org NAC Rule

func (*OrgsNACRules) DeleteOrgNacRule 

func (o *OrgsNACRules) DeleteOrgNacRule(
	ctx context.Context,
	orgId uuid.UUID,
	nacruleId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgNacRule takes context, orgId, nacruleId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org NAC Rule

func (*OrgsNACRules) GetOrgNacRule 

func (o *OrgsNACRules) GetOrgNacRule(
	ctx context.Context,
	orgId uuid.UUID,
	nacruleId uuid.UUID) (
	models.ApiResponse[models.NacRule],
	error)

GetOrgNacRule takes context, orgId, nacruleId as parameters and returns an models.ApiResponse with models.NacRule data and an error if there was an issue with the request or response. Get Org NAC Rule

func (*OrgsNACRules) ListOrgNacRules 

func (o *OrgsNACRules) ListOrgNacRules(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.NacRule],
	error)

ListOrgNacRules takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.NacRule data and an error if there was an issue with the request or response. Get List of Org NAC Rules

func (*OrgsNACRules) UpdateOrgNacRule 

func (o *OrgsNACRules) UpdateOrgNacRule(
	ctx context.Context,
	orgId uuid.UUID,
	nacruleId uuid.UUID,
	body *models.NacRule) (
	models.ApiResponse[models.NacRule],
	error)

UpdateOrgNacRule takes context, orgId, nacruleId, body as parameters and returns an models.ApiResponse with models.NacRule data and an error if there was an issue with the request or response. Update Org NAC Rule

type OrgsNACTags 

type OrgsNACTags struct {
	// contains filtered or unexported fields
}

OrgsNACTags represents a controller struct.

func NewOrgsNACTags 

func NewOrgsNACTags(baseController baseController) *OrgsNACTags

NewOrgsNACTags creates a new instance of OrgsNACTags. It takes a baseController as a parameter and returns a pointer to the OrgsNACTags.

func (*OrgsNACTags) CreateOrgNacTag 

func (o *OrgsNACTags) CreateOrgNacTag(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.NacTag) (
	models.ApiResponse[models.NacTag],
	error)

CreateOrgNacTag takes context, orgId, body as parameters and returns an models.ApiResponse with models.NacTag data and an error if there was an issue with the request or response. Create Org NAC Tag

func (*OrgsNACTags) DeleteOrgNacTag 

func (o *OrgsNACTags) DeleteOrgNacTag(
	ctx context.Context,
	orgId uuid.UUID,
	nactagId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgNacTag takes context, orgId, nactagId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org NAC Tag

func (*OrgsNACTags) GetOrgNacTag 

func (o *OrgsNACTags) GetOrgNacTag(
	ctx context.Context,
	orgId uuid.UUID,
	nactagId uuid.UUID) (
	models.ApiResponse[models.NacTag],
	error)

GetOrgNacTag takes context, orgId, nactagId as parameters and returns an models.ApiResponse with models.NacTag data and an error if there was an issue with the request or response. Get Org NAC Tag

func (*OrgsNACTags) ListOrgNacTags 

func (o *OrgsNACTags) ListOrgNacTags(
	ctx context.Context,
	orgId uuid.UUID,
	mType *string,
	name *string,
	match *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.NacTag],
	error)

ListOrgNacTags takes context, orgId, mType, name, match, limit, page as parameters and returns an models.ApiResponse with []models.NacTag data and an error if there was an issue with the request or response. Get List of Org NAC Tags

func (*OrgsNACTags) UpdateOrgNacTag 

func (o *OrgsNACTags) UpdateOrgNacTag(
	ctx context.Context,
	orgId uuid.UUID,
	nactagId uuid.UUID,
	body *models.NacTag) (
	models.ApiResponse[models.NacTag],
	error)

UpdateOrgNacTag takes context, orgId, nactagId, body as parameters and returns an models.ApiResponse with models.NacTag data and an error if there was an issue with the request or response. Update Org NAC Tag

type OrgsNetworkTemplates 

type OrgsNetworkTemplates struct {
	// contains filtered or unexported fields
}

OrgsNetworkTemplates represents a controller struct.

func NewOrgsNetworkTemplates 

func NewOrgsNetworkTemplates(baseController baseController) *OrgsNetworkTemplates

NewOrgsNetworkTemplates creates a new instance of OrgsNetworkTemplates. It takes a baseController as a parameter and returns a pointer to the OrgsNetworkTemplates.

func (*OrgsNetworkTemplates) CreateOrgNetworkTemplate 

func (o *OrgsNetworkTemplates) CreateOrgNetworkTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.NetworkTemplate) (
	models.ApiResponse[models.NetworkTemplate],
	error)

CreateOrgNetworkTemplate takes context, orgId, body as parameters and returns an models.ApiResponse with models.NetworkTemplate data and an error if there was an issue with the request or response. Update Org Network Templates

func (*OrgsNetworkTemplates) DeleteOrgNetworkTemplate 

func (o *OrgsNetworkTemplates) DeleteOrgNetworkTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	networktemplateId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgNetworkTemplate takes context, orgId, networktemplateId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Network Template

func (*OrgsNetworkTemplates) GetOrgNetworkTemplate 

func (o *OrgsNetworkTemplates) GetOrgNetworkTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	networktemplateId uuid.UUID) (
	models.ApiResponse[models.NetworkTemplate],
	error)

GetOrgNetworkTemplate takes context, orgId, networktemplateId as parameters and returns an models.ApiResponse with models.NetworkTemplate data and an error if there was an issue with the request or response. Get Org Network Templates Details

func (*OrgsNetworkTemplates) ListOrgNetworkTemplates 

func (o *OrgsNetworkTemplates) ListOrgNetworkTemplates(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.NetworkTemplate],
	error)

ListOrgNetworkTemplates takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.NetworkTemplate data and an error if there was an issue with the request or response. Get List of Org Network Templates

func (*OrgsNetworkTemplates) UpdateOrgNetworkTemplates 

func (o *OrgsNetworkTemplates) UpdateOrgNetworkTemplates(
	ctx context.Context,
	orgId uuid.UUID,
	networktemplateId uuid.UUID,
	body *models.NetworkTemplate) (
	models.ApiResponse[models.NetworkTemplate],
	error)

UpdateOrgNetworkTemplates takes context, orgId, networktemplateId, body as parameters and returns an models.ApiResponse with models.NetworkTemplate data and an error if there was an issue with the request or response. Update Org Network Template

type OrgsNetworks 

type OrgsNetworks struct {
	// contains filtered or unexported fields
}

OrgsNetworks represents a controller struct.

func NewOrgsNetworks 

func NewOrgsNetworks(baseController baseController) *OrgsNetworks

NewOrgsNetworks creates a new instance of OrgsNetworks. It takes a baseController as a parameter and returns a pointer to the OrgsNetworks.

func (*OrgsNetworks) CreateOrgNetwork 

func (o *OrgsNetworks) CreateOrgNetwork(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Network) (
	models.ApiResponse[models.Network],
	error)

CreateOrgNetwork takes context, orgId, body as parameters and returns an models.ApiResponse with models.Network data and an error if there was an issue with the request or response. Create Organization Network

func (*OrgsNetworks) DeleteOrgNetwork 

func (o *OrgsNetworks) DeleteOrgNetwork(
	ctx context.Context,
	orgId uuid.UUID,
	networkId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgNetwork takes context, orgId, networkId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Organization Network

func (*OrgsNetworks) GetOrgNetwork 

func (o *OrgsNetworks) GetOrgNetwork(
	ctx context.Context,
	orgId uuid.UUID,
	networkId uuid.UUID) (
	models.ApiResponse[models.Network],
	error)

GetOrgNetwork takes context, orgId, networkId as parameters and returns an models.ApiResponse with models.Network data and an error if there was an issue with the request or response. Get Organization Network Details

func (*OrgsNetworks) ListOrgNetworks 

func (o *OrgsNetworks) ListOrgNetworks(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Network],
	error)

ListOrgNetworks takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Network data and an error if there was an issue with the request or response. Get List of Org Networks

func (*OrgsNetworks) UpdateOrgNetwork 

func (o *OrgsNetworks) UpdateOrgNetwork(
	ctx context.Context,
	orgId uuid.UUID,
	networkId uuid.UUID,
	body *models.Network) (
	models.ApiResponse[models.Network],
	error)

UpdateOrgNetwork takes context, orgId, networkId, body as parameters and returns an models.ApiResponse with models.Network data and an error if there was an issue with the request or response. Update Organization Network

type OrgsPremiumAnalytics 

type OrgsPremiumAnalytics struct {
	// contains filtered or unexported fields
}

OrgsPremiumAnalytics represents a controller struct.

func NewOrgsPremiumAnalytics 

func NewOrgsPremiumAnalytics(baseController baseController) *OrgsPremiumAnalytics

NewOrgsPremiumAnalytics creates a new instance of OrgsPremiumAnalytics. It takes a baseController as a parameter and returns a pointer to the OrgsPremiumAnalytics.

func (*OrgsPremiumAnalytics) ListOrgPmaDashboards 

func (o *OrgsPremiumAnalytics) ListOrgPmaDashboards(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.PmaDashboard],
	error)

ListOrgPmaDashboards takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.PmaDashboard data and an error if there was an issue with the request or response. Get List of premium analytics dashboards for this Org

type OrgsPskPortals 

type OrgsPskPortals struct {
	// contains filtered or unexported fields
}

OrgsPskPortals represents a controller struct.

func NewOrgsPskPortals 

func NewOrgsPskPortals(baseController baseController) *OrgsPskPortals

NewOrgsPskPortals creates a new instance of OrgsPskPortals. It takes a baseController as a parameter and returns a pointer to the OrgsPskPortals.

func (*OrgsPskPortals) CountOrgPskPortalLogs 

func (o *OrgsPskPortals) CountOrgPskPortalLogs(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgPskPortalLogsCountDistinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgPskPortalLogs takes context, orgId, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of PskPortal Logs

func (*OrgsPskPortals) CreateOrgPskPortal 

func (o *OrgsPskPortals) CreateOrgPskPortal(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.PskPortal) (
	models.ApiResponse[models.PskPortal],
	error)

CreateOrgPskPortal takes context, orgId, body as parameters and returns an models.ApiResponse with models.PskPortal data and an error if there was an issue with the request or response. Create Org Psk Portal

func (*OrgsPskPortals) DeleteOrgPskPortal 

func (o *OrgsPskPortals) DeleteOrgPskPortal(
	ctx context.Context,
	orgId uuid.UUID,
	pskportalId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgPskPortal takes context, orgId, pskportalId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Psk Portal

func (*OrgsPskPortals) DeleteOrgPskPortalImage 

func (o *OrgsPskPortals) DeleteOrgPskPortalImage(
	ctx context.Context,
	orgId uuid.UUID,
	pskportalId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgPskPortalImage takes context, orgId, pskportalId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete background image for PskPortal If image is not uploaded or is deleted, PskPortal will use default image.

func (*OrgsPskPortals) GetOrgPskPortal 

func (o *OrgsPskPortals) GetOrgPskPortal(
	ctx context.Context,
	orgId uuid.UUID,
	pskportalId uuid.UUID) (
	models.ApiResponse[models.PskPortal],
	error)

GetOrgPskPortal takes context, orgId, pskportalId as parameters and returns an models.ApiResponse with models.PskPortal data and an error if there was an issue with the request or response. get Org Psk Portal Details

func (*OrgsPskPortals) ListOrgPskPortalLogs 

func (o *OrgsPskPortals) ListOrgPskPortalLogs(
	ctx context.Context,
	orgId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponsePskPortalLogsSearch],
	error)

ListOrgPskPortalLogs takes context, orgId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponsePskPortalLogsSearch data and an error if there was an issue with the request or response. Get the list of PSK Portals Logs

func (*OrgsPskPortals) ListOrgPskPortals 

func (o *OrgsPskPortals) ListOrgPskPortals(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.PskPortal],
	error)

ListOrgPskPortals takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.PskPortal data and an error if there was an issue with the request or response. Get List of Org Psk Portals

func (*OrgsPskPortals) SearchOrgPskPortalLogs 

func (o *OrgsPskPortals) SearchOrgPskPortalLogs(
	ctx context.Context,
	orgId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int,
	pskName *string,
	pskId *string,
	pskportalId *string,
	id *uuid.UUID,
	adminName *string,
	adminId *string,
	nameId *uuid.UUID) (
	models.ApiResponse[models.ResponsePskPortalLogsSearch],
	error)

SearchOrgPskPortalLogs takes context, orgId, start, end, duration, limit, page, pskName, pskId, pskportalId, id, adminName, adminId, nameId as parameters and returns an models.ApiResponse with models.ResponsePskPortalLogsSearch data and an error if there was an issue with the request or response. Search Org PSK Portal Logs

func (*OrgsPskPortals) UpdateOrgPskPortal 

func (o *OrgsPskPortals) UpdateOrgPskPortal(
	ctx context.Context,
	orgId uuid.UUID,
	pskportalId uuid.UUID,
	body *models.PskPortal) (
	models.ApiResponse[models.PskPortal],
	error)

UpdateOrgPskPortal takes context, orgId, pskportalId, body as parameters and returns an models.ApiResponse with models.PskPortal data and an error if there was an issue with the request or response. update Org Psk Portal

func (*OrgsPskPortals) UpdateOrgPskPortalTemplate 

func (o *OrgsPskPortals) UpdateOrgPskPortalTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	pskportalId uuid.UUID,
	body *models.PskPortalTemplate) (
	*http.Response,
	error)

UpdateOrgPskPortalTemplate takes context, orgId, pskportalId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Update Org Psk Portal Template

func (*OrgsPskPortals) UploadOrgPskPortalImage 

func (o *OrgsPskPortals) UploadOrgPskPortalImage(
	ctx context.Context,
	orgId uuid.UUID,
	pskportalId uuid.UUID,
	file *models.FileWrapper,
	json *string) (
	*http.Response,
	error)

UploadOrgPskPortalImage takes context, orgId, pskportalId, file, json as parameters and returns an *Response and an error if there was an issue with the request or response. Upload background image for PskPortal

type OrgsPsks 

type OrgsPsks struct {
	// contains filtered or unexported fields
}

OrgsPsks represents a controller struct.

func NewOrgsPsks 

func NewOrgsPsks(baseController baseController) *OrgsPsks

NewOrgsPsks creates a new instance of OrgsPsks. It takes a baseController as a parameter and returns a pointer to the OrgsPsks.

func (*OrgsPsks) CreateOrgPsk 

func (o *OrgsPsks) CreateOrgPsk(
	ctx context.Context,
	orgId uuid.UUID,
	upsert *bool,
	body *models.Psk) (
	models.ApiResponse[models.Psk],
	error)

CreateOrgPsk takes context, orgId, upsert, body as parameters and returns an models.ApiResponse with models.Psk data and an error if there was an issue with the request or response. Create Org PSK When `usage`==`macs`, corresponding "macs" field will hold a list consisting of client mac addresses (["xx:xx:xx:xx:xx",...]) or mac patterns(["xx:xx:*","xx*",...]) or both (["xx:xx:xx:xx:xx:xx", "xx:*", ...]). This list is capped at 5000

func (*OrgsPsks) DeleteOrgPsk 

func (o *OrgsPsks) DeleteOrgPsk(
	ctx context.Context,
	orgId uuid.UUID,
	pskId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgPsk takes context, orgId, pskId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org PSK

func (*OrgsPsks) DeleteOrgPskList 

func (o *OrgsPsks) DeleteOrgPskList(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.PskIdList) (
	*http.Response,
	error)

DeleteOrgPskList takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org PSK List Delete list of psks on the org. This API accepts single string or list of strings

func (*OrgsPsks) DeleteOrgPskOldPassphrase 

func (o *OrgsPsks) DeleteOrgPskOldPassphrase(
	ctx context.Context,
	orgId uuid.UUID,
	pskId uuid.UUID) (
	models.ApiResponse[models.Psk],
	error)

DeleteOrgPskOldPassphrase takes context, orgId, pskId as parameters and returns an models.ApiResponse with models.Psk data and an error if there was an issue with the request or response. Delete `old_passphrase` from PSK. If successful, response is same as GET, returns the PSK with `old_passphrase` removed.

func (*OrgsPsks) GetOrgPsk 

func (o *OrgsPsks) GetOrgPsk(
	ctx context.Context,
	orgId uuid.UUID,
	pskId uuid.UUID) (
	models.ApiResponse[models.Psk],
	error)

GetOrgPsk takes context, orgId, pskId as parameters and returns an models.ApiResponse with models.Psk data and an error if there was an issue with the request or response. Get Org PSK Details

func (*OrgsPsks) ImportOrgPsks 

func (o *OrgsPsks) ImportOrgPsks(
	ctx context.Context,
	orgId uuid.UUID,
	file *models.FileWrapper) (
	models.ApiResponse[[]models.Psk],
	error)

ImportOrgPsks takes context, orgId, file as parameters and returns an models.ApiResponse with []models.Psk data and an error if there was an issue with the request or response. Import PSK from CSV file or JSON ## CSV File Format ``` PSK Import CSV File Format: name,ssid,passphrase,usage,vlan_id,mac,max_usage,role,expire_time,notify_expiry,expiry_notification_time,notify_on_create_or_edit,email Common,warehouse,foryoureyesonly,single,35,a31425f31278,0,student,1618594236 Justin,reception,visible,multi,1002,200,teacher,1618594236 Common2,ssid,1245678-xx,single,35,a31425f31278,0,student,1618594236,true,7,true,admin@test.com ```

func (*OrgsPsks) ListOrgPsks 

func (o *OrgsPsks) ListOrgPsks(
	ctx context.Context,
	orgId uuid.UUID,
	name *string,
	ssid *string,
	role *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Psk],
	error)

ListOrgPsks takes context, orgId, name, ssid, role, limit, page as parameters and returns an models.ApiResponse with []models.Psk data and an error if there was an issue with the request or response. Get List of Org Psks

func (*OrgsPsks) UpdateOrgMultiplePsks 

func (o *OrgsPsks) UpdateOrgMultiplePsks(
	ctx context.Context,
	orgId uuid.UUID,
	body []models.Psk) (
	models.ApiResponse[[]models.Psk],
	error)

UpdateOrgMultiplePsks takes context, orgId, body as parameters and returns an models.ApiResponse with []models.Psk data and an error if there was an issue with the request or response. Update Multiple PSKs

func (*OrgsPsks) UpdateOrgPsk 

func (o *OrgsPsks) UpdateOrgPsk(
	ctx context.Context,
	orgId uuid.UUID,
	pskId uuid.UUID,
	body *models.Psk) (
	models.ApiResponse[models.Psk],
	error)

UpdateOrgPsk takes context, orgId, pskId, body as parameters and returns an models.ApiResponse with models.Psk data and an error if there was an issue with the request or response. Update Org PSK

type OrgsRFTemplates 

type OrgsRFTemplates struct {
	// contains filtered or unexported fields
}

OrgsRFTemplates represents a controller struct.

func NewOrgsRFTemplates 

func NewOrgsRFTemplates(baseController baseController) *OrgsRFTemplates

NewOrgsRFTemplates creates a new instance of OrgsRFTemplates. It takes a baseController as a parameter and returns a pointer to the OrgsRFTemplates.

func (*OrgsRFTemplates) CreateOrgRfTemplate 

func (o *OrgsRFTemplates) CreateOrgRfTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.RfTemplate) (
	models.ApiResponse[models.RfTemplate],
	error)

CreateOrgRfTemplate takes context, orgId, body as parameters and returns an models.ApiResponse with models.RfTemplate data and an error if there was an issue with the request or response. Create Org RF Template

func (*OrgsRFTemplates) DeleteOrgRfTemplate 

func (o *OrgsRFTemplates) DeleteOrgRfTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	rftemplateId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgRfTemplate takes context, orgId, rftemplateId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org RF Template

func (*OrgsRFTemplates) GetOrgRfTemplate 

func (o *OrgsRFTemplates) GetOrgRfTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	rftemplateId uuid.UUID) (
	models.ApiResponse[models.RfTemplate],
	error)

GetOrgRfTemplate takes context, orgId, rftemplateId as parameters and returns an models.ApiResponse with models.RfTemplate data and an error if there was an issue with the request or response. Get Org RF Template Details

func (*OrgsRFTemplates) ListOrgRfTemplates 

func (o *OrgsRFTemplates) ListOrgRfTemplates(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.RfTemplate],
	error)

ListOrgRfTemplates takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.RfTemplate data and an error if there was an issue with the request or response. Get List of Org RF Template

func (*OrgsRFTemplates) UpdateOrgRfTemplate 

func (o *OrgsRFTemplates) UpdateOrgRfTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	rftemplateId uuid.UUID,
	body *models.RfTemplate) (
	models.ApiResponse[models.RfTemplate],
	error)

UpdateOrgRfTemplate takes context, orgId, rftemplateId, body as parameters and returns an models.ApiResponse with models.RfTemplate data and an error if there was an issue with the request or response. Update Org RF Template

type OrgsSCEP added in v0.2.38 

type OrgsSCEP struct {
	// contains filtered or unexported fields
}

OrgsSCEP represents a controller struct.

func NewOrgsSCEP added in v0.2.38 

func NewOrgsSCEP(baseController baseController) *OrgsSCEP

NewOrgsSCEP creates a new instance of OrgsSCEP. It takes a baseController as a parameter and returns a pointer to the OrgsSCEP.

func (*OrgsSCEP) DisableOrgMistScep added in v0.2.38 

func (o *OrgsSCEP) DisableOrgMistScep(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.OrgSettingScep],
	error)

DisableOrgMistScep takes context, orgId as parameters and returns an models.ApiResponse with models.OrgSettingScep data and an error if there was an issue with the request or response. Disable Mist SCEP Org setting

func (*OrgsSCEP) GetOrgIssuedClientCertificates added in v0.2.38 

func (o *OrgsSCEP) GetOrgIssuedClientCertificates(
	ctx context.Context,
	orgId uuid.UUID,
	ssoNameId *string,
	serialNumber *string,
	deviceId *string) (
	models.ApiResponse[models.IssuedClientCertificatesResults],
	error)

GetOrgIssuedClientCertificates takes context, orgId, ssoNameId, serialNumber, deviceId as parameters and returns an models.ApiResponse with models.IssuedClientCertificatesResults data and an error if there was an issue with the request or response. Get Issued Client Certificates

func (*OrgsSCEP) GetOrgMistScep added in v0.2.38 

func (o *OrgsSCEP) GetOrgMistScep(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.OrgSettingScep],
	error)

GetOrgMistScep takes context, orgId as parameters and returns an models.ApiResponse with models.OrgSettingScep data and an error if there was an issue with the request or response. Get Mist SCEP Org setting

func (*OrgsSCEP) RevokeOrgIssuedClientCertificates added in v0.2.38 

func (o *OrgsSCEP) RevokeOrgIssuedClientCertificates(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.ClientCertSerialNumbers) (
	*http.Response,
	error)

RevokeOrgIssuedClientCertificates takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Revoke Issued Client Certificates

func (*OrgsSCEP) UpdateOrgMistScep added in v0.2.38 

func (o *OrgsSCEP) UpdateOrgMistScep(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.OrgSettingScep) (
	models.ApiResponse[models.OrgSettingScep],
	error)

UpdateOrgMistScep takes context, orgId, body as parameters and returns an models.ApiResponse with models.OrgSettingScep data and an error if there was an issue with the request or response. Update Mist SCEP Org setting

type OrgsSDKInvites 

type OrgsSDKInvites struct {
	// contains filtered or unexported fields
}

OrgsSDKInvites represents a controller struct.

func NewOrgsSDKInvites 

func NewOrgsSDKInvites(baseController baseController) *OrgsSDKInvites

NewOrgsSDKInvites creates a new instance of OrgsSDKInvites. It takes a baseController as a parameter and returns a pointer to the OrgsSDKInvites.

func (*OrgsSDKInvites) ActivateSdkInvite 

func (o *OrgsSDKInvites) ActivateSdkInvite(
	ctx context.Context,
	secret string,
	body *models.DeviceIdString) (
	models.ApiResponse[models.ResponseMobileVerifySecret],
	error)

ActivateSdkInvite takes context, secret, body as parameters and returns an models.ApiResponse with models.ResponseMobileVerifySecret data and an error if there was an issue with the request or response. Verify secret

func (*OrgsSDKInvites) CreateSdkInvite 

func (o *OrgsSDKInvites) CreateSdkInvite(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Sdkinvite) (
	models.ApiResponse[models.Sdkinvite],
	error)

CreateSdkInvite takes context, orgId, body as parameters and returns an models.ApiResponse with models.Sdkinvite data and an error if there was an issue with the request or response. Create SDK Invite

func (*OrgsSDKInvites) GetSdkInvite 

func (o *OrgsSDKInvites) GetSdkInvite(
	ctx context.Context,
	orgId uuid.UUID,
	sdkinviteId uuid.UUID) (
	models.ApiResponse[models.Sdkinvite],
	error)

GetSdkInvite takes context, orgId, sdkinviteId as parameters and returns an models.ApiResponse with models.Sdkinvite data and an error if there was an issue with the request or response. Get SDK Invite Details

func (*OrgsSDKInvites) GetSdkInviteQrCode 

func (o *OrgsSDKInvites) GetSdkInviteQrCode(
	ctx context.Context,
	orgId uuid.UUID,
	sdkinviteId uuid.UUID) (
	models.ApiResponse[[]byte],
	error)

GetSdkInviteQrCode takes context, orgId, sdkinviteId as parameters and returns an models.ApiResponse with []byte data and an error if there was an issue with the request or response. Revoke SDK Invite

func (*OrgsSDKInvites) ListSdkInvites 

func (o *OrgsSDKInvites) ListSdkInvites(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.Sdkinvite],
	error)

ListSdkInvites takes context, orgId as parameters and returns an models.ApiResponse with []models.Sdkinvite data and an error if there was an issue with the request or response. Get List of Org SDK Invites

func (*OrgsSDKInvites) RevokeSdkInvite 

func (o *OrgsSDKInvites) RevokeSdkInvite(
	ctx context.Context,
	orgId uuid.UUID,
	sdkinviteId uuid.UUID) (
	*http.Response,
	error)

RevokeSdkInvite takes context, orgId, sdkinviteId as parameters and returns an *Response and an error if there was an issue with the request or response. Revoke SDK Invite

func (*OrgsSDKInvites) SendSdkInviteEmail 

func (o *OrgsSDKInvites) SendSdkInviteEmail(
	ctx context.Context,
	orgId uuid.UUID,
	sdkinviteId uuid.UUID,
	body *models.EmailString) (
	*http.Response,
	error)

SendSdkInviteEmail takes context, orgId, sdkinviteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Send SDK Invite by Email

func (*OrgsSDKInvites) SendSdkInviteSms 

func (o *OrgsSDKInvites) SendSdkInviteSms(
	ctx context.Context,
	orgId uuid.UUID,
	sdkinviteId uuid.UUID,
	body *models.SdkInviteSms) (
	*http.Response,
	error)

SendSdkInviteSms takes context, orgId, sdkinviteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Send SDK Invite by SMS

func (*OrgsSDKInvites) UpdateSdkInvite 

func (o *OrgsSDKInvites) UpdateSdkInvite(
	ctx context.Context,
	orgId uuid.UUID,
	sdkinviteId uuid.UUID,
	body *models.Sdkinvite) (
	models.ApiResponse[models.Sdkinvite],
	error)

UpdateSdkInvite takes context, orgId, sdkinviteId, body as parameters and returns an models.ApiResponse with models.Sdkinvite data and an error if there was an issue with the request or response. Update SDK Invite

type OrgsSDKTemplates 

type OrgsSDKTemplates struct {
	// contains filtered or unexported fields
}

OrgsSDKTemplates represents a controller struct.

func NewOrgsSDKTemplates 

func NewOrgsSDKTemplates(baseController baseController) *OrgsSDKTemplates

NewOrgsSDKTemplates creates a new instance of OrgsSDKTemplates. It takes a baseController as a parameter and returns a pointer to the OrgsSDKTemplates.

func (*OrgsSDKTemplates) CreateSdkTemplate 

func (o *OrgsSDKTemplates) CreateSdkTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Sdktemplate) (
	models.ApiResponse[models.Sdktemplate],
	error)

CreateSdkTemplate takes context, orgId, body as parameters and returns an models.ApiResponse with models.Sdktemplate data and an error if there was an issue with the request or response. Create SDK Template

func (*OrgsSDKTemplates) DeleteSdkTemplate 

func (o *OrgsSDKTemplates) DeleteSdkTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	sdktemplateId uuid.UUID) (
	*http.Response,
	error)

DeleteSdkTemplate takes context, orgId, sdktemplateId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete SDK Template

func (*OrgsSDKTemplates) GetSdkTemplate 

func (o *OrgsSDKTemplates) GetSdkTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	sdktemplateId uuid.UUID) (
	models.ApiResponse[models.Sdktemplate],
	error)

GetSdkTemplate takes context, orgId, sdktemplateId as parameters and returns an models.ApiResponse with models.Sdktemplate data and an error if there was an issue with the request or response. Get SDK Template Details

func (*OrgsSDKTemplates) ListSdkTemplates 

func (o *OrgsSDKTemplates) ListSdkTemplates(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.Sdktemplate],
	error)

ListSdkTemplates takes context, orgId as parameters and returns an models.ApiResponse with []models.Sdktemplate data and an error if there was an issue with the request or response. Get List of Org SDK Templates

func (*OrgsSDKTemplates) UpdateSdkTemplate 

func (o *OrgsSDKTemplates) UpdateSdkTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	sdktemplateId uuid.UUID,
	body *models.Sdktemplate) (
	models.ApiResponse[models.Sdktemplate],
	error)

UpdateSdkTemplate takes context, orgId, sdktemplateId, body as parameters and returns an models.ApiResponse with models.Sdktemplate data and an error if there was an issue with the request or response. Update SDK Template

type OrgsSLEs 

type OrgsSLEs struct {
	// contains filtered or unexported fields
}

OrgsSLEs represents a controller struct.

func NewOrgsSLEs 

func NewOrgsSLEs(baseController baseController) *OrgsSLEs

NewOrgsSLEs creates a new instance of OrgsSLEs. It takes a baseController as a parameter and returns a pointer to the OrgsSLEs.

func (*OrgsSLEs) GetOrgSitesSle 

func (o *OrgsSLEs) GetOrgSitesSle(
	ctx context.Context,
	orgId uuid.UUID,
	sle *models.OrgSiteSleTypeEnum,
	start *int,
	end *int,
	duration *string,
	interval *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseOrgSiteSle],
	error)

GetOrgSitesSle takes context, orgId, sle, start, end, duration, interval, limit, page as parameters and returns an models.ApiResponse with models.ResponseOrgSiteSle data and an error if there was an issue with the request or response. Get Org Sites SLE

func (*OrgsSLEs) GetOrgSle 

func (o *OrgsSLEs) GetOrgSle(
	ctx context.Context,
	orgId uuid.UUID,
	metric string,
	sle *string,
	duration *string,
	interval *string,
	start *int,
	end *int) (
	models.ApiResponse[models.InsightMetrics],
	error)

GetOrgSle takes context, orgId, metric, sle, duration, interval, start, end as parameters and returns an models.ApiResponse with models.InsightMetrics data and an error if there was an issue with the request or response. Get Org SLEs (all/worst sites, Mx Edges, ...)

type OrgsSSO 

type OrgsSSO struct {
	// contains filtered or unexported fields
}

OrgsSSO represents a controller struct.

func NewOrgsSSO 

func NewOrgsSSO(baseController baseController) *OrgsSSO

NewOrgsSSO creates a new instance of OrgsSSO. It takes a baseController as a parameter and returns a pointer to the OrgsSSO.

func (*OrgsSSO) CreateOrgSso 

func (o *OrgsSSO) CreateOrgSso(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Sso) (
	models.ApiResponse[models.Sso],
	error)

CreateOrgSso takes context, orgId, body as parameters and returns an models.ApiResponse with models.Sso data and an error if there was an issue with the request or response. Create Org SSO Configuration

func (*OrgsSSO) DeleteOrgSso 

func (o *OrgsSSO) DeleteOrgSso(
	ctx context.Context,
	orgId uuid.UUID,
	ssoId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgSso takes context, orgId, ssoId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org SSO Configuration

func (*OrgsSSO) DownloadOrgSamlMetadata added in v0.4.0 

func (o *OrgsSSO) DownloadOrgSamlMetadata(
	ctx context.Context,
	orgId uuid.UUID,
	ssoId uuid.UUID) (
	models.ApiResponse[[]byte],
	error)

DownloadOrgSamlMetadata takes context, orgId, ssoId as parameters and returns an models.ApiResponse with []byte data and an error if there was an issue with the request or response. Download Org SAML Metdata Example of metadata.xml: ```xml <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/5hdF5g/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"> <md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"> <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/logout" /> <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat> <md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/login" index="0" isDefault="true"/> <md:AttributeConsumingService index="0"> <md:ServiceName xml:lang="en-US">Mist</md:ServiceName> <md:RequestedAttribute Name="Role" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="true"/> <md:RequestedAttribute Name="FirstName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/> <md:RequestedAttribute Name="LastName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/> </md:AttributeConsumingService> </md:SPSSODescriptor> </md:EntityDescriptor> ```

func (*OrgsSSO) GetOrgSamlMetadata added in v0.4.0 

func (o *OrgsSSO) GetOrgSamlMetadata(
	ctx context.Context,
	orgId uuid.UUID,
	ssoId uuid.UUID) (
	models.ApiResponse[models.SamlMetadata],
	error)

GetOrgSamlMetadata takes context, orgId, ssoId as parameters and returns an models.ApiResponse with models.SamlMetadata data and an error if there was an issue with the request or response. Get Org SAML Metadata

func (*OrgsSSO) GetOrgSso 

func (o *OrgsSSO) GetOrgSso(
	ctx context.Context,
	orgId uuid.UUID,
	ssoId uuid.UUID) (
	models.ApiResponse[models.Sso],
	error)

GetOrgSso takes context, orgId, ssoId as parameters and returns an models.ApiResponse with models.Sso data and an error if there was an issue with the request or response. Get Org SSO Configuration Details

func (*OrgsSSO) ListOrgSsoLatestFailures 

func (o *OrgsSSO) ListOrgSsoLatestFailures(
	ctx context.Context,
	orgId uuid.UUID,
	ssoId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseSsoFailureSearch],
	error)

ListOrgSsoLatestFailures takes context, orgId, ssoId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponseSsoFailureSearch data and an error if there was an issue with the request or response. Get List of Org SSO Latest Failures

func (*OrgsSSO) ListOrgSsos 

func (o *OrgsSSO) ListOrgSsos(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Sso],
	error)

ListOrgSsos takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Sso data and an error if there was an issue with the request or response. Get List of Org SSO Configuration

func (*OrgsSSO) UpdateOrgSso 

func (o *OrgsSSO) UpdateOrgSso(
	ctx context.Context,
	orgId uuid.UUID,
	ssoId uuid.UUID,
	body *models.Sso) (
	models.ApiResponse[models.Sso],
	error)

UpdateOrgSso takes context, orgId, ssoId, body as parameters and returns an models.ApiResponse with models.Sso data and an error if there was an issue with the request or response. Update Org SSO Configuration

type OrgsSSORoles 

type OrgsSSORoles struct {
	// contains filtered or unexported fields
}

OrgsSSORoles represents a controller struct.

func NewOrgsSSORoles 

func NewOrgsSSORoles(baseController baseController) *OrgsSSORoles

NewOrgsSSORoles creates a new instance of OrgsSSORoles. It takes a baseController as a parameter and returns a pointer to the OrgsSSORoles.

func (*OrgsSSORoles) CreateOrgSsoRole 

func (o *OrgsSSORoles) CreateOrgSsoRole(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.SsoRoleOrg) (
	models.ApiResponse[models.SsoRoleOrg],
	error)

CreateOrgSsoRole takes context, orgId, body as parameters and returns an models.ApiResponse with models.SsoRoleOrg data and an error if there was an issue with the request or response. Create Org SSO Role

func (*OrgsSSORoles) DeleteOrgSsoRole 

func (o *OrgsSSORoles) DeleteOrgSsoRole(
	ctx context.Context,
	orgId uuid.UUID,
	ssoroleId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgSsoRole takes context, orgId, ssoroleId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org SSO Role

func (*OrgsSSORoles) GetOrgSsoRole 

func (o *OrgsSSORoles) GetOrgSsoRole(
	ctx context.Context,
	orgId uuid.UUID,
	ssoroleId uuid.UUID) (
	models.ApiResponse[models.SsoRoleOrg],
	error)

GetOrgSsoRole takes context, orgId, ssoroleId as parameters and returns an models.ApiResponse with models.SsoRoleOrg data and an error if there was an issue with the request or response. Get Org SSO Role Details

func (*OrgsSSORoles) ListOrgSsoRoles 

func (o *OrgsSSORoles) ListOrgSsoRoles(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.SsoRoleMsp],
	error)

ListOrgSsoRoles takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.SsoRoleMsp data and an error if there was an issue with the request or response. Get List of Org SSO Roles

func (*OrgsSSORoles) UpdateOrgSsoRole 

func (o *OrgsSSORoles) UpdateOrgSsoRole(
	ctx context.Context,
	orgId uuid.UUID,
	ssoroleId uuid.UUID,
	body *models.SsoRoleOrg) (
	models.ApiResponse[models.SsoRoleOrg],
	error)

UpdateOrgSsoRole takes context, orgId, ssoroleId, body as parameters and returns an models.ApiResponse with models.SsoRoleOrg data and an error if there was an issue with the request or response. Update Org SSO Role

type OrgsSecIntelProfiles added in v0.3.17 

type OrgsSecIntelProfiles struct {
	// contains filtered or unexported fields
}

OrgsSecIntelProfiles represents a controller struct.

func NewOrgsSecIntelProfiles added in v0.3.17 

func NewOrgsSecIntelProfiles(baseController baseController) *OrgsSecIntelProfiles

NewOrgsSecIntelProfiles creates a new instance of OrgsSecIntelProfiles. It takes a baseController as a parameter and returns a pointer to the OrgsSecIntelProfiles.

func (*OrgsSecIntelProfiles) CreateOrgSecIntelProfile added in v0.3.17 

func (o *OrgsSecIntelProfiles) CreateOrgSecIntelProfile(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.SecintelProfile) (
	models.ApiResponse[models.SecintelProfile],
	error)

CreateOrgSecIntelProfile takes context, orgId, body as parameters and returns an models.ApiResponse with models.SecintelProfile data and an error if there was an issue with the request or response. Create Sec Intel Profiles

func (*OrgsSecIntelProfiles) DeleteOrgSecIntelProfile added in v0.3.17 

func (o *OrgsSecIntelProfiles) DeleteOrgSecIntelProfile(
	ctx context.Context,
	orgId uuid.UUID,
	secintelprofileId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgSecIntelProfile takes context, orgId, secintelprofileId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Sec Intel Profile

func (*OrgsSecIntelProfiles) GetOrgSecIntelProfile added in v0.3.17 

func (o *OrgsSecIntelProfiles) GetOrgSecIntelProfile(
	ctx context.Context,
	orgId uuid.UUID,
	secintelprofileId uuid.UUID) (
	models.ApiResponse[models.SecintelProfile],
	error)

GetOrgSecIntelProfile takes context, orgId, secintelprofileId as parameters and returns an models.ApiResponse with models.SecintelProfile data and an error if there was an issue with the request or response. Get Sec Intel Profile

func (*OrgsSecIntelProfiles) ListOrgSecIntelProfiles added in v0.3.17 

func (o *OrgsSecIntelProfiles) ListOrgSecIntelProfiles(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.SecintelProfile],
	error)

ListOrgSecIntelProfiles takes context, orgId as parameters and returns an models.ApiResponse with []models.SecintelProfile data and an error if there was an issue with the request or response. Get List of Sec Intel Profiles

func (*OrgsSecIntelProfiles) UpdateOrgSecIntelProfile added in v0.3.17 

func (o *OrgsSecIntelProfiles) UpdateOrgSecIntelProfile(
	ctx context.Context,
	orgId uuid.UUID,
	secintelprofileId uuid.UUID,
	body *models.SecintelProfile) (
	models.ApiResponse[models.SecintelProfile],
	error)

UpdateOrgSecIntelProfile takes context, orgId, secintelprofileId, body as parameters and returns an models.ApiResponse with models.SecintelProfile data and an error if there was an issue with the request or response. Update Sec Intel Profile

type OrgsSecPolicies 

type OrgsSecPolicies struct {
	// contains filtered or unexported fields
}

OrgsSecPolicies represents a controller struct.

func NewOrgsSecPolicies 

func NewOrgsSecPolicies(baseController baseController) *OrgsSecPolicies

NewOrgsSecPolicies creates a new instance of OrgsSecPolicies. It takes a baseController as a parameter and returns a pointer to the OrgsSecPolicies.

func (*OrgsSecPolicies) CreateOrgSecPolicies 

func (o *OrgsSecPolicies) CreateOrgSecPolicies(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Secpolicy) (
	models.ApiResponse[models.Secpolicy],
	error)

CreateOrgSecPolicies takes context, orgId, body as parameters and returns an models.ApiResponse with models.Secpolicy data and an error if there was an issue with the request or response. Create Org Security Policy

func (*OrgsSecPolicies) DeleteOrgSecPolicy 

func (o *OrgsSecPolicies) DeleteOrgSecPolicy(
	ctx context.Context,
	orgId uuid.UUID,
	secpolicyId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgSecPolicy takes context, orgId, secpolicyId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Security Policy

func (*OrgsSecPolicies) GetOrgSecPolicy 

func (o *OrgsSecPolicies) GetOrgSecPolicy(
	ctx context.Context,
	orgId uuid.UUID,
	secpolicyId uuid.UUID) (
	models.ApiResponse[models.Secpolicy],
	error)

GetOrgSecPolicy takes context, orgId, secpolicyId as parameters and returns an models.ApiResponse with models.Secpolicy data and an error if there was an issue with the request or response. Get Org Security Policy

func (*OrgsSecPolicies) ListOrgSecPolicies 

func (o *OrgsSecPolicies) ListOrgSecPolicies(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Secpolicy],
	error)

ListOrgSecPolicies takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Secpolicy data and an error if there was an issue with the request or response. Get List of Org Security Policies

func (*OrgsSecPolicies) UpdateOrgSecPolicies 

func (o *OrgsSecPolicies) UpdateOrgSecPolicies(
	ctx context.Context,
	orgId uuid.UUID,
	secpolicyId uuid.UUID,
	body *models.Secpolicy) (
	models.ApiResponse[models.Secpolicy],
	error)

UpdateOrgSecPolicies takes context, orgId, secpolicyId, body as parameters and returns an models.ApiResponse with models.Secpolicy data and an error if there was an issue with the request or response. Update Org Security Policy

type OrgsServicePolicies 

type OrgsServicePolicies struct {
	// contains filtered or unexported fields
}

OrgsServicePolicies represents a controller struct.

func NewOrgsServicePolicies 

func NewOrgsServicePolicies(baseController baseController) *OrgsServicePolicies

NewOrgsServicePolicies creates a new instance of OrgsServicePolicies. It takes a baseController as a parameter and returns a pointer to the OrgsServicePolicies.

func (*OrgsServicePolicies) CreateOrgServicePolicy 

func (o *OrgsServicePolicies) CreateOrgServicePolicy(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.OrgServicePolicy) (
	models.ApiResponse[models.OrgServicePolicy],
	error)

CreateOrgServicePolicy takes context, orgId, body as parameters and returns an models.ApiResponse with models.OrgServicePolicy data and an error if there was an issue with the request or response. Create Org Serrvice Policy

func (*OrgsServicePolicies) DeleteOrgServicePolicy 

func (o *OrgsServicePolicies) DeleteOrgServicePolicy(
	ctx context.Context,
	orgId uuid.UUID,
	servicepolicyId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgServicePolicy takes context, orgId, servicepolicyId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Service Policuy

func (*OrgsServicePolicies) GetOrgServicePolicy 

func (o *OrgsServicePolicies) GetOrgServicePolicy(
	ctx context.Context,
	orgId uuid.UUID,
	servicepolicyId uuid.UUID) (
	models.ApiResponse[models.OrgServicePolicy],
	error)

GetOrgServicePolicy takes context, orgId, servicepolicyId as parameters and returns an models.ApiResponse with models.OrgServicePolicy data and an error if there was an issue with the request or response. Get Org Service Policy Details

func (*OrgsServicePolicies) ListOrgServicePolicies 

func (o *OrgsServicePolicies) ListOrgServicePolicies(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.OrgServicePolicy],
	error)

ListOrgServicePolicies takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.OrgServicePolicy data and an error if there was an issue with the request or response. Get List of Org Service Policies

func (*OrgsServicePolicies) UpdateOrgServicePolicy 

func (o *OrgsServicePolicies) UpdateOrgServicePolicy(
	ctx context.Context,
	orgId uuid.UUID,
	servicepolicyId uuid.UUID,
	body *models.OrgServicePolicy) (
	models.ApiResponse[models.OrgServicePolicy],
	error)

UpdateOrgServicePolicy takes context, orgId, servicepolicyId, body as parameters and returns an models.ApiResponse with models.OrgServicePolicy data and an error if there was an issue with the request or response. Update Org Serrvice Policy

type OrgsServices 

type OrgsServices struct {
	// contains filtered or unexported fields
}

OrgsServices represents a controller struct.

func NewOrgsServices 

func NewOrgsServices(baseController baseController) *OrgsServices

NewOrgsServices creates a new instance of OrgsServices. It takes a baseController as a parameter and returns a pointer to the OrgsServices.

func (*OrgsServices) CreateOrgService 

func (o *OrgsServices) CreateOrgService(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Service) (
	models.ApiResponse[models.Service],
	error)

CreateOrgService takes context, orgId, body as parameters and returns an models.ApiResponse with models.Service data and an error if there was an issue with the request or response. Create getOrgServices Service

func (*OrgsServices) DeleteOrgService 

func (o *OrgsServices) DeleteOrgService(
	ctx context.Context,
	orgId uuid.UUID,
	serviceId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgService takes context, orgId, serviceId as parameters and returns an *Response and an error if there was an issue with the request or response. delete Org Service

func (*OrgsServices) GetOrgService 

func (o *OrgsServices) GetOrgService(
	ctx context.Context,
	orgId uuid.UUID,
	serviceId uuid.UUID) (
	models.ApiResponse[models.Service],
	error)

GetOrgService takes context, orgId, serviceId as parameters and returns an models.ApiResponse with models.Service data and an error if there was an issue with the request or response. Get Org Service

func (*OrgsServices) ListOrgServices 

func (o *OrgsServices) ListOrgServices(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Service],
	error)

ListOrgServices takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Service data and an error if there was an issue with the request or response. Get List of Org Services

func (*OrgsServices) UpdateOrgService 

func (o *OrgsServices) UpdateOrgService(
	ctx context.Context,
	orgId uuid.UUID,
	serviceId uuid.UUID,
	body *models.Service) (
	models.ApiResponse[models.Service],
	error)

UpdateOrgService takes context, orgId, serviceId, body as parameters and returns an models.ApiResponse with models.Service data and an error if there was an issue with the request or response. update Org Service

type OrgsSetting 

type OrgsSetting struct {
	// contains filtered or unexported fields
}

OrgsSetting represents a controller struct.

func NewOrgsSetting 

func NewOrgsSetting(baseController baseController) *OrgsSetting

NewOrgsSetting creates a new instance of OrgsSetting. It takes a baseController as a parameter and returns a pointer to the OrgsSetting.

func (*OrgsSetting) CreateOrgWirelessClientsBlocklist 

func (o *OrgsSetting) CreateOrgWirelessClientsBlocklist(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.MacAddresses) (
	models.ApiResponse[models.MacAddresses],
	error)

CreateOrgWirelessClientsBlocklist takes context, orgId, body as parameters and returns an models.ApiResponse with models.MacAddresses data and an error if there was an issue with the request or response. Create Org Blacklist Client List. If there is already a blacklist, this API will replace it with the new one. Max number of blacklist clients is 1000. Retrieve the current blacklisted clients from `blacklist_url` under Org:Setting

func (*OrgsSetting) DeleteOrgWirelessClientsBlocklist 

func (o *OrgsSetting) DeleteOrgWirelessClientsBlocklist(
	ctx context.Context,
	orgId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgWirelessClientsBlocklist takes context, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Blacklist Station Clients

func (*OrgsSetting) GetOrgSettings 

func (o *OrgsSetting) GetOrgSettings(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.OrgSetting],
	error)

GetOrgSettings takes context, orgId as parameters and returns an models.ApiResponse with models.OrgSetting data and an error if there was an issue with the request or response. Get Org Settings

func (*OrgsSetting) SetOrgCustomBucket 

func (o *OrgsSetting) SetOrgCustomBucket(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.PcapBucket) (
	models.ApiResponse[models.ResponsePcapBucketConfig],
	error)

SetOrgCustomBucket takes context, orgId, body as parameters and returns an models.ApiResponse with models.ResponsePcapBucketConfig data and an error if there was an issue with the request or response. Provide Customer Bucket Name Setting up Custom PCAP Bucket Involves the following: * provide the bucket name * we’ll attempt to write a file MIST_TOKEN * you have to verify the ownership of the bucket by providing the content of the MIST_TOKEN

func (*OrgsSetting) UpdateOrgSettings 

func (o *OrgsSetting) UpdateOrgSettings(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.OrgSetting) (
	models.ApiResponse[models.OrgSetting],
	error)

UpdateOrgSettings takes context, orgId, body as parameters and returns an models.ApiResponse with models.OrgSetting data and an error if there was an issue with the request or response. Update Org Settings

func (*OrgsSetting) VerifyOrgCustomBucket 

func (o *OrgsSetting) VerifyOrgCustomBucket(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.PcapBucketVerify) (
	*http.Response,
	error)

VerifyOrgCustomBucket takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Verify Customer PCAP Bucket **Note**: If successful, a “VERIFIED” file will be created in the bucket

type OrgsSettingZscaler added in v0.2.25 

type OrgsSettingZscaler struct {
	// contains filtered or unexported fields
}

OrgsSettingZscaler represents a controller struct.

func NewOrgsSettingZscaler added in v0.2.25 

func NewOrgsSettingZscaler(baseController baseController) *OrgsSettingZscaler

NewOrgsSettingZscaler creates a new instance of OrgsSettingZscaler. It takes a baseController as a parameter and returns a pointer to the OrgsSettingZscaler.

func (*OrgsSettingZscaler) DeleteOrgZscalerCredential added in v0.2.25 

func (o *OrgsSettingZscaler) DeleteOrgZscalerCredential(
	ctx context.Context,
	orgId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgZscalerCredential takes context, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. To delete Zscaler credential

func (*OrgsSettingZscaler) GetOrgZscalerCredential added in v0.2.25 

func (o *OrgsSettingZscaler) GetOrgZscalerCredential(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.AccountZscalerInfo],
	error)

GetOrgZscalerCredential takes context, orgId as parameters and returns an models.ApiResponse with models.AccountZscalerInfo data and an error if there was an issue with the request or response. To get Zscaler credential

func (*OrgsSettingZscaler) SetupOrgZscalerCredential added in v0.2.25 

func (o *OrgsSettingZscaler) SetupOrgZscalerCredential(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.AccountZscalerConfig) (
	*http.Response,
	error)

SetupOrgZscalerCredential takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. To setup Zscaler credential

type OrgsSiteTemplates 

type OrgsSiteTemplates struct {
	// contains filtered or unexported fields
}

OrgsSiteTemplates represents a controller struct.

func NewOrgsSiteTemplates 

func NewOrgsSiteTemplates(baseController baseController) *OrgsSiteTemplates

NewOrgsSiteTemplates creates a new instance of OrgsSiteTemplates. It takes a baseController as a parameter and returns a pointer to the OrgsSiteTemplates.

func (*OrgsSiteTemplates) CreateOrgSiteTemplates 

func (o *OrgsSiteTemplates) CreateOrgSiteTemplates(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.SiteTemplate) (
	models.ApiResponse[models.SiteTemplate],
	error)

CreateOrgSiteTemplates takes context, orgId, body as parameters and returns an models.ApiResponse with models.SiteTemplate data and an error if there was an issue with the request or response. Create Org Site Template

func (*OrgsSiteTemplates) DeleteOrgSiteTemplate 

func (o *OrgsSiteTemplates) DeleteOrgSiteTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	sitetemplateId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgSiteTemplate takes context, orgId, sitetemplateId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Site Template

func (*OrgsSiteTemplates) GetOrgSiteTemplate 

func (o *OrgsSiteTemplates) GetOrgSiteTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	sitetemplateId uuid.UUID) (
	models.ApiResponse[models.SiteTemplate],
	error)

GetOrgSiteTemplate takes context, orgId, sitetemplateId as parameters and returns an models.ApiResponse with models.SiteTemplate data and an error if there was an issue with the request or response. Get Org Site Template

func (*OrgsSiteTemplates) ListOrgSiteTemplates 

func (o *OrgsSiteTemplates) ListOrgSiteTemplates(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.SiteTemplate],
	error)

ListOrgSiteTemplates takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.SiteTemplate data and an error if there was an issue with the request or response. Get List of Org Site Templates

func (*OrgsSiteTemplates) UpdateOrgSiteTemplate 

func (o *OrgsSiteTemplates) UpdateOrgSiteTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	sitetemplateId uuid.UUID,
	body *models.SiteTemplate) (
	models.ApiResponse[models.SiteTemplate],
	error)

UpdateOrgSiteTemplate takes context, orgId, sitetemplateId, body as parameters and returns an models.ApiResponse with models.SiteTemplate data and an error if there was an issue with the request or response. Update Org Site Template

type OrgsSitegroups 

type OrgsSitegroups struct {
	// contains filtered or unexported fields
}

OrgsSitegroups represents a controller struct.

func NewOrgsSitegroups 

func NewOrgsSitegroups(baseController baseController) *OrgsSitegroups

NewOrgsSitegroups creates a new instance of OrgsSitegroups. It takes a baseController as a parameter and returns a pointer to the OrgsSitegroups.

func (*OrgsSitegroups) CreateOrgSiteGroup 

func (o *OrgsSitegroups) CreateOrgSiteGroup(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Sitegroup) (
	models.ApiResponse[models.Sitegroup],
	error)

CreateOrgSiteGroup takes context, orgId, body as parameters and returns an models.ApiResponse with models.Sitegroup data and an error if there was an issue with the request or response. Create Org Site Group

func (*OrgsSitegroups) DeleteOrgSiteGroup 

func (o *OrgsSitegroups) DeleteOrgSiteGroup(
	ctx context.Context,
	orgId uuid.UUID,
	sitegroupId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgSiteGroup takes context, orgId, sitegroupId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Site Group

func (*OrgsSitegroups) GetOrgSiteGroup 

func (o *OrgsSitegroups) GetOrgSiteGroup(
	ctx context.Context,
	orgId uuid.UUID,
	sitegroupId uuid.UUID) (
	models.ApiResponse[models.Sitegroup],
	error)

GetOrgSiteGroup takes context, orgId, sitegroupId as parameters and returns an models.ApiResponse with models.Sitegroup data and an error if there was an issue with the request or response. Get Org Site Group

func (*OrgsSitegroups) ListOrgSiteGroups 

func (o *OrgsSitegroups) ListOrgSiteGroups(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Sitegroup],
	error)

ListOrgSiteGroups takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Sitegroup data and an error if there was an issue with the request or response. Get List of Org Site Groups

func (*OrgsSitegroups) UpdateOrgSiteGroup 

func (o *OrgsSitegroups) UpdateOrgSiteGroup(
	ctx context.Context,
	orgId uuid.UUID,
	sitegroupId uuid.UUID,
	body *models.NameString) (
	models.ApiResponse[models.Sitegroup],
	error)

UpdateOrgSiteGroup takes context, orgId, sitegroupId, body as parameters and returns an models.ApiResponse with models.Sitegroup data and an error if there was an issue with the request or response. Update Org Site Group

type OrgsSites 

type OrgsSites struct {
	// contains filtered or unexported fields
}

OrgsSites represents a controller struct.

func NewOrgsSites 

func NewOrgsSites(baseController baseController) *OrgsSites

NewOrgsSites creates a new instance of OrgsSites. It takes a baseController as a parameter and returns a pointer to the OrgsSites.

func (*OrgsSites) CountOrgSites 

func (o *OrgsSites) CountOrgSites(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgSitesCountDistinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgSites takes context, orgId, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Sites

func (*OrgsSites) CreateOrgSite 

func (o *OrgsSites) CreateOrgSite(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Site) (
	models.ApiResponse[models.Site],
	error)

CreateOrgSite takes context, orgId, body as parameters and returns an models.ApiResponse with models.Site data and an error if there was an issue with the request or response. Create Org Site

func (*OrgsSites) ListOrgSites 

func (o *OrgsSites) ListOrgSites(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Site],
	error)

ListOrgSites takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Site data and an error if there was an issue with the request or response. Get List of Org Sites

func (*OrgsSites) SearchOrgSites 

func (o *OrgsSites) SearchOrgSites(
	ctx context.Context,
	orgId uuid.UUID,
	analyticEnabled *bool,
	appWaking *bool,
	assetEnabled *bool,
	autoUpgradeEnabled *bool,
	autoUpgradeVersion *string,
	countryCode *string,
	honeypotEnabled *bool,
	id *string,
	locateUnconnected *bool,
	meshEnabled *bool,
	name *string,
	rogueEnabled *bool,
	remoteSyslogEnabled *bool,
	rtsaEnabled *bool,
	vnaEnabled *bool,
	wifiEnabled *bool,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseSiteSearch],
	error)

SearchOrgSites takes context, orgId, analyticEnabled, appWaking, assetEnabled, autoUpgradeEnabled, autoUpgradeVersion, countryCode, honeypotEnabled, id, locateUnconnected, meshEnabled, name, rogueEnabled, remoteSyslogEnabled, rtsaEnabled, vnaEnabled, wifiEnabled, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseSiteSearch data and an error if there was an issue with the request or response. Search Sites

type OrgsStats added in v0.2.25 

type OrgsStats struct {
	// contains filtered or unexported fields
}

OrgsStats represents a controller struct.

func NewOrgsStats added in v0.2.25 

func NewOrgsStats(baseController baseController) *OrgsStats

NewOrgsStats creates a new instance of OrgsStats. It takes a baseController as a parameter and returns a pointer to the OrgsStats.

func (*OrgsStats) GetOrgStats added in v0.2.25 

func (o *OrgsStats) GetOrgStats(
	ctx context.Context,
	orgId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.StatsOrg],
	error)

GetOrgStats takes context, orgId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.StatsOrg data and an error if there was an issue with the request or response. Get Org Stats

type OrgsStatsAssets added in v0.2.25 

type OrgsStatsAssets struct {
	// contains filtered or unexported fields
}

OrgsStatsAssets represents a controller struct.

func NewOrgsStatsAssets added in v0.2.25 

func NewOrgsStatsAssets(baseController baseController) *OrgsStatsAssets

NewOrgsStatsAssets creates a new instance of OrgsStatsAssets. It takes a baseController as a parameter and returns a pointer to the OrgsStatsAssets.

func (*OrgsStatsAssets) CountOrgAssetsByDistanceField added in v0.2.25 

func (o *OrgsStatsAssets) CountOrgAssetsByDistanceField(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgAssetCountDistinctEnum) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgAssetsByDistanceField takes context, orgId, distinct as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Assets

func (*OrgsStatsAssets) ListOrgAssetsStats added in v0.2.25 

func (o *OrgsStatsAssets) ListOrgAssetsStats(
	ctx context.Context,
	orgId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.StatsAsset],
	error)

ListOrgAssetsStats takes context, orgId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with []models.StatsAsset data and an error if there was an issue with the request or response. Get List of Org Assets Stats

func (*OrgsStatsAssets) SearchOrgAssets added in v0.2.25 

func (o *OrgsStatsAssets) SearchOrgAssets(
	ctx context.Context,
	orgId uuid.UUID,
	siteId *string,
	mac *string,
	deviceName *string,
	name *string,
	mapId *string,
	ibeaconUuid *string,
	ibeaconMajor *string,
	ibeaconMinor *string,
	eddystoneUidNamespace *string,
	eddystoneUidInstance *string,
	eddystoneUrl *string,
	apMac *string,
	beam *int,
	rssi *int,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseStatsAssets],
	error)

SearchOrgAssets takes context, orgId, siteId, mac, deviceName, name, mapId, ibeaconUuid, ibeaconMajor, ibeaconMinor, eddystoneUidNamespace, eddystoneUidInstance, eddystoneUrl, apMac, beam, rssi, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseStatsAssets data and an error if there was an issue with the request or response. Search for Org Assets

type OrgsStatsBGPPeers added in v0.2.25 

type OrgsStatsBGPPeers struct {
	// contains filtered or unexported fields
}

OrgsStatsBGPPeers represents a controller struct.

func NewOrgsStatsBGPPeers added in v0.2.25 

func NewOrgsStatsBGPPeers(baseController baseController) *OrgsStatsBGPPeers

NewOrgsStatsBGPPeers creates a new instance of OrgsStatsBGPPeers. It takes a baseController as a parameter and returns a pointer to the OrgsStatsBGPPeers.

func (*OrgsStatsBGPPeers) CountOrgBgpStats added in v0.2.25 

func (o *OrgsStatsBGPPeers) CountOrgBgpStats(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgBgpStats takes context, orgId as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org BGP Stats

func (*OrgsStatsBGPPeers) SearchOrgBgpStats added in v0.2.25 

func (o *OrgsStatsBGPPeers) SearchOrgBgpStats(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.ResponseSearchBgps],
	error)

SearchOrgBgpStats takes context, orgId as parameters and returns an models.ApiResponse with models.ResponseSearchBgps data and an error if there was an issue with the request or response. Search Org BGP Stats

type OrgsStatsDevices added in v0.2.25 

type OrgsStatsDevices struct {
	// contains filtered or unexported fields
}

OrgsStatsDevices represents a controller struct.

func NewOrgsStatsDevices added in v0.2.25 

func NewOrgsStatsDevices(baseController baseController) *OrgsStatsDevices

NewOrgsStatsDevices creates a new instance of OrgsStatsDevices. It takes a baseController as a parameter and returns a pointer to the OrgsStatsDevices.

func (*OrgsStatsDevices) ListOrgDevicesStats added in v0.2.25 

func (o *OrgsStatsDevices) ListOrgDevicesStats(
	ctx context.Context,
	orgId uuid.UUID,
	mType *models.DeviceTypeWithAllEnum,
	status *models.DeviceStatusEnum,
	siteId *string,
	mac *string,
	evpntopoId *string,
	evpnUnused *string,
	fields *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.StatsDevice],
	error)

ListOrgDevicesStats takes context, orgId, mType, status, siteId, mac, evpntopoId, evpnUnused, fields, start, end, duration, limit, page as parameters and returns an models.ApiResponse with []models.StatsDevice data and an error if there was an issue with the request or response. Get List of Org Devices stats This API renders some high-level device stats, pagination is assumed and returned in response header (as the response is an array)

type OrgsStatsMxEdges added in v0.2.25 

type OrgsStatsMxEdges struct {
	// contains filtered or unexported fields
}

OrgsStatsMxEdges represents a controller struct.

func NewOrgsStatsMxEdges added in v0.2.25 

func NewOrgsStatsMxEdges(baseController baseController) *OrgsStatsMxEdges

NewOrgsStatsMxEdges creates a new instance of OrgsStatsMxEdges. It takes a baseController as a parameter and returns a pointer to the OrgsStatsMxEdges.

func (*OrgsStatsMxEdges) GetOrgMxEdgeStats added in v0.2.25 

func (o *OrgsStatsMxEdges) GetOrgMxEdgeStats(
	ctx context.Context,
	orgId uuid.UUID,
	mxedgeId uuid.UUID,
	forSite *bool) (
	models.ApiResponse[models.StatsMxedge],
	error)

GetOrgMxEdgeStats takes context, orgId, mxedgeId, forSite as parameters and returns an models.ApiResponse with models.StatsMxedge data and an error if there was an issue with the request or response. Get Org MxEdge Details Stats

func (*OrgsStatsMxEdges) ListOrgMxEdgesStats added in v0.2.25 

func (o *OrgsStatsMxEdges) ListOrgMxEdgesStats(
	ctx context.Context,
	orgId uuid.UUID,
	forSite *bool,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.StatsMxedge],
	error)

ListOrgMxEdgesStats takes context, orgId, forSite, start, end, duration, limit, page as parameters and returns an models.ApiResponse with []models.StatsMxedge data and an error if there was an issue with the request or response. Get List of Org MxEdge Stats

type OrgsStatsOtherDevices added in v0.2.25 

type OrgsStatsOtherDevices struct {
	// contains filtered or unexported fields
}

OrgsStatsOtherDevices represents a controller struct.

func NewOrgsStatsOtherDevices added in v0.2.25 

func NewOrgsStatsOtherDevices(baseController baseController) *OrgsStatsOtherDevices

NewOrgsStatsOtherDevices creates a new instance of OrgsStatsOtherDevices. It takes a baseController as a parameter and returns a pointer to the OrgsStatsOtherDevices.

func (*OrgsStatsOtherDevices) GetOrgOtherDeviceStats added in v0.2.25 

func (o *OrgsStatsOtherDevices) GetOrgOtherDeviceStats(
	ctx context.Context,
	orgId uuid.UUID,
	deviceMac string) (
	models.ApiResponse[models.StatsDeviceOther],
	error)

GetOrgOtherDeviceStats takes context, orgId, deviceMac as parameters and returns an models.ApiResponse with models.StatsDeviceOther data and an error if there was an issue with the request or response. Get Otherdevice Stats

type OrgsStatsPorts added in v0.2.25 

type OrgsStatsPorts struct {
	// contains filtered or unexported fields
}

OrgsStatsPorts represents a controller struct.

func NewOrgsStatsPorts added in v0.2.25 

func NewOrgsStatsPorts(baseController baseController) *OrgsStatsPorts

NewOrgsStatsPorts creates a new instance of OrgsStatsPorts. It takes a baseController as a parameter and returns a pointer to the OrgsStatsPorts.

func (*OrgsStatsPorts) SearchOrgSwOrGwPorts added in v0.2.25 

func (o *OrgsStatsPorts) SearchOrgSwOrGwPorts(
	ctx context.Context,
	orgId uuid.UUID,
	fullDuplex *bool,
	mac *string,
	neighborMac *string,
	neighborPortDesc *string,
	neighborSystemName *string,
	poeDisabled *bool,
	poeMode *string,
	poeOn *bool,
	portId *string,
	portMac *string,
	powerDraw *float64,
	txPkts *int,
	rxPkts *int,
	rxBytes *int,
	txBps *int,
	rxBps *int,
	txErrors *int,
	rxErrors *int,
	txMcastPkts *int,
	txBcastPkts *int,
	rxMcastPkts *int,
	rxBcastPkts *int,
	speed *int,
	macLimit *int,
	macCount *int,
	up *bool,
	stpState *models.SearchOrgSwOrGwPortsStpStateEnum,
	stpRole *models.SearchOrgSwOrGwPortsStpRoleEnum,
	authState *models.SearchOrgSwOrGwPortsAuthStateEnum,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponsePortStatsSearch],
	error)

SearchOrgSwOrGwPorts takes context, orgId, fullDuplex, mac, neighborMac, neighborPortDesc, neighborSystemName, poeDisabled, poeMode, poeOn, portId, portMac, powerDraw, txPkts, rxPkts, rxBytes, txBps, rxBps, txErrors, rxErrors, txMcastPkts, txBcastPkts, rxMcastPkts, rxBcastPkts, speed, macLimit, macCount, up, stpState, stpRole, authState, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponsePortStatsSearch data and an error if there was an issue with the request or response. Search Switch / Gateway Ports

type OrgsStatsSites added in v0.3.41 

type OrgsStatsSites struct {
	// contains filtered or unexported fields
}

OrgsStatsSites represents a controller struct.

func NewOrgsStatsSites added in v0.3.41 

func NewOrgsStatsSites(baseController baseController) *OrgsStatsSites

NewOrgsStatsSites creates a new instance of OrgsStatsSites. It takes a baseController as a parameter and returns a pointer to the OrgsStatsSites.

func (*OrgsStatsSites) ListOrgSiteStats added in v0.3.41 

func (o *OrgsStatsSites) ListOrgSiteStats(
	ctx context.Context,
	orgId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.StatsSite],
	error)

ListOrgSiteStats takes context, orgId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with []models.StatsSite data and an error if there was an issue with the request or response. Get List of Org Site Stats

type OrgsStatsTunnels added in v0.2.25 

type OrgsStatsTunnels struct {
	// contains filtered or unexported fields
}

OrgsStatsTunnels represents a controller struct.

func NewOrgsStatsTunnels added in v0.2.25 

func NewOrgsStatsTunnels(baseController baseController) *OrgsStatsTunnels

NewOrgsStatsTunnels creates a new instance of OrgsStatsTunnels. It takes a baseController as a parameter and returns a pointer to the OrgsStatsTunnels.

func (*OrgsStatsTunnels) CountOrgTunnelsStats added in v0.2.25 

func (o *OrgsStatsTunnels) CountOrgTunnelsStats(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgTunnelCountDistinctEnum,
	mType *models.OrgTunnelTypeCountEnum) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgTunnelsStats takes context, orgId, distinct, mType as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Mist Tunnels Stats

func (*OrgsStatsTunnels) SearchOrgTunnelsStats added in v0.2.25 

func (o *OrgsStatsTunnels) SearchOrgTunnelsStats(
	ctx context.Context,
	orgId uuid.UUID,
	mxclusterId *string,
	siteId *string,
	wxtunnelId *string,
	ap *string,
	mac *string,
	node *string,
	peerIp *string,
	peerHost *string,
	ip *string,
	tunnelName *string,
	protocol *string,
	authAlgo *string,
	encryptAlgo *string,
	ikeVersion *string,
	up *string,
	mType *models.TunnelTypeEnum,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseTunnelSearch],
	error)

SearchOrgTunnelsStats takes context, orgId, mxclusterId, siteId, wxtunnelId, ap, mac, node, peerIp, peerHost, ip, tunnelName, protocol, authAlgo, encryptAlgo, ikeVersion, up, mType, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseTunnelSearch data and an error if there was an issue with the request or response. Search Org Tunnels Stats

type OrgsStatsVPNPeers added in v0.2.25 

type OrgsStatsVPNPeers struct {
	// contains filtered or unexported fields
}

OrgsStatsVPNPeers represents a controller struct.

func NewOrgsStatsVPNPeers added in v0.2.25 

func NewOrgsStatsVPNPeers(baseController baseController) *OrgsStatsVPNPeers

NewOrgsStatsVPNPeers creates a new instance of OrgsStatsVPNPeers. It takes a baseController as a parameter and returns a pointer to the OrgsStatsVPNPeers.

func (*OrgsStatsVPNPeers) CountOrgPeerPathStats added in v0.2.25 

func (o *OrgsStatsVPNPeers) CountOrgPeerPathStats(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgPeerPathStats takes context, orgId, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Peer Path Statgs

func (*OrgsStatsVPNPeers) SearchOrgPeerPathStats added in v0.2.25 

func (o *OrgsStatsVPNPeers) SearchOrgPeerPathStats(
	ctx context.Context,
	orgId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.VpnPeerStatSearch],
	error)

SearchOrgPeerPathStats takes context, orgId, start, end, duration, limit as parameters and returns an models.ApiResponse with models.VpnPeerStatSearch data and an error if there was an issue with the request or response. Search Org Peer Path Stats

type OrgsSubscriptions 

type OrgsSubscriptions struct {
	// contains filtered or unexported fields
}

OrgsSubscriptions represents a controller struct.

func NewOrgsSubscriptions 

func NewOrgsSubscriptions(baseController baseController) *OrgsSubscriptions

NewOrgsSubscriptions creates a new instance of OrgsSubscriptions. It takes a baseController as a parameter and returns a pointer to the OrgsSubscriptions.

func (*OrgsSubscriptions) SubscribeOrgAlarmsReports 

func (o *OrgsSubscriptions) SubscribeOrgAlarmsReports(
	ctx context.Context,
	orgId uuid.UUID) (
	*http.Response,
	error)

SubscribeOrgAlarmsReports takes context, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. Subscribe to Org Alarms/Reports Subscriptions define how Org Alarms/Reports are delivered to whom

func (*OrgsSubscriptions) UnsubscribeOrgAlarmsReports 

func (o *OrgsSubscriptions) UnsubscribeOrgAlarmsReports(
	ctx context.Context,
	orgId uuid.UUID) (
	*http.Response,
	error)

UnsubscribeOrgAlarmsReports takes context, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. Unsubscribe from Org Alarms/Reports Subscriptions define how Org Alarms/Reports are delivered to whom

type OrgsTickets 

type OrgsTickets struct {
	// contains filtered or unexported fields
}

OrgsTickets represents a controller struct.

func NewOrgsTickets 

func NewOrgsTickets(baseController baseController) *OrgsTickets

NewOrgsTickets creates a new instance of OrgsTickets. It takes a baseController as a parameter and returns a pointer to the OrgsTickets.

func (*OrgsTickets) AddOrgTicketComment 

func (o *OrgsTickets) AddOrgTicketComment(
	ctx context.Context,
	orgId uuid.UUID,
	ticketId uuid.UUID,
	comment *string,
	file *models.FileWrapper) (
	models.ApiResponse[models.Ticket],
	error)

AddOrgTicketComment takes context, orgId, ticketId, comment, file as parameters and returns an models.ApiResponse with models.Ticket data and an error if there was an issue with the request or response. Add Comment to support ticket

func (*OrgsTickets) CountOrgTickets 

func (o *OrgsTickets) CountOrgTickets(
	ctx context.Context,
	orgId uuid.UUID,
	distinct *models.OrgTicketsCountDistinctEnum) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgTickets takes context, orgId, distinct as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Tickets

func (*OrgsTickets) CreateOrgTicket 

func (o *OrgsTickets) CreateOrgTicket(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Ticket) (
	models.ApiResponse[models.Ticket],
	error)

CreateOrgTicket takes context, orgId, body as parameters and returns an models.ApiResponse with models.Ticket data and an error if there was an issue with the request or response. Create a support ticket

func (*OrgsTickets) GetOrgTicket 

func (o *OrgsTickets) GetOrgTicket(
	ctx context.Context,
	orgId uuid.UUID,
	ticketId uuid.UUID,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.Ticket],
	error)

GetOrgTicket takes context, orgId, ticketId, start, end, duration as parameters and returns an models.ApiResponse with models.Ticket data and an error if there was an issue with the request or response. Get support ticket details

func (*OrgsTickets) GetOrgTicketAttachment 

func (o *OrgsTickets) GetOrgTicketAttachment(
	ctx context.Context,
	orgId uuid.UUID,
	ticketId uuid.UUID,
	attachmentId uuid.UUID,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.TicketAttachment],
	error)

GetOrgTicketAttachment takes context, orgId, ticketId, attachmentId, start, end, duration as parameters and returns an models.ApiResponse with models.TicketAttachment data and an error if there was an issue with the request or response. Get Org ticket Attachment

func (*OrgsTickets) ListOrgTickets 

func (o *OrgsTickets) ListOrgTickets(
	ctx context.Context,
	orgId uuid.UUID,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[[]models.Ticket],
	error)

ListOrgTickets takes context, orgId, start, end, duration as parameters and returns an models.ApiResponse with []models.Ticket data and an error if there was an issue with the request or response. Get List of Tickets of an Org

func (*OrgsTickets) UpdateOrgTicket 

func (o *OrgsTickets) UpdateOrgTicket(
	ctx context.Context,
	orgId uuid.UUID,
	ticketId uuid.UUID,
	body *models.Ticket) (
	models.ApiResponse[models.Ticket],
	error)

UpdateOrgTicket takes context, orgId, ticketId, body as parameters and returns an models.ApiResponse with models.Ticket data and an error if there was an issue with the request or response. Update support ticket

func (*OrgsTickets) UploadrgTicketAttachment 

func (o *OrgsTickets) UploadrgTicketAttachment(
	ctx context.Context,
	orgId uuid.UUID,
	ticketId uuid.UUID,
	file *models.FileWrapper) (
	*http.Response,
	error)

UploadrgTicketAttachment takes context, orgId, ticketId, file as parameters and returns an *Response and an error if there was an issue with the request or response. Get Org ticket Attachment

type OrgsUserMACs 

type OrgsUserMACs struct {
	// contains filtered or unexported fields
}

OrgsUserMACs represents a controller struct.

func NewOrgsUserMACs 

func NewOrgsUserMACs(baseController baseController) *OrgsUserMACs

NewOrgsUserMACs creates a new instance of OrgsUserMACs. It takes a baseController as a parameter and returns a pointer to the OrgsUserMACs.

func (*OrgsUserMACs) CreateOrgUserMacs 

func (o *OrgsUserMACs) CreateOrgUserMacs(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.UserMac) (
	models.ApiResponse[models.UserMacImport],
	error)

CreateOrgUserMacs takes context, orgId, body as parameters and returns an models.ApiResponse with models.UserMacImport data and an error if there was an issue with the request or response. Create Org User MACs ### Usermacs import CSV file format mac,labels,vlan,notes 921b638445cd,”bldg1,flor1”,vlan-100 721b638445ef,”bldg2,flor2”,vlan-101,Canon Printers 721b638445ee,”bldg3,flor3”,vlan-102 921b638445ce,”bldg4,flor4”,vlan-103 921b638445cf,”bldg5,flor5”,vlan-104

func (*OrgsUserMACs) DeleteOrgUserMac 

func (o *OrgsUserMACs) DeleteOrgUserMac(
	ctx context.Context,
	orgId uuid.UUID,
	usermacId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgUserMac takes context, orgId, usermacId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org User MAC

func (*OrgsUserMACs) GetOrgUserMac 

func (o *OrgsUserMACs) GetOrgUserMac(
	ctx context.Context,
	orgId uuid.UUID,
	usermacId uuid.UUID) (
	models.ApiResponse[models.UserMac],
	error)

GetOrgUserMac takes context, orgId, usermacId as parameters and returns an models.ApiResponse with models.UserMac data and an error if there was an issue with the request or response. Get Org User MAC

func (*OrgsUserMACs) ImportOrgUserMacs 

func (o *OrgsUserMACs) ImportOrgUserMacs(
	ctx context.Context,
	orgId uuid.UUID,
	file models.FileWrapper) (
	*http.Response,
	error)

ImportOrgUserMacs takes context, orgId, file as parameters and returns an *Response and an error if there was an issue with the request or response. Import Org User MACs ### CSV Import example ```csv mac,labels,vlan,notes,name,radius_group 921b638445cd,"bldg1,flor1",vlan-100 721b638445ef,"bldg2,flor2",vlan-101,Canon Printers 721b638445ee,"bldg3,flor3",vlan-102,Printer2,VIP 921b638445ce,"bldg4,flor4",vlan-103 921b638445cf,"bldg5,flor5",vlan-104 ````

func (*OrgsUserMACs) SearchOrgUserMacs 

func (o *OrgsUserMACs) SearchOrgUserMacs(
	ctx context.Context,
	orgId uuid.UUID,
	mac *string,
	labels []string,
	limit *int,
	page *int) (
	models.ApiResponse[models.UserMacsSearch],
	error)

SearchOrgUserMacs takes context, orgId, mac, labels, limit, page as parameters and returns an models.ApiResponse with models.UserMacsSearch data and an error if there was an issue with the request or response. Search Org User MACs

func (*OrgsUserMACs) UpdateOrgUserMac added in v0.3.2 

func (o *OrgsUserMACs) UpdateOrgUserMac(
	ctx context.Context,
	orgId uuid.UUID,
	usermacId uuid.UUID,
	body *models.UserMac) (
	models.ApiResponse[models.UserMac],
	error)

UpdateOrgUserMac takes context, orgId, usermacId, body as parameters and returns an models.ApiResponse with models.UserMac data and an error if there was an issue with the request or response. Update Org User MAC

type OrgsVPNs 

type OrgsVPNs struct {
	// contains filtered or unexported fields
}

OrgsVPNs represents a controller struct.

func NewOrgsVPNs 

func NewOrgsVPNs(baseController baseController) *OrgsVPNs

NewOrgsVPNs creates a new instance of OrgsVPNs. It takes a baseController as a parameter and returns a pointer to the OrgsVPNs.

func (*OrgsVPNs) CreateOrgVpns 

func (o *OrgsVPNs) CreateOrgVpns(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Vpn) (
	models.ApiResponse[models.Vpn],
	error)

CreateOrgVpns takes context, orgId, body as parameters and returns an models.ApiResponse with models.Vpn data and an error if there was an issue with the request or response. Create Org VPN

func (*OrgsVPNs) DeleteOrgVpn 

func (o *OrgsVPNs) DeleteOrgVpn(
	ctx context.Context,
	orgId uuid.UUID,
	vpnId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgVpn takes context, orgId, vpnId as parameters and returns an *Response and an error if there was an issue with the request or response. delete Org Vpn

func (*OrgsVPNs) GetOrgVpn 

func (o *OrgsVPNs) GetOrgVpn(
	ctx context.Context,
	orgId uuid.UUID,
	vpnId uuid.UUID) (
	models.ApiResponse[models.Vpn],
	error)

GetOrgVpn takes context, orgId, vpnId as parameters and returns an models.ApiResponse with models.Vpn data and an error if there was an issue with the request or response. getOrgVpn

func (*OrgsVPNs) ListOrgsVpns 

func (o *OrgsVPNs) ListOrgsVpns(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Vpn],
	error)

ListOrgsVpns takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Vpn data and an error if there was an issue with the request or response. Get List of Org VPNs

func (*OrgsVPNs) UpdateOrgVpn 

func (o *OrgsVPNs) UpdateOrgVpn(
	ctx context.Context,
	orgId uuid.UUID,
	vpnId uuid.UUID,
	body *models.Vpn) (
	models.ApiResponse[models.Vpn],
	error)

UpdateOrgVpn takes context, orgId, vpnId, body as parameters and returns an models.ApiResponse with models.Vpn data and an error if there was an issue with the request or response. update Org Vpn

type OrgsVars 

type OrgsVars struct {
	// contains filtered or unexported fields
}

OrgsVars represents a controller struct.

func NewOrgsVars 

func NewOrgsVars(baseController baseController) *OrgsVars

NewOrgsVars creates a new instance of OrgsVars. It takes a baseController as a parameter and returns a pointer to the OrgsVars.

func (*OrgsVars) SearchOrgVars 

func (o *OrgsVars) SearchOrgVars(
	ctx context.Context,
	orgId uuid.UUID,
	siteId *string,
	vars *string,
	src *models.VarSourceEnum,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseSearchVar],
	error)

SearchOrgVars takes context, orgId, siteId, vars, src, limit, page as parameters and returns an models.ApiResponse with models.ResponseSearchVar data and an error if there was an issue with the request or response. Search vars Example: /api/v1/orgs/:org_id/vars/search?vars=*

type OrgsWLANTemplates 

type OrgsWLANTemplates struct {
	// contains filtered or unexported fields
}

OrgsWLANTemplates represents a controller struct.

func NewOrgsWLANTemplates 

func NewOrgsWLANTemplates(baseController baseController) *OrgsWLANTemplates

NewOrgsWLANTemplates creates a new instance of OrgsWLANTemplates. It takes a baseController as a parameter and returns a pointer to the OrgsWLANTemplates.

func (*OrgsWLANTemplates) CloneOrgTemplate 

func (o *OrgsWLANTemplates) CloneOrgTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	templateId uuid.UUID,
	body *models.NameString) (
	models.ApiResponse[models.Template],
	error)

CloneOrgTemplate takes context, orgId, templateId, body as parameters and returns an models.ApiResponse with models.Template data and an error if there was an issue with the request or response. Clone Org Template

func (*OrgsWLANTemplates) CreateOrgTemplate 

func (o *OrgsWLANTemplates) CreateOrgTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Template) (
	models.ApiResponse[models.Template],
	error)

CreateOrgTemplate takes context, orgId, body as parameters and returns an models.ApiResponse with models.Template data and an error if there was an issue with the request or response. Create Org Template

func (*OrgsWLANTemplates) DeleteOrgTemplate 

func (o *OrgsWLANTemplates) DeleteOrgTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	templateId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgTemplate takes context, orgId, templateId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Template

func (*OrgsWLANTemplates) GetOrgTemplate 

func (o *OrgsWLANTemplates) GetOrgTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	templateId uuid.UUID) (
	models.ApiResponse[models.Template],
	error)

GetOrgTemplate takes context, orgId, templateId as parameters and returns an models.ApiResponse with models.Template data and an error if there was an issue with the request or response. Get Org Template Details

func (*OrgsWLANTemplates) ListOrgTemplates 

func (o *OrgsWLANTemplates) ListOrgTemplates(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Template],
	error)

ListOrgTemplates takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Template data and an error if there was an issue with the request or response. Get List of Org WLAN Templates

func (*OrgsWLANTemplates) UpdateOrgTemplate 

func (o *OrgsWLANTemplates) UpdateOrgTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	templateId uuid.UUID,
	body *models.Template) (
	models.ApiResponse[models.Template],
	error)

UpdateOrgTemplate takes context, orgId, templateId, body as parameters and returns an models.ApiResponse with models.Template data and an error if there was an issue with the request or response. Update Org Template

type OrgsWebhooks 

type OrgsWebhooks struct {
	// contains filtered or unexported fields
}

OrgsWebhooks represents a controller struct.

func NewOrgsWebhooks 

func NewOrgsWebhooks(baseController baseController) *OrgsWebhooks

NewOrgsWebhooks creates a new instance of OrgsWebhooks. It takes a baseController as a parameter and returns a pointer to the OrgsWebhooks.

func (*OrgsWebhooks) CountOrgWebhooksDeliveries 

func (o *OrgsWebhooks) CountOrgWebhooksDeliveries(
	ctx context.Context,
	orgId uuid.UUID,
	webhookId uuid.UUID,
	mError *string,
	statusCode *int,
	status *models.WebhookDeliveryStatusEnum,
	topic *models.WebhookDeliveryTopicEnum,
	distinct *models.WebhookDeliveryDistinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountOrgWebhooksDeliveries takes context, orgId, webhookId, mError, statusCode, status, topic, distinct, start, end, duration, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Org Webhooks deliveries Topics Supported: - alarms - audits - device-updowns - occupancy-alerts - ping

func (*OrgsWebhooks) CreateOrgWebhook 

func (o *OrgsWebhooks) CreateOrgWebhook(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Webhook) (
	models.ApiResponse[models.Webhook],
	error)

CreateOrgWebhook takes context, orgId, body as parameters and returns an models.ApiResponse with models.Webhook data and an error if there was an issue with the request or response. Create Org Webhook **N.B**. For org webhooks, only alarms/audits/client-info/client-join/client-sessions/device_events/device-updowns/mxedge_events Infrastructure topics are supported.

func (*OrgsWebhooks) DeleteOrgWebhook 

func (o *OrgsWebhooks) DeleteOrgWebhook(
	ctx context.Context,
	orgId uuid.UUID,
	webhookId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgWebhook takes context, orgId, webhookId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org Webhook

func (*OrgsWebhooks) GetOrgWebhook 

func (o *OrgsWebhooks) GetOrgWebhook(
	ctx context.Context,
	orgId uuid.UUID,
	webhookId uuid.UUID) (
	models.ApiResponse[models.Webhook],
	error)

GetOrgWebhook takes context, orgId, webhookId as parameters and returns an models.ApiResponse with models.Webhook data and an error if there was an issue with the request or response. Get Org Webhook Details

func (*OrgsWebhooks) ListOrgWebhooks 

func (o *OrgsWebhooks) ListOrgWebhooks(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Webhook],
	error)

ListOrgWebhooks takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Webhook data and an error if there was an issue with the request or response. Get List of Org Webhooks

func (*OrgsWebhooks) PingOrgWebhook 

func (o *OrgsWebhooks) PingOrgWebhook(
	ctx context.Context,
	orgId uuid.UUID,
	webhookId uuid.UUID) (
	*http.Response,
	error)

PingOrgWebhook takes context, orgId, webhookId as parameters and returns an *Response and an error if there was an issue with the request or response. send a Ping event to the webhook

func (*OrgsWebhooks) SearchOrgWebhooksDeliveries 

func (o *OrgsWebhooks) SearchOrgWebhooksDeliveries(
	ctx context.Context,
	orgId uuid.UUID,
	webhookId uuid.UUID,
	mError *string,
	statusCode *int,
	status *models.WebhookDeliveryStatusEnum,
	topic *models.WebhookDeliveryTopicEnum,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.SearchWebhookDelivery],
	error)

SearchOrgWebhooksDeliveries takes context, orgId, webhookId, mError, statusCode, status, topic, start, end, duration, limit as parameters and returns an models.ApiResponse with models.SearchWebhookDelivery data and an error if there was an issue with the request or response. Search Org Webhooks deliveries Topics Supported: - alarms - audits - device-updowns - occupancy-alerts - ping

func (*OrgsWebhooks) UpdateOrgWebhook 

func (o *OrgsWebhooks) UpdateOrgWebhook(
	ctx context.Context,
	orgId uuid.UUID,
	webhookId uuid.UUID,
	body *models.Webhook) (
	models.ApiResponse[models.Webhook],
	error)

UpdateOrgWebhook takes context, orgId, webhookId, body as parameters and returns an models.ApiResponse with models.Webhook data and an error if there was an issue with the request or response. Update Org Webhook

type OrgsWlans 

type OrgsWlans struct {
	// contains filtered or unexported fields
}

OrgsWlans represents a controller struct.

func NewOrgsWlans 

func NewOrgsWlans(baseController baseController) *OrgsWlans

NewOrgsWlans creates a new instance of OrgsWlans. It takes a baseController as a parameter and returns a pointer to the OrgsWlans.

func (*OrgsWlans) CreateOrgWlan 

func (o *OrgsWlans) CreateOrgWlan(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.Wlan) (
	models.ApiResponse[models.Wlan],
	error)

CreateOrgWlan takes context, orgId, body as parameters and returns an models.ApiResponse with models.Wlan data and an error if there was an issue with the request or response. Create Org Wlan

func (*OrgsWlans) DeleteOrgWlan 

func (o *OrgsWlans) DeleteOrgWlan(
	ctx context.Context,
	orgId uuid.UUID,
	wlanId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgWlan takes context, orgId, wlanId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org WLAN

func (*OrgsWlans) DeleteOrgWlanPortalImage 

func (o *OrgsWlans) DeleteOrgWlanPortalImage(
	ctx context.Context,
	orgId uuid.UUID,
	wlanId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgWlanPortalImage takes context, orgId, wlanId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org WLAN Portal Image

func (*OrgsWlans) GetOrgWLAN 

func (o *OrgsWlans) GetOrgWLAN(
	ctx context.Context,
	orgId uuid.UUID,
	wlanId uuid.UUID) (
	models.ApiResponse[models.Wlan],
	error)

GetOrgWLAN takes context, orgId, wlanId as parameters and returns an models.ApiResponse with models.Wlan data and an error if there was an issue with the request or response. Get Org Wlan Detail

func (*OrgsWlans) ListOrgWlans 

func (o *OrgsWlans) ListOrgWlans(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Wlan],
	error)

ListOrgWlans takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.Wlan data and an error if there was an issue with the request or response. Get List of Org Wlans

func (*OrgsWlans) UpdateOrgWlan 

func (o *OrgsWlans) UpdateOrgWlan(
	ctx context.Context,
	orgId uuid.UUID,
	wlanId uuid.UUID,
	body *models.Wlan) (
	models.ApiResponse[models.Wlan],
	error)

UpdateOrgWlan takes context, orgId, wlanId, body as parameters and returns an models.ApiResponse with models.Wlan data and an error if there was an issue with the request or response. Update Org Wlan

func (*OrgsWlans) UpdateOrgWlanPortalTemplate 

func (o *OrgsWlans) UpdateOrgWlanPortalTemplate(
	ctx context.Context,
	orgId uuid.UUID,
	wlanId uuid.UUID,
	body *models.WlanPortalTemplate) (
	models.ApiResponse[models.WlanPortalTemplate],
	error)

UpdateOrgWlanPortalTemplate takes context, orgId, wlanId, body as parameters and returns an models.ApiResponse with models.WlanPortalTemplate data and an error if there was an issue with the request or response. Update a Portal Template #### Sponsor Email Template Sponsor Email Template supports following template variables: | **Name** | **Description** | | --- | --- | | approve_url | Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized | | deny_url | Renders URL to reject the request | | guest_email | Renders Email ID of the guest | | guest_name | Renders Name of the guest | | field1 | Renders value of the Custom Field 1 | | field2 | Renders value of the Custom Field 2 | | company | Renders value of the Company field | | sponsor_link_validity_duration | Renders validity time of the request (i.e. Approve/Deny URL) | | auth_expire_minutes | Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes) |

func (*OrgsWlans) UploadOrgWlanPortalImage 

func (o *OrgsWlans) UploadOrgWlanPortalImage(
	ctx context.Context,
	orgId uuid.UUID,
	wlanId uuid.UUID,
	file models.FileWrapper,
	json *string) (
	*http.Response,
	error)

UploadOrgWlanPortalImage takes context, orgId, wlanId, file, json as parameters and returns an *Response and an error if there was an issue with the request or response. Upload Org WLAN Portal Image

type OrgsWxRules 

type OrgsWxRules struct {
	// contains filtered or unexported fields
}

OrgsWxRules represents a controller struct.

func NewOrgsWxRules 

func NewOrgsWxRules(baseController baseController) *OrgsWxRules

NewOrgsWxRules creates a new instance of OrgsWxRules. It takes a baseController as a parameter and returns a pointer to the OrgsWxRules.

func (*OrgsWxRules) CreateOrgWxRule 

func (o *OrgsWxRules) CreateOrgWxRule(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.WxlanRule) (
	models.ApiResponse[models.WxlanRule],
	error)

CreateOrgWxRule takes context, orgId, body as parameters and returns an models.ApiResponse with models.WxlanRule data and an error if there was an issue with the request or response. Create Org WxRule

func (*OrgsWxRules) DeleteOrgWxRule 

func (o *OrgsWxRules) DeleteOrgWxRule(
	ctx context.Context,
	orgId uuid.UUID,
	wxruleId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgWxRule takes context, orgId, wxruleId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org WxRule

func (*OrgsWxRules) GetOrgWxRule 

func (o *OrgsWxRules) GetOrgWxRule(
	ctx context.Context,
	orgId uuid.UUID,
	wxruleId uuid.UUID) (
	models.ApiResponse[models.WxlanRule],
	error)

GetOrgWxRule takes context, orgId, wxruleId as parameters and returns an models.ApiResponse with models.WxlanRule data and an error if there was an issue with the request or response. Get Org WxRule Details

func (*OrgsWxRules) ListOrgWxRules 

func (o *OrgsWxRules) ListOrgWxRules(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.WxlanRule],
	error)

ListOrgWxRules takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.WxlanRule data and an error if there was an issue with the request or response. Get List of Org WxRules

func (*OrgsWxRules) UpdateOrgWxRule 

func (o *OrgsWxRules) UpdateOrgWxRule(
	ctx context.Context,
	orgId uuid.UUID,
	wxruleId uuid.UUID,
	body *models.WxlanRule) (
	models.ApiResponse[models.WxlanRule],
	error)

UpdateOrgWxRule takes context, orgId, wxruleId, body as parameters and returns an models.ApiResponse with models.WxlanRule data and an error if there was an issue with the request or response. Update Org WxRule

type OrgsWxTags 

type OrgsWxTags struct {
	// contains filtered or unexported fields
}

OrgsWxTags represents a controller struct.

func NewOrgsWxTags 

func NewOrgsWxTags(baseController baseController) *OrgsWxTags

NewOrgsWxTags creates a new instance of OrgsWxTags. It takes a baseController as a parameter and returns a pointer to the OrgsWxTags.

func (*OrgsWxTags) CreateOrgWxTag 

func (o *OrgsWxTags) CreateOrgWxTag(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.WxlanTag) (
	models.ApiResponse[models.WxlanTag],
	error)

CreateOrgWxTag takes context, orgId, body as parameters and returns an models.ApiResponse with models.WxlanTag data and an error if there was an issue with the request or response. Create WxLAN Tag

func (*OrgsWxTags) DeleteOrgWxTag 

func (o *OrgsWxTags) DeleteOrgWxTag(
	ctx context.Context,
	orgId uuid.UUID,
	wxtagId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgWxTag takes context, orgId, wxtagId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete WxLAN Tag

func (*OrgsWxTags) GetOrgApplicationList 

func (o *OrgsWxTags) GetOrgApplicationList(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.SearchWxtagAppsItem],
	error)

GetOrgApplicationList takes context, orgId as parameters and returns an models.ApiResponse with []models.SearchWxtagAppsItem data and an error if there was an issue with the request or response. Get Application List

func (*OrgsWxTags) GetOrgCurrentMatchingClientsOfAWxTag 

func (o *OrgsWxTags) GetOrgCurrentMatchingClientsOfAWxTag(
	ctx context.Context,
	orgId uuid.UUID,
	wxtagId uuid.UUID) (
	models.ApiResponse[[]models.WxtagClient],
	error)

GetOrgCurrentMatchingClientsOfAWxTag takes context, orgId, wxtagId as parameters and returns an models.ApiResponse with []models.WxtagClient data and an error if there was an issue with the request or response. Get Current Matching Clients of a WXLAN Tag

func (*OrgsWxTags) GetOrgWxTag 

func (o *OrgsWxTags) GetOrgWxTag(
	ctx context.Context,
	orgId uuid.UUID,
	wxtagId uuid.UUID) (
	models.ApiResponse[models.WxlanTag],
	error)

GetOrgWxTag takes context, orgId, wxtagId as parameters and returns an models.ApiResponse with models.WxlanTag data and an error if there was an issue with the request or response. Get WxLAN Tag Details

func (*OrgsWxTags) ListOrgWxTags 

func (o *OrgsWxTags) ListOrgWxTags(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.WxlanTag],
	error)

ListOrgWxTags takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.WxlanTag data and an error if there was an issue with the request or response. Get List of Org WxLAN Tags

func (*OrgsWxTags) UpdateOrgWxTag 

func (o *OrgsWxTags) UpdateOrgWxTag(
	ctx context.Context,
	orgId uuid.UUID,
	wxtagId uuid.UUID,
	body *models.WxlanTag) (
	models.ApiResponse[models.WxlanTag],
	error)

UpdateOrgWxTag takes context, orgId, wxtagId, body as parameters and returns an models.ApiResponse with models.WxlanTag data and an error if there was an issue with the request or response. Update WxLAN Tag

type OrgsWxTunnels 

type OrgsWxTunnels struct {
	// contains filtered or unexported fields
}

OrgsWxTunnels represents a controller struct.

func NewOrgsWxTunnels 

func NewOrgsWxTunnels(baseController baseController) *OrgsWxTunnels

NewOrgsWxTunnels creates a new instance of OrgsWxTunnels. It takes a baseController as a parameter and returns a pointer to the OrgsWxTunnels.

func (*OrgsWxTunnels) CreateOrgWxTunnel 

func (o *OrgsWxTunnels) CreateOrgWxTunnel(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.WxlanTunnel) (
	models.ApiResponse[models.WxlanTunnel],
	error)

CreateOrgWxTunnel takes context, orgId, body as parameters and returns an models.ApiResponse with models.WxlanTunnel data and an error if there was an issue with the request or response. Create Org WxAN Tunnel

func (*OrgsWxTunnels) DeleteOrgWxTunnel 

func (o *OrgsWxTunnels) DeleteOrgWxTunnel(
	ctx context.Context,
	orgId uuid.UUID,
	wxtunnelId uuid.UUID) (
	*http.Response,
	error)

DeleteOrgWxTunnel takes context, orgId, wxtunnelId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Org WxLAN Tunnel

func (*OrgsWxTunnels) GetOrgWxTunnel 

func (o *OrgsWxTunnels) GetOrgWxTunnel(
	ctx context.Context,
	orgId uuid.UUID,
	wxtunnelId uuid.UUID) (
	models.ApiResponse[models.WxlanTunnel],
	error)

GetOrgWxTunnel takes context, orgId, wxtunnelId as parameters and returns an models.ApiResponse with models.WxlanTunnel data and an error if there was an issue with the request or response. Get Org WxLAN Tunnel Details

func (*OrgsWxTunnels) ListOrgWxTunnels 

func (o *OrgsWxTunnels) ListOrgWxTunnels(
	ctx context.Context,
	orgId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.WxlanTunnel],
	error)

ListOrgWxTunnels takes context, orgId, limit, page as parameters and returns an models.ApiResponse with []models.WxlanTunnel data and an error if there was an issue with the request or response. Get List of Org WxLAN Tunnels

func (*OrgsWxTunnels) UpdateOrgWxTunnel 

func (o *OrgsWxTunnels) UpdateOrgWxTunnel(
	ctx context.Context,
	orgId uuid.UUID,
	wxtunnelId uuid.UUID,
	body *models.WxlanTunnel) (
	models.ApiResponse[models.WxlanTunnel],
	error)

UpdateOrgWxTunnel takes context, orgId, wxtunnelId, body as parameters and returns an models.ApiResponse with models.WxlanTunnel data and an error if there was an issue with the request or response. Update Org WxLAN Tunnel

type RetryConfiguration 

type RetryConfiguration = https.RetryConfiguration

RetryConfiguration holds the configuration options for the client.

func CreateRetryConfiguration 

func CreateRetryConfiguration(options ...RetryConfigurationOptions) RetryConfiguration

CreateRetryConfiguration creates a new RetryConfiguration with the provided options.

func DefaultRetryConfiguration 

func DefaultRetryConfiguration() RetryConfiguration

DefaultRetryConfiguration returns the default RetryConfiguration for HTTP requests. It also configures various retry options.

type RetryConfigurationOptions 

type RetryConfigurationOptions = https.RetryConfigurationOptions

RetryConfigurationOptions is a function type that modifies the RetryConfiguration.

type SamplesWebhooks added in v0.2.36 

type SamplesWebhooks struct {
	// contains filtered or unexported fields
}

SamplesWebhooks represents a controller struct.

func NewSamplesWebhooks added in v0.2.36 

func NewSamplesWebhooks(baseController baseController) *SamplesWebhooks

NewSamplesWebhooks creates a new instance of SamplesWebhooks. It takes a baseController as a parameter and returns a pointer to the SamplesWebhooks.

func (*SamplesWebhooks) Alarms added in v0.2.36 

func (s *SamplesWebhooks) Alarms(
	ctx context.Context,
	body *models.WebhookAlarms) (
	*http.Response,
	error)

Alarms takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `alarm` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) AssetRaw added in v0.2.36 

func (s *SamplesWebhooks) AssetRaw(
	ctx context.Context,
	body *models.WebhookAssetRaw) (
	*http.Response,
	error)

AssetRaw takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `asset_raw` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages **will be deprecated after 06/30/2024**

func (*SamplesWebhooks) Audits added in v0.2.36 

func (s *SamplesWebhooks) Audits(
	ctx context.Context,
	body *models.WebhookAudits) (
	*http.Response,
	error)

Audits takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `audit` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) ClientInfo added in v0.2.36 

func (s *SamplesWebhooks) ClientInfo(
	ctx context.Context,
	body *models.WebhookClientInfo) (
	*http.Response,
	error)

ClientInfo takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `client-info` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) ClientJoin added in v0.2.36 

func (s *SamplesWebhooks) ClientJoin(
	ctx context.Context,
	body *models.WebhookClientJoin) (
	*http.Response,
	error)

ClientJoin takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `client_join` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) ClientLatency added in v0.2.36 

func (s *SamplesWebhooks) ClientLatency(
	ctx context.Context,
	body *models.WebhookClientLatency) (
	*http.Response,
	error)

ClientLatency takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `client-latency` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) ClientSessions added in v0.2.36 

func (s *SamplesWebhooks) ClientSessions(
	ctx context.Context,
	body *models.WebhookClientSessions) (
	*http.Response,
	error)

ClientSessions takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `client_sessions` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) DeviceEvents added in v0.2.36 

func (s *SamplesWebhooks) DeviceEvents(
	ctx context.Context,
	body *models.WebhookDeviceEvents) (
	*http.Response,
	error)

DeviceEvents takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `device_events` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) DeviceUpDown added in v0.2.36 

func (s *SamplesWebhooks) DeviceUpDown(
	ctx context.Context,
	body *models.WebhookDeviceUpdowns) (
	*http.Response,
	error)

DeviceUpDown takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `device_updowns` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) DiscoveredRawRssi added in v0.2.36 

func (s *SamplesWebhooks) DiscoveredRawRssi(
	ctx context.Context,
	body *models.WebhookDiscoveredRawRssi) (
	*http.Response,
	error)

DiscoveredRawRssi takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `discovered-raw-rssi` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) Location added in v0.2.36 

func (s *SamplesWebhooks) Location(
	ctx context.Context,
	body *models.WebhookLocation) (
	*http.Response,
	error)

Location takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `location` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) LocationAsset added in v0.2.36 

func (s *SamplesWebhooks) LocationAsset(
	ctx context.Context,
	body *models.WebhookLocationAsset) (
	*http.Response,
	error)

LocationAsset takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `location_asset` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) LocationCentrak added in v0.2.36 

func (s *SamplesWebhooks) LocationCentrak(
	ctx context.Context,
	body *models.WebhookLocationCentrak) (
	*http.Response,
	error)

LocationCentrak takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `location_centrak` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) LocationClient added in v0.2.36 

func (s *SamplesWebhooks) LocationClient(
	ctx context.Context,
	body *models.WebhookLocationClient) (
	*http.Response,
	error)

LocationClient takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `location_client` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) LocationSdk added in v0.2.36 

func (s *SamplesWebhooks) LocationSdk(
	ctx context.Context,
	body *models.WebhookLocationSdk) (
	*http.Response,
	error)

LocationSdk takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `location_sdk` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) LocationUnclient added in v0.2.36 

func (s *SamplesWebhooks) LocationUnclient(
	ctx context.Context,
	body *models.WebhookLocationUnclient) (
	*http.Response,
	error)

LocationUnclient takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `location_unclient` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) NacAccounting added in v0.2.36 

func (s *SamplesWebhooks) NacAccounting(
	ctx context.Context,
	body *models.WebhookNacAccounting) (
	*http.Response,
	error)

NacAccounting takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `nac-accounting` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) NacEvents added in v0.2.36 

func (s *SamplesWebhooks) NacEvents(
	ctx context.Context,
	body *models.WebhookNacEvents) (
	*http.Response,
	error)

NacEvents takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Example Delivery of nac_events

func (*SamplesWebhooks) OccupancyAlerts added in v0.2.36 

func (s *SamplesWebhooks) OccupancyAlerts(
	ctx context.Context,
	body *models.WebhookOccupancyAlerts) (
	*http.Response,
	error)

OccupancyAlerts takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `occupancy_alerts` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) Ping added in v0.2.36 

func (s *SamplesWebhooks) Ping(
	ctx context.Context,
	body *models.WebhookPing) (
	*http.Response,
	error)

Ping takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `ping` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) SdkclientScanData added in v0.2.36 

func (s *SamplesWebhooks) SdkclientScanData(
	ctx context.Context,
	body *models.WebhookSdkclientScanData) (
	*http.Response,
	error)

SdkclientScanData takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `sdkclient_scan_data` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) SiteSle added in v0.2.36 

func (s *SamplesWebhooks) SiteSle(
	ctx context.Context,
	body *models.WebhookSiteSle) (
	*http.Response,
	error)

SiteSle takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `site_sle` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

func (*SamplesWebhooks) Zone added in v0.2.36 

func (s *SamplesWebhooks) Zone(
	ctx context.Context,
	body *models.WebhookZone) (
	*http.Response,
	error)

Zone takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Webhook sample for `zone` topic **Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

type SdkLoggerInterface 

type SdkLoggerInterface = logger.SdkLoggerInterface

SdkLoggerInterface holds the configuration options for the client.

type SelfAPIToken 

type SelfAPIToken struct {
	// contains filtered or unexported fields
}

SelfAPIToken represents a controller struct.

func NewSelfAPIToken 

func NewSelfAPIToken(baseController baseController) *SelfAPIToken

NewSelfAPIToken creates a new instance of SelfAPIToken. It takes a baseController as a parameter and returns a pointer to the SelfAPIToken.

func (*SelfAPIToken) CreateApiToken 

func (s *SelfAPIToken) CreateApiToken(
	ctx context.Context,
	body *models.UserApitoken) (
	models.ApiResponse[[]models.UserApitoken],
	error)

CreateApiToken takes context, body as parameters and returns an models.ApiResponse with []models.UserApitoken data and an error if there was an issue with the request or response. Create API Token Note that the key is only available during creation time.

func (*SelfAPIToken) DeleteApiToken 

func (s *SelfAPIToken) DeleteApiToken(
	ctx context.Context,
	apitokenId uuid.UUID) (
	*http.Response,
	error)

DeleteApiToken takes context, apitokenId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete an API Token

func (*SelfAPIToken) GetApiToken 

func (s *SelfAPIToken) GetApiToken(
	ctx context.Context,
	apitokenId uuid.UUID) (
	models.ApiResponse[models.UserApitoken],
	error)

GetApiToken takes context, apitokenId as parameters and returns an models.ApiResponse with models.UserApitoken data and an error if there was an issue with the request or response. Get User API Token

func (*SelfAPIToken) ListApiTokens 

func (s *SelfAPIToken) ListApiTokens(ctx context.Context) (
	models.ApiResponse[[]models.UserApitoken],
	error)

ListApiTokens takes context as parameters and returns an models.ApiResponse with []models.UserApitoken data and an error if there was an issue with the request or response. Get List of Current User API Tokens

func (*SelfAPIToken) UpdateApiToken 

func (s *SelfAPIToken) UpdateApiToken(
	ctx context.Context,
	apitokenId uuid.UUID,
	body *models.UserApitoken) (
	models.ApiResponse[models.UserApitoken],
	error)

UpdateApiToken takes context, apitokenId, body as parameters and returns an models.ApiResponse with models.UserApitoken data and an error if there was an issue with the request or response. Update User API Token

type SelfAccount 

type SelfAccount struct {
	// contains filtered or unexported fields
}

SelfAccount represents a controller struct.

func NewSelfAccount 

func NewSelfAccount(baseController baseController) *SelfAccount

NewSelfAccount creates a new instance of SelfAccount. It takes a baseController as a parameter and returns a pointer to the SelfAccount.

func (*SelfAccount) DeleteSelf 

func (s *SelfAccount) DeleteSelf(ctx context.Context) (
	*http.Response,
	error)

DeleteSelf takes context as parameters and returns an *Response and an error if there was an issue with the request or response. To delete ones account and every associated with it. The effects: the account would be deleted any orphaned Org (that only has this account as admin) will be deleted along with all data with Org (sites, wlans, devices) will be gone.

func (*SelfAccount) GetSelf 

func (s *SelfAccount) GetSelf(ctx context.Context) (
	models.ApiResponse[models.Admin],
	error)

GetSelf takes context as parameters and returns an models.ApiResponse with models.Admin data and an error if there was an issue with the request or response. Get ‘whoami’ and privileges (which org and which sites I have access to)

func (*SelfAccount) UpdateSelf 

func (s *SelfAccount) UpdateSelf(
	ctx context.Context,
	body *models.Admin) (
	models.ApiResponse[models.Admin],
	error)

UpdateSelf takes context, body as parameters and returns an models.ApiResponse with models.Admin data and an error if there was an issue with the request or response. update Account Information

func (*SelfAccount) UpdateSelfEmail 

func (s *SelfAccount) UpdateSelfEmail(
	ctx context.Context,
	body *models.EmailString) (
	*http.Response,
	error)

UpdateSelfEmail takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Change Email We require the user to verify that they actually own the email address they intend to change it to. After the API call, the user will receive an email to the new email address with a link like https://manage.mist.com/verify/update?expire=:exp_time&email=:admin_email&token=:token Upon clicking the link, the user is provided with a login page to authenticate using existing credentials. After successful login, the email address of the user gets updated **Note**: The request parameter email can be used by UI to validate that the current session (if any) belongs to the admin or provide a login page (by pre-populating the email on login screen). UI can also use the request parameter expire to validate token expiry.

func (*SelfAccount) VerifySelfEmail 

func (s *SelfAccount) VerifySelfEmail(
	ctx context.Context,
	token string) (
	*http.Response,
	error)

VerifySelfEmail takes context, token as parameters and returns an *Response and an error if there was an issue with the request or response. Verify Email change

type SelfAlarms 

type SelfAlarms struct {
	// contains filtered or unexported fields
}

SelfAlarms represents a controller struct.

func NewSelfAlarms 

func NewSelfAlarms(baseController baseController) *SelfAlarms

NewSelfAlarms creates a new instance of SelfAlarms. It takes a baseController as a parameter and returns a pointer to the SelfAlarms.

func (*SelfAlarms) ListAlarmSubscriptions 

func (s *SelfAlarms) ListAlarmSubscriptions(ctx context.Context) (
	models.ApiResponse[[]models.ResponseSelfSubscription],
	error)

ListAlarmSubscriptions takes context as parameters and returns an models.ApiResponse with []models.ResponseSelfSubscription data and an error if there was an issue with the request or response. Get List of all the subscriptions

type SelfAuditLogs 

type SelfAuditLogs struct {
	// contains filtered or unexported fields
}

SelfAuditLogs represents a controller struct.

func NewSelfAuditLogs 

func NewSelfAuditLogs(baseController baseController) *SelfAuditLogs

NewSelfAuditLogs creates a new instance of SelfAuditLogs. It takes a baseController as a parameter and returns a pointer to the SelfAuditLogs.

func (*SelfAuditLogs) ListSelfAuditLogs 

func (s *SelfAuditLogs) ListSelfAuditLogs(
	ctx context.Context,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseSelfAuditLogs],
	error)

ListSelfAuditLogs takes context, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponseSelfAuditLogs data and an error if there was an issue with the request or response. Get List of change logs across all Orgs for current admin Audit logs records all administrative activities done by current admin across all orgs

type SelfMFA 

type SelfMFA struct {
	// contains filtered or unexported fields
}

SelfMFA represents a controller struct.

func NewSelfMFA 

func NewSelfMFA(baseController baseController) *SelfMFA

NewSelfMFA creates a new instance of SelfMFA. It takes a baseController as a parameter and returns a pointer to the SelfMFA.

func (*SelfMFA) GenerateSecretFor2faVerification 

func (s *SelfMFA) GenerateSecretFor2faVerification(
	ctx context.Context,
	by *models.MfaSecretTypeEnum) (
	models.ApiResponse[models.ResponseTwoFactorJson],
	error)

GenerateSecretFor2faVerification takes context, by as parameters and returns an models.ApiResponse with models.ResponseTwoFactorJson data and an error if there was an issue with the request or response. Generate Secret Key for 2FA verification

func (*SelfMFA) VerifyTwoFactor 

func (s *SelfMFA) VerifyTwoFactor(
	ctx context.Context,
	body *models.TwoFactorCode) (
	*http.Response,
	error)

VerifyTwoFactor takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Verify Two-factor (OTP) To verify two-factor authentication by using a code generated by app (e.g. Google Authenticator, Authy). Upon successful verification, the `two_factor_passed` will be set to true if it hasn’t already been.

type SelfOAuth2 

type SelfOAuth2 struct {
	// contains filtered or unexported fields
}

SelfOAuth2 represents a controller struct.

func NewSelfOAuth2 

func NewSelfOAuth2(baseController baseController) *SelfOAuth2

NewSelfOAuth2 creates a new instance of SelfOAuth2. It takes a baseController as a parameter and returns a pointer to the SelfOAuth2.

func (*SelfOAuth2) GetOauth2UrlForLinking 

func (s *SelfOAuth2) GetOauth2UrlForLinking(
	ctx context.Context,
	provider string,
	forward *string) (
	models.ApiResponse[models.ResponseSelfOauthUrl],
	error)

GetOauth2UrlForLinking takes context, provider, forward as parameters and returns an models.ApiResponse with models.ResponseSelfOauthUrl data and an error if there was an issue with the request or response. Obtain Authorization URL for Linking

func (*SelfOAuth2) LinkOauth2MistAccount 

func (s *SelfOAuth2) LinkOauth2MistAccount(
	ctx context.Context,
	provider string,
	body *models.CodeString) (
	models.ApiResponse[models.ResponseSelfOauthLinkSuccess],
	error)

LinkOauth2MistAccount takes context, provider, body as parameters and returns an models.ApiResponse with models.ResponseSelfOauthLinkSuccess data and an error if there was an issue with the request or response. Link Mist account with an OAuth2 Provider

type Server 

type Server string

Server represents available servers. 

const (
	APIHOST Server = "API Host"
)

type Sites 

type Sites struct {
	// contains filtered or unexported fields
}

Sites represents a controller struct.

func NewSites 

func NewSites(baseController baseController) *Sites

NewSites creates a new instance of Sites. It takes a baseController as a parameter and returns a pointer to the Sites.

func (*Sites) DeleteSite 

func (s *Sites) DeleteSite(
	ctx context.Context,
	siteId uuid.UUID) (
	*http.Response,
	error)

DeleteSite takes context, siteId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site

func (*Sites) GetSiteInfo 

func (s *Sites) GetSiteInfo(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.Site],
	error)

GetSiteInfo takes context, siteId as parameters and returns an models.ApiResponse with models.Site data and an error if there was an issue with the request or response. Get Site Info

func (*Sites) UpdateSiteInfo 

func (s *Sites) UpdateSiteInfo(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.Site) (
	models.ApiResponse[models.Site],
	error)

UpdateSiteInfo takes context, siteId, body as parameters and returns an models.ApiResponse with models.Site data and an error if there was an issue with the request or response. Update Site Info

type SitesAPTemplates 

type SitesAPTemplates struct {
	// contains filtered or unexported fields
}

SitesAPTemplates represents a controller struct.

func NewSitesAPTemplates 

func NewSitesAPTemplates(baseController baseController) *SitesAPTemplates

NewSitesAPTemplates creates a new instance of SitesAPTemplates. It takes a baseController as a parameter and returns a pointer to the SitesAPTemplates.

func (*SitesAPTemplates) ListSiteApTemplateDerived added in v0.3.17 

func (s *SitesAPTemplates) ListSiteApTemplateDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool) (
	models.ApiResponse[[]models.ApTemplate],
	error)

ListSiteApTemplateDerived takes context, siteId, resolve as parameters and returns an models.ApiResponse with []models.ApTemplate data and an error if there was an issue with the request or response. Get derived AP Templates for Site

type SitesAlarms 

type SitesAlarms struct {
	// contains filtered or unexported fields
}

SitesAlarms represents a controller struct.

func NewSitesAlarms 

func NewSitesAlarms(baseController baseController) *SitesAlarms

NewSitesAlarms creates a new instance of SitesAlarms. It takes a baseController as a parameter and returns a pointer to the SitesAlarms.

func (*SitesAlarms) AckSiteAlarm 

func (s *SitesAlarms) AckSiteAlarm(
	ctx context.Context,
	siteId uuid.UUID,
	alarmId uuid.UUID,
	body *models.NoteString) (
	*http.Response,
	error)

AckSiteAlarm takes context, siteId, alarmId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Ack Site Alarm

func (*SitesAlarms) AckSiteAllAlarms 

func (s *SitesAlarms) AckSiteAllAlarms(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.NoteString) (
	*http.Response,
	error)

AckSiteAllAlarms takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Ack all Site Alarms **N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.

func (*SitesAlarms) AckSiteMultipleAlarms 

func (s *SitesAlarms) AckSiteMultipleAlarms(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.AlarmAck) (
	*http.Response,
	error)

AckSiteMultipleAlarms takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Ack multiple Site Alarms

func (*SitesAlarms) CountSiteAlarms 

func (s *SitesAlarms) CountSiteAlarms(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.AlarmCountDisctinctEnum,
	ackAdminName *string,
	acked *bool,
	mType *string,
	severity *string,
	group *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteAlarms takes context, siteId, distinct, ackAdminName, acked, mType, severity, group, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Site Alarms

func (*SitesAlarms) SearchSiteAlarms 

func (s *SitesAlarms) SearchSiteAlarms(
	ctx context.Context,
	siteId uuid.UUID,
	mType *string,
	ackAdminName *string,
	acked *bool,
	severity *string,
	group *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.AlarmSearchResult],
	error)

SearchSiteAlarms takes context, siteId, mType, ackAdminName, acked, severity, group, limit, start, end, duration as parameters and returns an models.ApiResponse with models.AlarmSearchResult data and an error if there was an issue with the request or response. Search Site Alarms

func (*SitesAlarms) SubscribeSiteAlarms 

func (s *SitesAlarms) SubscribeSiteAlarms(
	ctx context.Context,
	siteId uuid.UUID) (
	*http.Response,
	error)

SubscribeSiteAlarms takes context, siteId as parameters and returns an *Response and an error if there was an issue with the request or response. Subscribe to Site Alarms

func (*SitesAlarms) UnackSiteAlarm 

func (s *SitesAlarms) UnackSiteAlarm(
	ctx context.Context,
	siteId uuid.UUID,
	alarmId uuid.UUID,
	body *models.NoteString) (
	*http.Response,
	error)

UnackSiteAlarm takes context, siteId, alarmId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Unack Site Alarm

func (*SitesAlarms) UnackSiteAllArlarms 

func (s *SitesAlarms) UnackSiteAllArlarms(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.NoteString) (
	*http.Response,
	error)

UnackSiteAllArlarms takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Unack all Site Alarms **N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.

func (*SitesAlarms) UnackSiteMultipleAlarms 

func (s *SitesAlarms) UnackSiteMultipleAlarms(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.AlarmAck) (
	*http.Response,
	error)

UnackSiteMultipleAlarms takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Unack multiple Site Alarms

func (*SitesAlarms) UnsubscribeSiteAlarms 

func (s *SitesAlarms) UnsubscribeSiteAlarms(
	ctx context.Context,
	siteId uuid.UUID) (
	*http.Response,
	error)

UnsubscribeSiteAlarms takes context, siteId as parameters and returns an *Response and an error if there was an issue with the request or response. Unsubscribe to Site Alarms

type SitesAnomaly 

type SitesAnomaly struct {
	// contains filtered or unexported fields
}

SitesAnomaly represents a controller struct.

func NewSitesAnomaly 

func NewSitesAnomaly(baseController baseController) *SitesAnomaly

NewSitesAnomaly creates a new instance of SitesAnomaly. It takes a baseController as a parameter and returns a pointer to the SitesAnomaly.

func (*SitesAnomaly) GetSiteAnomalyEvents 

func (s *SitesAnomaly) GetSiteAnomalyEvents(
	ctx context.Context,
	siteId uuid.UUID,
	metric string) (
	models.ApiResponse[models.ResponseAnomalySearch],
	error)

GetSiteAnomalyEvents takes context, siteId, metric as parameters and returns an models.ApiResponse with models.ResponseAnomalySearch data and an error if there was an issue with the request or response. Get Site Anomaly Events

func (*SitesAnomaly) GetSiteAnomalyEventsForClient 

func (s *SitesAnomaly) GetSiteAnomalyEventsForClient(
	ctx context.Context,
	siteId uuid.UUID,
	clientMac string,
	metric string) (
	models.ApiResponse[models.ResponseAnomalySearch],
	error)

GetSiteAnomalyEventsForClient takes context, siteId, clientMac, metric as parameters and returns an models.ApiResponse with models.ResponseAnomalySearch data and an error if there was an issue with the request or response. Get Client Anomaly Events

func (*SitesAnomaly) GetSiteAnomalyEventsforDevice 

func (s *SitesAnomaly) GetSiteAnomalyEventsforDevice(
	ctx context.Context,
	siteId uuid.UUID,
	metric string,
	deviceMac string) (
	models.ApiResponse[models.ResponseAnomalySearch],
	error)

GetSiteAnomalyEventsforDevice takes context, siteId, metric, deviceMac as parameters and returns an models.ApiResponse with models.ResponseAnomalySearch data and an error if there was an issue with the request or response. Get Device Anomaly Events

type SitesApplications 

type SitesApplications struct {
	// contains filtered or unexported fields
}

SitesApplications represents a controller struct.

func NewSitesApplications 

func NewSitesApplications(baseController baseController) *SitesApplications

NewSitesApplications creates a new instance of SitesApplications. It takes a baseController as a parameter and returns a pointer to the SitesApplications.

func (*SitesApplications) ListSiteApps 

func (s *SitesApplications) ListSiteApps(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[[]models.SiteApp],
	error)

ListSiteApps takes context, siteId as parameters and returns an models.ApiResponse with []models.SiteApp data and an error if there was an issue with the request or response. Get List of Site Applications

type SitesAssetFilters 

type SitesAssetFilters struct {
	// contains filtered or unexported fields
}

SitesAssetFilters represents a controller struct.

func NewSitesAssetFilters 

func NewSitesAssetFilters(baseController baseController) *SitesAssetFilters

NewSitesAssetFilters creates a new instance of SitesAssetFilters. It takes a baseController as a parameter and returns a pointer to the SitesAssetFilters.

func (*SitesAssetFilters) CreateSiteAssetFilters 

func (s *SitesAssetFilters) CreateSiteAssetFilters(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.AssetFilter) (
	models.ApiResponse[models.AssetFilter],
	error)

CreateSiteAssetFilters takes context, siteId, body as parameters and returns an models.ApiResponse with models.AssetFilter data and an error if there was an issue with the request or response. Create Site Asset Filter

func (*SitesAssetFilters) DeleteSiteAssetFilter 

func (s *SitesAssetFilters) DeleteSiteAssetFilter(
	ctx context.Context,
	siteId uuid.UUID,
	assetfilterId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteAssetFilter takes context, siteId, assetfilterId as parameters and returns an *Response and an error if there was an issue with the request or response. Deletes an existing BLE asset filter for the given site.

func (*SitesAssetFilters) GetSiteAssetFilter 

func (s *SitesAssetFilters) GetSiteAssetFilter(
	ctx context.Context,
	siteId uuid.UUID,
	assetfilterId uuid.UUID) (
	models.ApiResponse[models.AssetFilter],
	error)

GetSiteAssetFilter takes context, siteId, assetfilterId as parameters and returns an models.ApiResponse with models.AssetFilter data and an error if there was an issue with the request or response. Get Site Asset Filter Details

func (*SitesAssetFilters) ListSiteAssetFilters 

func (s *SitesAssetFilters) ListSiteAssetFilters(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.AssetFilter],
	error)

ListSiteAssetFilters takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.AssetFilter data and an error if there was an issue with the request or response. Get List of Site Asset Filters

func (*SitesAssetFilters) UpdateSiteAssetFilter 

func (s *SitesAssetFilters) UpdateSiteAssetFilter(
	ctx context.Context,
	siteId uuid.UUID,
	assetfilterId uuid.UUID,
	body *models.AssetFilter) (
	models.ApiResponse[models.AssetFilter],
	error)

UpdateSiteAssetFilter takes context, siteId, assetfilterId, body as parameters and returns an models.ApiResponse with models.AssetFilter data and an error if there was an issue with the request or response. Updates an existing BLE asset filter for the given site.

type SitesAssets 

type SitesAssets struct {
	// contains filtered or unexported fields
}

SitesAssets represents a controller struct.

func NewSitesAssets 

func NewSitesAssets(baseController baseController) *SitesAssets

NewSitesAssets creates a new instance of SitesAssets. It takes a baseController as a parameter and returns a pointer to the SitesAssets.

func (*SitesAssets) CreateSiteAsset 

func (s *SitesAssets) CreateSiteAsset(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.Asset) (
	models.ApiResponse[models.Asset],
	error)

CreateSiteAsset takes context, siteId, body as parameters and returns an models.ApiResponse with models.Asset data and an error if there was an issue with the request or response. Create Site Asset

func (*SitesAssets) DeleteSiteAsset 

func (s *SitesAssets) DeleteSiteAsset(
	ctx context.Context,
	siteId uuid.UUID,
	assetId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteAsset takes context, siteId, assetId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site Asset

func (*SitesAssets) GetSiteAsset 

func (s *SitesAssets) GetSiteAsset(
	ctx context.Context,
	siteId uuid.UUID,
	assetId uuid.UUID) (
	models.ApiResponse[models.Asset],
	error)

GetSiteAsset takes context, siteId, assetId as parameters and returns an models.ApiResponse with models.Asset data and an error if there was an issue with the request or response. Get Site Asset Details

func (*SitesAssets) ImportSiteAssets 

func (s *SitesAssets) ImportSiteAssets(
	ctx context.Context,
	siteId uuid.UUID,
	upsert *models.ImportSiteAssetsUpsertEnum,
	file *models.FileWrapper) (
	*http.Response,
	error)

ImportSiteAssets takes context, siteId, upsert, file as parameters and returns an *Response and an error if there was an issue with the request or response. Impert Site Assets. It can be done via a CSV file or a JSON payload. ## CSV File Format ```csv name,mac "asset_name",5c5b53010101 ```

func (*SitesAssets) ListSiteAssets 

func (s *SitesAssets) ListSiteAssets(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Asset],
	error)

ListSiteAssets takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.Asset data and an error if there was an issue with the request or response. Get List of Site Assets

func (*SitesAssets) UpdateSiteAsset 

func (s *SitesAssets) UpdateSiteAsset(
	ctx context.Context,
	siteId uuid.UUID,
	assetId uuid.UUID,
	body *models.Asset) (
	models.ApiResponse[models.Asset],
	error)

UpdateSiteAsset takes context, siteId, assetId, body as parameters and returns an models.ApiResponse with models.Asset data and an error if there was an issue with the request or response. Update Site Asset

type SitesBeacons 

type SitesBeacons struct {
	// contains filtered or unexported fields
}

SitesBeacons represents a controller struct.

func NewSitesBeacons 

func NewSitesBeacons(baseController baseController) *SitesBeacons

NewSitesBeacons creates a new instance of SitesBeacons. It takes a baseController as a parameter and returns a pointer to the SitesBeacons.

func (*SitesBeacons) CreateSiteBeacon 

func (s *SitesBeacons) CreateSiteBeacon(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.Beacon) (
	models.ApiResponse[models.Beacon],
	error)

CreateSiteBeacon takes context, siteId, body as parameters and returns an models.ApiResponse with models.Beacon data and an error if there was an issue with the request or response. Create Site Beacon

func (*SitesBeacons) DeleteSiteBeacons 

func (s *SitesBeacons) DeleteSiteBeacons(
	ctx context.Context,
	siteId uuid.UUID,
	beaconId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteBeacons takes context, siteId, beaconId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site Beacon

func (*SitesBeacons) GetSiteBeacon 

func (s *SitesBeacons) GetSiteBeacon(
	ctx context.Context,
	siteId uuid.UUID,
	beaconId uuid.UUID) (
	models.ApiResponse[models.Beacon],
	error)

GetSiteBeacon takes context, siteId, beaconId as parameters and returns an models.ApiResponse with models.Beacon data and an error if there was an issue with the request or response. Get Site Beacon Details

func (*SitesBeacons) ListSiteBeacons 

func (s *SitesBeacons) ListSiteBeacons(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Beacon],
	error)

ListSiteBeacons takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.Beacon data and an error if there was an issue with the request or response. Get List of Site Beacons

func (*SitesBeacons) UpdateSiteBeacons 

func (s *SitesBeacons) UpdateSiteBeacons(
	ctx context.Context,
	siteId uuid.UUID,
	beaconId uuid.UUID,
	body *models.Beacon) (
	models.ApiResponse[models.Beacon],
	error)

UpdateSiteBeacons takes context, siteId, beaconId, body as parameters and returns an models.ApiResponse with models.Beacon data and an error if there was an issue with the request or response. Update Site Beacon

type SitesClientsNAC 

type SitesClientsNAC struct {
	// contains filtered or unexported fields
}

SitesClientsNAC represents a controller struct.

func NewSitesClientsNAC 

func NewSitesClientsNAC(baseController baseController) *SitesClientsNAC

NewSitesClientsNAC creates a new instance of SitesClientsNAC. It takes a baseController as a parameter and returns a pointer to the SitesClientsNAC.

func (*SitesClientsNAC) CountSiteNacClientEvents 

func (s *SitesClientsNAC) CountSiteNacClientEvents(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteNacClientEventsCountDistinctEnum,
	mType *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteNacClientEvents takes context, siteId, distinct, mType, start, end, duration, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of NAC Client-Events

func (*SitesClientsNAC) CountSiteNacClients 

func (s *SitesClientsNAC) CountSiteNacClients(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteNacClientsCountDistinctEnum,
	lastNacruleId *string,
	nacruleMatched *bool,
	authType *string,
	lastVlanId *string,
	lastNasVendor *string,
	idpId *string,
	lastSsid *string,
	lastUsername *string,
	timestamp *float64,
	lastAp *string,
	mac *string,
	lastStatus *string,
	mType *string,
	mdmComplianceStatus *string,
	mdmProvider *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteNacClients takes context, siteId, distinct, lastNacruleId, nacruleMatched, authType, lastVlanId, lastNasVendor, idpId, lastSsid, lastUsername, timestamp, lastAp, mac, lastStatus, mType, mdmComplianceStatus, mdmProvider, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of NAC Clients

func (*SitesClientsNAC) SearchSiteNacClientEvents added in v0.2.18 

func (s *SitesClientsNAC) SearchSiteNacClientEvents(
	ctx context.Context,
	siteId uuid.UUID,
	mType *string,
	nacruleId *uuid.UUID,
	nacruleMatched *bool,
	dryrunNacruleId *string,
	dryrunNacruleMatched *bool,
	authType *string,
	vlan *int,
	nasVendor *string,
	bssid *string,
	idpId *uuid.UUID,
	idpRole *string,
	idpUsername *string,
	respAttrs []string,
	ssid *string,
	username *string,
	ap *string,
	randomMac *bool,
	mac *string,
	timestamp *float64,
	usermacLabel *string,
	text *string,
	nasIp *string,
	sort *string,
	ingressVlan *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.ResponseEventsNacClientSearch],
	error)

SearchSiteNacClientEvents takes context, siteId, mType, nacruleId, nacruleMatched, dryrunNacruleId, dryrunNacruleMatched, authType, vlan, nasVendor, bssid, idpId, idpRole, idpUsername, respAttrs, ssid, username, ap, randomMac, mac, timestamp, usermacLabel, text, nasIp, sort, ingressVlan, start, end, duration, limit as parameters and returns an models.ApiResponse with models.ResponseEventsNacClientSearch data and an error if there was an issue with the request or response. Search NAC Client Events

func (*SitesClientsNAC) SearchSiteNacClients 

func (s *SitesClientsNAC) SearchSiteNacClients(
	ctx context.Context,
	siteId uuid.UUID,
	nacruleId *string,
	nacruleMatched *bool,
	authType *string,
	vlan *string,
	nasVendor *string,
	idpId *string,
	ssid *string,
	username *string,
	timestamp *float64,
	ap *string,
	mac *string,
	mxedgeId *string,
	nacruleName *string,
	status *string,
	mType *string,
	mdmCompliance *string,
	mdmProvider *string,
	sort *string,
	ingressVlan *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseClientNacSearch],
	error)

SearchSiteNacClients takes context, siteId, nacruleId, nacruleMatched, authType, vlan, nasVendor, idpId, ssid, username, timestamp, ap, mac, mxedgeId, nacruleName, status, mType, mdmCompliance, mdmProvider, sort, ingressVlan, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponseClientNacSearch data and an error if there was an issue with the request or response. Search Site NAC Clients

type SitesClientsWan 

type SitesClientsWan struct {
	// contains filtered or unexported fields
}

SitesClientsWan represents a controller struct.

func NewSitesClientsWan 

func NewSitesClientsWan(baseController baseController) *SitesClientsWan

NewSitesClientsWan creates a new instance of SitesClientsWan. It takes a baseController as a parameter and returns a pointer to the SitesClientsWan.

func (*SitesClientsWan) CountSiteWanClientEvents 

func (s *SitesClientsWan) CountSiteWanClientEvents(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteWanClientEventsDistinctEnum,
	mType *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteWanClientEvents takes context, siteId, distinct, mType, start, end, duration, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Site WAN Client-Events

func (*SitesClientsWan) CountSiteWanClients 

func (s *SitesClientsWan) CountSiteWanClients(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteWanClientsCountDistinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteWanClients takes context, siteId, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Site WAN Clients

func (*SitesClientsWan) SearchSiteWanClientEvents 

func (s *SitesClientsWan) SearchSiteWanClientEvents(
	ctx context.Context,
	siteId uuid.UUID,
	mType *string,
	mac *string,
	hostname *string,
	ip *string,
	mfg *string,
	nacruleId *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.SearchEventsWanClient],
	error)

SearchSiteWanClientEvents takes context, siteId, mType, mac, hostname, ip, mfg, nacruleId, start, end, duration, limit as parameters and returns an models.ApiResponse with models.SearchEventsWanClient data and an error if there was an issue with the request or response. Search Site WAN Client Events

func (*SitesClientsWan) SearchSiteWanClients 

func (s *SitesClientsWan) SearchSiteWanClients(
	ctx context.Context,
	siteId uuid.UUID,
	mac *string,
	hostname *string,
	ip *string,
	mfg *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.SearchWanClient],
	error)

SearchSiteWanClients takes context, siteId, mac, hostname, ip, mfg, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.SearchWanClient data and an error if there was an issue with the request or response. Search Site WAN Clients

type SitesClientsWired 

type SitesClientsWired struct {
	// contains filtered or unexported fields
}

SitesClientsWired represents a controller struct.

func NewSitesClientsWired 

func NewSitesClientsWired(baseController baseController) *SitesClientsWired

NewSitesClientsWired creates a new instance of SitesClientsWired. It takes a baseController as a parameter and returns a pointer to the SitesClientsWired.

func (*SitesClientsWired) CountSiteWiredClients 

func (s *SitesClientsWired) CountSiteWiredClients(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteWiredClientsCountDistinctEnum,
	mac *string,
	deviceMac *string,
	portId *string,
	vlan *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteWiredClients takes context, siteId, distinct, mac, deviceMac, portId, vlan, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Clients

func (*SitesClientsWired) SearchSiteWiredClients 

func (s *SitesClientsWired) SearchSiteWiredClients(
	ctx context.Context,
	siteId uuid.UUID,
	deviceMac *string,
	mac *string,
	ip *string,
	portId *string,
	vlan *string,
	manufacture *string,
	text *string,
	nacruleId *string,
	dhcpHostname *string,
	dhcpFqdn *string,
	dhcpClientIdentifier *string,
	dhcpVendorClassIdentifier *string,
	dhcpRequestParams *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.SearchWiredClient],
	error)

SearchSiteWiredClients takes context, siteId, deviceMac, mac, ip, portId, vlan, manufacture, text, nacruleId, dhcpHostname, dhcpFqdn, dhcpClientIdentifier, dhcpVendorClassIdentifier, dhcpRequestParams, limit, start, end, duration as parameters and returns an models.ApiResponse with models.SearchWiredClient data and an error if there was an issue with the request or response. Search Wired Clients

type SitesClientsWireless 

type SitesClientsWireless struct {
	// contains filtered or unexported fields
}

SitesClientsWireless represents a controller struct.

func NewSitesClientsWireless 

func NewSitesClientsWireless(baseController baseController) *SitesClientsWireless

NewSitesClientsWireless creates a new instance of SitesClientsWireless. It takes a baseController as a parameter and returns a pointer to the SitesClientsWireless.

func (*SitesClientsWireless) CountSiteWirelessClientEvents 

func (s *SitesClientsWireless) CountSiteWirelessClientEvents(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteClientEventsCountDistinctEnum,
	mType *string,
	reasonCode *int,
	ssid *string,
	ap *string,
	proto *models.Dot11ProtoEnum,
	band *models.Dot11BandEnum,
	wlanId *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteWirelessClientEvents takes context, siteId, distinct, mType, reasonCode, ssid, ap, proto, band, wlanId, limit, start, end, duration as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Client-Events

func (*SitesClientsWireless) CountSiteWirelessClientSessions 

func (s *SitesClientsWireless) CountSiteWirelessClientSessions(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteClientSessionsCountDistinctEnum,
	ap *string,
	band *models.Dot11BandEnum,
	clientFamily *string,
	clientManufacture *string,
	clientModel *string,
	clientOs *string,
	ssid *string,
	wlanId *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteWirelessClientSessions takes context, siteId, distinct, ap, band, clientFamily, clientManufacture, clientModel, clientOs, ssid, wlanId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Client Sessions

func (*SitesClientsWireless) CountSiteWirelessClients 

func (s *SitesClientsWireless) CountSiteWirelessClients(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteClientsCountDistinctEnum,
	ssid *string,
	ap *string,
	ipAddress *string,
	vlan *string,
	hostname *string,
	os *string,
	model *string,
	device *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteWirelessClients takes context, siteId, distinct, ssid, ap, ipAddress, vlan, hostname, os, model, device, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Clients

func (*SitesClientsWireless) GetSiteEventsForClient 

func (s *SitesClientsWireless) GetSiteEventsForClient(
	ctx context.Context,
	siteId uuid.UUID,
	clientMac string,
	mType *string,
	proto *models.Dot11ProtoEnum,
	band *models.Dot11BandEnum,
	channel *string,
	wlanId *string,
	ssid *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseClientEventsSearch],
	error)

GetSiteEventsForClient takes context, siteId, clientMac, mType, proto, band, channel, wlanId, ssid, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponseClientEventsSearch data and an error if there was an issue with the request or response. Get the list of events for a specific client

func (*SitesClientsWireless) SearchSiteWirelessClientEvents 

func (s *SitesClientsWireless) SearchSiteWirelessClientEvents(
	ctx context.Context,
	siteId uuid.UUID,
	mType *string,
	reasonCode *int,
	ssid *string,
	ap *string,
	proto *models.Dot11ProtoEnum,
	band *models.Dot11BandEnum,
	wlanId *string,
	nacruleId *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseEventsSearch],
	error)

SearchSiteWirelessClientEvents takes context, siteId, mType, reasonCode, ssid, ap, proto, band, wlanId, nacruleId, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseEventsSearch data and an error if there was an issue with the request or response. Get Site Clients Events

func (*SitesClientsWireless) SearchSiteWirelessClientSessions 

func (s *SitesClientsWireless) SearchSiteWirelessClientSessions(
	ctx context.Context,
	siteId uuid.UUID,
	ap *string,
	band *models.Dot11BandEnum,
	clientFamily *string,
	clientManufacture *string,
	clientModel *string,
	clientUsername *string,
	clientOs *string,
	ssid *string,
	wlanId *string,
	pskId *string,
	pskName *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseClientSessionsSearch],
	error)

SearchSiteWirelessClientSessions takes context, siteId, ap, band, clientFamily, clientManufacture, clientModel, clientUsername, clientOs, ssid, wlanId, pskId, pskName, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseClientSessionsSearch data and an error if there was an issue with the request or response. Search Client Sessions

func (*SitesClientsWireless) SearchSiteWirelessClients 

func (s *SitesClientsWireless) SearchSiteWirelessClients(
	ctx context.Context,
	siteId uuid.UUID,
	mac *string,
	ipAddress *string,
	hostname *string,
	device *string,
	os *string,
	model *string,
	ap *string,
	ssid *string,
	text *string,
	nacruleId *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseClientSearch],
	error)

SearchSiteWirelessClients takes context, siteId, mac, ipAddress, hostname, device, os, model, ap, ssid, text, nacruleId, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseClientSearch data and an error if there was an issue with the request or response. Search Wireless Clients **NOTE**: fuzzy logic can be used with ‘*’, supported filters: mac, hostname, device, os, model. E.g. /clients/search?device=Mac*&hostname=jerry

type SitesDeviceProfiles 

type SitesDeviceProfiles struct {
	// contains filtered or unexported fields
}

SitesDeviceProfiles represents a controller struct.

func NewSitesDeviceProfiles 

func NewSitesDeviceProfiles(baseController baseController) *SitesDeviceProfiles

NewSitesDeviceProfiles creates a new instance of SitesDeviceProfiles. It takes a baseController as a parameter and returns a pointer to the SitesDeviceProfiles.

func (*SitesDeviceProfiles) ListSiteDeviceProfilesDerived 

func (s *SitesDeviceProfiles) ListSiteDeviceProfilesDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool) (
	models.ApiResponse[[]models.Deviceprofile],
	error)

ListSiteDeviceProfilesDerived takes context, siteId, resolve as parameters and returns an models.ApiResponse with []models.Deviceprofile data and an error if there was an issue with the request or response. Retrieves the list of Device Profiles available for the Site

type SitesDevices 

type SitesDevices struct {
	// contains filtered or unexported fields
}

SitesDevices represents a controller struct.

func NewSitesDevices 

func NewSitesDevices(baseController baseController) *SitesDevices

NewSitesDevices creates a new instance of SitesDevices. It takes a baseController as a parameter and returns a pointer to the SitesDevices.

func (*SitesDevices) AddSiteDeviceImage 

func (s *SitesDevices) AddSiteDeviceImage(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	imageNumber int,
	file models.FileWrapper,
	json *string) (
	*http.Response,
	error)

AddSiteDeviceImage takes context, siteId, deviceId, imageNumber, file, json as parameters and returns an *Response and an error if there was an issue with the request or response. Attach up to 3 images to a device

func (*SitesDevices) CountSiteDeviceConfigHistory 

func (s *SitesDevices) CountSiteDeviceConfigHistory(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *string,
	mac *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteDeviceConfigHistory takes context, siteId, distinct, mac, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Counts the number of entries in device config history for distinct field with given filters

func (*SitesDevices) CountSiteDeviceEvents 

func (s *SitesDevices) CountSiteDeviceEvents(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteDeviceEventsCountDistinctEnum,
	model *string,
	mType *string,
	typeCode *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteDeviceEvents takes context, siteId, distinct, model, mType, typeCode, limit, start, end, duration as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Counts the number of entries in ap events history for distinct field with given filters

func (*SitesDevices) CountSiteDeviceLastConfig 

func (s *SitesDevices) CountSiteDeviceLastConfig(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteDeviceLastConfigCountDistinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteDeviceLastConfig takes context, siteId, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Counts the number of entries in device config history for distinct field with given filters

func (*SitesDevices) CountSiteDevices 

func (s *SitesDevices) CountSiteDevices(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteDevicesCountDistinctEnum,
	hostname *string,
	model *string,
	mac *string,
	version *string,
	mxtunnelStatus *string,
	mxedgeId *string,
	lldpSystemName *string,
	lldpSystemDesc *string,
	lldpPortId *string,
	lldpMgmtAddr *string,
	mapId *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteDevices takes context, siteId, distinct, hostname, model, mac, version, mxtunnelStatus, mxedgeId, lldpSystemName, lldpSystemDesc, lldpPortId, lldpMgmtAddr, mapId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Counts the number of entries in ap events history for distinct field with given filters

func (*SitesDevices) DeleteSiteDeviceImage 

func (s *SitesDevices) DeleteSiteDeviceImage(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	imageNumber int) (
	*http.Response,
	error)

DeleteSiteDeviceImage takes context, siteId, deviceId, imageNumber as parameters and returns an *Response and an error if there was an issue with the request or response. Delete image from a device

func (*SitesDevices) ExportSiteDevices 

func (s *SitesDevices) ExportSiteDevices(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[[]byte],
	error)

ExportSiteDevices takes context, siteId as parameters and returns an models.ApiResponse with []byte data and an error if there was an issue with the request or response. To download the exported device information

func (*SitesDevices) GetSiteDevice 

func (s *SitesDevices) GetSiteDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[models.MistDevice],
	error)

GetSiteDevice takes context, siteId, deviceId as parameters and returns an models.ApiResponse with models.MistDevice data and an error if there was an issue with the request or response. Get Device Configuration

func (*SitesDevices) ImportSiteDevices 

func (s *SitesDevices) ImportSiteDevices(
	ctx context.Context,
	siteId uuid.UUID,
	file models.FileWrapper) (
	models.ApiResponse[[]models.ConfigDevice],
	error)

ImportSiteDevices takes context, siteId, file as parameters and returns an models.ApiResponse with []models.ConfigDevice data and an error if there was an issue with the request or response. Import Information for Multiple Devices CSV format: ```csv mac,name,map_id,x,y,height,orientation,labels,band_24.power,band_24.bandwidth,band_24.channel,band_24.disabled,band_5.power,band_5.bandwidth,band_5.channel,band_5.disabled,band_6.power,band_6.bandwidth,band_6.channel,band_6.disabled 5c5b53010101,"AP 1",845a23bf-bed9-e43c-4c86-6fa474be7ae5,30,10,2.3,45,"guest, campus, vip",1,20,0,false,0,40,0,false,17,80,0,false ```

func (*SitesDevices) ListSiteDevices 

func (s *SitesDevices) ListSiteDevices(
	ctx context.Context,
	siteId uuid.UUID,
	mType *models.DeviceTypeWithAllEnum,
	name *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.ConfigDevice],
	error)

ListSiteDevices takes context, siteId, mType, name, limit, page as parameters and returns an models.ApiResponse with []models.ConfigDevice data and an error if there was an issue with the request or response. Get list of devices on the site.

func (*SitesDevices) RestartSiteMultipleDevices 

func (s *SitesDevices) RestartSiteMultipleDevices(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.UtilsDevicesRestartMulti) (
	*http.Response,
	error)

RestartSiteMultipleDevices takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Note that only the devices that are connected will be restarted.

func (*SitesDevices) SearchSiteDeviceConfigHistory 

func (s *SitesDevices) SearchSiteDeviceConfigHistory(
	ctx context.Context,
	siteId uuid.UUID,
	mType *models.DeviceTypeEnum,
	mac *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseConfigHistorySearch],
	error)

SearchSiteDeviceConfigHistory takes context, siteId, mType, mac, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseConfigHistorySearch data and an error if there was an issue with the request or response. Search for entries in device config history

func (*SitesDevices) SearchSiteDeviceEvents 

func (s *SitesDevices) SearchSiteDeviceEvents(
	ctx context.Context,
	siteId uuid.UUID,
	mac *string,
	model *string,
	text *string,
	timestamp *string,
	mType *string,
	lastBy *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseEventsDevices],
	error)

SearchSiteDeviceEvents takes context, siteId, mac, model, text, timestamp, mType, lastBy, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseEventsDevices data and an error if there was an issue with the request or response. Search Devices Events

func (*SitesDevices) SearchSiteDeviceLastConfigs 

func (s *SitesDevices) SearchSiteDeviceLastConfigs(
	ctx context.Context,
	siteId uuid.UUID,
	mType *models.DeviceTypeEnum,
	mac *string,
	version *string,
	name *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseConfigHistorySearch],
	error)

SearchSiteDeviceLastConfigs takes context, siteId, mType, mac, version, name, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseConfigHistorySearch data and an error if there was an issue with the request or response. Search Device Last Configs

func (*SitesDevices) SearchSiteDevices 

func (s *SitesDevices) SearchSiteDevices(
	ctx context.Context,
	siteId uuid.UUID,
	hostname *string,
	mType *models.DeviceTypeEnum,
	model *string,
	mac *string,
	version *string,
	powerConstrained *bool,
	ipAddress *string,
	mxtunnelStatus *models.SearchSiteDevicesMxtunnelStatusEnum,
	mxedgeId *uuid.UUID,
	lldpSystemName *string,
	lldpSystemDesc *string,
	lldpPortId *string,
	lldpMgmtAddr *string,
	band24Channel *int,
	band5Channel *int,
	band6Channel *int,
	band24Bandwidth *int,
	band5Bandwidth *int,
	band6Bandwidth *int,
	eth0PortSpeed *int,
	sort *models.SearchSiteDevicesSortEnum,
	descSort *models.SearchSiteDevicesDescSortEnum,
	stats *bool,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseDeviceSearch],
	error)

SearchSiteDevices takes context, siteId, hostname, mType, model, mac, version, powerConstrained, ipAddress, mxtunnelStatus, mxedgeId, lldpSystemName, lldpSystemDesc, lldpPortId, lldpMgmtAddr, band24Channel, band5Channel, band6Channel, band24Bandwidth, band5Bandwidth, band6Bandwidth, eth0PortSpeed, sort, descSort, stats, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseDeviceSearch data and an error if there was an issue with the request or response. Search Device

func (*SitesDevices) UpdateSiteDevice 

func (s *SitesDevices) UpdateSiteDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.MistDevice) (
	models.ApiResponse[models.MistDevice],
	error)

UpdateSiteDevice takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.MistDevice data and an error if there was an issue with the request or response. Update Device Configuration

type SitesDevicesOthers 

type SitesDevicesOthers struct {
	// contains filtered or unexported fields
}

SitesDevicesOthers represents a controller struct.

func NewSitesDevicesOthers 

func NewSitesDevicesOthers(baseController baseController) *SitesDevicesOthers

NewSitesDevicesOthers creates a new instance of SitesDevicesOthers. It takes a baseController as a parameter and returns a pointer to the SitesDevicesOthers.

func (*SitesDevicesOthers) CountSiteOtherDeviceEvents 

func (s *SitesDevicesOthers) CountSiteOtherDeviceEvents(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteOtherDeviceEventsCountDistinctEnum,
	mType *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteOtherDeviceEvents takes context, siteId, distinct, mType, start, end, duration, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Site OtherDevices Events

func (*SitesDevicesOthers) ListSiteOtherDevices 

func (s *SitesDevicesOthers) ListSiteOtherDevices(
	ctx context.Context,
	siteId uuid.UUID,
	vendor *string,
	mac *string,
	serial *string,
	model *string,
	name *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.DeviceOther],
	error)

ListSiteOtherDevices takes context, siteId, vendor, mac, serial, model, name, limit, page as parameters and returns an models.ApiResponse with []models.DeviceOther data and an error if there was an issue with the request or response. Get List of Site other devices (3rd party devices)

func (*SitesDevicesOthers) SearchSiteOtherDeviceEvents 

func (s *SitesDevicesOthers) SearchSiteOtherDeviceEvents(
	ctx context.Context,
	siteId uuid.UUID,
	mac *string,
	deviceMac *string,
	vendor *string,
	mType *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.ResponseEventsOtherDevicesSearch],
	error)

SearchSiteOtherDeviceEvents takes context, siteId, mac, deviceMac, vendor, mType, start, end, duration, limit as parameters and returns an models.ApiResponse with models.ResponseEventsOtherDevicesSearch data and an error if there was an issue with the request or response. Search Site OtherDevices Events

type SitesDevicesWANCluster 

type SitesDevicesWANCluster struct {
	// contains filtered or unexported fields
}

SitesDevicesWANCluster represents a controller struct.

func NewSitesDevicesWANCluster 

func NewSitesDevicesWANCluster(baseController baseController) *SitesDevicesWANCluster

NewSitesDevicesWANCluster creates a new instance of SitesDevicesWANCluster. It takes a baseController as a parameter and returns a pointer to the SitesDevicesWANCluster.

func (*SitesDevicesWANCluster) CreateSiteDeviceHaCluster 

func (s *SitesDevicesWANCluster) CreateSiteDeviceHaCluster(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.GatewayCluster) (
	models.ApiResponse[models.GatewayCluster],
	error)

CreateSiteDeviceHaCluster takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.GatewayCluster data and an error if there was an issue with the request or response. ## Create HA Cluster Both nodes has to be in the same site. We expect the user to configure ha_sync / ha_data port in port_configs already ### SRX cabling see [Chassis Cluster User Guide for SRX Series Devices](https://www.juniper.net/documentation/us/en/software/junos/chassis-cluster-security-devices/topics/concept/chassis-cluster-srx-series-node-interface-understanding.html) Here’s the recommended cabling. #### SRX300 From ZTP / default state, ge-0/0/0 and ge-0/0/7 (SFP) are default WAN ports and will get DHCP IP. However, ge-0/0/0 becomes OOB/fxp0 after cluster is enabled (i.e. using it for reach Mist is not recommended) 1. form cluster in UI 2. configure ge-0/0/7,ge-1/0/7 for WAN (reth0) 3. configure ge-0/0/2,ge-1/0/2 for ha_data 4. configure ge-0/0/3- for LAN or additional WAN e.g. ``` json { "port_config": { "ge-0/0/2,ge-1/0/2": { "usage": "ha_data" }, "ge-0/0/7,ge-1/0/7": { "usage": "wan", "redundant": true, "reth_idx": 0, "ip_config": {"type": "dhcp"} }, } } ``` 1. connect ge-0/0/1 back to back for ha_control 2. connect ge-0/0/2 back to back for ha_data 3. connect both ge-0/0/7 to uplink switch to WAN and to reach Mist 4. power up both devices 5. it takes about 30 minutes for the cluster to form #### SRX320 From ZTP / default state, ge-0/0/0, ge-0/0/7 (SFP) and cl-1/0/0 (LTE) are default WAN ports and will get DHCP IP. However, ge-0/0/0 becomes OOB/fxp0 after cluster is enabled (i.e. using it for reach Mist is not recommended) ##### ZTP via ge-0/0/7 Similar to SRX300 ##### ZTP via cl-1/0/0 (LTE) 1. form cluster in UI 2. configure cl-1/0/0, cl-3/0/0 as WAN (reth0) 3. configure ge-0/0/2,ge-3/0/2 for ha_data 4. same as above #### SRX340 / SRX345 / SRX380 SRX340/SRX345 has dedicated OOB/fxp0 ports 1. form cluster in UI 2. configure ge-0/0/0,ge-5/0/0 for WAN (reth0) 3. configure ge-0/0/2,ge-5/0/2 for ha_data 4. configure ge-0/0/3- for LAN or additional WAN 5. connect ge-0/0/0 to uplink switch to WAN and to reach Mist 6. connect ge-0/0/1 back-to-back for ha_control 7. connect ge-0/0/2 back-to-back for ha_data (fabric); or for SRX380, xe-0/0/16 if 10G SFP+ is used 8. connect ge-0/0/3- to LAN or additional WANs #### SRX550 ge-0/0/0 becomes OOB/fxp0 after cluster is enabled, make suenable oob_ip_config as dhcp to maintain cloud connectivity 1. connect ge-0/0/0 to reach Mist (after cluster is fully up, this port becomes OOB/fxp0) 2. connect ge-0/0/1 back-to-back for ha_control 3. connect ge-0/0/2 back-to-back for ha_data (fabric) 4. connect ge-0/0/3 to WAN (after cluster is up, intended to be used for reth0) 5. connect ge-0/0/4- to LAN or additional WANs #### SRX1500 SRX1500 has, additionally, dedicated HA Control port 1. form cluster in UI 2. configure ge-0/0/0,ge-5/0/0 for WAN (reth0) 3. configure ge-0/0/1,ge-5/0/1 for ha_data 4. configure ge-0/0/2- for LAN or additional WAN 5. connect dedicated ha_control back-to-back 6. connect ge-0/0/0 to uplink switch to WAN and to reach Mist 7. connect ge-0/0/1 back-to-back for ha_data 8. connect ge-0/0/2- to LAN or additional WANs #### SRX4100 SRX4100 has dedicated ha_control and ha_data (fabric) ports 1. connect dedicated ha_control back-to-back 2. connect dedicated ha_data back-to-back 3. connect xe-0/0/0 to WAN to reach Mist 4. connect xe-0/0/1- to LAN or additional WANs #### VSRX When standalone, VSRX has fxp0 as first Network Adapter, then ge-0/0/0-N When clustered, VSRX has fxp0, em0, then ge-0/0/0-N 1. connect net0 (fxp0) to WAN to reach Mist 2. connect net1 back-to-back for ha_control 3. connect net2 (ge-0/0/0) back-to-back for ha_data (fab0/fab1) 4. connect net3 (ge-0/0/1) to WAN, intended to be used for reth0 5. connect net4 (ge-0/0/2) to LAN SRX340/SRX345 has dedicated OOB/fxp0 ports VSRX has fxp0 as first Network Adapter, then ge-0/0/0-N 1. connect ge-0/0/0 to WAN to reach Mist 2. connect ge-0/0/1 back-to-back for ha_control 3. connect ge-0/0/2 back-to-back for ha_data (fabric); or for SRX380, xe-0/0/16 if 10G SFP+ is used 4. connect ge-0/0/3- to LAN or additional WANs #### SRX550 ge-0/0/0 becomes OOB/fxp0 after cluster is enabled, make suenable oob_ip_config as dhcp to maintain cloud connectivity 1. connect ge-0/0/0 to reach Mist (after cluster is fully up, this port becomes OOB/fxp0) 2. connect ge-0/0/1 back-to-back for ha_control 3. connect ge-0/0/2 back-to-back for ha_data (fabric) 4. connect ge-0/0/3 to WAN (after cluster is up, intended to be used for reth0) 5. connect ge-0/0/4- to LAN or additional WANs #### SRX1500 SRX1500 has, additionally, dedicated HA Control port 1. form cluster in UI 2. configure ge-0/0/0,ge-7/0/0 for WAN (reth0) 3. configure ge-0/0/1,ge-7/0/1 for ha_data 4. configure ge-0/0/2- for LAN or additional WAN 5. connect dedicated ha_control back-to-back 6. connect ge-0/0/0 to uplink switch to WAN and to reach Mist 7. connect ge-0/0/1 back-to-back for ha_data 8. connect ge-0/0/2- to LAN or additional WANs #### SRX1600 SRX1600 has, additionally, two dedicated HA Control port 1. form cluster in UI 2. configure ge-0/0/0,ge-7/0/0 for WAN (reth0) 3. configure ge-0/0/1,ge-7/0/1 for ha_data 4. configure ge-0/0/2- for LAN or additional WAN 5. connect dedicated both ha_control back-to-back 6. connect ge-0/0/0 to uplink switch to WAN and to reach Mist 7. connect ge-0/0/1 back-to-back for ha_data 8. connect ge-0/0/2- to LAN or additional WANs #### SRX4100 SRX4100 has dedicated ha_control and ha_data (fabric) ports 1. connect dedicated ha_control back-to-back 2. connect dedicated ha_data back-to-back 3. connect xe-0/0/0 to WAN to reach Mist 4. connect xe-0/0/1- to LAN or additional WANs ## Replace a Node in a HA Cluster Usually Device Replacement is done by Device Replacement API. For a HA cluster, you can also replace a node by another device in the same site.

func (*SitesDevicesWANCluster) DeleteSiteDeviceHaCluster 

func (s *SitesDevicesWANCluster) DeleteSiteDeviceHaCluster(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteDeviceHaCluster takes context, siteId, deviceId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete HA Cluster

func (*SitesDevicesWANCluster) GetSiteDeviceHaClusterNode 

func (s *SitesDevicesWANCluster) GetSiteDeviceHaClusterNode(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[models.GatewayCluster],
	error)

GetSiteDeviceHaClusterNode takes context, siteId, deviceId as parameters and returns an models.ApiResponse with models.GatewayCluster data and an error if there was an issue with the request or response. Delete HA Cluster

type SitesDevicesWired 

type SitesDevicesWired struct {
	// contains filtered or unexported fields
}

SitesDevicesWired represents a controller struct.

func NewSitesDevicesWired 

func NewSitesDevicesWired(baseController baseController) *SitesDevicesWired

NewSitesDevicesWired creates a new instance of SitesDevicesWired. It takes a baseController as a parameter and returns a pointer to the SitesDevicesWired.

func (*SitesDevicesWired) DeleteSiteLocalSwitchPortConfig 

func (s *SitesDevicesWired) DeleteSiteLocalSwitchPortConfig(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteLocalSwitchPortConfig takes context, siteId, deviceId as parameters and returns an *Response and an error if there was an issue with the request or response. API Calls delete all the existing port config local overrides, and reapply the configured planed at the device level (with site / template heritance).

func (*SitesDevicesWired) UpdateSiteLocalSwitchPortConfig 

func (s *SitesDevicesWired) UpdateSiteLocalSwitchPortConfig(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body map[string]models.JunosLocalPortConfig) (
	*http.Response,
	error)

UpdateSiteLocalSwitchPortConfig takes context, siteId, deviceId, body as parameters and returns an *Response and an error if there was an issue with the request or response. API Calls to add port config local overrides. This can be used by Switch Port Operators or Helpdesk administrators to change a Switch Port configuration without having to change the switch configuration. The local overrides configured for the switchports with `no_local_overwrite`==`true` won't be applied to the switch configuration. > NOTE: > > When using the API Call, it is required to put send all overrides in the PUT request Payload, even the existing once. > > The current overrides can be retrieved with the API Call [Get Site Device]($e/Sites%20Devices/getSiteDevice). The local overrides will show up separately from the `port_config` in the `local_port_config` so it can be easily identified (and cleared)

type SitesDevicesWiredVirtualChassis 

type SitesDevicesWiredVirtualChassis struct {
	// contains filtered or unexported fields
}

SitesDevicesWiredVirtualChassis represents a controller struct.

func NewSitesDevicesWiredVirtualChassis 

func NewSitesDevicesWiredVirtualChassis(baseController baseController) *SitesDevicesWiredVirtualChassis

NewSitesDevicesWiredVirtualChassis creates a new instance of SitesDevicesWiredVirtualChassis. It takes a baseController as a parameter and returns a pointer to the SitesDevicesWiredVirtualChassis.

func (*SitesDevicesWiredVirtualChassis) CreateSiteVirtualChassis 

func (s *SitesDevicesWiredVirtualChassis) CreateSiteVirtualChassis(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.VirtualChassisConfig) (
	models.ApiResponse[models.ResponseVirtualChassisConfig],
	error)

CreateSiteVirtualChassis takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.ResponseVirtualChassisConfig data and an error if there was an issue with the request or response. For models (e.g. EX3400 and up) having dedicated VC ports, it is easier to form a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new VC and update the inventory. In case that the user would like to choose the dedicated switch as a VC master. Or for EX2300-C-12P and EX2300-C-12T which doesn’t have dedicated VC ports, below are procedures to automate the VC creation: 1. Power on the switch that is choosen as the VC master first. And the powering on the other member switches. 2. Claim or adopt all these switches under the same organization’s Inventory 3. Assign these switches into the same Site 4. Invoke vc command on the switch choosen to be the VC master. For EX2300-C-12P, VC ports will be created automatically. 5. Connect the cables to the VC ports for these switches 6. Wait for the VC to be formed. The Org’s inventory will be updated for the new VC.

func (*SitesDevicesWiredVirtualChassis) DeleteSiteVirtualChassis 

func (s *SitesDevicesWiredVirtualChassis) DeleteSiteVirtualChassis(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteVirtualChassis takes context, siteId, deviceId as parameters and returns an *Response and an error if there was an issue with the request or response. When all the member switches of VC are removed and only member ID 0 is left, the cloud would detect this situation and automatically changes the single switch to non-VC role. For some unexpected cases that the VC is gone and disconncted, the API below could be used to change the state of VC’s switches to be standalone. After it is executed, all the switches will be shown as standalone switches under Inventory.

func (*SitesDevicesWiredVirtualChassis) GetSiteDeviceVirtualChassis 

func (s *SitesDevicesWiredVirtualChassis) GetSiteDeviceVirtualChassis(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[models.ResponseVirtualChassisConfig],
	error)

GetSiteDeviceVirtualChassis takes context, siteId, deviceId as parameters and returns an models.ApiResponse with models.ResponseVirtualChassisConfig data and an error if there was an issue with the request or response. Get VC Status The API returns a combined view of the VC status which includes topology and stats_

func (*SitesDevicesWiredVirtualChassis) SetSiteVcPort 

func (s *SitesDevicesWiredVirtualChassis) SetSiteVcPort(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.VirtualChassisPort) (
	*http.Response,
	error)

SetSiteVcPort takes context, siteId, deviceId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Set VC port

func (*SitesDevicesWiredVirtualChassis) UpdateSiteVirtualChassisMember 

func (s *SitesDevicesWiredVirtualChassis) UpdateSiteVirtualChassisMember(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.VirtualChassisUpdate) (
	models.ApiResponse[models.ResponseVirtualChassisConfig],
	error)

UpdateSiteVirtualChassisMember takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.ResponseVirtualChassisConfig data and an error if there was an issue with the request or response. The VC creation and adding member switch API will update the device’ s virtual chassis config which is applied after VC is formed to create JUNOS pre-provisioned virtual chassis configuration. ## Change to use preprovisioned VC To switch the VC to use preprovisioned VC, enable preprovisioned in virtual_chassis config. Both vc_role master and backup will be matched to routing-engine role in Junos preprovisioned VC config. In this config, fpc0 has to be the same as the mac of device_id. Use renumber if you want to replace fpc0 which involves device_id change. Notice: to configure preprovisioned VC, every member of the VC must be in the inventory. ## Add new members For models (e.g. EX4300 and up) having dedicated VC ports, it is easier to add new member switches into a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new members and update the inventory. For EX2300 VC, adding new members requires to follow the procedures below: 1. Powering on the new member switches and ensuring cables are not connected to any VC ports. 2. Claim or adopt all new member switches under the VC’s organization Inventory 3. Assign all new member switches to the same Site as the VC 4. Invoke vc command to add switches to the VC. 5. Connect the cables to the VC ports for these switches 6. After a while, the Org’s Inventory shows this new switches has been added into the VC. ## Removing member switch To remove a member switch from the VC, following the procedures below: 1. Ensuring the VC is connected to the cloud first 2. Unplug the cable from the VC port of the switch 3. Waiting for the VC state (vc_state) of this switch is changed to not-present 4. Invoke update_vc with remove to remove this switch from the VC 5. The Org’s Inventory shows the switch is removed. Please notice that member ID 0 (fpc0) cannot be removed. When a VC has two switches left, unpluging the cable may result in the situation that fpc0 becomes a line card (LC). When this situation is happened, please re-plug in the cable, wait for both switches becoming present (show virtual-chassis) and then removing the cable again. ## Renumber a member switch When a member switch doesn’ t work properly and needed to be replaced, the renumber API could be used. The following two types of renumber are supported: 1. Replace a non-fpc0 member switch 2. Replace fpc0. When fpc0 is relaced, PAPI device config and JUNOS config will be both updated. For renumber to work, the following procedures are needed: 1. Ensuring the VC is connected to the cloud and the state of the member switch to be replaced must be non present. 2. Adding the new member switch to the VC 3. Waiting for the VC state (vc_state) of this VC to be updated to API server 4. Invoke vc with renumber to replace the new member switch from fpc X to ## Perprovision VC members By specifying “preprovision” op, you can convert the current VC to pre-provisioned mode, update VC members as well as specify vc_ports when adding new members for device models without dedicated vc ports. Use renumber for fpc0 replacement which involves device_id change. Note: 1. vc_ports is used for adding new members and not needed if * the device model has dedicated vc ports, or * no new member is added 2. New VC members to be added should exist in the same Site as the VC Update Device’s VC config can achieve similar purpose by directly modifying current virtual_chassis config. However, it cannot fulfill requests to enabling vc_ports on new members that are yet to belong to current VC.

type SitesDevicesWireless 

type SitesDevicesWireless struct {
	// contains filtered or unexported fields
}

SitesDevicesWireless represents a controller struct.

func NewSitesDevicesWireless 

func NewSitesDevicesWireless(baseController baseController) *SitesDevicesWireless

NewSitesDevicesWireless creates a new instance of SitesDevicesWireless. It takes a baseController as a parameter and returns a pointer to the SitesDevicesWireless.

func (*SitesDevicesWireless) GetSiteDeviceIotPort 

func (s *SitesDevicesWireless) GetSiteDeviceIotPort(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[map[string]int],
	error)

GetSiteDeviceIotPort takes context, siteId, deviceId as parameters and returns an models.ApiResponse with map[string]int data and an error if there was an issue with the request or response. Returns the current state of each enabled IoT pin configured as an output.

func (*SitesDevicesWireless) GetSiteDeviceRadioChannels 

func (s *SitesDevicesWireless) GetSiteDeviceRadioChannels(
	ctx context.Context,
	siteId uuid.UUID,
	countryCode *string) (
	models.ApiResponse[models.ResponseDeviceRadioChannels],
	error)

GetSiteDeviceRadioChannels takes context, siteId, countryCode as parameters and returns an models.ApiResponse with models.ResponseDeviceRadioChannels data and an error if there was an issue with the request or response. Get a list of allowed channels (per channel width)

func (*SitesDevicesWireless) SetSiteDeviceIotPort 

func (s *SitesDevicesWireless) SetSiteDeviceIotPort(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body map[string]int) (
	models.ApiResponse[map[string]int],
	error)

SetSiteDeviceIotPort takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with map[string]int data and an error if there was an issue with the request or response. **Note**: For each IoT pin referenced: * The pin must be enabled using the Device `iot_config` API * The pin must support the output direction

type SitesEVPNTopologies 

type SitesEVPNTopologies struct {
	// contains filtered or unexported fields
}

SitesEVPNTopologies represents a controller struct.

func NewSitesEVPNTopologies 

func NewSitesEVPNTopologies(baseController baseController) *SitesEVPNTopologies

NewSitesEVPNTopologies creates a new instance of SitesEVPNTopologies. It takes a baseController as a parameter and returns a pointer to the SitesEVPNTopologies.

func (*SitesEVPNTopologies) CreateSiteEvpnTopology 

func (s *SitesEVPNTopologies) CreateSiteEvpnTopology(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.EvpnTopology) (
	models.ApiResponse[models.EvpnTopology],
	error)

CreateSiteEvpnTopology takes context, siteId, body as parameters and returns an models.ApiResponse with models.EvpnTopology data and an error if there was an issue with the request or response. While all the `evpn_id` / `downlink_ips` can be specifidd by hand, the easiest way is to call the `build_vpn_topology` API, allowing you to examine the diff, and update it yourself. You can also simply call it with `overwrite=true` which will apply the updates for you. **Notes:** 1. You can use `core` / `distribution` / `access` to create a CLOS topology 2. You can also use `core` / `distribution` to form a 2-tier EVPN topology where ESI-Lag is configured distribution to connect to access switches 3. In a small/medium campus, `collapsed-core` can be used where core switches are the inter-connected to do EVPN 4. The API uses a few pre-defined parameters and best-practices to generate the configs. It can be customized by using `evpn_options` in Site Setting / Network Template. (e.g. a different subnet for the underlay) #### Collapsed Core In a small-medium campus, EVPN can also be enabled only at the core switches (up to 4) by assigning all participating switches with `collapsed-core role`. When there are more than 2 switches, a ring-like topology will be formed. #### ESI-Lag If the access switchess does not have EVPN support, you can take advantage of EVPN by setting up ESI-Lag on distribution switches #### Leaf / Access / Collapsed-Core For leaf nodes in a EVPN topology, you’d have to configure the IPs for networks that would participate in EVPN. Optionally, VRFs to isolate traffic from one tenant verus another

func (*SitesEVPNTopologies) DeleteSiteEvpnTopology 

func (s *SitesEVPNTopologies) DeleteSiteEvpnTopology(
	ctx context.Context,
	siteId uuid.UUID,
	evpnTopologyId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteEvpnTopology takes context, siteId, evpnTopologyId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete the site EVPN Topology

func (*SitesEVPNTopologies) GetSiteEvpnTopology 

func (s *SitesEVPNTopologies) GetSiteEvpnTopology(
	ctx context.Context,
	siteId uuid.UUID,
	evpnTopologyId uuid.UUID) (
	models.ApiResponse[models.EvpnTopology],
	error)

GetSiteEvpnTopology takes context, siteId, evpnTopologyId as parameters and returns an models.ApiResponse with models.EvpnTopology data and an error if there was an issue with the request or response. Get One EVPN Topology Detail

func (*SitesEVPNTopologies) ListSiteEvpnTopologies 

func (s *SitesEVPNTopologies) ListSiteEvpnTopologies(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.EvpnTopology],
	error)

ListSiteEvpnTopologies takes context, siteId as parameters and returns an models.ApiResponse with models.EvpnTopology data and an error if there was an issue with the request or response. Get the existing EVPN topology

func (*SitesEVPNTopologies) UpdateSiteEvpnTopology 

func (s *SitesEVPNTopologies) UpdateSiteEvpnTopology(
	ctx context.Context,
	siteId uuid.UUID,
	evpnTopologyId uuid.UUID,
	body *models.EvpnTopology) (
	models.ApiResponse[models.EvpnTopology],
	error)

UpdateSiteEvpnTopology takes context, siteId, evpnTopologyId, body as parameters and returns an models.ApiResponse with models.EvpnTopology data and an error if there was an issue with the request or response. Update the EVPN Topolgy

type SitesEvents 

type SitesEvents struct {
	// contains filtered or unexported fields
}

SitesEvents represents a controller struct.

func NewSitesEvents 

func NewSitesEvents(baseController baseController) *SitesEvents

NewSitesEvents creates a new instance of SitesEvents. It takes a baseController as a parameter and returns a pointer to the SitesEvents.

func (*SitesEvents) CountSiteSystemEvents 

func (s *SitesEvents) CountSiteSystemEvents(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteSystemEventsCountDistinctEnum,
	mType *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteSystemEvents takes context, siteId, distinct, mType, limit, start, end, duration as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count System Events

func (*SitesEvents) GetSiteRoamingEvents 

func (s *SitesEvents) GetSiteRoamingEvents(
	ctx context.Context,
	siteId uuid.UUID,
	mType *models.FastRoamResultEnum,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseEventsFastroam],
	error)

GetSiteRoamingEvents takes context, siteId, mType, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseEventsFastroam data and an error if there was an issue with the request or response. Get Roaming Events data

func (*SitesEvents) SearchSiteSystemEvents 

func (s *SitesEvents) SearchSiteSystemEvents(
	ctx context.Context,
	siteId uuid.UUID,
	mType *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseDeviceEventsSearch],
	error)

SearchSiteSystemEvents takes context, siteId, mType, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseDeviceEventsSearch data and an error if there was an issue with the request or response. Search System Events

type SitesGatewayTemplates 

type SitesGatewayTemplates struct {
	// contains filtered or unexported fields
}

SitesGatewayTemplates represents a controller struct.

func NewSitesGatewayTemplates 

func NewSitesGatewayTemplates(baseController baseController) *SitesGatewayTemplates

NewSitesGatewayTemplates creates a new instance of SitesGatewayTemplates. It takes a baseController as a parameter and returns a pointer to the SitesGatewayTemplates.

func (*SitesGatewayTemplates) ListSiteGatewayTemplateDerived added in v0.3.17 

func (s *SitesGatewayTemplates) ListSiteGatewayTemplateDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool) (
	models.ApiResponse[[]models.GatewayTemplate],
	error)

ListSiteGatewayTemplateDerived takes context, siteId, resolve as parameters and returns an models.ApiResponse with []models.GatewayTemplate data and an error if there was an issue with the request or response. Get derived Gateway Templates for Site

type SitesGuests 

type SitesGuests struct {
	// contains filtered or unexported fields
}

SitesGuests represents a controller struct.

func NewSitesGuests 

func NewSitesGuests(baseController baseController) *SitesGuests

NewSitesGuests creates a new instance of SitesGuests. It takes a baseController as a parameter and returns a pointer to the SitesGuests.

func (*SitesGuests) CountSiteGuestAuthorizations 

func (s *SitesGuests) CountSiteGuestAuthorizations(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteGuestsCountDistinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteGuestAuthorizations takes context, siteId, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Authorized Guest

func (*SitesGuests) DeleteSiteGuestAuthorization 

func (s *SitesGuests) DeleteSiteGuestAuthorization(
	ctx context.Context,
	siteId uuid.UUID,
	guestMac string) (
	*http.Response,
	error)

DeleteSiteGuestAuthorization takes context, siteId, guestMac as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Guest Authorization

func (*SitesGuests) GetSiteGuestAuthorization 

func (s *SitesGuests) GetSiteGuestAuthorization(
	ctx context.Context,
	siteId uuid.UUID,
	guestMac string) (
	models.ApiResponse[models.Guest],
	error)

GetSiteGuestAuthorization takes context, siteId, guestMac as parameters and returns an models.ApiResponse with models.Guest data and an error if there was an issue with the request or response. Get Guest Authorization

func (*SitesGuests) ListSiteAllGuestAuthorizations 

func (s *SitesGuests) ListSiteAllGuestAuthorizations(
	ctx context.Context,
	siteId uuid.UUID,
	wlanId *string) (
	models.ApiResponse[[]models.Guest],
	error)

ListSiteAllGuestAuthorizations takes context, siteId, wlanId as parameters and returns an models.ApiResponse with []models.Guest data and an error if there was an issue with the request or response. Get List of Site Guest Authorizations

func (*SitesGuests) ListSiteAllGuestAuthorizationsDerived 

func (s *SitesGuests) ListSiteAllGuestAuthorizationsDerived(
	ctx context.Context,
	siteId uuid.UUID,
	wlanId *string,
	crossSite *bool) (
	models.ApiResponse[[]models.Guest],
	error)

ListSiteAllGuestAuthorizationsDerived takes context, siteId, wlanId, crossSite as parameters and returns an models.ApiResponse with []models.Guest data and an error if there was an issue with the request or response. Get List of Site Guest Authorizations

func (*SitesGuests) SearchSiteGuestAuthorization 

func (s *SitesGuests) SearchSiteGuestAuthorization(
	ctx context.Context,
	siteId uuid.UUID,
	wlanId *string,
	authMethod *string,
	ssid *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseGuestSearch],
	error)

SearchSiteGuestAuthorization takes context, siteId, wlanId, authMethod, ssid, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseGuestSearch data and an error if there was an issue with the request or response. Search Authorized Guest

func (*SitesGuests) UpdateSiteGuestAuthorization 

func (s *SitesGuests) UpdateSiteGuestAuthorization(
	ctx context.Context,
	siteId uuid.UUID,
	guestMac string,
	body *models.Guest) (
	models.ApiResponse[models.Guest],
	error)

UpdateSiteGuestAuthorization takes context, siteId, guestMac, body as parameters and returns an models.ApiResponse with models.Guest data and an error if there was an issue with the request or response. Update Guest Authorization

type SitesInsights 

type SitesInsights struct {
	// contains filtered or unexported fields
}

SitesInsights represents a controller struct.

func NewSitesInsights 

func NewSitesInsights(baseController baseController) *SitesInsights

NewSitesInsights creates a new instance of SitesInsights. It takes a baseController as a parameter and returns a pointer to the SitesInsights.

func (*SitesInsights) GetSiteInsightMetrics 

func (s *SitesInsights) GetSiteInsightMetrics(
	ctx context.Context,
	siteId uuid.UUID,
	metric string,
	start *int,
	end *int,
	duration *string,
	interval *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.InsightMetrics],
	error)

GetSiteInsightMetrics takes context, siteId, metric, start, end, duration, interval, limit, page as parameters and returns an models.ApiResponse with models.InsightMetrics data and an error if there was an issue with the request or response. Get Site Insight Metrics See metrics possibilities at /api/v1/const/insight_metrics

func (*SitesInsights) GetSiteInsightMetricsForClient 

func (s *SitesInsights) GetSiteInsightMetricsForClient(
	ctx context.Context,
	siteId uuid.UUID,
	clientMac string,
	metric string,
	start *int,
	end *int,
	duration *string,
	interval *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.InsightMetrics],
	error)

GetSiteInsightMetricsForClient takes context, siteId, clientMac, metric, start, end, duration, interval, limit, page as parameters and returns an models.ApiResponse with models.InsightMetrics data and an error if there was an issue with the request or response. Get Client Insight Metrics See metrics possibilities at /api/v1/const/insight_metrics

func (*SitesInsights) GetSiteInsightMetricsForDevice 

func (s *SitesInsights) GetSiteInsightMetricsForDevice(
	ctx context.Context,
	siteId uuid.UUID,
	metric string,
	deviceMac string,
	start *int,
	end *int,
	duration *string,
	interval *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseDeviceMetrics],
	error)

GetSiteInsightMetricsForDevice takes context, siteId, metric, deviceMac, start, end, duration, interval, limit, page as parameters and returns an models.ApiResponse with models.ResponseDeviceMetrics data and an error if there was an issue with the request or response. Get AP Insight Metrics See metrics possibilities at /api/v1/const/insight_metrics

type SitesJSE 

type SitesJSE struct {
	// contains filtered or unexported fields
}

SitesJSE represents a controller struct.

func NewSitesJSE 

func NewSitesJSE(baseController baseController) *SitesJSE

NewSitesJSE creates a new instance of SitesJSE. It takes a baseController as a parameter and returns a pointer to the SitesJSE.

func (*SitesJSE) GetSiteJseInfo 

func (s *SitesJSE) GetSiteJseInfo(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.AccountJseInfo],
	error)

GetSiteJseInfo takes context, siteId as parameters and returns an models.ApiResponse with models.AccountJseInfo data and an error if there was an issue with the request or response. Retrieves the list of JSE orgs associated with the account

type SitesLicenses 

type SitesLicenses struct {
	// contains filtered or unexported fields
}

SitesLicenses represents a controller struct.

func NewSitesLicenses 

func NewSitesLicenses(baseController baseController) *SitesLicenses

NewSitesLicenses creates a new instance of SitesLicenses. It takes a baseController as a parameter and returns a pointer to the SitesLicenses.

func (*SitesLicenses) GetSiteLicenseUsage 

func (s *SitesLicenses) GetSiteLicenseUsage(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.LicenseUsageSite],
	error)

GetSiteLicenseUsage takes context, siteId as parameters and returns an models.ApiResponse with models.LicenseUsageSite data and an error if there was an issue with the request or response. This shows license usage (i.e. needed) based on the features enabled for the site.

type SitesLocation 

type SitesLocation struct {
	// contains filtered or unexported fields
}

SitesLocation represents a controller struct.

func NewSitesLocation 

func NewSitesLocation(baseController baseController) *SitesLocation

NewSitesLocation creates a new instance of SitesLocation. It takes a baseController as a parameter and returns a pointer to the SitesLocation.

func (*SitesLocation) ClearSiteMlOverwriteForDevice 

func (s *SitesLocation) ClearSiteMlOverwriteForDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	*http.Response,
	error)

ClearSiteMlOverwriteForDevice takes context, siteId, deviceId as parameters and returns an *Response and an error if there was an issue with the request or response. Clear ML Overwrite for Device

func (*SitesLocation) ClearSiteMlOverwriteForMap 

func (s *SitesLocation) ClearSiteMlOverwriteForMap(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID) (
	*http.Response,
	error)

ClearSiteMlOverwriteForMap takes context, siteId, mapId as parameters and returns an *Response and an error if there was an issue with the request or response. Clear ML Overwrite for Map

func (*SitesLocation) GetSiteBeamCoverageOverview 

func (s *SitesLocation) GetSiteBeamCoverageOverview(
	ctx context.Context,
	siteId uuid.UUID,
	mapId *string,
	mType *models.RfClientTypeEnum,
	clientType *string,
	duration *string,
	resolution *models.ResolutionEnum,
	start *int,
	end *int) (
	models.ApiResponse[models.ResponseLocationCoverage],
	error)

GetSiteBeamCoverageOverview takes context, siteId, mapId, mType, clientType, duration, resolution, start, end as parameters and returns an models.ApiResponse with models.ResponseLocationCoverage data and an error if there was an issue with the request or response. Get Beam Coverage Overview

func (*SitesLocation) GetSiteDefaultPlfForModels 

func (s *SitesLocation) GetSiteDefaultPlfForModels(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[[]interface{}],
	error)

GetSiteDefaultPlfForModels takes context, siteId as parameters and returns an models.ApiResponse with []interface{} data and an error if there was an issue with the request or response. Get Default PLF for Models

func (*SitesLocation) GetSiteMachineLearningCurrentStat 

func (s *SitesLocation) GetSiteMachineLearningCurrentStat(
	ctx context.Context,
	siteId uuid.UUID,
	mapId *string) (
	models.ApiResponse[[]interface{}],
	error)

GetSiteMachineLearningCurrentStat takes context, siteId, mapId as parameters and returns an models.ApiResponse with []interface{} data and an error if there was an issue with the request or response. Get Machine Learning Current Stat For each VBLE AP, it has ML model parameters (e.g. Path-loss-estimate, Intercept) as well as completion indicators (Level and PercentageComplete). For the completeness, ML takes N sample to finish its first level and use N*0.25 samples to complete each successive level. When a device is moved, the completeness will be reset as it has to re-learn.

func (*SitesLocation) OverwriteSiteMlForDevice 

func (s *SitesLocation) OverwriteSiteMlForDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body map[string]models.MlOverwriteAdditionalProperties) (
	models.ApiResponse[[]interface{}],
	error)

OverwriteSiteMlForDevice takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with []interface{} data and an error if there was an issue with the request or response. Overwrite ML For Device

func (*SitesLocation) OverwriteSiteMlForMap 

func (s *SitesLocation) OverwriteSiteMlForMap(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID,
	body map[string]models.MlOverwriteAdditionalProperties) (
	models.ApiResponse[[]interface{}],
	error)

OverwriteSiteMlForMap takes context, siteId, mapId, body as parameters and returns an models.ApiResponse with []interface{} data and an error if there was an issue with the request or response. Overwrite ML For Map

func (*SitesLocation) ResetSiteMlStatsByMap 

func (s *SitesLocation) ResetSiteMlStatsByMap(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID) (
	*http.Response,
	error)

ResetSiteMlStatsByMap takes context, siteId, mapId as parameters and returns an *Response and an error if there was an issue with the request or response. Reset ML Stats by Map

type SitesMaps 

type SitesMaps struct {
	// contains filtered or unexported fields
}

SitesMaps represents a controller struct.

func NewSitesMaps 

func NewSitesMaps(baseController baseController) *SitesMaps

NewSitesMaps creates a new instance of SitesMaps. It takes a baseController as a parameter and returns a pointer to the SitesMaps.

func (*SitesMaps) AddSiteMapImage 

func (s *SitesMaps) AddSiteMapImage(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID,
	file models.FileWrapper,
	json *string) (
	*http.Response,
	error)

AddSiteMapImage takes context, siteId, mapId, file, json as parameters and returns an *Response and an error if there was an issue with the request or response. Add image map is a multipart POST which has an file (Image) and an optional json parameter

func (*SitesMaps) BulkAssignSiteApsToMap 

func (s *SitesMaps) BulkAssignSiteApsToMap(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID,
	body *models.MacAddresses) (
	models.ApiResponse[models.ResponseSetDevicesMap],
	error)

BulkAssignSiteApsToMap takes context, siteId, mapId, body as parameters and returns an models.ApiResponse with models.ResponseSetDevicesMap data and an error if there was an issue with the request or response. This API can be used to assign a list of AP Macs associated with site_id to the specified map_id. Note that map_id must be associated with corresponding site_id. This API obeys the following rules 1. if AP is unassigned to any Map, it gets associated with map_id 2. Any moved APs are returned in the response 3. If the AP is considered a locked AP, no action will be taken

func (*SitesMaps) CreateSiteMap 

func (s *SitesMaps) CreateSiteMap(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.Map) (
	models.ApiResponse[models.Map],
	error)

CreateSiteMap takes context, siteId, body as parameters and returns an models.ApiResponse with models.Map data and an error if there was an issue with the request or response. Create Site Map

func (*SitesMaps) DeleteSiteMap 

func (s *SitesMaps) DeleteSiteMap(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteMap takes context, siteId, mapId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site Map

func (*SitesMaps) DeleteSiteMapImage 

func (s *SitesMaps) DeleteSiteMapImage(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteMapImage takes context, siteId, mapId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site Map Image

func (*SitesMaps) GetSiteMap 

func (s *SitesMaps) GetSiteMap(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID) (
	models.ApiResponse[models.Map],
	error)

GetSiteMap takes context, siteId, mapId as parameters and returns an models.ApiResponse with models.Map data and an error if there was an issue with the request or response. Get Site Map Details

func (*SitesMaps) ImportSiteMaps 

func (s *SitesMaps) ImportSiteMaps(
	ctx context.Context,
	siteId uuid.UUID,
	autoDeviceprofileAssignment *bool,
	csv *models.FileWrapper,
	file *models.FileWrapper,
	json *models.MapImportJson) (
	models.ApiResponse[models.ResponseMapImport],
	error)

ImportSiteMaps takes context, siteId, autoDeviceprofileAssignment, csv, file, json as parameters and returns an models.ApiResponse with models.ResponseMapImport data and an error if there was an issue with the request or response. Import data from files is a multipart POST which has an file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches. # Note This endpoint (at the site level), the AP must be already assigned to the site to be placed on the floorplan. If you want to place APs from the Org inventory, it is required to use the endpoint at the Org level [importOrgMaps](#operation/importOrgMaps) # CSV File Format ```csv Vendor AP name,Mist AP Mac US Office AP-2,5c:5b:35:00:00:02 US Office AP-3,5c5b35000002 ```

func (*SitesMaps) ImportSiteWayfindings 

func (s *SitesMaps) ImportSiteWayfindings(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID,
	body *models.WayfindingImportJson) (
	*http.Response,
	error)

ImportSiteWayfindings takes context, siteId, mapId, body as parameters and returns an *Response and an error if there was an issue with the request or response. This imports the vendor map meta data into the Map JSON. This is required by the SDK and App in order to access/render the vendor Map properly.

func (*SitesMaps) ListSiteMaps 

func (s *SitesMaps) ListSiteMaps(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Map],
	error)

ListSiteMaps takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.Map data and an error if there was an issue with the request or response. Get List of Site Maps

func (*SitesMaps) ReplaceSiteMapImage 

func (s *SitesMaps) ReplaceSiteMapImage(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID,
	file models.FileWrapper,
	json *models.MapSiteReplaceFileJson) (
	*http.Response,
	error)

ReplaceSiteMapImage takes context, siteId, mapId, file, json as parameters and returns an *Response and an error if there was an issue with the request or response. Replace Map Image This works like an PUT where the image will be replaced. If transform is provided, all the locations of the objects on the map (AP, Zone, Vbeacon, Beacon) will be transformed as well (relative to the new Map)

func (*SitesMaps) UpdateSiteMap 

func (s *SitesMaps) UpdateSiteMap(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID,
	body *models.Map) (
	models.ApiResponse[models.Map],
	error)

UpdateSiteMap takes context, siteId, mapId, body as parameters and returns an models.ApiResponse with models.Map data and an error if there was an issue with the request or response. Update Site Map

type SitesMapsAutoPlacement 

type SitesMapsAutoPlacement struct {
	// contains filtered or unexported fields
}

SitesMapsAutoPlacement represents a controller struct.

func NewSitesMapsAutoPlacement 

func NewSitesMapsAutoPlacement(baseController baseController) *SitesMapsAutoPlacement

NewSitesMapsAutoPlacement creates a new instance of SitesMapsAutoPlacement. It takes a baseController as a parameter and returns a pointer to the SitesMapsAutoPlacement.

func (*SitesMapsAutoPlacement) ClearSiteApAutoOrient added in v0.2.25 

func (s *SitesMapsAutoPlacement) ClearSiteApAutoOrient(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID,
	body *models.MacAddresses) (
	*http.Response,
	error)

ClearSiteApAutoOrient takes context, siteId, mapId, body as parameters and returns an *Response and an error if there was an issue with the request or response. This API is used to destroy the autoorientations of a map or subset of APs on a map.

func (*SitesMapsAutoPlacement) ClearSiteApAutoplacement 

func (s *SitesMapsAutoPlacement) ClearSiteApAutoplacement(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID,
	body *models.MacAddresses) (
	*http.Response,
	error)

ClearSiteApAutoplacement takes context, siteId, mapId, body as parameters and returns an *Response and an error if there was an issue with the request or response. This API is used to destroy the cached autoplacement locations of a map or subset of APs on a map.

func (*SitesMapsAutoPlacement) ConfirmSiteApLocalizationData 

func (s *SitesMapsAutoPlacement) ConfirmSiteApLocalizationData(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID,
	body *models.UseAutoApValues) (
	*http.Response,
	error)

ConfirmSiteApLocalizationData takes context, siteId, mapId, body as parameters and returns an *Response and an error if there was an issue with the request or response. This API is used to accept or reject the cached autoplacement and auto orientation values of a map or subset of APs on a map. A rejected AP will retain its current X,Y and orientation until accpeted.

func (*SitesMapsAutoPlacement) DeleteSiteApAutoOrientation added in v0.2.25 

func (s *SitesMapsAutoPlacement) DeleteSiteApAutoOrientation(
	ctx context.Context,
	mapId uuid.UUID,
	siteId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteApAutoOrientation takes context, mapId, siteId as parameters and returns an *Response and an error if there was an issue with the request or response. This API is called to force stop auto placement for a given map

func (*SitesMapsAutoPlacement) DeleteSiteApAutoplacement 

func (s *SitesMapsAutoPlacement) DeleteSiteApAutoplacement(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteApAutoplacement takes context, siteId, mapId as parameters and returns an *Response and an error if there was an issue with the request or response. This API is called to force stop auto placement for a given map

func (*SitesMapsAutoPlacement) GetSiteApAutoPlacement 

func (s *SitesMapsAutoPlacement) GetSiteApAutoPlacement(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID) (
	models.ApiResponse[models.ResponseAutoPlacementInfo],
	error)

GetSiteApAutoPlacement takes context, siteId, mapId as parameters and returns an models.ApiResponse with models.ResponseAutoPlacementInfo data and an error if there was an issue with the request or response. This API is called to view the current status of auto placement for a given map. #### Status Descriptions | Status | Description | | --- | --- | | `pending` | Autoplacement has not been requested for this map | | `inprogress` | Autoplacement is currently processing | | `done` | The autoplacement process has completed | | `data_needed` | Additional position data is required for autoplacement. Users should verify the requested anchor APs have a position on the map | | `invalid_model` | Autoplacement is not supported on the model of the APs on the map | | `invalid_version` | Autoplacement is not supported with the APs current firmware version | | `error` | There was an error in the autoplacement process |

func (*SitesMapsAutoPlacement) RunSiteApAutoplacement 

func (s *SitesMapsAutoPlacement) RunSiteApAutoplacement(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID,
	body *models.AutoPlacement) (
	*http.Response,
	error)

RunSiteApAutoplacement takes context, siteId, mapId, body as parameters and returns an *Response and an error if there was an issue with the request or response. This API is called to trigger a map for auto placement. For auto placement feature to work, RTT-FTM data need to be collected from the APs on the map. This scan is disruptive and therefore the user must be notified of service disrution during the functioning of auto placement Repeated POST to this endpoint while a map is still running will be rejected. List of devices to provide suggestions for is an optional parameter that can be given to this API. This will provide autoplacement suggestions only for the devices specified. If no list of devices is provided, all APs asociated with that map are considered by default

func (*SitesMapsAutoPlacement) StartSiteApAutoOrientation added in v0.2.25 

func (s *SitesMapsAutoPlacement) StartSiteApAutoOrientation(
	ctx context.Context,
	mapId uuid.UUID,
	siteId uuid.UUID,
	body *models.AutoOrient) (
	models.ApiResponse[models.ResponseAutoOrientation],
	error)

StartSiteApAutoOrientation takes context, mapId, siteId, body as parameters and returns an models.ApiResponse with models.ResponseAutoOrientation data and an error if there was an issue with the request or response. This API is called to trigger a map for auto orientation. For auto orient feature to work, BLE data needs to be collected from the APs on the map. This precess is not disruptive unlike FTM collection. Repeated POST to this endpoint while a map is still running will be rejected. List of devices to provide suggestions for is an optional parameter that can be given to this API. This will provide auto orient suggestions only for the devices specified. If no list of devices is provided, all APs asociated with that map are considered by default

type SitesMapsAutoZone added in v0.4.0 

type SitesMapsAutoZone struct {
	// contains filtered or unexported fields
}

SitesMapsAutoZone represents a controller struct.

func NewSitesMapsAutoZone added in v0.4.0 

func NewSitesMapsAutoZone(baseController baseController) *SitesMapsAutoZone

NewSitesMapsAutoZone creates a new instance of SitesMapsAutoZone. It takes a baseController as a parameter and returns a pointer to the SitesMapsAutoZone.

func (*SitesMapsAutoZone) DeleteSiteMapAutoZone added in v0.4.0 

func (s *SitesMapsAutoZone) DeleteSiteMapAutoZone(
	ctx context.Context,
	mapId uuid.UUID,
	siteId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteMapAutoZone takes context, mapId, siteId as parameters and returns an *Response and an error if there was an issue with the request or response. This API starts the auto zones service for a specified map. This map must have an image to parse for the auto zones service. Repeated POST requests to this endpoint while the auto zones service is proccessing the map or awaiting review will be rejected.

func (*SitesMapsAutoZone) GetSiteMapAutoZoneStatus added in v0.4.0 

func (s *SitesMapsAutoZone) GetSiteMapAutoZoneStatus(
	ctx context.Context,
	mapId uuid.UUID,
	siteId uuid.UUID) (
	models.ApiResponse[models.ResponseAutoZone],
	error)

GetSiteMapAutoZoneStatus takes context, mapId, siteId as parameters and returns an models.ApiResponse with models.ResponseAutoZone data and an error if there was an issue with the request or response. This API provides the current status of the auto zones service for a given map

func (*SitesMapsAutoZone) StartSiteMapAutoZone added in v0.4.0 

func (s *SitesMapsAutoZone) StartSiteMapAutoZone(
	ctx context.Context,
	mapId uuid.UUID,
	siteId uuid.UUID) (
	*http.Response,
	error)

StartSiteMapAutoZone takes context, mapId, siteId as parameters and returns an *Response and an error if there was an issue with the request or response. This API starts the auto zones service for a specified map. This map must have an image to parse for the auto zones service. Reppeated POST requests to this endpoint while the auto zones service is proccessing the map will be rejected.

type SitesMxEdges 

type SitesMxEdges struct {
	// contains filtered or unexported fields
}

SitesMxEdges represents a controller struct.

func NewSitesMxEdges 

func NewSitesMxEdges(baseController baseController) *SitesMxEdges

NewSitesMxEdges creates a new instance of SitesMxEdges. It takes a baseController as a parameter and returns a pointer to the SitesMxEdges.

func (*SitesMxEdges) CountSiteMxEdgeEvents 

func (s *SitesMxEdges) CountSiteMxEdgeEvents(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteMxedgeEventsCountDistinctEnum,
	mxedgeId *string,
	mxclusterId *string,
	mType *string,
	service *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteMxEdgeEvents takes context, siteId, distinct, mxedgeId, mxclusterId, mType, service, start, end, duration, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Mist Edge Events

func (*SitesMxEdges) DeleteSiteMxEdge 

func (s *SitesMxEdges) DeleteSiteMxEdge(
	ctx context.Context,
	siteId uuid.UUID,
	mxedgeId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteMxEdge takes context, siteId, mxedgeId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site Mist Edge

func (*SitesMxEdges) GetSiteMxEdge 

func (s *SitesMxEdges) GetSiteMxEdge(
	ctx context.Context,
	siteId uuid.UUID,
	mxedgeId uuid.UUID) (
	*http.Response,
	error)

GetSiteMxEdge takes context, siteId, mxedgeId as parameters and returns an *Response and an error if there was an issue with the request or response. get Site Mist Edge

func (*SitesMxEdges) ListSiteMxEdges 

func (s *SitesMxEdges) ListSiteMxEdges(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Mxedge],
	error)

ListSiteMxEdges takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.Mxedge data and an error if there was an issue with the request or response. Get List of Site Mist Edges

func (*SitesMxEdges) SearchSiteMistEdgeEvents 

func (s *SitesMxEdges) SearchSiteMistEdgeEvents(
	ctx context.Context,
	siteId uuid.UUID,
	mxedgeId *string,
	mxclusterId *string,
	mType *string,
	service *string,
	component *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.ResponseMxedgeEventsSearch],
	error)

SearchSiteMistEdgeEvents takes context, siteId, mxedgeId, mxclusterId, mType, service, component, start, end, duration, limit as parameters and returns an models.ApiResponse with models.ResponseMxedgeEventsSearch data and an error if there was an issue with the request or response. Search Site Mist Edge Events

func (*SitesMxEdges) UpdateSiteMxEdge 

func (s *SitesMxEdges) UpdateSiteMxEdge(
	ctx context.Context,
	siteId uuid.UUID,
	mxedgeId uuid.UUID,
	body *models.Mxedge) (
	models.ApiResponse[models.Mxedge],
	error)

UpdateSiteMxEdge takes context, siteId, mxedgeId, body as parameters and returns an models.ApiResponse with models.Mxedge data and an error if there was an issue with the request or response. Update Site Mist Edge settings

func (*SitesMxEdges) UploadSiteMxEdgeSupportFiles 

func (s *SitesMxEdges) UploadSiteMxEdgeSupportFiles(
	ctx context.Context,
	siteId uuid.UUID,
	mxedgeId uuid.UUID) (
	*http.Response,
	error)

UploadSiteMxEdgeSupportFiles takes context, siteId, mxedgeId as parameters and returns an *Response and an error if there was an issue with the request or response. Support / Upload Mist Edge support files

type SitesNetworkTemplates 

type SitesNetworkTemplates struct {
	// contains filtered or unexported fields
}

SitesNetworkTemplates represents a controller struct.

func NewSitesNetworkTemplates 

func NewSitesNetworkTemplates(baseController baseController) *SitesNetworkTemplates

NewSitesNetworkTemplates creates a new instance of SitesNetworkTemplates. It takes a baseController as a parameter and returns a pointer to the SitesNetworkTemplates.

func (*SitesNetworkTemplates) ListSiteNetworkTemplateDerived added in v0.3.17 

func (s *SitesNetworkTemplates) ListSiteNetworkTemplateDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool) (
	models.ApiResponse[models.NetworkTemplate],
	error)

ListSiteNetworkTemplateDerived takes context, siteId, resolve as parameters and returns an models.ApiResponse with models.NetworkTemplate data and an error if there was an issue with the request or response. Get derived Network Templates for Site

type SitesNetworks 

type SitesNetworks struct {
	// contains filtered or unexported fields
}

SitesNetworks represents a controller struct.

func NewSitesNetworks 

func NewSitesNetworks(baseController baseController) *SitesNetworks

NewSitesNetworks creates a new instance of SitesNetworks. It takes a baseController as a parameter and returns a pointer to the SitesNetworks.

func (*SitesNetworks) ListSiteNetworksDerived 

func (s *SitesNetworks) ListSiteNetworksDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool) (
	models.ApiResponse[[]models.Network],
	error)

ListSiteNetworksDerived takes context, siteId, resolve as parameters and returns an models.ApiResponse with []models.Network data and an error if there was an issue with the request or response. Retrieves the list of Networks available for the Site

type SitesPsks 

type SitesPsks struct {
	// contains filtered or unexported fields
}

SitesPsks represents a controller struct.

func NewSitesPsks 

func NewSitesPsks(baseController baseController) *SitesPsks

NewSitesPsks creates a new instance of SitesPsks. It takes a baseController as a parameter and returns a pointer to the SitesPsks.

func (*SitesPsks) CreateSitePsk 

func (s *SitesPsks) CreateSitePsk(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.Psk) (
	models.ApiResponse[models.Psk],
	error)

CreateSitePsk takes context, siteId, body as parameters and returns an models.ApiResponse with models.Psk data and an error if there was an issue with the request or response. Create Site PSK When `usage`==`macs`, corresponding "macs" field will hold a list consisting of client mac addresses (["xx:xx:xx:xx:xx",...]) or mac patterns(["xx:xx:*","xx*",...]) or both (["xx:xx:xx:xx:xx:xx", "xx:*", ...]). This list is capped at 5000

func (*SitesPsks) DeleteSitePsk 

func (s *SitesPsks) DeleteSitePsk(
	ctx context.Context,
	siteId uuid.UUID,
	pskId uuid.UUID) (
	*http.Response,
	error)

DeleteSitePsk takes context, siteId, pskId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site PSK

func (*SitesPsks) GetSitePsk 

func (s *SitesPsks) GetSitePsk(
	ctx context.Context,
	siteId uuid.UUID,
	pskId uuid.UUID) (
	models.ApiResponse[models.Psk],
	error)

GetSitePsk takes context, siteId, pskId as parameters and returns an models.ApiResponse with models.Psk data and an error if there was an issue with the request or response. Get Site PSK Details

func (*SitesPsks) ImportSitePsks 

func (s *SitesPsks) ImportSitePsks(
	ctx context.Context,
	siteId uuid.UUID,
	file *models.FileWrapper) (
	models.ApiResponse[[]models.Psk],
	error)

ImportSitePsks takes context, siteId, file as parameters and returns an models.ApiResponse with []models.Psk data and an error if there was an issue with the request or response. Import PSK from CSV file or JSON ## CSV File Format ```csv PSK Import CSV File Format: name,ssid,passphrase,usage,vlan_id,mac Common,warehouse,foryoureyesonly,single,35,a31425f31278 Justin,reception,visible,multi,1002 ```

func (*SitesPsks) ListSitePsks 

func (s *SitesPsks) ListSitePsks(
	ctx context.Context,
	siteId uuid.UUID,
	ssid *string,
	role *string,
	name *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Psk],
	error)

ListSitePsks takes context, siteId, ssid, role, name, limit, page as parameters and returns an models.ApiResponse with []models.Psk data and an error if there was an issue with the request or response. Get List of Site PSKs

func (*SitesPsks) UpdateSiteMultiplePsks 

func (s *SitesPsks) UpdateSiteMultiplePsks(
	ctx context.Context,
	siteId uuid.UUID,
	body []models.Psk) (
	models.ApiResponse[[]models.Psk],
	error)

UpdateSiteMultiplePsks takes context, siteId, body as parameters and returns an models.ApiResponse with []models.Psk data and an error if there was an issue with the request or response. Update multiple PSKs

func (*SitesPsks) UpdateSitePsk 

func (s *SitesPsks) UpdateSitePsk(
	ctx context.Context,
	siteId uuid.UUID,
	pskId uuid.UUID,
	body *models.Psk) (
	models.ApiResponse[models.Psk],
	error)

UpdateSitePsk takes context, siteId, pskId, body as parameters and returns an models.ApiResponse with models.Psk data and an error if there was an issue with the request or response. Update Site PSK

type SitesRFTemplates 

type SitesRFTemplates struct {
	// contains filtered or unexported fields
}

SitesRFTemplates represents a controller struct.

func NewSitesRFTemplates 

func NewSitesRFTemplates(baseController baseController) *SitesRFTemplates

NewSitesRFTemplates creates a new instance of SitesRFTemplates. It takes a baseController as a parameter and returns a pointer to the SitesRFTemplates.

func (*SitesRFTemplates) ListSiteRfTemplateDerived added in v0.3.17 

func (s *SitesRFTemplates) ListSiteRfTemplateDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool) (
	models.ApiResponse[[]models.RfTemplate],
	error)

ListSiteRfTemplateDerived takes context, siteId, resolve as parameters and returns an models.ApiResponse with []models.RfTemplate data and an error if there was an issue with the request or response. Get derived RF Templates for Site

type SitesRRM 

type SitesRRM struct {
	// contains filtered or unexported fields
}

SitesRRM represents a controller struct.

func NewSitesRRM 

func NewSitesRRM(baseController baseController) *SitesRRM

NewSitesRRM creates a new instance of SitesRRM. It takes a baseController as a parameter and returns a pointer to the SitesRRM.

func (*SitesRRM) GetSiteCurrentChannelPlanning 

func (s *SitesRRM) GetSiteCurrentChannelPlanning(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.Rrm],
	error)

GetSiteCurrentChannelPlanning takes context, siteId as parameters and returns an models.ApiResponse with models.Rrm data and an error if there was an issue with the request or response. Get Current Channel Planning

func (*SitesRRM) GetSiteCurrentRrmConsiderations 

func (s *SitesRRM) GetSiteCurrentRrmConsiderations(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	band models.Dot11BandEnum) (
	models.ApiResponse[models.ResponseRrmConsideration],
	error)

GetSiteCurrentRrmConsiderations takes context, siteId, deviceId, band as parameters and returns an models.ApiResponse with models.ResponseRrmConsideration data and an error if there was an issue with the request or response. Get Current RRM Considerations for an AP on a Specific Band

func (*SitesRRM) GetSiteCurrentRrmNeighbors 

func (s *SitesRRM) GetSiteCurrentRrmNeighbors(
	ctx context.Context,
	siteId uuid.UUID,
	band models.Dot11BandEnum,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseRrmNeighbors],
	error)

GetSiteCurrentRrmNeighbors takes context, siteId, band, limit, page as parameters and returns an models.ApiResponse with models.ResponseRrmNeighbors data and an error if there was an issue with the request or response. Get Current RRM observed neighbors

func (*SitesRRM) GetSiteRrmEvents 

func (s *SitesRRM) GetSiteRrmEvents(
	ctx context.Context,
	siteId uuid.UUID,
	band *models.Dot11BandEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseEventsRrm],
	error)

GetSiteRrmEvents takes context, siteId, band, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponseEventsRrm data and an error if there was an issue with the request or response. Get Site RRM Events

type SitesRSSIZones 

type SitesRSSIZones struct {
	// contains filtered or unexported fields
}

SitesRSSIZones represents a controller struct.

func NewSitesRSSIZones 

func NewSitesRSSIZones(baseController baseController) *SitesRSSIZones

NewSitesRSSIZones creates a new instance of SitesRSSIZones. It takes a baseController as a parameter and returns a pointer to the SitesRSSIZones.

func (*SitesRSSIZones) CreateSiteRssiZone 

func (s *SitesRSSIZones) CreateSiteRssiZone(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.RssiZone) (
	models.ApiResponse[models.RssiZone],
	error)

CreateSiteRssiZone takes context, siteId, body as parameters and returns an models.ApiResponse with models.RssiZone data and an error if there was an issue with the request or response. Create RSSI Zone

func (*SitesRSSIZones) DeleteSiteRssiZone 

func (s *SitesRSSIZones) DeleteSiteRssiZone(
	ctx context.Context,
	siteId uuid.UUID,
	rssizoneId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteRssiZone takes context, siteId, rssizoneId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site RSSI Zone

func (*SitesRSSIZones) GetSiteRssiZone 

func (s *SitesRSSIZones) GetSiteRssiZone(
	ctx context.Context,
	siteId uuid.UUID,
	rssizoneId uuid.UUID) (
	models.ApiResponse[[]models.RssiZone],
	error)

GetSiteRssiZone takes context, siteId, rssizoneId as parameters and returns an models.ApiResponse with []models.RssiZone data and an error if there was an issue with the request or response. Get Site RSSI Zone details

func (*SitesRSSIZones) ListSiteRssiZones 

func (s *SitesRSSIZones) ListSiteRssiZones(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.RssiZone],
	error)

ListSiteRssiZones takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.RssiZone data and an error if there was an issue with the request or response. Get List of Site RSSI Zone (RSSI-based)

func (*SitesRSSIZones) UpdateSiteRssiZone 

func (s *SitesRSSIZones) UpdateSiteRssiZone(
	ctx context.Context,
	siteId uuid.UUID,
	rssizoneId uuid.UUID,
	body *models.RssiZone) (
	models.ApiResponse[models.RssiZone],
	error)

UpdateSiteRssiZone takes context, siteId, rssizoneId, body as parameters and returns an models.ApiResponse with models.RssiZone data and an error if there was an issue with the request or response. Update Site RSSI Zone

type SitesRfdiags 

type SitesRfdiags struct {
	// contains filtered or unexported fields
}

SitesRfdiags represents a controller struct.

func NewSitesRfdiags 

func NewSitesRfdiags(baseController baseController) *SitesRfdiags

NewSitesRfdiags creates a new instance of SitesRfdiags. It takes a baseController as a parameter and returns a pointer to the SitesRfdiags.

func (*SitesRfdiags) DeleteSiteRfdiagRecording 

func (s *SitesRfdiags) DeleteSiteRfdiagRecording(
	ctx context.Context,
	siteId uuid.UUID,
	rfdiagId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteRfdiagRecording takes context, siteId, rfdiagId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Recording

func (*SitesRfdiags) DownloadSiteRfdiagRecording 

func (s *SitesRfdiags) DownloadSiteRfdiagRecording(
	ctx context.Context,
	siteId uuid.UUID,
	rfdiagId uuid.UUID) (
	models.ApiResponse[[]byte],
	error)

DownloadSiteRfdiagRecording takes context, siteId, rfdiagId as parameters and returns an models.ApiResponse with []byte data and an error if there was an issue with the request or response. Download Recording Download raw_events blob

func (*SitesRfdiags) GetSiteRfdiagRecording 

func (s *SitesRfdiags) GetSiteRfdiagRecording(
	ctx context.Context,
	siteId uuid.UUID,
	rfdiagId uuid.UUID) (
	models.ApiResponse[[]models.RfDiagInfoItem],
	error)

GetSiteRfdiagRecording takes context, siteId, rfdiagId as parameters and returns an models.ApiResponse with []models.RfDiagInfoItem data and an error if there was an issue with the request or response. Get RF Diage Recording Details

func (*SitesRfdiags) GetSiteSiteRfdiagRecording 

func (s *SitesRfdiags) GetSiteSiteRfdiagRecording(
	ctx context.Context,
	siteId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[[][]models.RfDiagInfoItem],
	error)

GetSiteSiteRfdiagRecording takes context, siteId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with [][]models.RfDiagInfoItem data and an error if there was an issue with the request or response. List RF Glass Recording

func (*SitesRfdiags) StartSiteRecording 

func (s *SitesRfdiags) StartSiteRecording(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.RfDiag) (
	models.ApiResponse[[]models.RfDiagInfoItem],
	error)

StartSiteRecording takes context, siteId, body as parameters and returns an models.ApiResponse with []models.RfDiagInfoItem data and an error if there was an issue with the request or response. Start RF Glass Recording

func (*SitesRfdiags) StopSiteRfdiagRecording 

func (s *SitesRfdiags) StopSiteRfdiagRecording(
	ctx context.Context,
	siteId uuid.UUID,
	rfdiagId uuid.UUID) (
	*http.Response,
	error)

StopSiteRfdiagRecording takes context, siteId, rfdiagId as parameters and returns an *Response and an error if there was an issue with the request or response. If the recording session is active for the given rfdiag_id, it will finish the recording. duration and end_time will be updated to reflect the correct values.

func (*SitesRfdiags) UpdateSiteRfdiagRecording 

func (s *SitesRfdiags) UpdateSiteRfdiagRecording(
	ctx context.Context,
	siteId uuid.UUID,
	rfdiagId uuid.UUID,
	body *models.RfDiag) (
	models.ApiResponse[[]models.RfDiagInfoItem],
	error)

UpdateSiteRfdiagRecording takes context, siteId, rfdiagId, body as parameters and returns an models.ApiResponse with []models.RfDiagInfoItem data and an error if there was an issue with the request or response. Update Recording

type SitesRogues 

type SitesRogues struct {
	// contains filtered or unexported fields
}

SitesRogues represents a controller struct.

func NewSitesRogues 

func NewSitesRogues(baseController baseController) *SitesRogues

NewSitesRogues creates a new instance of SitesRogues. It takes a baseController as a parameter and returns a pointer to the SitesRogues.

func (*SitesRogues) CountSiteRogueEvents 

func (s *SitesRogues) CountSiteRogueEvents(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteRogueEventsCountDistinctEnum,
	mType *models.RogueTypeEnum,
	ssid *string,
	bssid *string,
	apMac *string,
	channel *string,
	seenOnLan *bool,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteRogueEvents takes context, siteId, distinct, mType, ssid, bssid, apMac, channel, seenOnLan, limit, start, end, duration as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Rogue Events

func (*SitesRogues) GetSiteRogueAP 

func (s *SitesRogues) GetSiteRogueAP(
	ctx context.Context,
	siteId uuid.UUID,
	rogueBssid string) (
	models.ApiResponse[models.RogueDetails],
	error)

GetSiteRogueAP takes context, siteId, rogueBssid as parameters and returns an models.ApiResponse with models.RogueDetails data and an error if there was an issue with the request or response. Get Rogue AP Details

func (*SitesRogues) ListSiteRogueAPs 

func (s *SitesRogues) ListSiteRogueAPs(
	ctx context.Context,
	siteId uuid.UUID,
	mType *models.RogueTypeEnum,
	limit *int,
	start *int,
	end *int,
	duration *string,
	interval *string) (
	models.ApiResponse[models.ResponseInsightRogue],
	error)

ListSiteRogueAPs takes context, siteId, mType, limit, start, end, duration, interval as parameters and returns an models.ApiResponse with models.ResponseInsightRogue data and an error if there was an issue with the request or response. Get List of Site Rogue/Neighbor APs

func (*SitesRogues) ListSiteRogueClients 

func (s *SitesRogues) ListSiteRogueClients(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	start *int,
	end *int,
	duration *string,
	interval *string) (
	models.ApiResponse[models.ResponseInsightRogueClient],
	error)

ListSiteRogueClients takes context, siteId, limit, start, end, duration, interval as parameters and returns an models.ApiResponse with models.ResponseInsightRogueClient data and an error if there was an issue with the request or response. Get List of Site Rogue Clients

func (*SitesRogues) SearchSiteRogueEvents 

func (s *SitesRogues) SearchSiteRogueEvents(
	ctx context.Context,
	siteId uuid.UUID,
	mType *models.RogueTypeEnum,
	ssid *string,
	bssid *string,
	apMac *string,
	channel *int,
	seenOnLan *bool,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseEventsRogueSearch],
	error)

SearchSiteRogueEvents takes context, siteId, mType, ssid, bssid, apMac, channel, seenOnLan, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseEventsRogueSearch data and an error if there was an issue with the request or response. Search Rogue Events

type SitesSLEs 

type SitesSLEs struct {
	// contains filtered or unexported fields
}

SitesSLEs represents a controller struct.

func NewSitesSLEs 

func NewSitesSLEs(baseController baseController) *SitesSLEs

NewSitesSLEs creates a new instance of SitesSLEs. It takes a baseController as a parameter and returns a pointer to the SitesSLEs.

func (*SitesSLEs) GetSiteSleClassifierDetails 

func (s *SitesSLEs) GetSiteSleClassifierDetails(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SleSummaryScopeEnum,
	scopeId string,
	metric string,
	classifier string,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.SleClassifierSummary],
	error)

GetSiteSleClassifierDetails takes context, siteId, scope, scopeId, metric, classifier, start, end, duration as parameters and returns an models.ApiResponse with models.SleClassifierSummary data and an error if there was an issue with the request or response. Get SLE classifier details

func (*SitesSLEs) GetSiteSleHistogram 

func (s *SitesSLEs) GetSiteSleHistogram(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleHistogramScopeParametersEnum,
	scopeId string,
	metric string,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.SleHistogram],
	error)

GetSiteSleHistogram takes context, siteId, scope, scopeId, metric, start, end, duration as parameters and returns an models.ApiResponse with models.SleHistogram data and an error if there was an issue with the request or response. Get the histogram for the SLE metric

func (*SitesSLEs) GetSiteSleImpactSummary 

func (s *SitesSLEs) GetSiteSleImpactSummary(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleImpactSummaryScopeParametersEnum,
	scopeId string,
	metric string,
	start *int,
	end *int,
	duration *string,
	fields *models.SiteSleImpactSummaryFieldsParameterEnum,
	classifier *string) (
	models.ApiResponse[models.SleImpactSummary],
	error)

GetSiteSleImpactSummary takes context, siteId, scope, scopeId, metric, start, end, duration, fields, classifier as parameters and returns an models.ApiResponse with models.SleImpactSummary data and an error if there was an issue with the request or response. Get impact summary counts optionally filtered by classifier and failure type * Wireless SLE Fields: `wlan`, `device_type`, `device_os` ,`band`, `ap`, `server`, `mxedge` * Wired SLE Fields: `switch`, `client`, `vlan`, `interface`, `chassis` * WAN SLE Fields: `gateway`, `client`, `interface`, `chassis`, `peer_path`, `gateway_zones`

func (*SitesSLEs) GetSiteSleImpactedApplications 

func (s *SitesSLEs) GetSiteSleImpactedApplications(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleScopeEnum,
	scopeId uuid.UUID,
	metric string,
	start *int,
	end *int,
	duration *string,
	classifier *string) (
	models.ApiResponse[models.SleImpactedApplications],
	error)

GetSiteSleImpactedApplications takes context, siteId, scope, scopeId, metric, start, end, duration, classifier as parameters and returns an models.ApiResponse with models.SleImpactedApplications data and an error if there was an issue with the request or response. For WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type

func (*SitesSLEs) GetSiteSleImpactedAps 

func (s *SitesSLEs) GetSiteSleImpactedAps(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleImpactedApsScopeParametersEnum,
	scopeId uuid.UUID,
	metric string,
	start *int,
	end *int,
	duration *string,
	classifier *string) (
	models.ApiResponse[models.SleImpactedAps],
	error)

GetSiteSleImpactedAps takes context, siteId, scope, scopeId, metric, start, end, duration, classifier as parameters and returns an models.ApiResponse with models.SleImpactedAps data and an error if there was an issue with the request or response. For Wireless SLEs. Get list of impacted APs optionally filtered by classifier and failure type

func (*SitesSLEs) GetSiteSleImpactedChassis 

func (s *SitesSLEs) GetSiteSleImpactedChassis(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleImpactedChassisScopeParametersEnum,
	scopeId uuid.UUID,
	metric string,
	start *int,
	end *int,
	duration *string,
	classifier *string) (
	models.ApiResponse[models.SleImpactedChassis],
	error)

GetSiteSleImpactedChassis takes context, siteId, scope, scopeId, metric, start, end, duration, classifier as parameters and returns an models.ApiResponse with models.SleImpactedChassis data and an error if there was an issue with the request or response. For Wired and WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type

func (*SitesSLEs) GetSiteSleImpactedGateways 

func (s *SitesSLEs) GetSiteSleImpactedGateways(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleImpactedGatewaysScopeParametersEnum,
	scopeId uuid.UUID,
	metric string,
	start *int,
	end *int,
	duration *string,
	classifier *string) (
	models.ApiResponse[models.SleImpactedGateways],
	error)

GetSiteSleImpactedGateways takes context, siteId, scope, scopeId, metric, start, end, duration, classifier as parameters and returns an models.ApiResponse with models.SleImpactedGateways data and an error if there was an issue with the request or response. For WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type

func (*SitesSLEs) GetSiteSleImpactedInterfaces 

func (s *SitesSLEs) GetSiteSleImpactedInterfaces(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleImpactedInterfacesScopeParametersEnum,
	scopeId uuid.UUID,
	metric string,
	start *int,
	end *int,
	duration *string,
	classifier *string) (
	models.ApiResponse[models.SleImpactedInterfaces],
	error)

GetSiteSleImpactedInterfaces takes context, siteId, scope, scopeId, metric, start, end, duration, classifier as parameters and returns an models.ApiResponse with models.SleImpactedInterfaces data and an error if there was an issue with the request or response. For Wired and WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type

func (*SitesSLEs) GetSiteSleImpactedSwitches 

func (s *SitesSLEs) GetSiteSleImpactedSwitches(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleImpactedSwitchesScopeParametersEnum,
	scopeId uuid.UUID,
	metric string,
	start *int,
	end *int,
	duration *string,
	classifier *string) (
	models.ApiResponse[models.SleImpactedSwitches],
	error)

GetSiteSleImpactedSwitches takes context, siteId, scope, scopeId, metric, start, end, duration, classifier as parameters and returns an models.ApiResponse with models.SleImpactedSwitches data and an error if there was an issue with the request or response. For Wired SLEs. Get list of impacted switches optionally filtered by classifier and failure type

func (*SitesSLEs) GetSiteSleImpactedWiredClients 

func (s *SitesSLEs) GetSiteSleImpactedWiredClients(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleImpactedClientsScopeParametersEnum,
	scopeId uuid.UUID,
	metric string,
	start *int,
	end *int,
	duration *string,
	classifier *string) (
	models.ApiResponse[models.SleImpactedClients],
	error)

GetSiteSleImpactedWiredClients takes context, siteId, scope, scopeId, metric, start, end, duration, classifier as parameters and returns an models.ApiResponse with models.SleImpactedClients data and an error if there was an issue with the request or response. For Wired SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type

func (*SitesSLEs) GetSiteSleImpactedWirelessClients 

func (s *SitesSLEs) GetSiteSleImpactedWirelessClients(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleImpactedUsersScopeParameterEnum,
	scopeId uuid.UUID,
	metric string,
	start *int,
	end *int,
	duration *string,
	classifier *string) (
	models.ApiResponse[models.SleImpactedUsers],
	error)

GetSiteSleImpactedWirelessClients takes context, siteId, scope, scopeId, metric, start, end, duration, classifier as parameters and returns an models.ApiResponse with models.SleImpactedUsers data and an error if there was an issue with the request or response. For Wireless SLEs. Get list of impacted wireless users optionally filtered by classifier and failure type

func (*SitesSLEs) GetSiteSleMetricClassifiers 

func (s *SitesSLEs) GetSiteSleMetricClassifiers(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleMetricClassifiersScopeParametersEnum,
	scopeId string,
	metric string) (
	models.ApiResponse[[]string],
	error)

GetSiteSleMetricClassifiers takes context, siteId, scope, scopeId, metric as parameters and returns an models.ApiResponse with []string data and an error if there was an issue with the request or response. Get the list of classifiers for a specific metric

func (*SitesSLEs) GetSiteSleSummary 

func (s *SitesSLEs) GetSiteSleSummary(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleMetricSummaryScopeParametersEnum,
	scopeId string,
	metric string,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.SleSummary],
	error)

GetSiteSleSummary takes context, siteId, scope, scopeId, metric, start, end, duration as parameters and returns an models.ApiResponse with models.SleSummary data and an error if there was an issue with the request or response. Get the summary for the SLE metric

func (*SitesSLEs) GetSiteSleThreshold 

func (s *SitesSLEs) GetSiteSleThreshold(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleThresholdScopeParameterEnum,
	scopeId string,
	metric string) (
	models.ApiResponse[models.SleThreshold],
	error)

GetSiteSleThreshold takes context, siteId, scope, scopeId, metric as parameters and returns an models.ApiResponse with models.SleThreshold data and an error if there was an issue with the request or response. Get the SLE threshold

func (*SitesSLEs) GetSiteSlesMetrics 

func (s *SitesSLEs) GetSiteSlesMetrics(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleMetricsScopeParametersEnum,
	scopeId string) (
	models.ApiResponse[models.SiteSleMetrics],
	error)

GetSiteSlesMetrics takes context, siteId, scope, scopeId as parameters and returns an models.ApiResponse with models.SiteSleMetrics data and an error if there was an issue with the request or response. Get the list of metrics for the given scope

func (*SitesSLEs) ReplaceSiteSleThreshold 

func (s *SitesSLEs) ReplaceSiteSleThreshold(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleThresholdScopeParameterEnum,
	scopeId string,
	metric string,
	body *models.SleThreshold) (
	models.ApiResponse[models.SleThreshold],
	error)

ReplaceSiteSleThreshold takes context, siteId, scope, scopeId, metric, body as parameters and returns an models.ApiResponse with models.SleThreshold data and an error if there was an issue with the request or response. Replace the SLE threshold

func (*SitesSLEs) UpdateSiteSleThreshold 

func (s *SitesSLEs) UpdateSiteSleThreshold(
	ctx context.Context,
	siteId uuid.UUID,
	scope models.SiteSleThresholdScopeParameterEnum,
	scopeId string,
	metric string,
	body *models.SleThreshold) (
	models.ApiResponse[models.SleThreshold],
	error)

UpdateSiteSleThreshold takes context, siteId, scope, scopeId, metric, body as parameters and returns an models.ApiResponse with models.SleThreshold data and an error if there was an issue with the request or response. Update the SLE threshold

type SitesSecIntelProfiles added in v0.3.17 

type SitesSecIntelProfiles struct {
	// contains filtered or unexported fields
}

SitesSecIntelProfiles represents a controller struct.

func NewSitesSecIntelProfiles added in v0.3.17 

func NewSitesSecIntelProfiles(baseController baseController) *SitesSecIntelProfiles

NewSitesSecIntelProfiles creates a new instance of SitesSecIntelProfiles. It takes a baseController as a parameter and returns a pointer to the SitesSecIntelProfiles.

func (*SitesSecIntelProfiles) ListSiteSecIntelProfilesDerived added in v0.3.17 

func (s *SitesSecIntelProfiles) ListSiteSecIntelProfilesDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool) (
	models.ApiResponse[[]models.SecintelProfile],
	error)

ListSiteSecIntelProfilesDerived takes context, siteId, resolve as parameters and returns an models.ApiResponse with []models.SecintelProfile data and an error if there was an issue with the request or response. Get derived Sky-ATP secintel profiles for Site

type SitesServicePolicies 

type SitesServicePolicies struct {
	// contains filtered or unexported fields
}

SitesServicePolicies represents a controller struct.

func NewSitesServicePolicies 

func NewSitesServicePolicies(baseController baseController) *SitesServicePolicies

NewSitesServicePolicies creates a new instance of SitesServicePolicies. It takes a baseController as a parameter and returns a pointer to the SitesServicePolicies.

func (*SitesServicePolicies) ListSiteServicePoliciesDerived 

func (s *SitesServicePolicies) ListSiteServicePoliciesDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool) (
	models.ApiResponse[[]models.OrgServicePolicy],
	error)

ListSiteServicePoliciesDerived takes context, siteId, resolve as parameters and returns an models.ApiResponse with []models.OrgServicePolicy data and an error if there was an issue with the request or response. Retrieves the list of Service Policies available for the Site

type SitesServices 

type SitesServices struct {
	// contains filtered or unexported fields
}

SitesServices represents a controller struct.

func NewSitesServices 

func NewSitesServices(baseController baseController) *SitesServices

NewSitesServices creates a new instance of SitesServices. It takes a baseController as a parameter and returns a pointer to the SitesServices.

func (*SitesServices) CountSiteServicePathEvents 

func (s *SitesServices) CountSiteServicePathEvents(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteServiceEventsCountDistinctEnum,
	mType *string,
	text *string,
	vpnName *string,
	vpnPath *string,
	policy *string,
	portId *string,
	model *string,
	version *string,
	timestamp *float64,
	mac *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteServicePathEvents takes context, siteId, distinct, mType, text, vpnName, vpnPath, policy, portId, model, version, timestamp, mac, start, end, duration, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Service Path Events

func (*SitesServices) ListSiteServicesDerived 

func (s *SitesServices) ListSiteServicesDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool) (
	models.ApiResponse[[]models.Service],
	error)

ListSiteServicesDerived takes context, siteId, resolve as parameters and returns an models.ApiResponse with []models.Service data and an error if there was an issue with the request or response. Retrieves the list of Services available for the Site

func (*SitesServices) SearchSiteServicePathEvents 

func (s *SitesServices) SearchSiteServicePathEvents(
	ctx context.Context,
	siteId uuid.UUID,
	mType *string,
	text *string,
	peerPortId *string,
	peerMac *string,
	vpnName *string,
	vpnPath *string,
	policy *string,
	portId *string,
	model *string,
	version *string,
	timestamp *float64,
	mac *string,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.ResponseEventsPathSearch],
	error)

SearchSiteServicePathEvents takes context, siteId, mType, text, peerPortId, peerMac, vpnName, vpnPath, policy, portId, model, version, timestamp, mac, start, end, duration, limit as parameters and returns an models.ApiResponse with models.ResponseEventsPathSearch data and an error if there was an issue with the request or response. Search Service Path Events

type SitesSetting 

type SitesSetting struct {
	// contains filtered or unexported fields
}

SitesSetting represents a controller struct.

func NewSitesSetting 

func NewSitesSetting(baseController baseController) *SitesSetting

NewSitesSetting creates a new instance of SitesSetting. It takes a baseController as a parameter and returns a pointer to the SitesSetting.

func (*SitesSetting) CreateSiteWatchedStations 

func (s *SitesSetting) CreateSiteWatchedStations(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.MacAddresses) (
	models.ApiResponse[models.MacAddresses],
	error)

CreateSiteWatchedStations takes context, siteId, body as parameters and returns an models.ApiResponse with models.MacAddresses data and an error if there was an issue with the request or response. This endpoint is to provide list of client macs for annotation as watched station. Retrieve the current clients list from `watched_station_url` under Site:Setting

func (*SitesSetting) CreateSiteWirelessClientsAllowlist 

func (s *SitesSetting) CreateSiteWirelessClientsAllowlist(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.MacAddresses) (
	models.ApiResponse[models.MacAddresses],
	error)

CreateSiteWirelessClientsAllowlist takes context, siteId, body as parameters and returns an models.ApiResponse with models.MacAddresses data and an error if there was an issue with the request or response. This endpoint is to provide list of client macs for annotation as whitelist. Retrieve the current clients list from `whitelist_url` under Site:Setting

func (*SitesSetting) CreateSiteWirelessClientsBlocklist 

func (s *SitesSetting) CreateSiteWirelessClientsBlocklist(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.MacAddresses) (
	models.ApiResponse[models.MacAddresses],
	error)

CreateSiteWirelessClientsBlocklist takes context, siteId, body as parameters and returns an models.ApiResponse with models.MacAddresses data and an error if there was an issue with the request or response. This endpoint is to provide list of client macs for annotation blacklist. Retrieve the current clients list `blacklist_url` under Site:Setting

func (*SitesSetting) DeleteSiteWatchedStations 

func (s *SitesSetting) DeleteSiteWatchedStations(
	ctx context.Context,
	siteId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteWatchedStations takes context, siteId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site Watched Station Clients

func (*SitesSetting) DeleteSiteWirelessClientsAllowlist 

func (s *SitesSetting) DeleteSiteWirelessClientsAllowlist(
	ctx context.Context,
	siteId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteWirelessClientsAllowlist takes context, siteId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site Whitelist Station Clients

func (*SitesSetting) DeleteSiteWirelessClientsBlocklist 

func (s *SitesSetting) DeleteSiteWirelessClientsBlocklist(
	ctx context.Context,
	siteId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteWirelessClientsBlocklist takes context, siteId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site Blacklist Station Clients

func (*SitesSetting) GetSiteSetting 

func (s *SitesSetting) GetSiteSetting(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.SiteSetting],
	error)

GetSiteSetting takes context, siteId as parameters and returns an models.ApiResponse with models.SiteSetting data and an error if there was an issue with the request or response. Get the Derived Site Settings, generated by merging the Org level templates (network templates, gateway templates) and the Site level configuration. If the same parameter is defined in both scopes, the Site level one is used.

func (*SitesSetting) GetSiteSettingDerived added in v0.4.0 

func (s *SitesSetting) GetSiteSettingDerived(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.SiteSetting],
	error)

GetSiteSettingDerived takes context, siteId as parameters and returns an models.ApiResponse with models.SiteSetting data and an error if there was an issue with the request or response. Get Site Settings

func (*SitesSetting) UpdateSiteSettings 

func (s *SitesSetting) UpdateSiteSettings(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.SiteSetting) (
	models.ApiResponse[models.SiteSetting],
	error)

UpdateSiteSettings takes context, siteId, body as parameters and returns an models.ApiResponse with models.SiteSetting data and an error if there was an issue with the request or response. Update Site Settings

type SitesSiteTemplates 

type SitesSiteTemplates struct {
	// contains filtered or unexported fields
}

SitesSiteTemplates represents a controller struct.

func NewSitesSiteTemplates 

func NewSitesSiteTemplates(baseController baseController) *SitesSiteTemplates

NewSitesSiteTemplates creates a new instance of SitesSiteTemplates. It takes a baseController as a parameter and returns a pointer to the SitesSiteTemplates.

func (*SitesSiteTemplates) ListSiteSiteTemplateDerived added in v0.3.17 

func (s *SitesSiteTemplates) ListSiteSiteTemplateDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool) (
	models.ApiResponse[[]models.SiteTemplate],
	error)

ListSiteSiteTemplateDerived takes context, siteId, resolve as parameters and returns an models.ApiResponse with []models.SiteTemplate data and an error if there was an issue with the request or response. Get derived Site Templates for Site

type SitesSkyatp 

type SitesSkyatp struct {
	// contains filtered or unexported fields
}

SitesSkyatp represents a controller struct.

func NewSitesSkyatp 

func NewSitesSkyatp(baseController baseController) *SitesSkyatp

NewSitesSkyatp creates a new instance of SitesSkyatp. It takes a baseController as a parameter and returns a pointer to the SitesSkyatp.

func (*SitesSkyatp) CountSiteSkyatpEvents 

func (s *SitesSkyatp) CountSiteSkyatpEvents(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteSkyAtpEventsCountDistinctEnum,
	mType *string,
	mac *string,
	deviceMac *string,
	threatLevel *int,
	ipAddress *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteSkyatpEvents takes context, siteId, distinct, mType, mac, deviceMac, threatLevel, ipAddress, limit, start, end, duration as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Skyatp Events (WIP)

func (*SitesSkyatp) SearchSiteSkyatpEvents 

func (s *SitesSkyatp) SearchSiteSkyatpEvents(
	ctx context.Context,
	siteId uuid.UUID,
	mType *string,
	mac *string,
	deviceMac *string,
	threatLevel *int,
	ipAddress *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseEventsSkyAtpSearch],
	error)

SearchSiteSkyatpEvents takes context, siteId, mType, mac, deviceMac, threatLevel, ipAddress, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseEventsSkyAtpSearch data and an error if there was an issue with the request or response. Search Skyatp Events (WIP)

type SitesStats added in v0.2.25 

type SitesStats struct {
	// contains filtered or unexported fields
}

SitesStats represents a controller struct.

func NewSitesStats added in v0.2.25 

func NewSitesStats(baseController baseController) *SitesStats

NewSitesStats creates a new instance of SitesStats. It takes a baseController as a parameter and returns a pointer to the SitesStats.

func (*SitesStats) GetSiteStats added in v0.2.25 

func (s *SitesStats) GetSiteStats(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.StatsSite],
	error)

GetSiteStats takes context, siteId as parameters and returns an models.ApiResponse with models.StatsSite data and an error if there was an issue with the request or response. Get Sites Stats

type SitesStatsApps added in v0.2.25 

type SitesStatsApps struct {
	// contains filtered or unexported fields
}

SitesStatsApps represents a controller struct.

func NewSitesStatsApps added in v0.2.25 

func NewSitesStatsApps(baseController baseController) *SitesStatsApps

NewSitesStatsApps creates a new instance of SitesStatsApps. It takes a baseController as a parameter and returns a pointer to the SitesStatsApps.

func (*SitesStatsApps) CountSiteApps added in v0.2.25 

func (s *SitesStatsApps) CountSiteApps(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteAppsCountDistinctEnum,
	deviceMac *string,
	app *string,
	wired *string) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteApps takes context, siteId, distinct, deviceMac, app, wired as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Applications

type SitesStatsAssets added in v0.2.25 

type SitesStatsAssets struct {
	// contains filtered or unexported fields
}

SitesStatsAssets represents a controller struct.

func NewSitesStatsAssets added in v0.2.25 

func NewSitesStatsAssets(baseController baseController) *SitesStatsAssets

NewSitesStatsAssets creates a new instance of SitesStatsAssets. It takes a baseController as a parameter and returns a pointer to the SitesStatsAssets.

func (*SitesStatsAssets) CountSiteAssets added in v0.2.25 

func (s *SitesStatsAssets) CountSiteAssets(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteAssetsCountDistinctEnum) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteAssets takes context, siteId, distinct as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Asset by distinct field

func (*SitesStatsAssets) GetSiteAssetStats added in v0.2.25 

func (s *SitesStatsAssets) GetSiteAssetStats(
	ctx context.Context,
	siteId uuid.UUID,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.StatsAsset],
	error)

GetSiteAssetStats takes context, siteId, start, end, duration as parameters and returns an models.ApiResponse with models.StatsAsset data and an error if there was an issue with the request or response. Get Site Asset Details

func (*SitesStatsAssets) GetSiteAssetsOfInterest added in v0.2.25 

func (s *SitesStatsAssets) GetSiteAssetsOfInterest(
	ctx context.Context,
	siteId uuid.UUID,
	duration *string,
	start *int,
	end *int,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.AssetOfInterest],
	error)

GetSiteAssetsOfInterest takes context, siteId, duration, start, end, limit, page as parameters and returns an models.ApiResponse with []models.AssetOfInterest data and an error if there was an issue with the request or response. Get a list of BLE beacons that matches Asset or AssetFilter

func (*SitesStatsAssets) GetSiteDiscoveredAssetByMap added in v0.2.25 

func (s *SitesStatsAssets) GetSiteDiscoveredAssetByMap(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID) (
	models.ApiResponse[[]models.StatsAsset],
	error)

GetSiteDiscoveredAssetByMap takes context, siteId, mapId as parameters and returns an models.ApiResponse with []models.StatsAsset data and an error if there was an issue with the request or response. Get a list of BLE beacons that we discovered (whether they’ re defined as assets or not)

func (*SitesStatsAssets) ListSiteAssetsStats added in v0.2.25 

func (s *SitesStatsAssets) ListSiteAssetsStats(
	ctx context.Context,
	siteId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.StatsAsset],
	error)

ListSiteAssetsStats takes context, siteId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with []models.StatsAsset data and an error if there was an issue with the request or response. Get List of Site Assets Stats

func (*SitesStatsAssets) ListSiteDiscoveredAssets added in v0.2.25 

func (s *SitesStatsAssets) ListSiteDiscoveredAssets(
	ctx context.Context,
	siteId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Asset],
	error)

ListSiteDiscoveredAssets takes context, siteId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with []models.Asset data and an error if there was an issue with the request or response. Get List of Site Discovered BLE Assets that doesn’t match any of the Asset / Assetfilters

func (*SitesStatsAssets) SearchSiteAssets added in v0.2.25 

func (s *SitesStatsAssets) SearchSiteAssets(
	ctx context.Context,
	siteId uuid.UUID,
	mac *string,
	mapId *string,
	ibeaconUuid *string,
	ibeaconMajor *int,
	ibeaconMinor *int,
	eddystoneUidNamespace *string,
	eddystoneUidInstance *string,
	eddystoneUrl *string,
	deviceName *string,
	by *string,
	name *string,
	apMac *string,
	beam *string,
	rssi *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseStatsAssets],
	error)

SearchSiteAssets takes context, siteId, mac, mapId, ibeaconUuid, ibeaconMajor, ibeaconMinor, eddystoneUidNamespace, eddystoneUidInstance, eddystoneUrl, deviceName, by, name, apMac, beam, rssi, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseStatsAssets data and an error if there was an issue with the request or response. Assets Search

type SitesStatsBGPPeers added in v0.2.25 

type SitesStatsBGPPeers struct {
	// contains filtered or unexported fields
}

SitesStatsBGPPeers represents a controller struct.

func NewSitesStatsBGPPeers added in v0.2.25 

func NewSitesStatsBGPPeers(baseController baseController) *SitesStatsBGPPeers

NewSitesStatsBGPPeers creates a new instance of SitesStatsBGPPeers. It takes a baseController as a parameter and returns a pointer to the SitesStatsBGPPeers.

func (*SitesStatsBGPPeers) CountSiteBgpStats added in v0.2.25 

func (s *SitesStatsBGPPeers) CountSiteBgpStats(
	ctx context.Context,
	siteId uuid.UUID,
	state *string,
	distinct *string) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteBgpStats takes context, siteId, state, distinct as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count BGP Stats

func (*SitesStatsBGPPeers) SearchSiteBgpStats added in v0.2.25 

func (s *SitesStatsBGPPeers) SearchSiteBgpStats(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.ResponseSearchBgps],
	error)

SearchSiteBgpStats takes context, siteId as parameters and returns an models.ApiResponse with models.ResponseSearchBgps data and an error if there was an issue with the request or response. Search BGP Stats

type SitesStatsBeacons added in v0.2.25 

type SitesStatsBeacons struct {
	// contains filtered or unexported fields
}

SitesStatsBeacons represents a controller struct.

func NewSitesStatsBeacons added in v0.2.25 

func NewSitesStatsBeacons(baseController baseController) *SitesStatsBeacons

NewSitesStatsBeacons creates a new instance of SitesStatsBeacons. It takes a baseController as a parameter and returns a pointer to the SitesStatsBeacons.

func (*SitesStatsBeacons) ListSiteBeaconsStats added in v0.2.25 

func (s *SitesStatsBeacons) ListSiteBeaconsStats(
	ctx context.Context,
	siteId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.StatsBeacon],
	error)

ListSiteBeaconsStats takes context, siteId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with []models.StatsBeacon data and an error if there was an issue with the request or response. Get List of Site Beacons Stats

type SitesStatsCalls added in v0.2.25 

type SitesStatsCalls struct {
	// contains filtered or unexported fields
}

SitesStatsCalls represents a controller struct.

func NewSitesStatsCalls added in v0.2.25 

func NewSitesStatsCalls(baseController baseController) *SitesStatsCalls

NewSitesStatsCalls creates a new instance of SitesStatsCalls. It takes a baseController as a parameter and returns a pointer to the SitesStatsCalls.

func (*SitesStatsCalls) CountSiteCalls added in v0.2.25 

func (s *SitesStatsCalls) CountSiteCalls(
	ctx context.Context,
	siteId uuid.UUID,
	distrinct *models.CountSiteCallsDistrinctEnum,
	rating *int,
	app *string,
	start *string,
	end *string) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteCalls takes context, siteId, distrinct, rating, app, start, end as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Calls

func (*SitesStatsCalls) GetSiteCallsSummary added in v0.4.0 

func (s *SitesStatsCalls) GetSiteCallsSummary(
	ctx context.Context,
	siteId uuid.UUID,
	apMac *string,
	app *string,
	start *int,
	end *int) (
	models.ApiResponse[models.ResponseStatsCallsSummary],
	error)

GetSiteCallsSummary takes context, siteId, apMac, app, start, end as parameters and returns an models.ApiResponse with models.ResponseStatsCallsSummary data and an error if there was an issue with the request or response. Summarized, aggregated stats for the site calls

func (*SitesStatsCalls) ListSiteTroubleshootCalls added in v0.2.25 

func (s *SitesStatsCalls) ListSiteTroubleshootCalls(
	ctx context.Context,
	siteId uuid.UUID,
	ap *string,
	meetingId *string,
	mac *string,
	app *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.CallTroubleshootSummary],
	error)

ListSiteTroubleshootCalls takes context, siteId, ap, meetingId, mac, app, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.CallTroubleshootSummary data and an error if there was an issue with the request or response. Summary of calls troubleshoot by site

func (*SitesStatsCalls) SearchSiteCalls added in v0.2.25 

func (s *SitesStatsCalls) SearchSiteCalls(
	ctx context.Context,
	siteId uuid.UUID,
	mac *string,
	app *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseStatsCalls],
	error)

SearchSiteCalls takes context, siteId, mac, app, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseStatsCalls data and an error if there was an issue with the request or response. Search Calls

func (*SitesStatsCalls) TroubleshootSiteCall added in v0.2.25 

func (s *SitesStatsCalls) TroubleshootSiteCall(
	ctx context.Context,
	siteId uuid.UUID,
	clientMac string,
	meetingId string,
	mac *string,
	app *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.CallTroubleshoot],
	error)

TroubleshootSiteCall takes context, siteId, clientMac, meetingId, mac, app, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.CallTroubleshoot data and an error if there was an issue with the request or response. Troubleshoot a call

type SitesStatsClientsSDK added in v0.2.25 

type SitesStatsClientsSDK struct {
	// contains filtered or unexported fields
}

SitesStatsClientsSDK represents a controller struct.

func NewSitesStatsClientsSDK added in v0.2.25 

func NewSitesStatsClientsSDK(baseController baseController) *SitesStatsClientsSDK

NewSitesStatsClientsSDK creates a new instance of SitesStatsClientsSDK. It takes a baseController as a parameter and returns a pointer to the SitesStatsClientsSDK.

func (*SitesStatsClientsSDK) GetSiteSdkStats added in v0.2.25 

func (s *SitesStatsClientsSDK) GetSiteSdkStats(
	ctx context.Context,
	siteId uuid.UUID,
	sdkclientId uuid.UUID) (
	models.ApiResponse[models.SdkstatsWirelessClient],
	error)

GetSiteSdkStats takes context, siteId, sdkclientId as parameters and returns an models.ApiResponse with models.SdkstatsWirelessClient data and an error if there was an issue with the request or response. Get Detail Stats of a SdkClient

func (*SitesStatsClientsSDK) GetSiteSdkStatsByMap added in v0.2.25 

func (s *SitesStatsClientsSDK) GetSiteSdkStatsByMap(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID) (
	models.ApiResponse[[]models.StatsSdkclient],
	error)

GetSiteSdkStatsByMap takes context, siteId, mapId as parameters and returns an models.ApiResponse with []models.StatsSdkclient data and an error if there was an issue with the request or response. Get SdkClient Stats By Map

type SitesStatsClientsWireless added in v0.2.25 

type SitesStatsClientsWireless struct {
	// contains filtered or unexported fields
}

SitesStatsClientsWireless represents a controller struct.

func NewSitesStatsClientsWireless added in v0.2.25 

func NewSitesStatsClientsWireless(baseController baseController) *SitesStatsClientsWireless

NewSitesStatsClientsWireless creates a new instance of SitesStatsClientsWireless. It takes a baseController as a parameter and returns a pointer to the SitesStatsClientsWireless.

func (*SitesStatsClientsWireless) GetSiteWirelessClientStats added in v0.2.25 

func (s *SitesStatsClientsWireless) GetSiteWirelessClientStats(
	ctx context.Context,
	siteId uuid.UUID,
	clientMac string,
	wired *bool) (
	models.ApiResponse[[]models.StatsClient],
	error)

GetSiteWirelessClientStats takes context, siteId, clientMac, wired as parameters and returns an models.ApiResponse with []models.StatsClient data and an error if there was an issue with the request or response. Get Site Client Stats Details

func (*SitesStatsClientsWireless) GetSiteWirelessClientsStatsByMap added in v0.2.25 

func (s *SitesStatsClientsWireless) GetSiteWirelessClientsStatsByMap(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.StatsWirelessClient],
	error)

GetSiteWirelessClientsStatsByMap takes context, siteId, mapId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with []models.StatsWirelessClient data and an error if there was an issue with the request or response. Get Site Clients Stats By Map

func (*SitesStatsClientsWireless) ListSiteUnconnectedClientStats added in v0.2.25 

func (s *SitesStatsClientsWireless) ListSiteUnconnectedClientStats(
	ctx context.Context,
	siteId uuid.UUID,
	mapId uuid.UUID) (
	models.ApiResponse[[]models.StatsUnconnectedClient],
	error)

ListSiteUnconnectedClientStats takes context, siteId, mapId as parameters and returns an models.ApiResponse with []models.StatsUnconnectedClient data and an error if there was an issue with the request or response. Get List of Site Unconnected Client Location

func (*SitesStatsClientsWireless) ListSiteWirelessClientsStats added in v0.2.25 

func (s *SitesStatsClientsWireless) ListSiteWirelessClientsStats(
	ctx context.Context,
	siteId uuid.UUID,
	wired *bool,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[[]models.StatsClient],
	error)

ListSiteWirelessClientsStats takes context, siteId, wired, limit, start, end, duration as parameters and returns an models.ApiResponse with []models.StatsClient data and an error if there was an issue with the request or response. Get List of Site All Clients Stats Details

type SitesStatsDevices added in v0.2.25 

type SitesStatsDevices struct {
	// contains filtered or unexported fields
}

SitesStatsDevices represents a controller struct.

func NewSitesStatsDevices added in v0.2.25 

func NewSitesStatsDevices(baseController baseController) *SitesStatsDevices

NewSitesStatsDevices creates a new instance of SitesStatsDevices. It takes a baseController as a parameter and returns a pointer to the SitesStatsDevices.

func (*SitesStatsDevices) GetSiteAllClientsStatsByDevice added in v0.2.25 

func (s *SitesStatsDevices) GetSiteAllClientsStatsByDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[[]models.StatsWirelessClient],
	error)

GetSiteAllClientsStatsByDevice takes context, siteId, deviceId as parameters and returns an models.ApiResponse with []models.StatsWirelessClient data and an error if there was an issue with the request or response. Get wireless client stat by Device

func (*SitesStatsDevices) GetSiteDeviceStats added in v0.2.25 

func (s *SitesStatsDevices) GetSiteDeviceStats(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	fields *string) (
	models.ApiResponse[models.StatsDevice],
	error)

GetSiteDeviceStats takes context, siteId, deviceId, fields as parameters and returns an models.ApiResponse with models.StatsDevice data and an error if there was an issue with the request or response. Get Site Device Stats Details

func (*SitesStatsDevices) GetSiteGatewayMetrics added in v0.2.25 

func (s *SitesStatsDevices) GetSiteGatewayMetrics(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.GatewayMetrics],
	error)

GetSiteGatewayMetrics takes context, siteId as parameters and returns an models.ApiResponse with models.GatewayMetrics data and an error if there was an issue with the request or response. Get Site Gateway Metrics

func (*SitesStatsDevices) GetSiteSwitchesMetrics added in v0.2.25 

func (s *SitesStatsDevices) GetSiteSwitchesMetrics(
	ctx context.Context,
	siteId uuid.UUID,
	mType *models.SwitchMetricTypeEnum,
	scope *models.SwitchMetricScopeEnum,
	switchMac *string) (
	models.ApiResponse[models.ResponseSwitchMetrics],
	error)

GetSiteSwitchesMetrics takes context, siteId, mType, scope, switchMac as parameters and returns an models.ApiResponse with models.ResponseSwitchMetrics data and an error if there was an issue with the request or response. Get version compliance metrics for managed or monitored switches

func (*SitesStatsDevices) ListSiteDevicesStats added in v0.2.25 

func (s *SitesStatsDevices) ListSiteDevicesStats(
	ctx context.Context,
	siteId uuid.UUID,
	mType *models.DeviceTypeWithAllEnum,
	status *models.StatDeviceStatusFilterEnum,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.StatsDevice],
	error)

ListSiteDevicesStats takes context, siteId, mType, status, limit, page as parameters and returns an models.ApiResponse with []models.StatsDevice data and an error if there was an issue with the request or response. Get List of Site Devices Stats

type SitesStatsDiscoveredSwitches added in v0.2.25 

type SitesStatsDiscoveredSwitches struct {
	// contains filtered or unexported fields
}

SitesStatsDiscoveredSwitches represents a controller struct.

func NewSitesStatsDiscoveredSwitches added in v0.2.25 

func NewSitesStatsDiscoveredSwitches(baseController baseController) *SitesStatsDiscoveredSwitches

NewSitesStatsDiscoveredSwitches creates a new instance of SitesStatsDiscoveredSwitches. It takes a baseController as a parameter and returns a pointer to the SitesStatsDiscoveredSwitches.

func (*SitesStatsDiscoveredSwitches) CountSiteDiscoveredSwitches added in v0.2.25 

func (s *SitesStatsDiscoveredSwitches) CountSiteDiscoveredSwitches(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SiteDiscoveredSwitchesCountDistinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteDiscoveredSwitches takes context, siteId, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Discovered Switches

func (*SitesStatsDiscoveredSwitches) GetSiteDiscoveredSwitchesMetrics added in v0.2.25 

func (s *SitesStatsDiscoveredSwitches) GetSiteDiscoveredSwitchesMetrics(
	ctx context.Context,
	siteId uuid.UUID,
	threshold *string,
	systemName *string) (
	models.ApiResponse[models.ResponseDswitchesMetrics],
	error)

GetSiteDiscoveredSwitchesMetrics takes context, siteId, threshold, systemName as parameters and returns an models.ApiResponse with models.ResponseDswitchesMetrics data and an error if there was an issue with the request or response. Discovered switches related metrics, lists related switch system names & details if not compliant

func (*SitesStatsDiscoveredSwitches) SearchSiteDiscoveredSwitches added in v0.2.25 

func (s *SitesStatsDiscoveredSwitches) SearchSiteDiscoveredSwitches(
	ctx context.Context,
	siteId uuid.UUID,
	adopted *bool,
	systemName *string,
	hostname *string,
	vendor *string,
	model *string,
	version *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseDiscoveredSwitches],
	error)

SearchSiteDiscoveredSwitches takes context, siteId, adopted, systemName, hostname, vendor, model, version, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseDiscoveredSwitches data and an error if there was an issue with the request or response. Search Discovered Switches

func (*SitesStatsDiscoveredSwitches) SearchSiteDiscoveredSwitchesMetrics added in v0.2.25 

func (s *SitesStatsDiscoveredSwitches) SearchSiteDiscoveredSwitchesMetrics(
	ctx context.Context,
	siteId uuid.UUID,
	scope *models.DiscoveredSwitchesMetricScopeEnum,
	mType *models.DiscoveredSwitchMetricTypeEnum,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseDiscoveredSwitchMetrics],
	error)

SearchSiteDiscoveredSwitchesMetrics takes context, siteId, scope, mType, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseDiscoveredSwitchMetrics data and an error if there was an issue with the request or response. Search Discovered Switch Metrics

type SitesStatsMxEdges added in v0.2.25 

type SitesStatsMxEdges struct {
	// contains filtered or unexported fields
}

SitesStatsMxEdges represents a controller struct.

func NewSitesStatsMxEdges added in v0.2.25 

func NewSitesStatsMxEdges(baseController baseController) *SitesStatsMxEdges

NewSitesStatsMxEdges creates a new instance of SitesStatsMxEdges. It takes a baseController as a parameter and returns a pointer to the SitesStatsMxEdges.

func (*SitesStatsMxEdges) GetSiteMxEdgeStats added in v0.2.25 

func (s *SitesStatsMxEdges) GetSiteMxEdgeStats(
	ctx context.Context,
	siteId uuid.UUID,
	mxedgeId uuid.UUID,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.StatsMxedge],
	error)

GetSiteMxEdgeStats takes context, siteId, mxedgeId, start, end, duration as parameters and returns an models.ApiResponse with models.StatsMxedge data and an error if there was an issue with the request or response. Get One Site MxEdge Stats

func (*SitesStatsMxEdges) ListSiteMxEdgesStats added in v0.2.25 

func (s *SitesStatsMxEdges) ListSiteMxEdgesStats(
	ctx context.Context,
	siteId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.StatsMxedge],
	error)

ListSiteMxEdgesStats takes context, siteId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with []models.StatsMxedge data and an error if there was an issue with the request or response. Get List of Site MxEdges Stats

type SitesStatsPorts added in v0.2.25 

type SitesStatsPorts struct {
	// contains filtered or unexported fields
}

SitesStatsPorts represents a controller struct.

func NewSitesStatsPorts added in v0.2.25 

func NewSitesStatsPorts(baseController baseController) *SitesStatsPorts

NewSitesStatsPorts creates a new instance of SitesStatsPorts. It takes a baseController as a parameter and returns a pointer to the SitesStatsPorts.

func (*SitesStatsPorts) CountSiteSwOrGwPorts added in v0.2.25 

func (s *SitesStatsPorts) CountSiteSwOrGwPorts(
	ctx context.Context,
	siteId uuid.UUID,
	distinct *models.SitePortsCountDistinctEnum,
	fullDuplex *bool,
	mac *string,
	neighborMac *string,
	neighborPortDesc *string,
	neighborSystemName *string,
	poeDisabled *bool,
	poeMode *string,
	poeOn *bool,
	portId *string,
	portMac *string,
	powerDraw *float64,
	txPkts *int,
	rxPkts *int,
	rxBytes *int,
	txBps *int,
	rxBps *int,
	txMcastPkts *int,
	txBcastPkts *int,
	rxMcastPkts *int,
	rxBcastPkts *int,
	speed *int,
	stpState *models.CountPortsStpStateEnum,
	stpRole *models.CountPortsStpRoleEnum,
	authState *models.CountPortsAuthStateEnum,
	up *bool,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteSwOrGwPorts takes context, siteId, distinct, fullDuplex, mac, neighborMac, neighborPortDesc, neighborSystemName, poeDisabled, poeMode, poeOn, portId, portMac, powerDraw, txPkts, rxPkts, rxBytes, txBps, rxBps, txMcastPkts, txBcastPkts, rxMcastPkts, rxBcastPkts, speed, stpState, stpRole, authState, up, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count by Distinct Attributes of Switch/Gateway Ports

func (*SitesStatsPorts) SearchSiteSwOrGwPorts added in v0.2.25 

func (s *SitesStatsPorts) SearchSiteSwOrGwPorts(
	ctx context.Context,
	siteId uuid.UUID,
	fullDuplex *bool,
	mac *string,
	deviceType *models.SearchSiteSwOrGwPortsDeviceTypeEnum,
	neighborMac *string,
	neighborPortDesc *string,
	neighborSystemName *string,
	poeDisabled *bool,
	poeMode *string,
	poeOn *bool,
	portId *string,
	portMac *string,
	powerDraw *float64,
	txPkts *int,
	rxPkts *int,
	rxBytes *int,
	txBps *int,
	rxBps *int,
	txErrors *int,
	rxErrors *int,
	txMcastPkts *int,
	txBcastPkts *int,
	rxMcastPkts *int,
	rxBcastPkts *int,
	speed *int,
	macLimit *int,
	macCount *int,
	up *bool,
	active *bool,
	jitter *float64,
	loss *float64,
	latency *float64,
	stpState *models.SearchSiteSwOrGwPortsStpStateEnum,
	stpRole *models.SearchSiteSwOrGwPortsStpRoleEnum,
	xcvrPartNumber *string,
	authState *models.SearchSiteSwOrGwPortsAuthStateEnum,
	lteImsi *string,
	lteIccid *string,
	lteImei *string,
	limit *int,
	start *int,
	end *int,
	duration *string) (
	models.ApiResponse[models.ResponseSwitchPortSearch],
	error)

SearchSiteSwOrGwPorts takes context, siteId, fullDuplex, mac, deviceType, neighborMac, neighborPortDesc, neighborSystemName, poeDisabled, poeMode, poeOn, portId, portMac, powerDraw, txPkts, rxPkts, rxBytes, txBps, rxBps, txErrors, rxErrors, txMcastPkts, txBcastPkts, rxMcastPkts, rxBcastPkts, speed, macLimit, macCount, up, active, jitter, loss, latency, stpState, stpRole, xcvrPartNumber, authState, lteImsi, lteIccid, lteImei, limit, start, end, duration as parameters and returns an models.ApiResponse with models.ResponseSwitchPortSearch data and an error if there was an issue with the request or response. Search Switch / Gateway Ports

type SitesStatsWxRules added in v0.2.25 

type SitesStatsWxRules struct {
	// contains filtered or unexported fields
}

SitesStatsWxRules represents a controller struct.

func NewSitesStatsWxRules added in v0.2.25 

func NewSitesStatsWxRules(baseController baseController) *SitesStatsWxRules

NewSitesStatsWxRules creates a new instance of SitesStatsWxRules. It takes a baseController as a parameter and returns a pointer to the SitesStatsWxRules.

func (*SitesStatsWxRules) GetSiteWxRulesUsage added in v0.2.25 

func (s *SitesStatsWxRules) GetSiteWxRulesUsage(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[[]models.StatsWxrule],
	error)

GetSiteWxRulesUsage takes context, siteId as parameters and returns an models.ApiResponse with []models.StatsWxrule data and an error if there was an issue with the request or response. Get Wxlan Rule usage

type SitesStatsZones added in v0.2.25 

type SitesStatsZones struct {
	// contains filtered or unexported fields
}

SitesStatsZones represents a controller struct.

func NewSitesStatsZones added in v0.2.25 

func NewSitesStatsZones(baseController baseController) *SitesStatsZones

NewSitesStatsZones creates a new instance of SitesStatsZones. It takes a baseController as a parameter and returns a pointer to the SitesStatsZones.

func (*SitesStatsZones) GetSiteRssiZoneStats added in v0.4.18 

func (s *SitesStatsZones) GetSiteRssiZoneStats(
	ctx context.Context,
	siteId uuid.UUID,
	zoneId uuid.UUID) (
	models.ApiResponse[models.StatsZoneDetails],
	error)

GetSiteRssiZoneStats takes context, siteId, zoneId as parameters and returns an models.ApiResponse with models.StatsZoneDetails data and an error if there was an issue with the request or response. Get Detail RSSI Zone Stats

func (*SitesStatsZones) GetSiteZoneStats added in v0.2.25 

func (s *SitesStatsZones) GetSiteZoneStats(
	ctx context.Context,
	siteId uuid.UUID,
	zoneId uuid.UUID) (
	models.ApiResponse[models.StatsZoneDetails],
	error)

GetSiteZoneStats takes context, siteId, zoneId as parameters and returns an models.ApiResponse with models.StatsZoneDetails data and an error if there was an issue with the request or response. Get Detail Zone Stats

func (*SitesStatsZones) ListSiteRssiZonesStats added in v0.4.18 

func (s *SitesStatsZones) ListSiteRssiZonesStats(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[[]models.StatsRssiZone],
	error)

ListSiteRssiZonesStats takes context, siteId as parameters and returns an models.ApiResponse with []models.StatsRssiZone data and an error if there was an issue with the request or response. Get List of Site RSSI Zones Stats

func (*SitesStatsZones) ListSiteZonesStats added in v0.2.25 

func (s *SitesStatsZones) ListSiteZonesStats(
	ctx context.Context,
	siteId uuid.UUID,
	mapId *string) (
	models.ApiResponse[[]models.StatsZone],
	error)

ListSiteZonesStats takes context, siteId, mapId as parameters and returns an models.ApiResponse with []models.StatsZone data and an error if there was an issue with the request or response. Get List of Site Zones Stats

type SitesSyntheticTests 

type SitesSyntheticTests struct {
	// contains filtered or unexported fields
}

SitesSyntheticTests represents a controller struct.

func NewSitesSyntheticTests 

func NewSitesSyntheticTests(baseController baseController) *SitesSyntheticTests

NewSitesSyntheticTests creates a new instance of SitesSyntheticTests. It takes a baseController as a parameter and returns a pointer to the SitesSyntheticTests.

func (*SitesSyntheticTests) GetSiteDeviceSyntheticTest 

func (s *SitesSyntheticTests) GetSiteDeviceSyntheticTest(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[models.SynthetictestInfo],
	error)

GetSiteDeviceSyntheticTest takes context, siteId, deviceId as parameters and returns an models.ApiResponse with models.SynthetictestInfo data and an error if there was an issue with the request or response. Get Device Synthetic Test

func (*SitesSyntheticTests) SearchSiteSyntheticTest 

func (s *SitesSyntheticTests) SearchSiteSyntheticTest(
	ctx context.Context,
	siteId uuid.UUID,
	mac *string,
	portId *string,
	vlanId *string,
	by *string,
	reason *string,
	mType *models.SynthetictestTypeEnum,
	protocol *models.SynthetictestProtocolEnum,
	tenant *string) (
	models.ApiResponse[models.ReponseSynthetictestSearch],
	error)

SearchSiteSyntheticTest takes context, siteId, mac, portId, vlanId, by, reason, mType, protocol, tenant as parameters and returns an models.ApiResponse with models.ReponseSynthetictestSearch data and an error if there was an issue with the request or response. Search Site Synthetic Testing

func (*SitesSyntheticTests) StartSiteSwitchRadiusSyntheticTest 

func (s *SitesSyntheticTests) StartSiteSwitchRadiusSyntheticTest(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.SynthetictestRadiusServer) (
	models.ApiResponse[models.WebsocketSession],
	error)

StartSiteSwitchRadiusSyntheticTest takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Ping test from the AP to confirm ‘reachability’ of the Radius server. Utilize Juniper EX switch(to which an AP is connected to) radius test capabilities to get details on the Radius Server ‘availability’ .

func (*SitesSyntheticTests) TriggerSiteDeviceSyntheticTest 

func (s *SitesSyntheticTests) TriggerSiteDeviceSyntheticTest(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.SynthetictestDevice) (
	*http.Response,
	error)

TriggerSiteDeviceSyntheticTest takes context, siteId, deviceId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Trigger Device Synthetic Test

func (*SitesSyntheticTests) TriggerSiteSyntheticTest 

func (s *SitesSyntheticTests) TriggerSiteSyntheticTest(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.Synthetictest) (
	models.ApiResponse[models.ReponseSynthetictest],
	error)

TriggerSiteSyntheticTest takes context, siteId, body as parameters and returns an models.ApiResponse with models.ReponseSynthetictest data and an error if there was an issue with the request or response. Trigger Synthetic Testing

type SitesUISettings 

type SitesUISettings struct {
	// contains filtered or unexported fields
}

SitesUISettings represents a controller struct.

func NewSitesUISettings 

func NewSitesUISettings(baseController baseController) *SitesUISettings

NewSitesUISettings creates a new instance of SitesUISettings. It takes a baseController as a parameter and returns a pointer to the SitesUISettings.

func (*SitesUISettings) CreateSiteUiSettings 

func (s *SitesUISettings) CreateSiteUiSettings(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.UiSettings) (
	models.ApiResponse[models.UiSettings],
	error)

CreateSiteUiSettings takes context, siteId, body as parameters and returns an models.ApiResponse with models.UiSettings data and an error if there was an issue with the request or response. Site UI settings

func (*SitesUISettings) DeleteSiteUiSetting 

func (s *SitesUISettings) DeleteSiteUiSetting(
	ctx context.Context,
	siteId uuid.UUID,
	uisettingId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteUiSetting takes context, siteId, uisettingId as parameters and returns an *Response and an error if there was an issue with the request or response. Site UI settings

func (*SitesUISettings) GetSiteUiSetting 

func (s *SitesUISettings) GetSiteUiSetting(
	ctx context.Context,
	siteId uuid.UUID,
	uisettingId uuid.UUID) (
	models.ApiResponse[[]models.UiSettings],
	error)

GetSiteUiSetting takes context, siteId, uisettingId as parameters and returns an models.ApiResponse with []models.UiSettings data and an error if there was an issue with the request or response. Site UI settings

func (*SitesUISettings) ListSiteUiSettingDerived added in v0.3.17 

func (s *SitesUISettings) ListSiteUiSettingDerived(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.UiSettings],
	error)

ListSiteUiSettingDerived takes context, siteId as parameters and returns an models.ApiResponse with models.UiSettings data and an error if there was an issue with the request or response. Get both site UI settings(for_site=true) and org UI settings (for_site=false)

func (*SitesUISettings) ListSiteUiSettings 

func (s *SitesUISettings) ListSiteUiSettings(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[[]models.UiSettings],
	error)

ListSiteUiSettings takes context, siteId as parameters and returns an models.ApiResponse with []models.UiSettings data and an error if there was an issue with the request or response. Site UI settings

func (*SitesUISettings) UpdateSiteUiSetting 

func (s *SitesUISettings) UpdateSiteUiSetting(
	ctx context.Context,
	siteId uuid.UUID,
	uisettingId uuid.UUID,
	body *models.UiSettings) (
	models.ApiResponse[models.UiSettings],
	error)

UpdateSiteUiSetting takes context, siteId, uisettingId, body as parameters and returns an models.ApiResponse with models.UiSettings data and an error if there was an issue with the request or response. Site UI settings

type SitesVBeacons 

type SitesVBeacons struct {
	// contains filtered or unexported fields
}

SitesVBeacons represents a controller struct.

func NewSitesVBeacons 

func NewSitesVBeacons(baseController baseController) *SitesVBeacons

NewSitesVBeacons creates a new instance of SitesVBeacons. It takes a baseController as a parameter and returns a pointer to the SitesVBeacons.

func (*SitesVBeacons) CreateSiteVBeacon 

func (s *SitesVBeacons) CreateSiteVBeacon(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.Vbeacon) (
	models.ApiResponse[models.Vbeacon],
	error)

CreateSiteVBeacon takes context, siteId, body as parameters and returns an models.ApiResponse with models.Vbeacon data and an error if there was an issue with the request or response. Create Virtual Beacon

func (*SitesVBeacons) DeleteSiteVBeacon 

func (s *SitesVBeacons) DeleteSiteVBeacon(
	ctx context.Context,
	siteId uuid.UUID,
	vbeaconId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteVBeacon takes context, siteId, vbeaconId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site Virtual Beacon

func (*SitesVBeacons) GetSiteVBeacon 

func (s *SitesVBeacons) GetSiteVBeacon(
	ctx context.Context,
	siteId uuid.UUID,
	vbeaconId uuid.UUID) (
	models.ApiResponse[models.Vbeacon],
	error)

GetSiteVBeacon takes context, siteId, vbeaconId as parameters and returns an models.ApiResponse with models.Vbeacon data and an error if there was an issue with the request or response. Get Site Virtual Beacon Details

func (*SitesVBeacons) ListSiteVBeacons 

func (s *SitesVBeacons) ListSiteVBeacons(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Vbeacon],
	error)

ListSiteVBeacons takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.Vbeacon data and an error if there was an issue with the request or response. Get List of Site Virtual Beacons

func (*SitesVBeacons) UpdateSiteVBeacon 

func (s *SitesVBeacons) UpdateSiteVBeacon(
	ctx context.Context,
	siteId uuid.UUID,
	vbeaconId uuid.UUID,
	body *models.Vbeacon) (
	models.ApiResponse[models.Vbeacon],
	error)

UpdateSiteVBeacon takes context, siteId, vbeaconId, body as parameters and returns an models.ApiResponse with models.Vbeacon data and an error if there was an issue with the request or response. Update Site Virtual Beacon

type SitesVPNs 

type SitesVPNs struct {
	// contains filtered or unexported fields
}

SitesVPNs represents a controller struct.

func NewSitesVPNs 

func NewSitesVPNs(baseController baseController) *SitesVPNs

NewSitesVPNs creates a new instance of SitesVPNs. It takes a baseController as a parameter and returns a pointer to the SitesVPNs.

func (*SitesVPNs) ListSiteVpnsDerived 

func (s *SitesVPNs) ListSiteVpnsDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool) (
	models.ApiResponse[[]models.Vpn],
	error)

ListSiteVpnsDerived takes context, siteId, resolve as parameters and returns an models.ApiResponse with []models.Vpn data and an error if there was an issue with the request or response. VPN object represents an overlay network where gateways can participate in and optionally expose routes to.

type SitesWANUsages 

type SitesWANUsages struct {
	// contains filtered or unexported fields
}

SitesWANUsages represents a controller struct.

func NewSitesWANUsages 

func NewSitesWANUsages(baseController baseController) *SitesWANUsages

NewSitesWANUsages creates a new instance of SitesWANUsages. It takes a baseController as a parameter and returns a pointer to the SitesWANUsages.

func (*SitesWANUsages) CountSiteWanUsage 

func (s *SitesWANUsages) CountSiteWanUsage(
	ctx context.Context,
	siteId uuid.UUID,
	mac *string,
	peerMac *string,
	portId *string,
	peerPortId *string,
	policy *string,
	tenant *string,
	pathType *string,
	distinct *models.WanUsagesCountDisctinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteWanUsage takes context, siteId, mac, peerMac, portId, peerPortId, policy, tenant, pathType, distinct, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Site WAN Uages

func (*SitesWANUsages) SearchSiteWanUsage 

func (s *SitesWANUsages) SearchSiteWanUsage(
	ctx context.Context,
	siteId uuid.UUID,
	mac *string,
	peerMac *string,
	portId *string,
	peerPortId *string,
	policy *string,
	tenant *string,
	pathType *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.SearchWanUsage],
	error)

SearchSiteWanUsage takes context, siteId, mac, peerMac, portId, peerPortId, policy, tenant, pathType, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.SearchWanUsage data and an error if there was an issue with the request or response. Search Site WAN Uages

type SitesWebhooks 

type SitesWebhooks struct {
	// contains filtered or unexported fields
}

SitesWebhooks represents a controller struct.

func NewSitesWebhooks 

func NewSitesWebhooks(baseController baseController) *SitesWebhooks

NewSitesWebhooks creates a new instance of SitesWebhooks. It takes a baseController as a parameter and returns a pointer to the SitesWebhooks.

func (*SitesWebhooks) CountSiteWebhooksDeliveries 

func (s *SitesWebhooks) CountSiteWebhooksDeliveries(
	ctx context.Context,
	siteId uuid.UUID,
	webhookId uuid.UUID,
	mError *string,
	statusCode *int,
	status *models.WebhookDeliveryStatusEnum,
	topic *models.WebhookDeliveryTopicEnum,
	distinct *models.WebhookDeliveryDistinctEnum,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteWebhooksDeliveries takes context, siteId, webhookId, mError, statusCode, status, topic, distinct, start, end, duration, limit as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Site Webhooks deliveries Topics Supported: - alarms - audits - device-updowns - occupancy-alerts - ping

func (*SitesWebhooks) CreateSiteWebhook 

func (s *SitesWebhooks) CreateSiteWebhook(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.Webhook) (
	models.ApiResponse[models.Webhook],
	error)

CreateSiteWebhook takes context, siteId, body as parameters and returns an models.ApiResponse with models.Webhook data and an error if there was an issue with the request or response. Webhook defines a webhook, modeled after [github’s model](https://developer.github.com/webhooks/). There is two types of webhooks: * webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-be01e694-7253-4195-8563-78e2a745e114)) * raw data webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-e2d5d5f8-4bdb-4efc-93e4-90f4b33d0b2b)) ##### Webhooks Webhooks can be configured at the org level (subset of topics only) and at the site level. It is possible to have multiple topics in the same webhook configuration and/or to have multiple webhooks configured at the same time. ##### Client Raw Data Webhooks Raw data webhooks are a special subset of webhooks that provide insight into raw data packets emitted by a client, identified by their advertising MAC address (assets, discovered ble, connected wifi, unconnected wifi). The data that client raw data webhooks encompasses are reporting AP information, RSSI Data, and any special packets/telemetry packets that the client may emit. Note that client raw webhooks are the raw data coming from the client and do not contain the X,Y location data of the client. In order to get the location data for a client please see our location webhooks. Clients can be identified uniquely across these client raw data topics and location webhook topic using MAC address as the Unique identifier (client identifier). ###### Client Raw Data Webhooks Topics Topics that correspond to client raw data for different client types. * `asset-raw-rssi` - Raw data from packets emitted by named and filtered assets * `discovered-raw-rssi` - Raw data from packets emitted by passive BLE devices * `wifi-conn-raw` - Raw data from packets emitted by connected devices * `wifi-unconn-raw` - Raw data from packets emitted by unconnected devices (passive) ###### Rules for configuring client raw data webhooks 1. Only one instance of a webhook object containing a client raw data webhook topic is allowed. (a site level entry will override an org level entry for the client raw data webhook topic in question) 2. Only one client raw data webhook topic is allowed per `http-post` message to webhooks api

func (*SitesWebhooks) DeleteSiteWebhook 

func (s *SitesWebhooks) DeleteSiteWebhook(
	ctx context.Context,
	siteId uuid.UUID,
	webhookId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteWebhook takes context, siteId, webhookId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site Webhook

func (*SitesWebhooks) GetSiteWebhook 

func (s *SitesWebhooks) GetSiteWebhook(
	ctx context.Context,
	siteId uuid.UUID,
	webhookId uuid.UUID) (
	models.ApiResponse[models.Webhook],
	error)

GetSiteWebhook takes context, siteId, webhookId as parameters and returns an models.ApiResponse with models.Webhook data and an error if there was an issue with the request or response. Get Site Webhook Details

func (*SitesWebhooks) ListSiteWebhooks 

func (s *SitesWebhooks) ListSiteWebhooks(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Webhook],
	error)

ListSiteWebhooks takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.Webhook data and an error if there was an issue with the request or response. Get List of Site Webhooks

func (*SitesWebhooks) PingSiteWebhook 

func (s *SitesWebhooks) PingSiteWebhook(
	ctx context.Context,
	siteId uuid.UUID,
	webhookId uuid.UUID) (
	*http.Response,
	error)

PingSiteWebhook takes context, siteId, webhookId as parameters and returns an *Response and an error if there was an issue with the request or response. send a Ping event to the webhook

func (*SitesWebhooks) SearchSiteWebhooksDeliveries 

func (s *SitesWebhooks) SearchSiteWebhooksDeliveries(
	ctx context.Context,
	siteId uuid.UUID,
	webhookId uuid.UUID,
	mError *string,
	statusCode *int,
	status *models.WebhookDeliveryStatusEnum,
	topic *models.WebhookDeliveryTopicEnum,
	start *int,
	end *int,
	duration *string,
	limit *int) (
	models.ApiResponse[models.SearchWebhookDelivery],
	error)

SearchSiteWebhooksDeliveries takes context, siteId, webhookId, mError, statusCode, status, topic, start, end, duration, limit as parameters and returns an models.ApiResponse with models.SearchWebhookDelivery data and an error if there was an issue with the request or response. Search Site Webhooks deliveries Topics Supported: - alarms - audits - device-updowns - occupancy-alerts - ping

func (*SitesWebhooks) UpdateSiteWebhook 

func (s *SitesWebhooks) UpdateSiteWebhook(
	ctx context.Context,
	siteId uuid.UUID,
	webhookId uuid.UUID,
	body *models.Webhook) (
	models.ApiResponse[models.Webhook],
	error)

UpdateSiteWebhook takes context, siteId, webhookId, body as parameters and returns an models.ApiResponse with models.Webhook data and an error if there was an issue with the request or response. Update Site Webhook

type SitesWlans 

type SitesWlans struct {
	// contains filtered or unexported fields
}

SitesWlans represents a controller struct.

func NewSitesWlans 

func NewSitesWlans(baseController baseController) *SitesWlans

NewSitesWlans creates a new instance of SitesWlans. It takes a baseController as a parameter and returns a pointer to the SitesWlans.

func (*SitesWlans) CreateSiteWlan 

func (s *SitesWlans) CreateSiteWlan(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.Wlan) (
	models.ApiResponse[models.Wlan],
	error)

CreateSiteWlan takes context, siteId, body as parameters and returns an models.ApiResponse with models.Wlan data and an error if there was an issue with the request or response. Create Site WLAN

func (*SitesWlans) DeleteSiteWlan 

func (s *SitesWlans) DeleteSiteWlan(
	ctx context.Context,
	siteId uuid.UUID,
	wlanId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteWlan takes context, siteId, wlanId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site WLAN

func (*SitesWlans) DeleteSiteWlanPortalImage added in v0.3.13 

func (s *SitesWlans) DeleteSiteWlanPortalImage(
	ctx context.Context,
	siteId uuid.UUID,
	wlanId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteWlanPortalImage takes context, siteId, wlanId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site WLAN Portal Image

func (*SitesWlans) GetSiteWlan 

func (s *SitesWlans) GetSiteWlan(
	ctx context.Context,
	siteId uuid.UUID,
	wlanId uuid.UUID) (
	models.ApiResponse[models.Wlan],
	error)

GetSiteWlan takes context, siteId, wlanId as parameters and returns an models.ApiResponse with models.Wlan data and an error if there was an issue with the request or response. Get Site WLAN

func (*SitesWlans) ListSiteWlanDerived 

func (s *SitesWlans) ListSiteWlanDerived(
	ctx context.Context,
	siteId uuid.UUID,
	resolve *bool,
	wlanId *string) (
	models.ApiResponse[[]models.Wlan],
	error)

ListSiteWlanDerived takes context, siteId, resolve, wlanId as parameters and returns an models.ApiResponse with []models.Wlan data and an error if there was an issue with the request or response. Get Wlans Derived

func (*SitesWlans) ListSiteWlans 

func (s *SitesWlans) ListSiteWlans(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Wlan],
	error)

ListSiteWlans takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.Wlan data and an error if there was an issue with the request or response. Get List of Site WLANs

func (*SitesWlans) UpdateSiteWlan 

func (s *SitesWlans) UpdateSiteWlan(
	ctx context.Context,
	siteId uuid.UUID,
	wlanId uuid.UUID,
	body *models.Wlan) (
	models.ApiResponse[models.Wlan],
	error)

UpdateSiteWlan takes context, siteId, wlanId, body as parameters and returns an models.ApiResponse with models.Wlan data and an error if there was an issue with the request or response. Update Site WLAN

func (*SitesWlans) UpdateSiteWlanPortalTemplate 

func (s *SitesWlans) UpdateSiteWlanPortalTemplate(
	ctx context.Context,
	siteId uuid.UUID,
	wlanId uuid.UUID,
	body *models.WlanPortalTemplate) (
	models.ApiResponse[models.WlanPortalTemplate],
	error)

UpdateSiteWlanPortalTemplate takes context, siteId, wlanId, body as parameters and returns an models.ApiResponse with models.WlanPortalTemplate data and an error if there was an issue with the request or response. Update a Portal Template #### Sponsor Email Template Sponsor Email Template supports following template variables: | **Name** | **Description** | | --- | --- | | approve_url | Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized | | deny_url | Renders URL to reject the request | | guest_email | Renders Email ID of the guest | | guest_name | Renders Name of the guest | | field1 | Renders value of the Custom Field 1 | | field2 | Renders value of the Custom Field 2 | | company | Renders value of the Company field | | sponsor_link_validity_duration | Renders validity time of the request (i.e. Approve/Deny URL) | | auth_expire_minutes | Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes) |

func (*SitesWlans) UploadSiteWlanPortalImage 

func (s *SitesWlans) UploadSiteWlanPortalImage(
	ctx context.Context,
	siteId uuid.UUID,
	wlanId uuid.UUID,
	file models.FileWrapper,
	json *string) (
	*http.Response,
	error)

UploadSiteWlanPortalImage takes context, siteId, wlanId, file, json as parameters and returns an *Response and an error if there was an issue with the request or response. Wlan Portal Image Upload

type SitesWxRules 

type SitesWxRules struct {
	// contains filtered or unexported fields
}

SitesWxRules represents a controller struct.

func NewSitesWxRules 

func NewSitesWxRules(baseController baseController) *SitesWxRules

NewSitesWxRules creates a new instance of SitesWxRules. It takes a baseController as a parameter and returns a pointer to the SitesWxRules.

func (*SitesWxRules) CreateSiteWxRule 

func (s *SitesWxRules) CreateSiteWxRule(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.WxlanRule) (
	models.ApiResponse[models.WxlanRule],
	error)

CreateSiteWxRule takes context, siteId, body as parameters and returns an models.ApiResponse with models.WxlanRule data and an error if there was an issue with the request or response. Create Site WxLan Rule

func (*SitesWxRules) DeleteSiteWxRule 

func (s *SitesWxRules) DeleteSiteWxRule(
	ctx context.Context,
	siteId uuid.UUID,
	wxruleId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteWxRule takes context, siteId, wxruleId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site WxLan Rule

func (*SitesWxRules) GetSiteWxRule 

func (s *SitesWxRules) GetSiteWxRule(
	ctx context.Context,
	siteId uuid.UUID,
	wxruleId uuid.UUID) (
	models.ApiResponse[models.WxlanRule],
	error)

GetSiteWxRule takes context, siteId, wxruleId as parameters and returns an models.ApiResponse with models.WxlanRule data and an error if there was an issue with the request or response. Get Site WxLan Rule Details

func (*SitesWxRules) ListSiteWxRules 

func (s *SitesWxRules) ListSiteWxRules(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.WxlanRule],
	error)

ListSiteWxRules takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.WxlanRule data and an error if there was an issue with the request or response. Get List of Site WxLan Rules

func (*SitesWxRules) ListSiteWxRulesDerived added in v0.4.0 

func (s *SitesWxRules) ListSiteWxRulesDerived(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[[]models.WxlanRule],
	error)

ListSiteWxRulesDerived takes context, siteId as parameters and returns an models.ApiResponse with []models.WxlanRule data and an error if there was an issue with the request or response. Get Site WxLan Rule Derived

func (*SitesWxRules) UpdateSiteWxRule 

func (s *SitesWxRules) UpdateSiteWxRule(
	ctx context.Context,
	siteId uuid.UUID,
	wxruleId uuid.UUID,
	body *models.WxlanRule) (
	models.ApiResponse[models.WxlanRule],
	error)

UpdateSiteWxRule takes context, siteId, wxruleId, body as parameters and returns an models.ApiResponse with models.WxlanRule data and an error if there was an issue with the request or response. Update Site WxLan Rule

type SitesWxTags 

type SitesWxTags struct {
	// contains filtered or unexported fields
}

SitesWxTags represents a controller struct.

func NewSitesWxTags 

func NewSitesWxTags(baseController baseController) *SitesWxTags

NewSitesWxTags creates a new instance of SitesWxTags. It takes a baseController as a parameter and returns a pointer to the SitesWxTags.

func (*SitesWxTags) CreateSiteWxTag 

func (s *SitesWxTags) CreateSiteWxTag(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.WxlanTag) (
	models.ApiResponse[models.WxlanTag],
	error)

CreateSiteWxTag takes context, siteId, body as parameters and returns an models.ApiResponse with models.WxlanTag data and an error if there was an issue with the request or response. Create Site WxTag

func (*SitesWxTags) DeleteSiteWxTag 

func (s *SitesWxTags) DeleteSiteWxTag(
	ctx context.Context,
	siteId uuid.UUID,
	wxtagId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteWxTag takes context, siteId, wxtagId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site WxTag

func (*SitesWxTags) GetSiteApplicationList 

func (s *SitesWxTags) GetSiteApplicationList(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[[]models.SearchWxtagAppsItem],
	error)

GetSiteApplicationList takes context, siteId as parameters and returns an models.ApiResponse with []models.SearchWxtagAppsItem data and an error if there was an issue with the request or response. Get Application List

func (*SitesWxTags) GetSiteCurrentMatchingClientsOfAWxTag 

func (s *SitesWxTags) GetSiteCurrentMatchingClientsOfAWxTag(
	ctx context.Context,
	siteId uuid.UUID,
	wxtagId uuid.UUID) (
	models.ApiResponse[[]models.WxtagMatching],
	error)

GetSiteCurrentMatchingClientsOfAWxTag takes context, siteId, wxtagId as parameters and returns an models.ApiResponse with []models.WxtagMatching data and an error if there was an issue with the request or response. Get Current Matching Clients of a WXLAN Tag

func (*SitesWxTags) GetSiteWxTag 

func (s *SitesWxTags) GetSiteWxTag(
	ctx context.Context,
	siteId uuid.UUID,
	wxtagId uuid.UUID) (
	models.ApiResponse[models.WxlanTag],
	error)

GetSiteWxTag takes context, siteId, wxtagId as parameters and returns an models.ApiResponse with models.WxlanTag data and an error if there was an issue with the request or response. Get Site WxTag Details

func (*SitesWxTags) ListSiteWxTags 

func (s *SitesWxTags) ListSiteWxTags(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.WxlanTag],
	error)

ListSiteWxTags takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.WxlanTag data and an error if there was an issue with the request or response. Get List of Site WxTags

func (*SitesWxTags) UpdateSiteWxTag 

func (s *SitesWxTags) UpdateSiteWxTag(
	ctx context.Context,
	siteId uuid.UUID,
	wxtagId uuid.UUID,
	body *models.WxlanTag) (
	models.ApiResponse[models.WxlanTag],
	error)

UpdateSiteWxTag takes context, siteId, wxtagId, body as parameters and returns an models.ApiResponse with models.WxlanTag data and an error if there was an issue with the request or response. Update Site WxTag

type SitesWxTunnels 

type SitesWxTunnels struct {
	// contains filtered or unexported fields
}

SitesWxTunnels represents a controller struct.

func NewSitesWxTunnels 

func NewSitesWxTunnels(baseController baseController) *SitesWxTunnels

NewSitesWxTunnels creates a new instance of SitesWxTunnels. It takes a baseController as a parameter and returns a pointer to the SitesWxTunnels.

func (*SitesWxTunnels) CreateSiteWxTunnel 

func (s *SitesWxTunnels) CreateSiteWxTunnel(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.WxlanTunnel) (
	models.ApiResponse[models.WxlanTunnel],
	error)

CreateSiteWxTunnel takes context, siteId, body as parameters and returns an models.ApiResponse with models.WxlanTunnel data and an error if there was an issue with the request or response. Create Site WxLan Tunnel

func (*SitesWxTunnels) DeleteSiteWxTunnel 

func (s *SitesWxTunnels) DeleteSiteWxTunnel(
	ctx context.Context,
	siteId uuid.UUID,
	wxtunnelId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteWxTunnel takes context, siteId, wxtunnelId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site WxLan Tunnel

func (*SitesWxTunnels) GetSiteWxTunnel 

func (s *SitesWxTunnels) GetSiteWxTunnel(
	ctx context.Context,
	siteId uuid.UUID,
	wxtunnelId uuid.UUID) (
	models.ApiResponse[models.WxlanTunnel],
	error)

GetSiteWxTunnel takes context, siteId, wxtunnelId as parameters and returns an models.ApiResponse with models.WxlanTunnel data and an error if there was an issue with the request or response. Get Site WxLan tunnel Details

func (*SitesWxTunnels) ListSiteWxTunnels 

func (s *SitesWxTunnels) ListSiteWxTunnels(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.WxlanTunnel],
	error)

ListSiteWxTunnels takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.WxlanTunnel data and an error if there was an issue with the request or response. Get List of Site WxLan Tunnels

func (*SitesWxTunnels) UpdateSiteWxTunnel 

func (s *SitesWxTunnels) UpdateSiteWxTunnel(
	ctx context.Context,
	siteId uuid.UUID,
	wxtunnelId uuid.UUID,
	body *models.WxlanTunnel) (
	models.ApiResponse[models.WxlanTunnel],
	error)

UpdateSiteWxTunnel takes context, siteId, wxtunnelId, body as parameters and returns an models.ApiResponse with models.WxlanTunnel data and an error if there was an issue with the request or response. Update Site WxLan Tunnel

type SitesZones 

type SitesZones struct {
	// contains filtered or unexported fields
}

SitesZones represents a controller struct.

func NewSitesZones 

func NewSitesZones(baseController baseController) *SitesZones

NewSitesZones creates a new instance of SitesZones. It takes a baseController as a parameter and returns a pointer to the SitesZones.

func (*SitesZones) CountSiteZoneSessions 

func (s *SitesZones) CountSiteZoneSessions(
	ctx context.Context,
	siteId uuid.UUID,
	zoneType models.ZoneTypeEnum,
	distinct *models.SiteZoneCountDistinctEnum,
	userType *models.RfClientTypeEnum,
	user *string,
	scopeId *string,
	scope *models.ZoneScopeEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.RepsonseCount],
	error)

CountSiteZoneSessions takes context, siteId, zoneType, distinct, userType, user, scopeId, scope, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.RepsonseCount data and an error if there was an issue with the request or response. Count Site Zone Sessions

func (*SitesZones) CreateSiteZone 

func (s *SitesZones) CreateSiteZone(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.Zone) (
	models.ApiResponse[models.Zone],
	error)

CreateSiteZone takes context, siteId, body as parameters and returns an models.ApiResponse with models.Zone data and an error if there was an issue with the request or response. Create Site Zone

func (*SitesZones) DeleteSiteZone 

func (s *SitesZones) DeleteSiteZone(
	ctx context.Context,
	siteId uuid.UUID,
	zoneId uuid.UUID) (
	*http.Response,
	error)

DeleteSiteZone takes context, siteId, zoneId as parameters and returns an *Response and an error if there was an issue with the request or response. Delete Site Zone

func (*SitesZones) GetSiteZone 

func (s *SitesZones) GetSiteZone(
	ctx context.Context,
	siteId uuid.UUID,
	zoneId uuid.UUID) (
	models.ApiResponse[models.Zone],
	error)

GetSiteZone takes context, siteId, zoneId as parameters and returns an models.ApiResponse with models.Zone data and an error if there was an issue with the request or response. Get Site Zone Details

func (*SitesZones) ListSiteZones 

func (s *SitesZones) ListSiteZones(
	ctx context.Context,
	siteId uuid.UUID,
	limit *int,
	page *int) (
	models.ApiResponse[[]models.Zone],
	error)

ListSiteZones takes context, siteId, limit, page as parameters and returns an models.ApiResponse with []models.Zone data and an error if there was an issue with the request or response. Get List of Site Zones

func (*SitesZones) SearchSiteZoneSessions 

func (s *SitesZones) SearchSiteZoneSessions(
	ctx context.Context,
	siteId uuid.UUID,
	zoneType models.ZoneTypeEnum,
	userType *models.RfClientTypeEnum,
	user *string,
	scopeId *string,
	scope *models.VisitsScopeEnum,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponseZoneSearch],
	error)

SearchSiteZoneSessions takes context, siteId, zoneType, userType, user, scopeId, scope, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponseZoneSearch data and an error if there was an issue with the request or response. Search Zone Sessions

func (*SitesZones) UpdateSiteZone 

func (s *SitesZones) UpdateSiteZone(
	ctx context.Context,
	siteId uuid.UUID,
	zoneId uuid.UUID,
	body *models.Zone) (
	models.ApiResponse[models.Zone],
	error)

UpdateSiteZone takes context, siteId, zoneId, body as parameters and returns an models.ApiResponse with models.Zone data and an error if there was an issue with the request or response. Update Site Zone

type UtilitiesCommon 

type UtilitiesCommon struct {
	// contains filtered or unexported fields
}

UtilitiesCommon represents a controller struct.

func NewUtilitiesCommon 

func NewUtilitiesCommon(baseController baseController) *UtilitiesCommon

NewUtilitiesCommon creates a new instance of UtilitiesCommon. It takes a baseController as a parameter and returns a pointer to the UtilitiesCommon.

func (*UtilitiesCommon) ArpFromDevice 

func (u *UtilitiesCommon) ArpFromDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.HaClusterNode) (
	models.ApiResponse[models.WebsocketSession],
	error)

ArpFromDevice takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. ARP can be performed on the Device. The output will be available through websocket. As there can be multiple command issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` ##### Example output from ws stream ```json { "event": "data", "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd", "data": { "session": "session_id", "raw": "Output": "\tMAC\t\tDEV\tVLAN\tRx Packets\t\t Rx Bytes\t\tTx Packets\t\t Tx Bytes\tFlows\tIdle sec\n-----------------------------------------------------------------------------------------------------------------------" } } ```

func (*UtilitiesCommon) BounceDevicePort added in v0.4.0 

func (u *UtilitiesCommon) BounceDevicePort(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsBouncePort) (
	*http.Response,
	error)

BounceDevicePort takes context, siteId, deviceId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Port Bounce can be performed from Switch/Gateway. **Note:** Ports starting with vme, ae, irb, and HA control ports (for SSR only) are not supported The output will be available through websocket. As there can be multiple command issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` ##### Example output from ws stream ```json { "event": "data", "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd", "data": { "session": "session_id", "raw": "Port bounce complete." } } ```

func (*UtilitiesCommon) ClearSiteDeviceMacTable 

func (u *UtilitiesCommon) ClearSiteDeviceMacTable(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsMacTable) (
	models.ApiResponse[models.WebsocketSession],
	error)

ClearSiteDeviceMacTable takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Clear MAC Table from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ```

func (*UtilitiesCommon) ClearSiteDevicePolicyHitCount added in v0.2.38 

func (u *UtilitiesCommon) ClearSiteDevicePolicyHitCount(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[models.WebsocketSessionWithUrl],
	error)

ClearSiteDevicePolicyHitCount takes context, siteId, deviceId as parameters and returns an models.ApiResponse with models.WebsocketSessionWithUrl data and an error if there was an issue with the request or response. Clear application policy hit counts for all the policies

func (*UtilitiesCommon) CreateSiteDeviceShellSession 

func (u *UtilitiesCommon) CreateSiteDeviceShellSession(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[models.WebsocketSessionWithUrl],
	error)

CreateSiteDeviceShellSession takes context, siteId, deviceId as parameters and returns an models.ApiResponse with models.WebsocketSessionWithUrl data and an error if there was an issue with the request or response. Create Shell Session

func (*UtilitiesCommon) GetSiteDeviceConfigCmd 

func (u *UtilitiesCommon) GetSiteDeviceConfigCmd(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	sort *bool) (
	models.ApiResponse[models.ResponseDeviceConfigCli],
	error)

GetSiteDeviceConfigCmd takes context, siteId, deviceId, sort as parameters and returns an models.ApiResponse with models.ResponseDeviceConfigCli data and an error if there was an issue with the request or response. Get Config CLI Commands For a brown-field switch deployment where we adopted the switch through Adoption Command, we do not wipe out / overwrite the existing config automatically. Instead, we generate CLI commands that we would have generated. The user can inspect, modify, and incorporate this into their existing config manually. Once they feel comfortable about the config we generate, they can enable allow_mist_config where we will take full control of their config like a claimed switch

func (*UtilitiesCommon) GetSiteDeviceZtpPassword 

func (u *UtilitiesCommon) GetSiteDeviceZtpPassword(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[models.RootPasswordString],
	error)

GetSiteDeviceZtpPassword takes context, siteId, deviceId as parameters and returns an models.ApiResponse with models.RootPasswordString data and an error if there was an issue with the request or response. In the case where soemthing happens during/after ZTP, the root-password is modified (required for ZTP to set up outbound-ssh) but the user-defined password config has not be configured. This API can be used to retrieve the temporary password.

func (*UtilitiesCommon) MonitorSiteDeviceTraffic 

func (u *UtilitiesCommon) MonitorSiteDeviceTraffic(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsMonitorTraffic) (
	models.ApiResponse[models.WebsocketSessionWithUrl],
	error)

MonitorSiteDeviceTraffic takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSessionWithUrl data and an error if there was an issue with the request or response. Monitor traffic on switches and SRX. * JUNOS uses cmd "monitor interface <port>" to monitor traffic on particular <port> * JUNOS uses cmd "monitor interface traffic" to monitor traffic on all ports

func (*UtilitiesCommon) PingFromDevice 

func (u *UtilitiesCommon) PingFromDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsPing) (
	models.ApiResponse[models.WebsocketSession],
	error)

PingFromDevice takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Ping from AP, Switch and SSR Ping can be performed from the Device. The output will be available through websocket. As there can be multiple command issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` ##### Example output from ws stream ```json { "event": "data", "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd", "data": { "session": "session_id", "raw": "64 bytes from 23.211.0.110: seq=8 ttl=58 time=12.323 ms\n" } } ```

func (*UtilitiesCommon) ReadoptSiteOctermDevice 

func (u *UtilitiesCommon) ReadoptSiteOctermDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	*http.Response,
	error)

ReadoptSiteOctermDevice takes context, siteId, deviceId as parameters and returns an *Response and an error if there was an issue with the request or response. For the octerm devices, the device ID must come from fpc0. However, for a VC, the users may change the original fpc0 from CLI. To fix the issue, the readopt API could be used to trigger the readopt process so the device would get the corret device ID to connect the cloud.

func (*UtilitiesCommon) ReleaseSiteDeviceDhcpLease added in v0.2.38 

func (u *UtilitiesCommon) ReleaseSiteDeviceDhcpLease(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsReleaseDhcpLeases) (
	*http.Response,
	error)

ReleaseSiteDeviceDhcpLease takes context, siteId, deviceId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Releases an active DHCP lease.

func (*UtilitiesCommon) ReprovisionSiteOctermDevice 

func (u *UtilitiesCommon) ReprovisionSiteOctermDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	*http.Response,
	error)

ReprovisionSiteOctermDevice takes context, siteId, deviceId as parameters and returns an *Response and an error if there was an issue with the request or response. To force one device to reprovision itself again.

func (*UtilitiesCommon) RestartSiteDevice 

func (u *UtilitiesCommon) RestartSiteDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsDevicesRestart) (
	*http.Response,
	error)

RestartSiteDevice takes context, siteId, deviceId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Restart / Reboot a device

func (*UtilitiesCommon) ShowSiteDeviceArpTable added in v0.3.41 

func (u *UtilitiesCommon) ShowSiteDeviceArpTable(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowArp) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteDeviceArpTable takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get ARP Table from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ```

func (*UtilitiesCommon) ShowSiteDeviceBgpSummary added in v0.3.41 

func (u *UtilitiesCommon) ShowSiteDeviceBgpSummary(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowBgpRummary) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteDeviceBgpSummary takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get BGP Summary from SSR, SRX and Switch. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` ##### Example output from ws stream ``` Tue 2024-04-23 16:36:06 UTC Retrieving bgp entries... BGP table version is 354, local router ID is 10.224.8.16, vrf id 0 Default local pref 100, local AS 65000 Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, i internal, r RIB_failure, S Stale, R Removed Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self Origin codes: i - IGP, e - EGP, ? - incomplete RPKI validation codes: V valid, I invalid, N Not found Network Next Hop Metric LocPrf Weight Path *> 161.161.161.0/24 ```"

func (*UtilitiesCommon) ShowSiteDeviceDhcpLeases added in v0.2.38 

func (u *UtilitiesCommon) ShowSiteDeviceDhcpLeases(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowDhcpLeases) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteDeviceDhcpLeases takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Shows DHCP leases

func (*UtilitiesCommon) ShowSiteDeviceEvpnDatabase added in v0.3.41 

func (u *UtilitiesCommon) ShowSiteDeviceEvpnDatabase(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowEvpnDatabase) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteDeviceEvpnDatabase takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get EVPN Database from the Device. The output will be available through websocket.

func (*UtilitiesCommon) ShowSiteDeviceForwardingTable added in v0.3.41 

func (u *UtilitiesCommon) ShowSiteDeviceForwardingTable(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowForwardingTable) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteDeviceForwardingTable takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get forwarding table from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` ##### Example output from ws stream ``` Mon 2024-05-20 16:47:30 UTC Retrieving fib entries… Entry Count: 3268 Capacity: 22668 ==================== ====== ======= ================== ===== ====================== =========== =========== ====== IP Prefix Port Proto Tenant VRF Service Next Hops Vector Cost ==================== ====== ======= ================== ===== ====================== =========== =========== ====== 0.0.0.0/0 0 None Old_Mgmt - internet-wan_and_lte 1-2.0 broadband 1 1-4.0 lte 10 branch1-Kiosk - internet-wan_and_lte 1-2.0 broadband 1 1-4.0 lte 10 branch1-MGT - internet-wan_and_lte 1-2.0 broadband 1 1-4.0 lte 10 3.1.1.0/24 0 None Old_Mgmt - internet-wan_and_lte 1-2.0 broadband 1 1-4.0 lte 10 branch1-Kiosk - internet-wan_and_lte 1-2.0 broadband 1 1-4.0 lte 10 branch1-MGT - internet-wan_and_lte 1-2.0 broadband 1 1-4.0 lte 10 ```

func (*UtilitiesCommon) ShowSiteDeviceMacTable added in v0.3.41 

func (u *UtilitiesCommon) ShowSiteDeviceMacTable(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsMacTable) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteDeviceMacTable takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get MAC Table from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ```

func (*UtilitiesCommon) StartSiteLocateDevice 

func (u *UtilitiesCommon) StartSiteLocateDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.LocateSwitch) (
	*http.Response,
	error)

StartSiteLocateDevice takes context, siteId, deviceId, body as parameters and returns an *Response and an error if there was an issue with the request or response. ### Access Points Locate an Access Point by blinking it's LED. It is a persisted state that has to be stopped by calling Stop Locating API ### Switches Locate a Switch by blinking all port LEDs. By default, request is sent to `master` switch and LEDs will keep flashing for 5 minutes. In case of virtual chassis (VC) the desired member mac has to be passed in the request payload. At anypoint, only one VC member can be requested to flash the LED. To stop LED flashing before the duration ends /unlocate API request can be made. If /unlocate API is not called LED will continue to flash on device for the given duration. Default duration is 5 minutes and 120 minutes is the maximum.

func (*UtilitiesCommon) StopSiteLocateDevice 

func (u *UtilitiesCommon) StopSiteLocateDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	*http.Response,
	error)

StopSiteLocateDevice takes context, siteId, deviceId as parameters and returns an *Response and an error if there was an issue with the request or response. Stop Locate a Device

func (*UtilitiesCommon) TracerouteFromDevice 

func (u *UtilitiesCommon) TracerouteFromDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsTraceroute) (
	models.ApiResponse[models.WebsocketSession],
	error)

TracerouteFromDevice takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Traceroute can be performed from the Device. The output will be available through websocket. As there can be multiple command issued against the same Device at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" }``` #### Example output from ws stream ```json { "channel": "/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd", "event": "data", "data": { "session": "9106e908-74dc-4a4f-9050-9c2adcaf44a5", "raw": "Running traceroute...\ntraceroute to 8.8.8.8, 64 hops max\n 0 192.168.1.1 1 ms 192.168.1.1 1 ms 192.168.1.1 1 ms\n 1 80.10.236.81 2 ms 80.10.236.81 4 ms 80.10.236.81 2 ms\n 2 193.253.80.250 3 ms 193.253.80.250 2 ms 193.253.80.250 2 ms\n 3 193.252.159.41 2 ms 193.252.159.41 1 ms 193.252.159.41 3 ms\n" } } ``` "

func (*UtilitiesCommon) UploadSiteDeviceSupportFile 

func (u *UtilitiesCommon) UploadSiteDeviceSupportFile(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsSendSupportLogs) (
	*http.Response,
	error)

UploadSiteDeviceSupportFile takes context, siteId, deviceId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Support / Upload device support files #### Info Param | Name | Type | Description | | --- | --- | --- | | process | string | Upload 1 file with output of show system processes extensive | | outbound-ssh | string | Upload 1 file that concatenates all /var/log/outbound-ssh.log* files | | messages | string | Upload 1 to 10 /var/log/messages* files | | core-dumps | string | Upload all core dump files, if any | | full | string | Upload 1 file with output of request support information, 1 file that concatenates all /var/log/outbound-ssh.log files, all core dump files, the 3 most recent /var/log/messages files, and Mist agent logs (for Junos devices running the Mist agent) | | var-logs | string | Upload all non-empty files in the /var/log/ directory | | jma-logs | string | Upload Mist agent logs (for Junos devices running the Mist agent only) | "

type UtilitiesLAN 

type UtilitiesLAN struct {
	// contains filtered or unexported fields
}

UtilitiesLAN represents a controller struct.

func NewUtilitiesLAN 

func NewUtilitiesLAN(baseController baseController) *UtilitiesLAN

NewUtilitiesLAN creates a new instance of UtilitiesLAN. It takes a baseController as a parameter and returns a pointer to the UtilitiesLAN.

func (*UtilitiesLAN) CableTestFromSwitch 

func (u *UtilitiesLAN) CableTestFromSwitch(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsCableTests) (
	models.ApiResponse[models.WebsocketSession],
	error)

CableTestFromSwitch takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. TDR can be performed from the Switch. The output will be available through websocket. As there can be multiple command issued against the same Switch at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` ##### Example output from ws stream ```json { "event": "data", "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd", "data": { "session": "session_id", "raw": "Interface TDR detail:\nTest status : Test successfully executed ge-0/0/0\n" } } ```

func (*UtilitiesLAN) ClearAllLearnedMacsFromPortOnSwitch 

func (u *UtilitiesLAN) ClearAllLearnedMacsFromPortOnSwitch(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsClearMacs) (
	*http.Response,
	error)

ClearAllLearnedMacsFromPortOnSwitch takes context, siteId, deviceId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Clear all learned MAC addresses, including persistent MAC addresses, on a port.

func (*UtilitiesLAN) ClearBpduErrosFromPortsOnSwitch 

func (u *UtilitiesLAN) ClearBpduErrosFromPortsOnSwitch(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsClearBpdu) (
	*http.Response,
	error)

ClearBpduErrosFromPortsOnSwitch takes context, siteId, deviceId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Clear bridge protocol data unit (BPDU) error condition caused by the detection of a possible bridging loop from Spanning Tree Protocol (STP) operation that renders the port unoperational.

func (*UtilitiesLAN) CreateSiteDeviceSnapshot 

func (u *UtilitiesLAN) CreateSiteDeviceSnapshot(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[models.ResponseDeviceSnapshot],
	error)

CreateSiteDeviceSnapshot takes context, siteId, deviceId as parameters and returns an models.ApiResponse with models.ResponseDeviceSnapshot data and an error if there was an issue with the request or response. Create recovery device snapshot (Available on Junos OS EX2300-, EX3400-, EX4400- devices)

func (*UtilitiesLAN) PollSiteSwitchStats 

func (u *UtilitiesLAN) PollSiteSwitchStats(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	*http.Response,
	error)

PollSiteSwitchStats takes context, siteId, deviceId as parameters and returns an *Response and an error if there was an issue with the request or response. This API can be used to poll statistics from the Switch proactively once. After it is called, the statistics will be pushed back to the cloud within the statistics interval.

func (*UtilitiesLAN) ReauthOrgDot1xWiredClient added in v0.2.38 

func (u *UtilitiesLAN) ReauthOrgDot1xWiredClient(
	ctx context.Context,
	orgId uuid.UUID,
	clientMac string) (
	models.ApiResponse[models.ResponseWiredCoa],
	error)

ReauthOrgDot1xWiredClient takes context, orgId, clientMac as parameters and returns an models.ApiResponse with models.ResponseWiredCoa data and an error if there was an issue with the request or response. Trigger a CoA (change of authorization) against a Wiired client

func (*UtilitiesLAN) ReauthSiteDot1xWiredClient added in v0.2.38 

func (u *UtilitiesLAN) ReauthSiteDot1xWiredClient(
	ctx context.Context,
	siteId uuid.UUID,
	clientMac string) (
	models.ApiResponse[models.ResponseWiredCoa],
	error)

ReauthSiteDot1xWiredClient takes context, siteId, clientMac as parameters and returns an models.ApiResponse with models.ResponseWiredCoa data and an error if there was an issue with the request or response. Trigger a CoA (change of authorization) against a Wiired client

func (*UtilitiesLAN) UpgradeDeviceBios 

func (u *UtilitiesLAN) UpgradeDeviceBios(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UpgradeBios) (
	models.ApiResponse[models.ResponseDeviceBiosUpgrade],
	error)

UpgradeDeviceBios takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.ResponseDeviceBiosUpgrade data and an error if there was an issue with the request or response. Upgrade device bios

func (*UtilitiesLAN) UpgradeDeviceFPGA 

func (u *UtilitiesLAN) UpgradeDeviceFPGA(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UpgradeFpga) (
	models.ApiResponse[models.ResponseDeviceBiosUpgrade],
	error)

UpgradeDeviceFPGA takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.ResponseDeviceBiosUpgrade data and an error if there was an issue with the request or response. Upgrade device fpga

func (*UtilitiesLAN) UpgradeSiteDevicesBios 

func (u *UtilitiesLAN) UpgradeSiteDevicesBios(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.UpgradeBiosMulti) (
	*http.Response,
	error)

UpgradeSiteDevicesBios takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Upgrade Bios on Multiple Device

func (*UtilitiesLAN) UpgradeSiteDevicesFpga 

func (u *UtilitiesLAN) UpgradeSiteDevicesFpga(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.UpgradeFpgaMulti) (
	*http.Response,
	error)

UpgradeSiteDevicesFpga takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Upgrade Bios on Multiple Device

type UtilitiesLocation 

type UtilitiesLocation struct {
	// contains filtered or unexported fields
}

UtilitiesLocation represents a controller struct.

func NewUtilitiesLocation 

func NewUtilitiesLocation(baseController baseController) *UtilitiesLocation

NewUtilitiesLocation creates a new instance of UtilitiesLocation. It takes a baseController as a parameter and returns a pointer to the UtilitiesLocation.

func (*UtilitiesLocation) SendSiteDevicesArbitratryBleBeacon 

func (u *UtilitiesLocation) SendSiteDevicesArbitratryBleBeacon(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.UtilsSendBleBeacon) (
	*http.Response,
	error)

SendSiteDevicesArbitratryBleBeacon takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Send arbitrary BLE Beacon for a period of time Note that only the devices that are connected will be restarted.

type UtilitiesMxEdge 

type UtilitiesMxEdge struct {
	// contains filtered or unexported fields
}

UtilitiesMxEdge represents a controller struct.

func NewUtilitiesMxEdge 

func NewUtilitiesMxEdge(baseController baseController) *UtilitiesMxEdge

NewUtilitiesMxEdge creates a new instance of UtilitiesMxEdge. It takes a baseController as a parameter and returns a pointer to the UtilitiesMxEdge.

func (*UtilitiesMxEdge) PreemptSitesMxTunnel 

func (u *UtilitiesMxEdge) PreemptSitesMxTunnel(
	ctx context.Context,
	siteId uuid.UUID,
	mxtunnelId uuid.UUID) (
	models.ApiResponse[models.ResponseMxtunnelsPreemptAps],
	error)

PreemptSitesMxTunnel takes context, siteId, mxtunnelId as parameters and returns an models.ApiResponse with models.ResponseMxtunnelsPreemptAps data and an error if there was an issue with the request or response. To preempt AP’s which are not connected to preferred peer to the preferred peer

type UtilitiesPCAPs 

type UtilitiesPCAPs struct {
	// contains filtered or unexported fields
}

UtilitiesPCAPs represents a controller struct.

func NewUtilitiesPCAPs 

func NewUtilitiesPCAPs(baseController baseController) *UtilitiesPCAPs

NewUtilitiesPCAPs creates a new instance of UtilitiesPCAPs. It takes a baseController as a parameter and returns a pointer to the UtilitiesPCAPs.

func (*UtilitiesPCAPs) GetOrgCapturingStatus 

func (u *UtilitiesPCAPs) GetOrgCapturingStatus(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[models.ResponsePcapStatus],
	error)

GetOrgCapturingStatus takes context, orgId as parameters and returns an models.ApiResponse with models.ResponsePcapStatus data and an error if there was an issue with the request or response. Get Org Capturing status

func (*UtilitiesPCAPs) GetSiteCapturingStatus 

func (u *UtilitiesPCAPs) GetSiteCapturingStatus(
	ctx context.Context,
	siteId uuid.UUID) (
	models.ApiResponse[models.ResponsePcapStatus],
	error)

GetSiteCapturingStatus takes context, siteId as parameters and returns an models.ApiResponse with models.ResponsePcapStatus data and an error if there was an issue with the request or response. Get Capturing status

func (*UtilitiesPCAPs) ListOrgPacketCaptures 

func (u *UtilitiesPCAPs) ListOrgPacketCaptures(
	ctx context.Context,
	orgId uuid.UUID,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponsePcapSearch],
	error)

ListOrgPacketCaptures takes context, orgId, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponsePcapSearch data and an error if there was an issue with the request or response. Get List of Org Packet Captures

func (*UtilitiesPCAPs) ListSitePacketCaptures 

func (u *UtilitiesPCAPs) ListSitePacketCaptures(
	ctx context.Context,
	siteId uuid.UUID,
	clientMac *string,
	start *int,
	end *int,
	duration *string,
	limit *int,
	page *int) (
	models.ApiResponse[models.ResponsePcapSearch],
	error)

ListSitePacketCaptures takes context, siteId, clientMac, start, end, duration, limit, page as parameters and returns an models.ApiResponse with models.ResponsePcapSearch data and an error if there was an issue with the request or response. Get List of Site Packet Captures

func (*UtilitiesPCAPs) StartOrgPacketCapture 

func (u *UtilitiesPCAPs) StartOrgPacketCapture(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.CaptureOrg) (
	models.ApiResponse[models.ResponsePcapStart],
	error)

StartOrgPacketCapture takes context, orgId, body as parameters and returns an models.ApiResponse with models.ResponsePcapStart data and an error if there was an issue with the request or response. Initiate a Packet Capture **NOTE**: For packet captures of org level Mist Edges only. Use [Start Site Packet Capture]($e/Utilities%20PCAPs/startSitePacketCapture) for site level Mist Edges. The output will be available through websocket. As there can be multiple command issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/pcaps" } ``` #### Response (Wireless/RadioTap) ```json { "event": "data" "channel": "/orgs/67970e46-4e12-11e6-9188-0242ac110007/pcaps" "data": { "capture_id": "f039b1b4-a23e-48b2-906a-0da40524de73", "pcap_dict": { "dst_mac": "68:ec:c5:09:2e:87", "src_mac": "8c:3b:ad:e0:47:40", "vlan": 1, "src_ip": "34.224.147.117", "dst_ip": "192.168.1.55", "dst_port": 51635, "src_port": 443, "protocol": "TCP", "mxedge_id": "00000000-0000-0000-1000-001122334455", "direction": "tx", "timestamp": 1652247615, "length": 159.0, "interface": "port0", "info": "1652247616.007409 IP ec2-34-224-147-117.compute-1.amazonaws.com.https > ip-192-168-1-55.ec2.internal.51635: Flags [P.], seq 2192123968:2192124057, ack 4035166782, win 12, options [nop,nop,TS val 597467050 ecr 740580660], length 89\\n", }, "pcap_raw": "1MOyoQIABAAAAAAAAAAAAP//AAABAAAAQEx7YhMzAACfAAAAnwAAAGjsxQkuh4w7reBHQIEAAAEIAEUAAI1bLEAAKAZ/CiLgk3XAqAE3AbvJs4KpKEDwg8I+gBgADFf9AAABAQgKI5yfqiwkXTQXAwMAVKY5JopoKQrVEn0/3ld4YntctGEH/rTZuwtCvzSncFw71QJveJi9uxHs57KC8w9Apph3YvXJrmWg7M37+o+YV0KH/xmr626s5Bkhb3QhKOu+NoNEmA==\" } } ```

func (*UtilitiesPCAPs) StartSitePacketCapture 

func (u *UtilitiesPCAPs) StartSitePacketCapture(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.CaptureSite) (
	models.ApiResponse[models.ResponsePcapStart],
	error)

StartSitePacketCapture takes context, siteId, body as parameters and returns an models.ApiResponse with models.ResponsePcapStart data and an error if there was an issue with the request or response. Initiate a Site Packet Capture The output will be available through websocket. As there can be multiple command issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/pcaps" } ``` #### Response (MxEdge) ```json { "event": "data" "channel": "/sites/:site_id/pcaps" "data": { "capture_id": "6b1be4fb-b239-44d9-9d3b-cb1ff3af1721", "lost_messages": 0 "pcap_dict": { "channel_frequency": 2412, "channel": "1", "datarate": "1.0 Mbps", "rssi": -75, "dst": "78:bd:bc:ca:0b:0a", "src": "18:b8:1f:4c:91:c0", "bssid": "18:b8:1f:4c:91:c0", "frame_type": "Management", "frame_subtype": "Probe Response", "proto": "802.11", "ap_mac": "d4:20:b0:81:99:2e", "direction": "tx", "timestamp": 1652246543, "length": 416.0, "interface": "radiotap", "info": "1652246544.467733 1683216786us tsft 1.0 Mb/s 2412 MHz 11g -75dBm signal -82dBm noise antenna 0 Probe Response (ATTKmsWiVS) [1.0* 2.0* 5.5* 11.0* 18.0 24.0 36.0 54.0 Mbit] CH: 2, PRIVACY\\n", }, "pcap_raw": "1MOyoQIABAAAAAAAAAAAAP//AAABAAAAEEh7Yh5VBwCgAQAAoAEAAAAAKwBvCADAAQAAAIw7reCS2VNkAAAAABACbAmABLWuAAEAEBgAAwACAABQADoBeL28ygsKGLgfTJHAGLgfTJHAcIZ2WDlBJQAAAGQAERUACkFUVEttc1dpVlMBCIKEi5YkMEhsAwECBwZVUyABCx4gAQAjAhkAKgEEMgQMEhhgMBQBAAAPrAQBAAAPrAQBAAAPrAIMAAsFAQAbAABGBTIIAQAALRqtCR////8AAAAAAAAAAAAAAAAAAAAAAAAAAD0WAggVAAAAAAAAAAAAAAAAAAAAAAAAAH8IBAAIAAAAAEDdkwBQ8gQQSgABEBBEAAECEDsAAQMQRwAQn2481frn3KT+uGod2ERx+RAhAAtBcnJpcywgSW5jLhAjAApCR1cyMTAtNzAwECQACkJHVzIxMC03MDAQQgAKQkdXMjEwLTcwMBBUAAgABgBQ8gQAARARAA5BcnJpcyBXaXJlbGVzcxAIAAIgCBA8AAEBEEkABgA3KgABIN0JABAYAgEQHAAA3RgAUPICAQGEAAOkAAAnpAAAQkNeAGIyLwAzjakr" } ``` #### Response (Wired) ```json { "event": "data" "channel": "/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps" "data": { "capture_id": "f039b1b4-a23e-48b2-906a-0da40524de73", "pcap_dict": { "dst_mac": "68:ec:c5:09:2e:87", "src_mac": "8c:3b:ad:e0:47:40", "vlan": 1, "src_ip": "34.224.147.117", "dst_ip": "192.168.1.55", "dst_port": 51635, "src_port": 443, "proto": "TCP", "ap_mac": "d4:20:b0:81:99:2e", "direction": "tx", "timestamp": 1652247615, "length": 159.0, "interface": "wired", "info": "1652247616.007409 IP ec2-34-224-147-117.compute-1.amazonaws.com.https > ip-192-168-1-55.ec2.internal.51635: Flags [P.], seq 2192123968:2192124057, ack 4035166782, win 12, options [nop,nop,TS val 597467050 ecr 740580660], length 89\\n", }, "pcap_raw": "1MOyoQIABAAAAAAAAAAAAP//AAABAAAAQEx7YhMzAACfAAAAnwAAAGjsxQkuh4w7reBHQIEAAAEIAEUAAI1bLEAAKAZ/CiLgk3XAqAE3AbvJs4KpKEDwg8I+gBgADFf9AAABAQgKI5yfqiwkXTQXAwMAVKY5JopoKQrVEn0/3ld4YntctGEH/rTZuwtCvzSncFw71QJveJi9uxHs57KC8w9Apph3YvXJrmWg7M37+o+YV0KH/xmr626s5Bkhb3QhKOu+NoNEmA==" } } ``` #### Stop Response (Wired/Wireless) ```json { "event": "data" "channel": "/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps" "data": { "capture_id": "a2f7374d-6a70-41fd-8a3f-71e42573baaf", "lost_messages": 0, "pcap_dict": null } } ```

func (*UtilitiesPCAPs) StopOrgPacketCapture 

func (u *UtilitiesPCAPs) StopOrgPacketCapture(
	ctx context.Context,
	orgId uuid.UUID) (
	*http.Response,
	error)

StopOrgPacketCapture takes context, orgId as parameters and returns an *Response and an error if there was an issue with the request or response. Stop current Org capture

func (*UtilitiesPCAPs) StopSitePacketCapture 

func (u *UtilitiesPCAPs) StopSitePacketCapture(
	ctx context.Context,
	siteId uuid.UUID) (
	*http.Response,
	error)

StopSitePacketCapture takes context, siteId as parameters and returns an *Response and an error if there was an issue with the request or response. Stop current capture

func (*UtilitiesPCAPs) UpdateSitePacketCapture 

func (u *UtilitiesPCAPs) UpdateSitePacketCapture(
	ctx context.Context,
	siteId uuid.UUID,
	pcapId uuid.UUID,
	body *models.NotesString) (
	*http.Response,
	error)

UpdateSitePacketCapture takes context, siteId, pcapId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Update or add notes to a completed packet capture

type UtilitiesUpgrade 

type UtilitiesUpgrade struct {
	// contains filtered or unexported fields
}

UtilitiesUpgrade represents a controller struct.

func NewUtilitiesUpgrade 

func NewUtilitiesUpgrade(baseController baseController) *UtilitiesUpgrade

NewUtilitiesUpgrade creates a new instance of UtilitiesUpgrade. It takes a baseController as a parameter and returns a pointer to the UtilitiesUpgrade.

func (*UtilitiesUpgrade) CancelOrgSsrUpgrade 

func (u *UtilitiesUpgrade) CancelOrgSsrUpgrade(
	ctx context.Context,
	orgId uuid.UUID,
	upgradeId uuid.UUID) (
	*http.Response,
	error)

CancelOrgSsrUpgrade takes context, orgId, upgradeId as parameters and returns an *Response and an error if there was an issue with the request or response. Best effort to cancel an upgrade. Devices which are already upgraded wont be touched↵

func (*UtilitiesUpgrade) CancelSiteDeviceUpgrade 

func (u *UtilitiesUpgrade) CancelSiteDeviceUpgrade(
	ctx context.Context,
	siteId uuid.UUID,
	upgradeId uuid.UUID) (
	*http.Response,
	error)

CancelSiteDeviceUpgrade takes context, siteId, upgradeId as parameters and returns an *Response and an error if there was an issue with the request or response. Best effort to cancel an upgrade. Devices which are already upgraded wont be touched

func (*UtilitiesUpgrade) GetOrgDeviceUpgrade 

func (u *UtilitiesUpgrade) GetOrgDeviceUpgrade(
	ctx context.Context,
	orgId uuid.UUID,
	upgradeId uuid.UUID) (
	models.ApiResponse[models.ResponseUpgradeOrgDevices],
	error)

GetOrgDeviceUpgrade takes context, orgId, upgradeId as parameters and returns an models.ApiResponse with models.ResponseUpgradeOrgDevices data and an error if there was an issue with the request or response. Get Multiple Devices Upgrade

func (*UtilitiesUpgrade) GetOrgMxEdgeUpgrade 

func (u *UtilitiesUpgrade) GetOrgMxEdgeUpgrade(
	ctx context.Context,
	orgId uuid.UUID,
	upgradeId uuid.UUID) (
	models.ApiResponse[models.ResponseMxedgeUpgrade],
	error)

GetOrgMxEdgeUpgrade takes context, orgId, upgradeId as parameters and returns an models.ApiResponse with models.ResponseMxedgeUpgrade data and an error if there was an issue with the request or response. Get Mist Edge Upgrade

func (*UtilitiesUpgrade) GetSiteDeviceUpgrade 

func (u *UtilitiesUpgrade) GetSiteDeviceUpgrade(
	ctx context.Context,
	siteId uuid.UUID,
	upgradeId uuid.UUID) (
	models.ApiResponse[models.ResponseDeviceUpgrade],
	error)

GetSiteDeviceUpgrade takes context, siteId, upgradeId as parameters and returns an models.ApiResponse with models.ResponseDeviceUpgrade data and an error if there was an issue with the request or response. Get Site Device Upgrade

func (*UtilitiesUpgrade) GetSiteSsrUpgrade 

func (u *UtilitiesUpgrade) GetSiteSsrUpgrade(
	ctx context.Context,
	siteId uuid.UUID,
	upgradeId uuid.UUID) (
	models.ApiResponse[models.ResponseSsrUpgradeStatus],
	error)

GetSiteSsrUpgrade takes context, siteId, upgradeId as parameters and returns an models.ApiResponse with models.ResponseSsrUpgradeStatus data and an error if there was an issue with the request or response. Get Specific Site SSR Upgrade

func (*UtilitiesUpgrade) ListOrgAvailableDeviceVersions added in v0.3.17 

func (u *UtilitiesUpgrade) ListOrgAvailableDeviceVersions(
	ctx context.Context,
	orgId uuid.UUID,
	mType *models.DeviceTypeEnum,
	model *string) (
	models.ApiResponse[[]models.DeviceVersionItem],
	error)

ListOrgAvailableDeviceVersions takes context, orgId, mType, model as parameters and returns an models.ApiResponse with []models.DeviceVersionItem data and an error if there was an issue with the request or response. Get List of Available Device Versions

func (*UtilitiesUpgrade) ListOrgAvailableSsrVersions 

func (u *UtilitiesUpgrade) ListOrgAvailableSsrVersions(
	ctx context.Context,
	orgId uuid.UUID,
	channel *string) (
	models.ApiResponse[[]models.SsrVersion],
	error)

ListOrgAvailableSsrVersions takes context, orgId, channel as parameters and returns an models.ApiResponse with []models.SsrVersion data and an error if there was an issue with the request or response. Get available version for SSR

func (*UtilitiesUpgrade) ListOrgDeviceUpgrades 

func (u *UtilitiesUpgrade) ListOrgDeviceUpgrades(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.OrgDeviceUpgrade],
	error)

ListOrgDeviceUpgrades takes context, orgId as parameters and returns an models.ApiResponse with []models.OrgDeviceUpgrade data and an error if there was an issue with the request or response. Get List of Org multiple devces upgrades

func (*UtilitiesUpgrade) ListOrgMxEdgeUpgrades 

func (u *UtilitiesUpgrade) ListOrgMxEdgeUpgrades(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.ResponseMxedgeUpgrade],
	error)

ListOrgMxEdgeUpgrades takes context, orgId as parameters and returns an models.ApiResponse with []models.ResponseMxedgeUpgrade data and an error if there was an issue with the request or response. Get List of Org Mist Edge Upgrades

func (*UtilitiesUpgrade) ListOrgSsrUpgrades 

func (u *UtilitiesUpgrade) ListOrgSsrUpgrades(
	ctx context.Context,
	orgId uuid.UUID) (
	models.ApiResponse[[]models.SsrUpgradeResponse],
	error)

ListOrgSsrUpgrades takes context, orgId as parameters and returns an models.ApiResponse with []models.SsrUpgradeResponse data and an error if there was an issue with the request or response. Get List of Org SSR Upgrades

func (*UtilitiesUpgrade) ListSiteAvailableDeviceVersions 

func (u *UtilitiesUpgrade) ListSiteAvailableDeviceVersions(
	ctx context.Context,
	siteId uuid.UUID,
	mType *models.DeviceTypeEnum,
	model *string) (
	models.ApiResponse[[]models.DeviceVersionItem],
	error)

ListSiteAvailableDeviceVersions takes context, siteId, mType, model as parameters and returns an models.ApiResponse with []models.DeviceVersionItem data and an error if there was an issue with the request or response. Get List of Available Device Versions

func (*UtilitiesUpgrade) ListSiteDeviceUpgrades 

func (u *UtilitiesUpgrade) ListSiteDeviceUpgrades(
	ctx context.Context,
	siteId uuid.UUID,
	status *models.DeviceUpgradeStatusEnum) (
	models.ApiResponse[[]models.ResponseSiteDeviceUpgrade],
	error)

ListSiteDeviceUpgrades takes context, siteId, status as parameters and returns an models.ApiResponse with []models.ResponseSiteDeviceUpgrade data and an error if there was an issue with the request or response. Get all upgrades for site

func (*UtilitiesUpgrade) UpgradeDevice 

func (u *UtilitiesUpgrade) UpgradeDevice(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.DeviceUpgrade) (
	models.ApiResponse[models.ResponseUpgradeDevice],
	error)

UpgradeDevice takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.ResponseUpgradeDevice data and an error if there was an issue with the request or response. Device Upgrade

func (*UtilitiesUpgrade) UpgradeOrgDevices 

func (u *UtilitiesUpgrade) UpgradeOrgDevices(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.UpgradeOrgDevices) (
	models.ApiResponse[models.ResponseUpgradeOrgDevices],
	error)

UpgradeOrgDevices takes context, orgId, body as parameters and returns an models.ApiResponse with models.ResponseUpgradeOrgDevices data and an error if there was an issue with the request or response. Upgrade Multiple Sites (Only supported for Access Points ugprades)

func (*UtilitiesUpgrade) UpgradeOrgJsiDevice 

func (u *UtilitiesUpgrade) UpgradeOrgJsiDevice(
	ctx context.Context,
	orgId uuid.UUID,
	deviceMac string,
	body *models.VersionString) (
	*http.Response,
	error)

UpgradeOrgJsiDevice takes context, orgId, deviceMac, body as parameters and returns an *Response and an error if there was an issue with the request or response. Upgrade

func (*UtilitiesUpgrade) UpgradeOrgMxEdges 

func (u *UtilitiesUpgrade) UpgradeOrgMxEdges(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.MxedgeUpgradeMulti) (
	*http.Response,
	error)

UpgradeOrgMxEdges takes context, orgId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Upgrade Mist Edges

func (*UtilitiesUpgrade) UpgradeOrgSsrs 

func (u *UtilitiesUpgrade) UpgradeOrgSsrs(
	ctx context.Context,
	orgId uuid.UUID,
	body *models.SsrUpgradeMulti) (
	models.ApiResponse[models.SsrUpgradeResponse],
	error)

UpgradeOrgSsrs takes context, orgId, body as parameters and returns an models.ApiResponse with models.SsrUpgradeResponse data and an error if there was an issue with the request or response. Upgrade Org SSRs

func (*UtilitiesUpgrade) UpgradeSiteDevices 

func (u *UtilitiesUpgrade) UpgradeSiteDevices(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.UpgradeSiteDevices) (
	models.ApiResponse[models.ResponseUpgradeSiteDevices],
	error)

UpgradeSiteDevices takes context, siteId, body as parameters and returns an models.ApiResponse with models.ResponseUpgradeSiteDevices data and an error if there was an issue with the request or response. Upgrade Site Device **Note**: this call doesn’t guarantee the devices to be upgraded right away (they may be offline)

func (*UtilitiesUpgrade) UpgradeSsr 

func (u *UtilitiesUpgrade) UpgradeSsr(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.SsrUpgrade) (
	models.ApiResponse[models.SsrUpgradeResponse],
	error)

UpgradeSsr takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.SsrUpgradeResponse data and an error if there was an issue with the request or response. Upgrade Site SSR device

type UtilitiesWAN 

type UtilitiesWAN struct {
	// contains filtered or unexported fields
}

UtilitiesWAN represents a controller struct.

func NewUtilitiesWAN 

func NewUtilitiesWAN(baseController baseController) *UtilitiesWAN

NewUtilitiesWAN creates a new instance of UtilitiesWAN. It takes a baseController as a parameter and returns a pointer to the UtilitiesWAN.

func (*UtilitiesWAN) ClearSiteDeviceSession added in v0.2.38 

func (u *UtilitiesWAN) ClearSiteDeviceSession(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsClearSession) (
	*http.Response,
	error)

ClearSiteDeviceSession takes context, siteId, deviceId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Clear session

func (*UtilitiesWAN) ClearSiteSsrArpCache 

func (u *UtilitiesWAN) ClearSiteSsrArpCache(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsClearArp) (
	models.ApiResponse[models.WebsocketSession],
	error)

ClearSiteSsrArpCache takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Clear ARP cache for SSR, SRX and Switch Clear the entire ARP cache or a subset if arguments are provided. *Note*: port_id is optional if neither vlan nor ip is specified

func (*UtilitiesWAN) ClearSiteSsrBgpRoutes 

func (u *UtilitiesWAN) ClearSiteSsrBgpRoutes(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsClearBgp) (
	models.ApiResponse[models.WebsocketSession],
	error)

ClearSiteSsrBgpRoutes takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Clear routes associated with one or all BGP neighbors

func (*UtilitiesWAN) ReleaseSiteSsrDhcpLease 

func (u *UtilitiesWAN) ReleaseSiteSsrDhcpLease(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsReleaseDhcp) (
	models.ApiResponse[models.WebsocketSession],
	error)

ReleaseSiteSsrDhcpLease takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Releases an active DHCP lease. The output will be available through websocket. As there can be multiple command issued against the same Device at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" }``` #### Example output from ws stream ```json { "channel": "/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd", "event": "data", "data": { "session": "9106e908-74dc-4a4f-9050-9c2adcaf44a5", "raw": "Running traceroute...\ntraceroute to 8.8.8.8, 64 hops max\n 0 192.168.1.1 1 ms 192.168.1.1 1 ms 192.168.1.1 1 ms\n 1 80.10.236.81 2 ms 80.10.236.81 4 ms 80.10.236.81 2 ms\n 2 193.253.80.250 3 ms 193.253.80.250 2 ms 193.253.80.250 2 ms\n 3 193.252.159.41 2 ms 193.252.159.41 1 ms 193.252.159.41 3 ms\n" } } ``` "

func (*UtilitiesWAN) RunSiteSrxTopCommand added in v0.3.17 

func (u *UtilitiesWAN) RunSiteSrxTopCommand(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[models.WebsocketSessionWithUrl],
	error)

RunSiteSrxTopCommand takes context, siteId, deviceId as parameters and returns an models.ApiResponse with models.WebsocketSessionWithUrl data and an error if there was an issue with the request or response. Run top command on switches and SRX. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ```

func (*UtilitiesWAN) ServicePingFromSsr 

func (u *UtilitiesWAN) ServicePingFromSsr(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsServicePing) (
	models.ApiResponse[models.WebsocketSession],
	error)

ServicePingFromSsr takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Ping from SSR Service Ping can be performed from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` ##### Example output from ws stream ```json { "event": "data", "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd", "data": { "session": "session_id", "raw": "64 bytes from 23.211.0.110: seq=8 ttl=58 time=12.323 ms\n" } } ```

func (*UtilitiesWAN) ShowSiteSsrAndSrxRoutes added in v0.3.41 

func (u *UtilitiesWAN) ShowSiteSsrAndSrxRoutes(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowRoute) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteSsrAndSrxRoutes takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get routes from SSR, SRX and Switch. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` ##### Example output from ws stream ``` admin@labsystem1.fiedler# show bgp neighbors BGP neighbor is 192.168.4.1, remote AS 4200000001, local AS 4200000128, external link BGP version 4, remote router ID 1.1.1.1 BGP state = Established, up for 00:27:25 Last read 00:00:25, hold time is 90, keepalive interval is 30 seconds Configured hold time is 90, keepalive interval is 30 seconds Neighbor capabilities: 4 Byte AS: advertised and received Route refresh: advertised and received(old &amp; new) Address family IPv4 Unicast: advertised and received Graceful Restart Capabilty: advertised and received Remote Restart timer is 120 seconds Address families by peer: none ... ```

func (*UtilitiesWAN) ShowSiteSsrAndSrxSessions added in v0.3.41 

func (u *UtilitiesWAN) ShowSiteSsrAndSrxSessions(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowSession) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteSsrAndSrxSessions takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get active sessions passing through the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" }``` #### Example output from ws stream ```json { "channel": "/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd", "event": "data", "data": { "session": "f517bf29-1141-41ae-a084-17cacb0ccb57", "raw": "{\"status\":\"SUCCESS\",\"finished\":true,\"rows\":[{\"session_id\":\"a04b1cc7-dcc1-40a6-a010-0fe46ca38551\",\"direction\":\"forward\",\"service\":\"internet\",\"tenant\":\"SRV.PRD-Core\",\"device_interface\":\"ge-0/0/3\",\"network_interface\":\"ge-0/0/3.100\",\"protocol\":\"TCP\",\"source_ip\":\"10.3.20.101\",\"source_port\":45733,\"destination_ip\":\"13.38.46.35\",\"destination_port\":443,\"nat_ip\":\"192.168.1.115\",\"nat_port\":45256,\"payload_encrypted\":false,\"timeout\":1581,\"uptime\":319},{\"session_id\":\"a04b1cc7-dcc1-40a6-a010-0fe46ca38551\",\"direction\":\"reverse\",\"service\":\"internet\",\"tenant\":\"SRV.PRD-Core\",\"device_interface\":\"ge-0/0/0\",\"network_interface\":\"ge-0/0/0\",\"protocol\":\"TCP\",\"source_ip\":\"13.38.46.35\",\"source_port\":443,\"destination_ip\":\"192.168.1.115\",\"destination_port\":45256,\"nat_ip\":\"0.0.0.0\",\"nat_port\":0,\"payload_encrypted\":false,\"timeout\":1581,\"uptime\":319}]}\n" } } ```

func (*UtilitiesWAN) ShowSiteSsrOspfDatabase added in v0.3.41 

func (u *UtilitiesWAN) ShowSiteSsrOspfDatabase(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowOspfDatabase) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteSsrOspfDatabase takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get OSPF Database from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` #### Example output from ws stream ``` ===== ==================== ========== ======= ======== ================ =================== ================= Vrf Neighbor Router ID Priority State Uptime Dead Timer Due Interface Address Interface State ===== ==================== ========== ======= ======== ================ =================== ================= 1.0.0.3 1 Full 852 38 172.16.3.2 Backup 1.0.0.4 1 Full 811 33 172.16.3.2 DROther 1.0.0.3 1 Full 852 38 172.16.4.2 Backup 1.0.0.4 1 Full 811 34 172.16.4.2 DROther ```

func (*UtilitiesWAN) ShowSiteSsrOspfInterfaces added in v0.3.41 

func (u *UtilitiesWAN) ShowSiteSsrOspfInterfaces(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowOspfInterfaces) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteSsrOspfInterfaces takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get OSPF interfaces from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` #### Example output from ws stream ``` ===== ================== =================== ============== =============== =========== ========= =========== Vrf Device Interface Network Interface Interface Up IP Address OSPF Type Area ID Area Type ===== ================== =================== ============== =============== =========== ========= =========== net1 g1 True 172.16.1.2/24 Broadcast 0.0.0.0 default net3 g3 True 172.16.3.2/24 Broadcast 0.0.0.0 default net4 g4 True 172.16.4.2/24 Broadcast 0.0.0.4 default ```

func (*UtilitiesWAN) ShowSiteSsrOspfNeighbors added in v0.3.41 

func (u *UtilitiesWAN) ShowSiteSsrOspfNeighbors(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowOspfNeighbors) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteSsrOspfNeighbors takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get OSPF Neighbors from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` #### Example output from ws stream ``` ===== ==================== ========== ======= ======== ================ =================== ================= Vrf Neighbor Router ID Priority State Uptime Dead Timer Due Interface Address Interface State ===== ==================== ========== ======= ======== ================ =================== ================= 1.0.0.3 1 Full 852 38 172.16.3.2 Backup 1.0.0.4 1 Full 811 33 172.16.3.2 DROther 1.0.0.3 1 Full 852 38 172.16.4.2 Backup 1.0.0.4 1 Full 811 34 172.16.4.2 DROther ```

func (*UtilitiesWAN) ShowSiteSsrOspfSummary added in v0.3.41 

func (u *UtilitiesWAN) ShowSiteSsrOspfSummary(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowOspfSummary) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteSsrOspfSummary takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get OSPF summary from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` #### Example output from ws stream ``` ===== =========== ========== ============= ==================== ========= =========== ============= Vrf Router ID ABR Type ASBR Router External LSA Count Area ID Area Type Area Border Router ===== =========== ========== ============= ==================== ========= =========== ============= 1.0.0.2 cisco False 0 0.0.0.0 1.0.0.2 cisco False 0 0.0.0.4 default ```

func (*UtilitiesWAN) ShowSiteSsrServicePath added in v0.3.41 

func (u *UtilitiesWAN) ShowSiteSsrServicePath(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID,
	body *models.UtilsShowServicePath) (
	models.ApiResponse[models.WebsocketSession],
	error)

ShowSiteSsrServicePath takes context, siteId, deviceId, body as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. Get service path information of the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` #### Example output from ws stream ```json { "channel": "/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd", "event": "data", "data": { "session":"5cb8a6db-d11a-42cd-bed7-19e9f29e637", "raw":"{\"status\":\"SUCCESS\",\"finished\":true,\"rows\":[{\"service\":\"management\",\"type\":\"service-agent\",\"network_interface\":\"ge-0/0/0\",\"destination\":\"\",\"gateway_ip\":\"192.168.1.1\",\"vector\":\"\",\"cost\":0,\"rate\":0,\"state\":\"Up\",\"capacity\":\"0/unlimited\",\"meetsSLA\":\"Yes\"},{\"service\":\"management\",\"type\":\"service-agent\",\"network_interface\":\"ge-0/0/1\",\"destination\":\"\",\"gateway_ip\":\"192.168.0.1\",\"vector\":\"\",\"cost\":0,\"rate\":0,\"state\":\"Up\",\"capacity\":\"0/unlimited\",\"meetsSLA\":\"Yes\"}]}" } } ```

func (*UtilitiesWAN) TestSiteSsrDnsResolution 

func (u *UtilitiesWAN) TestSiteSsrDnsResolution(
	ctx context.Context,
	siteId uuid.UUID,
	deviceId uuid.UUID) (
	models.ApiResponse[models.WebsocketSession],
	error)

TestSiteSsrDnsResolution takes context, siteId, deviceId as parameters and returns an models.ApiResponse with models.WebsocketSession data and an error if there was an issue with the request or response. DNS resolutions are performed on the Device. The output will be available through websocket. As there can be multiple command issued against the same SSR at the same time and the output all goes through the same websocket stream, `session` is used for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` ##### Example output from ws stream ``` Router | Hostname | Resolved | Last Resolved | Expiration -------------|------------------------|----------|----------------------|--------------------- test-device | xxx.yyy.net | Y | 2022-03-28T03:56:49Z | 2022-03-28T03:57:49Z ```

type UtilitiesWiFi 

type UtilitiesWiFi struct {
	// contains filtered or unexported fields
}

UtilitiesWiFi represents a controller struct.

func NewUtilitiesWiFi 

func NewUtilitiesWiFi(baseController baseController) *UtilitiesWiFi

NewUtilitiesWiFi creates a new instance of UtilitiesWiFi. It takes a baseController as a parameter and returns a pointer to the UtilitiesWiFi.

func (*UtilitiesWiFi) DeauthSiteWirelessClientsConnectedToARogue 

func (u *UtilitiesWiFi) DeauthSiteWirelessClientsConnectedToARogue(
	ctx context.Context,
	siteId uuid.UUID,
	rogueBssid string) (
	*http.Response,
	error)

DeauthSiteWirelessClientsConnectedToARogue takes context, siteId, rogueBssid as parameters and returns an *Response and an error if there was an issue with the request or response. Send Deauth frame to clients connected to a Rogue AP

func (*UtilitiesWiFi) DisconnectSiteMultipleClients 

func (u *UtilitiesWiFi) DisconnectSiteMultipleClients(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.MacAddresses) (
	*http.Response,
	error)

DisconnectSiteMultipleClients takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. To unauthorize multiple clients

func (*UtilitiesWiFi) DisconnectSiteWirelessClient 

func (u *UtilitiesWiFi) DisconnectSiteWirelessClient(
	ctx context.Context,
	siteId uuid.UUID,
	clientMac string) (
	*http.Response,
	error)

DisconnectSiteWirelessClient takes context, siteId, clientMac as parameters and returns an *Response and an error if there was an issue with the request or response. This disconnect a client (and it’s likely to connect back)

func (*UtilitiesWiFi) OptimizeSiteRrm 

func (u *UtilitiesWiFi) OptimizeSiteRrm(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.UtilsRrmOptimize) (
	*http.Response,
	error)

OptimizeSiteRrm takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Optimize Site RRM

func (*UtilitiesWiFi) ReauthOrgDot1xWirelessClient 

func (u *UtilitiesWiFi) ReauthOrgDot1xWirelessClient(
	ctx context.Context,
	orgId uuid.UUID,
	clientMac string) (
	*http.Response,
	error)

ReauthOrgDot1xWirelessClient takes context, orgId, clientMac as parameters and returns an *Response and an error if there was an issue with the request or response. Trigger a CoA (change of authorization) against a client

func (*UtilitiesWiFi) ReauthSiteDot1xWirelessClient 

func (u *UtilitiesWiFi) ReauthSiteDot1xWirelessClient(
	ctx context.Context,
	siteId uuid.UUID,
	clientMac string) (
	*http.Response,
	error)

ReauthSiteDot1xWirelessClient takes context, siteId, clientMac as parameters and returns an *Response and an error if there was an issue with the request or response. Trigger a CoA (change of authorization) against a Wireless client

func (*UtilitiesWiFi) ReprovisionSiteAllAps 

func (u *UtilitiesWiFi) ReprovisionSiteAllAps(
	ctx context.Context,
	siteId uuid.UUID) (
	*http.Response,
	error)

ReprovisionSiteAllAps takes context, siteId as parameters and returns an *Response and an error if there was an issue with the request or response. To force all APs to reprovision itself again.

func (*UtilitiesWiFi) ResetSiteAllApsToUseRrm 

func (u *UtilitiesWiFi) ResetSiteAllApsToUseRrm(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.UtilsResetRadioConfig) (
	*http.Response,
	error)

ResetSiteAllApsToUseRrm takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Reset all APs in the Site to use RRM

func (*UtilitiesWiFi) TestSiteWlanTelstraSetup 

func (u *UtilitiesWiFi) TestSiteWlanTelstraSetup(
	ctx context.Context,
	body *models.TestTelstra) (
	*http.Response,
	error)

TestSiteWlanTelstraSetup takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Allows validation of Telstra sms gateway credentials. In case of success, a text message confirming successful setup should be received. In case of error, telstra error message are returned.

func (*UtilitiesWiFi) TestSiteWlanTwilioSetup 

func (u *UtilitiesWiFi) TestSiteWlanTwilioSetup(
	ctx context.Context,
	body *models.TestTwilio) (
	*http.Response,
	error)

TestSiteWlanTwilioSetup takes context, body as parameters and returns an *Response and an error if there was an issue with the request or response. Allows validation of twilio setup In case of success, a text message confirming successful setup should be received. In case of error, twilio error code and message are returned.

func (*UtilitiesWiFi) UnauthorizeSiteMultipleClients 

func (u *UtilitiesWiFi) UnauthorizeSiteMultipleClients(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.MacAddresses) (
	*http.Response,
	error)

UnauthorizeSiteMultipleClients takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. This unauthorize clients (if they are guest) and disconnect them. From the guest’s perspective, they will see the splash page again and go through the flow (e.g. Terms of Use) again.

func (*UtilitiesWiFi) UnauthorizeSiteWirelessClient 

func (u *UtilitiesWiFi) UnauthorizeSiteWirelessClient(
	ctx context.Context,
	siteId uuid.UUID,
	clientMac string) (
	*http.Response,
	error)

UnauthorizeSiteWirelessClient takes context, siteId, clientMac as parameters and returns an *Response and an error if there was an issue with the request or response. This unauthorize a client (if it’s a guest) and disconnect it. From the guest’s perspective, s/he will see the splash page again and go through the flow (e.g. Terms of Use) again.

func (*UtilitiesWiFi) ZeroizeSiteFipsAllAps 

func (u *UtilitiesWiFi) ZeroizeSiteFipsAllAps(
	ctx context.Context,
	siteId uuid.UUID,
	body *models.UtilsZeroiseFips) (
	*http.Response,
	error)

ZeroizeSiteFipsAllAps takes context, siteId, body as parameters and returns an *Response and an error if there was an issue with the request or response. Zeroize all FIPS APs in the Site

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.