apicem

package
v0.0.0-...-1bd88b4 Latest Latest
Warning

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

Go to latest
Published: Oct 18, 2016 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool

func Bool(v bool) *bool

Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.

func CheckResponse

func CheckResponse(r *http.Response) error

CheckResponse checks the API response for errors, and returns them if present. A response is considered an error if it has a status code outside the 200 range. API error responses are expected to have either no response body, or a JSON response body that maps to ErrorResponse. Any other response body will be silently ignored.

func Int

func Int(v int) *int

Int is a helper routine that allocates a new int32 value to store v and returns a pointer to it, but unlike Int32 its argument value is an int.

func StreamToString

func StreamToString(stream io.Reader) string

StreamToString converts a reader to a string

func String

func String(v string) *string

String is a helper routine that allocates a new string value to store v and returns a pointer to it.

Types

type AAAService

type AAAService service

AAAService is an interface with the AAA API

func (*AAAService) AddAAAAttribute

func (s *AAAService) AddAAAAttribute(aaaAttribute AaaAttribute) (*SuccessResult, *Response, error)

AddAAAAttribute is ... This method is used to add a custom AAA Attribute.

  • @param aaaAttribute aaaAttribute

* @return *SuccessResult

func (*AAAService) AddAAAServer

func (s *AAAService) AddAAAServer(aaaServerList *[]AaaServer) (*ServerIDListResult, *Response, error)

AddAAAServer is ... This method is used to add a list of AAA servers.

  • @param aaaServerList aaaServerList

* @return *ServerIDListResult

func (*AAAService) DeleteAAAAttribute

func (s *AAAService) DeleteAAAAttribute() (*SuccessResult, *Response, error)

DeleteAAAAttribute is ... This method is used to delete a custom AAA Attribute.

* @return *SuccessResult

func (*AAAService) DeleteServer

func (s *AAAService) DeleteServer(serverID string) (*SuccessResult, *Response, error)

DeleteServer is ... This method is used to delete a registered AAA server.

* @return *SuccessResult

func (*AAAService) GetAAAAttribute

func (s *AAAService) GetAAAAttribute() (*AaaAttributeResult, *Response, error)

GetAAAAttribute is ... This method is used to get all custom AAA Attributes.

* @return *AaaAttributeResult

func (*AAAService) GetServer

func (s *AAAService) GetServer(serverID string) (*AaaServerResult, *Response, error)

GetServer is ... This method is used to get a registered AAA server.

* @return *AaaServerResult

func (*AAAService) GetServers

func (s *AAAService) GetServers() (*AaaServerListResult, *Response, error)

GetServers is ... This method is used to get a list of registered AAA servers.

* @return *AaaServerListResult

func (*AAAService) UpdateServers

func (s *AAAService) UpdateServers(aaaServerList *[]AaaServer) (*SuccessResult, *Response, error)

UpdateServers is ... This method is used to update an individual or a list of AAA servers.

  • @param aaaServerList aaaServerList

* @return *SuccessResult

type AaaAttribute

type AaaAttribute struct {
	AttributeName string `json:"attributeName,omitempty"` // Attributename
}

AaaAttribute is ...

type AaaAttributeResult

type AaaAttributeResult struct {
	Version  string       `json:"version,omitempty"`
	Response AaaAttribute `json:"response,omitempty"`
}

AaaAttributeResult is ...

type AaaServer

type AaaServer struct {
	Protocol           string `json:"protocol,omitempty"`           // Protocol
	AuthenticationPort int32  `json:"authenticationPort,omitempty"` // Authentication Port
	AccountingPort     int32  `json:"accountingPort,omitempty"`     // Accounting Port
	Retries            int32  `json:"retries,omitempty"`            // Retries
	SocketTimeout      int32  `json:"socketTimeout,omitempty"`      // Timeout
	ServerID           string `json:"serverId,omitempty"`           // Server Id
	ServerIP           string `json:"serverIp,omitempty"`           // Server IP Address
	SharedSecret       string `json:"sharedSecret,omitempty"`       // Shared Secret
}

AaaServer is ...

type AaaServerListResult

type AaaServerListResult struct {
	Version  string      `json:"version,omitempty"`
	Response []AaaServer `json:"response,omitempty"`
}

AaaServerListResult is ...

type AaaServerResult

type AaaServerResult struct {
	Version  string    `json:"version,omitempty"`
	Response AaaServer `json:"response,omitempty"`
}

AaaServerResult is ...

type AccessClauseDto

type AccessClauseDto struct {
	Access string `json:"access,omitempty"` // access
}

AccessClauseDto is ...

type Accuracy

type Accuracy struct {
	Percent int32  `json:"percent,omitempty"`
	Reason  string `json:"reason,omitempty"`
}

Accuracy is ...

type AclAce

type AclAce struct {
	Result        string             `json:"result,omitempty"`
	Ace           string             `json:"ace,omitempty"`
	MatchingPorts []AclMatchingPorts `json:"matchingPorts,omitempty"`
}

AclAce is ...

type AclAnalysisResponse

type AclAnalysisResponse struct {
	Result       string   `json:"result,omitempty"`
	AclName      string   `json:"aclName,omitempty"`
	MatchingAces []AclAce `json:"matchingAces,omitempty"`
}

AclAnalysisResponse is ...

type AclMatchingPorts

type AclMatchingPorts struct {
	Protocol string        `json:"protocol,omitempty"`
	Ports    []AclPortInfo `json:"ports,omitempty"`
}

AclMatchingPorts is ...

type AclPortInfo

type AclPortInfo struct {
	SourcePorts []string `json:"sourcePorts,omitempty"`
	DestPorts   []string `json:"destPorts,omitempty"`
}

AclPortInfo is ...

type ActionProperty

type ActionProperty struct {
	Destinations       []string `json:"destinations,omitempty"`
	RelevanceLevel     string   `json:"relevanceLevel,omitempty"`     // relevance level for a policy
	PriorityLevel      string   `json:"priorityLevel,omitempty"`      // priority level for a policy
	ExperienceLevel    string   `json:"experienceLevel,omitempty"`    // experience level for a policy
	PathPreference     string   `json:"pathPreference,omitempty"`     // path preference for a policy
	PathControlFlag    bool     `json:"pathControlFlag,omitempty"`    // path control flag
	PathPreferenceFlag bool     `json:"pathPreferenceFlag,omitempty"` // path preference flag
	PathOfLastResort   string   `json:"PathOfLastResort,omitempty"`
	MaintainExperience string   `json:"maintainExperience,omitempty"`
	PrimaryPathPref    []string `json:"PrimaryPathPref,omitempty"`
	SecondaryPathPref  []string `json:"SecondaryPathPref,omitempty"`
	TertiaryPathPref   []string `json:"TertiaryPathPref,omitempty"`
	TrustLevel         string   `json:"trustLevel,omitempty"` // trust level for a policy
}

ActionProperty is ...

type AddApplicationQueryParams

type AddApplicationQueryParams struct {
	ScheduleAt     string `url:"scheduleAt,omitempty"`     // scheduleAt
	ScheduleDesc   string `url:"scheduleDesc,omitempty"`   // scheduleDesc
	ScheduleOrigin string `url:"scheduleOrigin,omitempty"` // scheduleOrigin
}

AddApplicationQueryParams is ...

type AddKeystoreFileQueryParams

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

AddKeystoreFileQueryParams is ...

type AddQueryParams

type AddQueryParams struct {
	ScheduleAt     string `url:"scheduleAt,omitempty"`     // Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the policy should be scheduled (Optional)
	ScheduleDesc   string `url:"scheduleDesc,omitempty"`   // Custom Description (Optional)
	ScheduleOrigin string `url:"scheduleOrigin,omitempty"` // Originator of this call (Optional)
}

AddQueryParams is ...

type AlarmDto

type AlarmDto struct {
	CausedAlarmsURL               string                 `json:"causedAlarmsUrl,omitempty"`
	CausingAlarmURL               string                 `json:"causingAlarmUrl,omitempty"`
	AlarmCreationTime             string                 `json:"alarmCreationTime,omitempty"`
	ApplicationSpecificAlarmID    string                 `json:"applicationSpecificAlarmID,omitempty"`
	EventCount                    int32                  `json:"eventCount,omitempty"`
	IsAcknowledged                bool                   `json:"isAcknowledged,omitempty"`
	LastModifiedTimestamp         string                 `json:"lastModifiedTimestamp,omitempty"`
	MayBeAutoCleared              bool                   `json:"mayBeAutoCleared,omitempty"`
	OwnerID                       string                 `json:"ownerID,omitempty"`
	PreviousSeverity              string                 `json:"previousSeverity,omitempty"`
	SubclassName                  string                 `json:"subclassName,omitempty"`
	CausedAlarms                  []IDRef                `json:"causedAlarms,omitempty"`
	CausingAlarm                  IDRef                  `json:"causingAlarm,omitempty"`
	Description                   string                 `json:"description,omitempty"`
	Severity                      string                 `json:"severity,omitempty"`
	Source                        string                 `json:"source,omitempty"`
	Category                      EventAlarmCategoryEnum `json:"category,omitempty"`
	EventType                     EventTypeEnum          `json:"eventType,omitempty"`
	AlarmDisplayable              bool                   `json:"alarmDisplayable,omitempty"`
	ApplicationCategoryData       string                 `json:"applicationCategoryData,omitempty"`
	DeviceTimestamp               string                 `json:"deviceTimestamp,omitempty"`
	IsDeviceMaster                bool                   `json:"isDeviceMaster,omitempty"`
	NotificationDeliveryMechanism string                 `json:"notificationDeliveryMechanism,omitempty"`
	NotificationState             int32                  `json:"notificationState,omitempty"`
	PendingUntil                  string                 `json:"pendingUntil,omitempty"`
	ReportingEntityAddress        InetAddress            `json:"reportingEntityAddress,omitempty"`
	SourceMacAddress              MacAddress             `json:"sourceMacAddress,omitempty"`
	SrcObjectClassID              int32                  `json:"srcObjectClassId,omitempty"`
	SrcObjectID                   int64                  `json:"srcObjectId,omitempty"`
	Stability                     string                 `json:"stability,omitempty"`
	TransientNameValue            string                 `json:"transientNameValue,omitempty"`
	EventAlarmDetails             []IDRef                `json:"eventAlarmDetails,omitempty"`
	EventAlarmDetailsURL          string                 `json:"eventAlarmDetailsUrl,omitempty"`
	InstanceUUID                  string                 `json:"instanceUuid,omitempty"`
	ID                            string                 `json:"id,omitempty"`
}

AlarmDto is ...

type AlarmService

type AlarmService service

AlarmService is an interface with the Alarm API

func (*AlarmService) AcknowledgeAlarm

func (s *AlarmService) AcknowledgeAlarm(alertUUID string, alarmDTO AlarmDto) (*SuccessResult, *Response, error)

AcknowledgeAlarm is ... This method is used to acknowledge an Alarm by UUID

  • @param alarmDTO alarmDTO

* @return *SuccessResult

func (*AlarmService) GetAlarmWithFilter

func (s *AlarmService) GetAlarmWithFilter() (*ListAlarmDtoResponse, *Response, error)

GetAlarmWithFilter is ... getAlarmWithFilter

* @return *ListAlarmDtoResponse

func (*AlarmService) GetAuditCountWithFilter

func (s *AlarmService) GetAuditCountWithFilter() (*int32, *Response, error)

GetAuditCountWithFilter is ... getAuditCountWithFilter

* @return *int32

type Annotation

type Annotation struct {
}

Annotation is ...

type ApplicationDTO

type ApplicationDTO struct {
	TrafficClass                    string `json:"trafficClass,omitempty"`                    // Traffic class to which the app belongs
	Rank                            int32  `json:"rank,omitempty"`                            // rank
	Status                          string `json:"status,omitempty"`                          // Gives status of the app
	Category                        string `json:"category,omitempty"`                        // Category name
	AppProtocol                     string `json:"appProtocol,omitempty"`                     // protocol of the app. Valid values are tcp, udp, tcp/udp, ip or it could be empty. Values are case sensitive.
	TCPPorts                        string `json:"tcpPorts,omitempty"`                        // list of tcp ports
	IndicativeTCPPorts              string `json:"indicativeTcpPorts,omitempty"`              // Indicative tcp ports
	UDPPorts                        string `json:"udpPorts,omitempty"`                        // list of udp ports
	IndicativeUDPPorts              string `json:"indicativeUdpPorts,omitempty"`              // Indicative udp ports
	IPPorts                         string `json:"ipPorts,omitempty"`                         // list of ip ports
	URL                             string `json:"url,omitempty"`                             // url of the app
	LongDescription                 string `json:"longDescription,omitempty"`                 // Long description of the app
	SubCategory                     string `json:"subCategory,omitempty"`                     // Sub-Category Id
	GlobalID                        string `json:"globalId,omitempty"`                        // global id
	EngineID                        string `json:"engineId,omitempty"`                        // engine id
	SelectorID                      string `json:"selectorId,omitempty"`                      // selector id
	HelpString                      string `json:"helpString,omitempty"`                      // help string to describe the app
	References                      string `json:"references,omitempty"`                      // references of the app
	ApplicationGroup                string `json:"applicationGroup,omitempty"`                // App group name
	Encrypted                       string `json:"encrypted,omitempty"`                       // If the app is encrypted
	Tunnel                          string `json:"tunnel,omitempty"`                          // If the app is a tunnel
	InstanceUUID                    string `json:"instanceUuid,omitempty"`                    //
	CategoryID                      string `json:"categoryId,omitempty"`                      // Category id
	Dscp                            string `json:"dscp,omitempty"`                            // dscp value
	PfrThresholdJitter              int32  `json:"pfrThresholdJitter,omitempty"`              // PfR Threshold Jitter
	PfrThresholdLossRate            int32  `json:"pfrThresholdLossRate,omitempty"`            // PfR Threshold Loss Rate
	PfrThresholdOneWayDelay         int32  `json:"pfrThresholdOneWayDelay,omitempty"`         // PfR Threshold One Way Delay
	Popularity                      int32  `json:"popularity,omitempty"`                      // popularity of the app
	TransportIps                    string `json:"transportIps,omitempty"`                    // Transport IP of the app
	Enabled                         string `json:"enabled,omitempty"`                         // If the app enabled
	IndicativeIPPorts               string `json:"indicativeIpPorts,omitempty"`               // Indicative ip ports
	IsRepresentativeApp             bool   `json:"isRepresentativeApp,omitempty"`             // If the app is representative
	NbarID                          string `json:"nbarId,omitempty"`                          // nbar id
	P2pTechnology                   string `json:"p2pTechnology,omitempty"`                   // If the app is a p2p technology
	PfrThresholdJitterPriority      int32  `json:"pfrThresholdJitterPriority,omitempty"`      // PfR Threshold Jitter Priority
	PfrThresholdLossRatePriority    int32  `json:"pfrThresholdLossRatePriority,omitempty"`    // PfR Threshold Loss Rate Priority
	PfrThresholdOneWayDelayPriority int32  `json:"pfrThresholdOneWayDelayPriority,omitempty"` // PfR Threshold One Way Delay Priority
	IgnoreConflict                  bool   `json:"ignoreConflict,omitempty"`                  // If true ignore conflicts with other Applications
	Name                            string `json:"name,omitempty"`                            // App Name
	ID                              string `json:"id,omitempty"`                              // id
}

ApplicationDTO is ...

type ApplicationListResult

type ApplicationListResult struct {
	Response []ApplicationDTO `json:"response,omitempty"`
	Version  string           `json:"version,omitempty"`
}

ApplicationListResult is ...

type ApplicationResult

type ApplicationResult struct {
	Response ApplicationDTO `json:"response,omitempty"`
	Version  string         `json:"version,omitempty"`
}

ApplicationResult is ...

type ApplicationService

type ApplicationService service

ApplicationService is an interface with the Application API

func (*ApplicationService) AddApplication

func (s *ApplicationService) AddApplication(queryParams *AddApplicationQueryParams, applicationDTOList []ApplicationDTO) (*TaskIDResult, *Response, error)

AddApplication is ... Create an application

  • @param queryParams

  • @param applicationDTOList applicationDTOList

* @return *TaskIDResult

func (*ApplicationService) DeleteApplication

func (s *ApplicationService) DeleteApplication(id string, queryParams *DeleteApplicationQueryParams) (*TaskIDResult, *Response, error)

DeleteApplication is ... Delete an application by id

  • @param queryParams

* @return *TaskIDResult

func (*ApplicationService) GetApplication

func (s *ApplicationService) GetApplication(id string) (*ApplicationResult, *Response, error)

GetApplication is ... Get an application by id

* @return *ApplicationResult

func (*ApplicationService) GetApplicationCount

func (s *ApplicationService) GetApplicationCount() (*CountResult, *Response, error)

GetApplicationCount is ... Get total count of application(s)

* @return *CountResult

func (*ApplicationService) GetFilterApplication

func (s *ApplicationService) GetFilterApplication(queryParams *GetFilterApplicationQueryParams) (*ApplicationListResult, *Response, error)

GetFilterApplication is ... Get application(s) based on a filter provided

  • @param queryParams

* @return *ApplicationListResult

func (*ApplicationService) UpdateApplication

func (s *ApplicationService) UpdateApplication(queryParams *UpdateApplicationQueryParams, applicationDTOList []ApplicationDTO) (*TaskIDResult, *Response, error)

UpdateApplication is ... Update an application

  • @param queryParams

  • @param applicationDTOList applicationDTOList

* @return *TaskIDResult

type AuditService

type AuditService service

AuditService is an interface with the Audit API

func (*AuditService) DownloadAuditLogs

func (s *AuditService) DownloadAuditLogs() (*TaskIDResult, *Response, error)

DownloadAuditLogs is ...

* @return *TaskIDResult

func (*AuditService) GetAuditCountWithFilter

func (s *AuditService) GetAuditCountWithFilter() (*ListAuditResourceDtoResponse, *Response, error)

GetAuditCountWithFilter is ... Same parameters as search should be passed.. <br/>For example: '/audit/count?auditRecordStartTime=10&auditRecordEndTime=1529152597971&auditRequestor=123a1&auditRequestor=some_other_value'. <br/>Request parameter is case sensitive, so '/audit/count?device<b>IP</b>=10.1.1.0' will search for deviceIP equals to 10.1.1.0. '/audit?device<b>ip</b>=10.1.1.0' will be ignored. <br/>Wildcards are supported using %25 as a wildcard, for example: '/audit/count?auditDescription=%25success%25' will retrieve all records matching success, successful, successive, etc.<br/>Request values are not case sensitive, so '/audit/count?auditRequestor=ADMIN' will retrieve all records with auditRequestor of 'admin', 'Admin', 'ADMIN', etc.

* @return *ListAuditResourceDtoResponse

func (*AuditService) GetAuditWithFilter

func (s *AuditService) GetAuditWithFilter() (*ListAuditResourceDtoResponse, *Response, error)

GetAuditWithFilter is ... Free search on any atomic attributes passed as request parameter. <br/>For example: '/audit?auditRecordStartTime=10&auditRecordEndTime=1529152597971&auditRequestor=123a1&auditRequestor=some_other_value'. <br/>Request parameter is case sensitive, so '/audit?device<b>IP</b>=10.1.1.0' will search for deviceIP equals to 10.1.1.0. '/audit?device<b>ip</b>=10.1.1.0' will be ignored. <br/>Operation supports offset, limit: '/audit?limit=100&offset=40' will retrieve 100 records starts from position 40 <br/>Wildcards are supported using %25 as a wildcard, for example: '/audit?auditDescription=%25success%25' will retrieve all records matching success, successful, successive, etc.<br/>Request values are not case sensitive, so '/audit?auditRequestor=ADMIN' will retrieve all records with auditRequestor of 'admin', 'Admin', 'ADMIN', etc.

* @return *ListAuditResourceDtoResponse

type AugmentedAuditResourceDto

type AugmentedAuditResourceDto struct {
	InstanceUUID     string    `json:"instanceUuid,omitempty"` // This field is deprecated. Use 'id' instead.
	Severity         string    `json:"severity,omitempty"`
	Tag              string    `json:"tag,omitempty"`
	ApplicationName  string    `json:"applicationName,omitempty"`
	HasParent        bool      `json:"hasParent,omitempty"`
	CreatedDateTime  time.Time `json:"createdDateTime,omitempty"`
	AuditID          string    `json:"auditId,omitempty"`
	AuditParentID    string    `json:"auditParentId,omitempty"`
	AuditRequestor   string    `json:"auditRequestor,omitempty"`
	AuditDescription string    `json:"auditDescription,omitempty"`
	DerivedParentID  string    `json:"derivedParentId,omitempty"`
	DeviceIP         string    `json:"deviceIP,omitempty"`
	DeviceName       string    `json:"deviceName,omitempty"`
	SiteName         string    `json:"siteName,omitempty"`
	HasChildren      bool      `json:"hasChildren,omitempty"`
	AuditParameters  string    `json:"auditParameters,omitempty"`
	PersistDateTime  time.Time `json:"persistDateTime,omitempty"`
}

AugmentedAuditResourceDto is ... See: http://apic-em/wiki/Audit_Design

type AugmentedTaskDto

type AugmentedTaskDto struct {
	ID              string           `json:"id,omitempty"`          // id
	StartTime       time.Time        `json:"startTime,omitempty"`   // startTime
	EndTime         time.Time        `json:"endTime,omitempty"`     // endTime
	Progress        string           `json:"progress,omitempty"`    // progress
	Data            string           `json:"data,omitempty"`        // data
	ErrorCode       string           `json:"errorCode,omitempty"`   // errorCode
	Version         int64            `json:"version,omitempty"`     // version
	ServiceType     string           `json:"serviceType,omitempty"` // serviceType
	OperationIDList Collectionstring `json:"operationIdList,omitempty"`
	ParentID        string           `json:"parentId,omitempty"`      // parentID
	RootID          string           `json:"rootId,omitempty"`        // rootId
	LastUpdate      time.Time        `json:"lastUpdate,omitempty"`    // lastUpdate
	Username        string           `json:"username,omitempty"`      // username
	IsError         bool             `json:"isError,omitempty"`       // isError
	FailureReason   string           `json:"failureReason,omitempty"` // failureReason
}

AugmentedTaskDto is ... Represents a task

type AutoPassphrase

type AutoPassphrase struct {
	AutoPassphrase string `json:"autoPassphrase,omitempty"` // Auto generated passphrase
}

AutoPassphrase is ... Object used to retrieve the optional auto generated passphrase.

type AutoPassphraseResult

type AutoPassphraseResult struct {
	Version  string         `json:"version,omitempty"`
	Response AutoPassphrase `json:"response,omitempty"`
}

AutoPassphraseResult is ...

type CPUStatistics

type CPUStatistics struct {
	RefreshedAt               int64   `json:"refreshedAt,omitempty"`
	FiveMinUsageInPercentage  float32 `json:"fiveMinUsageInPercentage,omitempty"`
	FiveSecsUsageInPercentage float32 `json:"fiveSecsUsageInPercentage,omitempty"`
	OneMinUsageInPercentage   float32 `json:"oneMinUsageInPercentage,omitempty"`
}

CPUStatistics is ...

type CategoryDto

type CategoryDto struct {
	ID   string `json:"id,omitempty"`   // id
	Name string `json:"name,omitempty"` // Category Name
}

CategoryDto is ...

type CategoryListResult

type CategoryListResult struct {
	Response []CategoryDto `json:"response,omitempty"`
	Version  string        `json:"version,omitempty"`
}

CategoryListResult is ...

type CategoryResult

type CategoryResult struct {
	Response CategoryDto `json:"response,omitempty"`
	Version  string      `json:"version,omitempty"`
}

CategoryResult is ...

type CategoryService

type CategoryService service

CategoryService is an interface with the Category API

func (*CategoryService) GetAllCategories

func (s *CategoryService) GetAllCategories() (*CategoryListResult, *Response, error)

GetAllCategories is ... Get all categories

* @return *CategoryListResult

func (*CategoryService) GetCategoryByID

func (s *CategoryService) GetCategoryByID(id string) (*CategoryResult, *Response, error)

GetCategoryByID is ... Get category by id

* @return *CategoryResult

func (*CategoryService) GetCategoryCount

func (s *CategoryService) GetCategoryCount() (*CountResult, *Response, error)

GetCategoryCount is ... Get total count for categories

* @return *CountResult

type CertPath

type CertPath struct {
	Encodings    Iteratorstring `json:"encodings,omitempty"`
	Certificates []Certificate  `json:"certificates,omitempty"`
	Type         string         `json:"type,omitempty"`
	Encoded      []byte         `json:"encoded,omitempty"`
}

CertPath is ...

type Certificate

type Certificate struct {
	Type      string    `json:"type,omitempty"`
	Encoded   []byte    `json:"encoded,omitempty"`
	PublicKey PublicKey `json:"publicKey,omitempty"`
}

Certificate is ...

type CertificateBrief

type CertificateBrief struct {
	CommonName    string `json:"commonName,omitempty"`   // Certificate common name
	Issuer        string `json:"issuer,omitempty"`       // Certificate issuer
	SerialNumber  string `json:"serialNumber,omitempty"` // Certificate serial-number
	Expiry        string `json:"expiry,omitempty"`       // Certificate expiry
	GvSerialID    string `json:"gvSerialId,omitempty"`   // Grapevine certificate serial identification
	SelfSigned    string `json:"selfSigned,omitempty"`   // Set if this is a self-signed certificate
	ProxyEnabled  string `json:"proxyEnabled,omitempty"` // Set if this is a proxy certificate
	AttributeInfo string `json:"attributeInfo,omitempty"`
	ID            string `json:"id,omitempty"`
}

CertificateBrief is ...

type CertificateBriefListResult

type CertificateBriefListResult struct {
	Response []CertificateBrief `json:"response,omitempty"`
	Version  string             `json:"version,omitempty"`
}

CertificateBriefListResult is ...

type CertificateBriefResult

type CertificateBriefResult struct {
	Response CertificateBrief `json:"response,omitempty"`
	Version  string           `json:"version,omitempty"`
}

CertificateBriefResult is ...

type CertificateManagementService

type CertificateManagementService service

CertificateManagementService is an interface with the API

func (*CertificateManagementService) GetCertificateBrief

func (s *CertificateManagementService) GetCertificateBrief(certificateID string) (*CertificateBriefResult, *Response, error)

GetCertificateBrief is ... This method is used to return a specific certificte by its ID

* @return *CertificateBriefResult

func (*CertificateManagementService) GetCertificateBriefList

func (s *CertificateManagementService) GetCertificateBriefList() (*CertificateBriefListResult, *Response, error)

GetCertificateBriefList is ... This method is used to return list of certificates

* @return *CertificateBriefListResult

func (*CertificateManagementService) GetCertificateBriefListByRange

func (s *CertificateManagementService) GetCertificateBriefListByRange(startIndex int32, recordsToReturn int32) (*CertificateBriefListResult, *Response, error)

GetCertificateBriefListByRange is ... This method is used to return list of certificates by range

* @return *CertificateBriefListResult

func (*CertificateManagementService) GetCertificateCount

func (s *CertificateManagementService) GetCertificateCount() (*CountResult, *Response, error)

GetCertificateCount is ... This method is used to return count of certificates

* @return *CountResult

func (*CertificateManagementService) GetProxyCertificate

func (s *CertificateManagementService) GetProxyCertificate() (*CertificateBriefResult, *Response, error)

GetProxyCertificate is ... This method is used to return the proxy certificate

* @return *CertificateBriefResult

func (*CertificateManagementService) ImportCertificate

func (s *CertificateManagementService) ImportCertificate(queryParams *ImportCertificateQueryParams) (*TaskIDResult, *Response, error)

ImportCertificate is ... This method is used to upload a certificate

  • @param queryParams

* @return *TaskIDResult

func (*CertificateManagementService) ImportCertificateP12

func (s *CertificateManagementService) ImportCertificateP12(queryParams *ImportCertificateP12QueryParams) (*TaskIDResult, *Response, error)

ImportCertificateP12 is ... This method is used to upload a PKCS#12 file

  • @param queryParams

* @return *TaskIDResult

func (*CertificateManagementService) PostProxyCertificate

func (s *CertificateManagementService) PostProxyCertificate(certFileUpload *os.File) (*TaskIDResult, *Response, error)

PostProxyCertificate is ... This method is used to upload the proxy certificate

* @return *TaskIDResult

func (*CertificateManagementService) UpdateProxyCertState

func (s *CertificateManagementService) UpdateProxyCertState(certificateProxyStatus CertificateProxyStatus) (*TaskIDResult, *Response, error)

UpdateProxyCertState is ... This method is used to update the proxy certificate

  • @param certificateProxyStatus Enable/Disable proxy certificate

* @return *TaskIDResult

type CertificateProxyStatus

type CertificateProxyStatus struct {
	ProxyEnabled bool `json:"proxyEnabled,omitempty"`
}

CertificateProxyStatus is ...

type CiscoISEDto

type CiscoISEDto struct {
	ID                       string `json:"id,omitempty"`                       // id
	Password                 string `json:"password,omitempty"`                 // password
	Description              string `json:"description,omitempty"`              // description
	Username                 string `json:"username,omitempty"`                 // username
	IPAddress                string `json:"ipAddress,omitempty"`                // ipAddress
	ServerState              string `json:"serverState,omitempty"`              // serverState
	SubscriberName           string `json:"subscriberName,omitempty"`           // subscriberName
	KeystoreFileID           string `json:"keystoreFileId,omitempty"`           // keystoreFileId
	KeystoreFilePassPhrase   string `json:"keystoreFilePassPhrase,omitempty"`   // keystoreFilePassPhrase
	TruststoreFileID         string `json:"truststoreFileId,omitempty"`         // truststoreFileId
	TruststoreFilePassPhrase string `json:"truststoreFilePassPhrase,omitempty"` // truststoreFilePassPhrase
}

CiscoISEDto is ...

type CiscoISEListResult

type CiscoISEListResult struct {
	Response []CiscoISEDto `json:"response,omitempty"`
	Version  string        `json:"version,omitempty"`
}

CiscoISEListResult is ...

type CiscoISEResult

type CiscoISEResult struct {
	Response CiscoISEDto `json:"response,omitempty"`
	Version  string      `json:"version,omitempty"`
}

CiscoISEResult is ...

type CiscoISEService

type CiscoISEService service

CiscoISEService is an interface with the Vciscoise API

func (*CiscoISEService) AddCiscoISEConfig

func (s *CiscoISEService) AddCiscoISEConfig(ciscoISEDTO CiscoISEDto) (*TaskIDResult, *Response, error)

AddCiscoISEConfig is ... This method is used to create the ISE Server Configuration

  • @param ciscoISEDTO CiscoISEDTO Object

* @return *TaskIDResult

func (*CiscoISEService) AddKeystoreFile

func (s *CiscoISEService) AddKeystoreFile(queryParams *AddKeystoreFileQueryParams) (*TaskIDResult, *Response, error)

AddKeystoreFile is ... This method is used to upload Identity Authentication file info

  • @param queryParams

* @return *TaskIDResult

func (*CiscoISEService) Delete

func (s *CiscoISEService) Delete(ipAddress string) (*TaskIDResult, *Response, error)

Delete is ... This method is used to remove the CISCO ISE configuration for a specific ISE Server IP address

* @return *TaskIDResult

func (*CiscoISEService) DeleteAuthFileInfo

func (s *CiscoISEService) DeleteAuthFileInfo(id string) (*TaskIDResult, *Response, error)

DeleteAuthFileInfo is ... This method is used to delete the Identity Auth File that was uploaded using an ID

* @return *TaskIDResult

func (*CiscoISEService) GetAuthFileCount

func (s *CiscoISEService) GetAuthFileCount() (*CountResult, *Response, error)

GetAuthFileCount is ... This method is used to obtain the number of Identity Auth Files uploaded to APIC-EM

* @return *CountResult

func (*CiscoISEService) GetAuthFileList

func (s *CiscoISEService) GetAuthFileList() (*IdentityAuthFileInfoListResult, *Response, error)

GetAuthFileList is ... This method is used to obtain the list of Keystore and Truststore files uploaded for ISE server configuration

* @return *IdentityAuthFileInfoListResult

func (*CiscoISEService) GetByIPAddress

func (s *CiscoISEService) GetByIPAddress(ipAddress string) (*CiscoISEResult, *Response, error)

GetByIPAddress is ... This method is used to get the CISCO ISE configuration for a specific ISE Server IP address

* @return *CiscoISEResult

func (*CiscoISEService) GetCount

func (s *CiscoISEService) GetCount() (*CountResult, *Response, error)

GetCount is ... This method is used to obtain the number of Cisco ISE configurations known to APIC-EM

* @return *CountResult

func (*CiscoISEService) GetEndPointGroupbyID

func (s *CiscoISEService) GetEndPointGroupbyID(id string) (*CiscoISEResult, *Response, error)

GetEndPointGroupbyID is ... Get Cisco ISE configuration based on id

* @return *CiscoISEResult

func (*CiscoISEService) GetList

func (s *CiscoISEService) GetList() (*CiscoISEListResult, *Response, error)

GetList is ... This method is used to obtain the list of Cisco ISE Server Configurations

* @return *CiscoISEListResult

type Class

type Class struct {
	Modifiers            int32             `json:"modifiers,omitempty"`
	Interface            bool              `json:"interface,omitempty"`
	Array                bool              `json:"array,omitempty"`
	Primitive            bool              `json:"primitive,omitempty"`
	Superclass           ClassObject       `json:"superclass,omitempty"`
	ComponentType        ClassObject       `json:"componentType,omitempty"`
	Name                 string            `json:"name,omitempty"`
	Annotation           bool              `json:"annotation,omitempty"`
	Synthetic            bool              `json:"synthetic,omitempty"`
	ClassLoader          ClassLoader       `json:"classLoader,omitempty"`
	TypeParameters       []TypeVariable    `json:"typeParameters,omitempty"`
	GenericSuperclass    Type              `json:"genericSuperclass,omitempty"`
	Package              Package           `json:"package,omitempty"`
	Interfaces           []Class           `json:"interfaces,omitempty"`
	GenericInterfaces    []Type            `json:"genericInterfaces,omitempty"`
	Signers              []string          `json:"signers,omitempty"`
	EnclosingMethod      Method            `json:"enclosingMethod,omitempty"`
	EnclosingConstructor ConstructorObject `json:"enclosingConstructor,omitempty"`
	DeclaringClass       ClassObject       `json:"declaringClass,omitempty"`
	EnclosingClass       ClassObject       `json:"enclosingClass,omitempty"`
	SimpleName           string            `json:"simpleName,omitempty"`
	CanonicalName        string            `json:"canonicalName,omitempty"`
	AnonymousClass       bool              `json:"anonymousClass,omitempty"`
	LocalClass           bool              `json:"localClass,omitempty"`
	MemberClass          bool              `json:"memberClass,omitempty"`
	Classes              []Class           `json:"classes,omitempty"`
	Fields               []Field           `json:"fields,omitempty"`
	Methods              []Method          `json:"methods,omitempty"`
	Constructors         []Constructor     `json:"constructors,omitempty"`
	DeclaredClasses      []Class           `json:"declaredClasses,omitempty"`
	DeclaredFields       []Field           `json:"declaredFields,omitempty"`
	DeclaredMethods      []Method          `json:"declaredMethods,omitempty"`
	DeclaredConstructors []Constructor     `json:"declaredConstructors,omitempty"`
	ProtectionDomain     ProtectionDomain  `json:"protectionDomain,omitempty"`
	Enum                 bool              `json:"enum,omitempty"`
	EnumConstants        []string          `json:"enumConstants,omitempty"`
	Annotations          []Annotation      `json:"annotations,omitempty"`
	DeclaredAnnotations  []Annotation      `json:"declaredAnnotations,omitempty"`
}

Class is ...

type ClassLoader

type ClassLoader struct {
	Parent *ClassLoader `json:"parent,omitempty"`
}

ClassLoader is ...

type ClassObject

type ClassObject struct {
	Modifiers            int32              `json:"modifiers,omitempty"`
	Interface            bool               `json:"interface,omitempty"`
	Array                bool               `json:"array,omitempty"`
	Primitive            bool               `json:"primitive,omitempty"`
	Superclass           *ClassObject       `json:"superclass,omitempty"`
	ComponentType        *ClassObject       `json:"componentType,omitempty"`
	Name                 string             `json:"name,omitempty"`
	Annotation           bool               `json:"annotation,omitempty"`
	Synthetic            bool               `json:"synthetic,omitempty"`
	ClassLoader          *ClassLoader       `json:"classLoader,omitempty"`
	TypeParameters       []*TypeVariable    `json:"typeParameters,omitempty"`
	GenericSuperclass    *Type              `json:"genericSuperclass,omitempty"`
	Package              *Package           `json:"package,omitempty"`
	Interfaces           []*Class           `json:"interfaces,omitempty"`
	GenericInterfaces    []*Type            `json:"genericInterfaces,omitempty"`
	Signers              []string           `json:"signers,omitempty"`
	EnclosingMethod      *Method            `json:"enclosingMethod,omitempty"`
	EnclosingConstructor *ConstructorObject `json:"enclosingConstructor,omitempty"`
	DeclaringClass       *ClassObject       `json:"declaringClass,omitempty"`
	EnclosingClass       *ClassObject       `json:"enclosingClass,omitempty"`
	SimpleName           string             `json:"simpleName,omitempty"`
	CanonicalName        string             `json:"canonicalName,omitempty"`
	AnonymousClass       bool               `json:"anonymousClass,omitempty"`
	LocalClass           bool               `json:"localClass,omitempty"`
	MemberClass          bool               `json:"memberClass,omitempty"`
	Classes              []*Class           `json:"classes,omitempty"`
	Fields               []*Field           `json:"fields,omitempty"`
	Methods              []*Method          `json:"methods,omitempty"`
	Constructors         []*Constructor     `json:"constructors,omitempty"`
	DeclaredClasses      []*Class           `json:"declaredClasses,omitempty"`
	DeclaredFields       []*Field           `json:"declaredFields,omitempty"`
	DeclaredMethods      []*Method          `json:"declaredMethods,omitempty"`
	DeclaredConstructors []*Constructor     `json:"declaredConstructors,omitempty"`
	ProtectionDomain     *ProtectionDomain  `json:"protectionDomain,omitempty"`
	Enum                 bool               `json:"enum,omitempty"`
	EnumConstants        []string           `json:"enumConstants,omitempty"`
	Annotations          []*Annotation      `json:"annotations,omitempty"`
	DeclaredAnnotations  []*Annotation      `json:"declaredAnnotations,omitempty"`
}

ClassObject is ...

type CliCredentialDTO

type CliCredentialDTO struct {
	Username       string `json:"username,omitempty"`       // CLI username
	Password       string `json:"password,omitempty"`       // CLI password
	EnablePassword string `json:"enablePassword,omitempty"` // CLI enable password
	Description    string `json:"description,omitempty"`    // Description of the credential
	Comments       string `json:"comments,omitempty"`       // Comments to identify the credential
	CredentialType string `json:"credentialType,omitempty"` // Credential type to identify the application that uses the credential
	InstanceUUID   string `json:"instanceUuid,omitempty"`
	ID             string `json:"id,omitempty"`
}

CliCredentialDTO is ...

type Client

type Client struct {

	// Base URL for API requests.
	BaseURL *url.URL

	// User agent for client
	UserAgent string

	// Authorization is the authentication token
	Authorization string

	// Services used for communicating with the APIC-EM API
	AAA                   *AAAService
	Alarm                 *AlarmService
	Application           *ApplicationService
	Audit                 *AuditService
	Category              *CategoryService
	CertificateManagement *CertificateManagementService
	CiscoISE              *CiscoISEService
	GlobalCredential      *GlobalCredentialService
	Discovery             *DiscoveryService
	// FileService           *FileServiceService
	FlowAnalysis        *FlowAnalysisService
	Host                *HostService
	Interface           *InterfaceService
	IPGeo               *IPGeoService
	IPPool              *IPPoolService
	License             *LicenseService
	Location            *LocationService
	Neighborhood        *NeighborhoodService
	NetworkDevice       *NetworkDeviceService
	NetworkDeviceConfig *NetworkDeviceConfigService
	PKIBroker           *PKIBrokerService
	Policy              *PolicyService
	ReachabilityInfo    *ReachabilityInfoService
	Relevance           *RelevanceService
	Role                *RoleService
	ScalableGroup       *ScalableGroupService
	Scheduler           *SchedulerService
	Segment             *SegmentService
	Tag                 *TagService
	Task                *TaskService
	Ticket              *TicketService
	Topology            *TopologyService
	TopologyApplication *TopologyApplicationService
	TopologyVLAN        *TopologyVLANService
	User                *UserService
	Contract            *ContractService
	PolicyV2            *PolicyV2Service
	VLAN                *VLANService
	VRF                 *VRFService
	// contains filtered or unexported fields
}

Client manages communication with Cisco Spark V1 API.

func New

func New(httpClient *http.Client, opts ...ClientOpt) (*Client, error)

New returns a new Cisco Spark API client instance.

func NewClient

func NewClient(httpClient *http.Client) *Client

NewClient returns a new Cisco Spark API client.

func (*Client) Do

func (c *Client) Do(req *http.Request, v interface{}) (*Response, error)

Do sends an API request and returns the API response. The API response is JSON decoded and stored in the value pointed to by v, or returned as an error if an API error has occurred. If v implements the io.Writer interface, the raw response will be written to v, without attempting to decode it.

func (*Client) NewRequest

func (c *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error)

NewRequest creates an API request. A relative URL can be provided in urlStr, which will be resolved to the BaseURL of the Client. Relative URLS should always be specified without a preceding slash. If specified, the value pointed to by body is JSON encoded and included in as the request body.

func (*Client) OnRequestCompleted

func (c *Client) OnRequestCompleted(rc RequestCompletionCallback)

OnRequestCompleted sets the Cisco Spark API request completion callback

type ClientOpt

type ClientOpt func(*Client) error

ClientOpt are options for New.

func SetBaseURL

func SetBaseURL(bu string) ClientOpt

SetBaseURL is a client option for setting the base URL.

func SetUserAgent

func SetUserAgent(ua string) ClientOpt

SetUserAgent is a client option for setting the user agent.

type CodeSigner

type CodeSigner struct {
	SignerCertPath CertPath  `json:"signerCertPath,omitempty"`
	Timestamp      Timestamp `json:"timestamp,omitempty"`
}

CodeSigner is ...

type CodeSource

type CodeSource struct {
	Location     URL           `json:"location,omitempty"`
	Certificates []Certificate `json:"certificates,omitempty"`
	CodeSigners  []CodeSigner  `json:"codeSigners,omitempty"`
}

CodeSource is ...

type Collectionstring

type Collectionstring struct {
}

Collectionstring is ...

type Constructor

type Constructor struct {
	Modifiers             int32          `json:"modifiers,omitempty"`
	Name                  string         `json:"name,omitempty"`
	Synthetic             bool           `json:"synthetic,omitempty"`
	TypeParameters        []TypeVariable `json:"typeParameters,omitempty"`
	DeclaringClass        ClassObject    `json:"declaringClass,omitempty"`
	DeclaredAnnotations   []Annotation   `json:"declaredAnnotations,omitempty"`
	ParameterTypes        []Class        `json:"parameterTypes,omitempty"`
	GenericParameterTypes []Type         `json:"genericParameterTypes,omitempty"`
	ExceptionTypes        []Class        `json:"exceptionTypes,omitempty"`
	GenericExceptionTypes []Type         `json:"genericExceptionTypes,omitempty"`
	VarArgs               bool           `json:"varArgs,omitempty"`
	ParameterAnnotations  []Annotation   `json:"parameterAnnotations,omitempty"` // Not sure about this type
	Annotations           []Annotation   `json:"annotations,omitempty"`
	Accessible            bool           `json:"accessible,omitempty"`
}

Constructor is ...

type ConstructorObject

type ConstructorObject struct {
	Modifiers             int32          `json:"modifiers,omitempty"`
	Name                  string         `json:"name,omitempty"`
	Synthetic             bool           `json:"synthetic,omitempty"`
	TypeParameters        []TypeVariable `json:"typeParameters,omitempty"`
	DeclaringClass        ClassObject    `json:"declaringClass,omitempty"`
	DeclaredAnnotations   []Annotation   `json:"declaredAnnotations,omitempty"`
	ParameterTypes        []Class        `json:"parameterTypes,omitempty"`
	GenericParameterTypes []Type         `json:"genericParameterTypes,omitempty"`
	ExceptionTypes        []Class        `json:"exceptionTypes,omitempty"`
	GenericExceptionTypes []Type         `json:"genericExceptionTypes,omitempty"`
	VarArgs               bool           `json:"varArgs,omitempty"`
	ParameterAnnotations  []Annotation   `json:"parameterAnnotations,omitempty"` // Not sure about this type
	Annotations           []Annotation   `json:"annotations,omitempty"`
	Accessible            bool           `json:"accessible,omitempty"`
}

ConstructorObject is ...

type ConsumerDto

type ConsumerDto struct {
	ScalableGroups []ScalableGroupDto `json:"scalableGroups,omitempty"`
}

ConsumerDto is ...

type ContractDto

type ContractDto struct {
	AccessClause   AccessClauseDto `json:"accessClause,omitempty"`   // accessClause
	Description    string          `json:"description,omitempty"`    // description
	Name           string          `json:"name,omitempty"`           // name
	ID             string          `json:"id,omitempty"`             // id
	CreateTime     int64           `json:"createTime,omitempty"`     // createTime
	LastUpdateTime int64           `json:"lastUpdateTime,omitempty"` // lastUpdateTime
}

ContractDto is ...

type ContractListResult

type ContractListResult struct {
	Response []ContractDto `json:"response,omitempty"`
	Version  string        `json:"version,omitempty"`
}

ContractListResult is ...

type ContractResult

type ContractResult struct {
	Response ContractDto `json:"response,omitempty"`
	Version  string      `json:"version,omitempty"`
}

ContractResult is ...

type ContractService

type ContractService service

ContractService is an interface with the Vcontract API

func (*ContractService) Add

func (s *ContractService) Add(contractDTOs *[]ContractDto) (*TaskIDResult, *Response, error)

Add is ... Create contract(s)

  • @param contractDTOs Contract Object(s)

* @return *TaskIDResult

func (*ContractService) Delete

func (s *ContractService) Delete(id string) (*TaskIDResult, *Response, error)

Delete is ... Delete a contract by id

* @return *TaskIDResult

func (*ContractService) GetByID

func (s *ContractService) GetByID(id string) (*ContractResult, *Response, error)

GetByID is ... Get a contract by id

* @return *ContractResult

func (*ContractService) GetContractByFilters

func (s *ContractService) GetContractByFilters(queryParams *GetContractByFiltersQueryParams) (*ContractListResult, *Response, error)

GetContractByFilters is ... Retrieves contracts based on a given filter

  • @param queryParams

* @return *ContractListResult

func (*ContractService) GetCount

func (s *ContractService) GetCount() (*CountResult, *Response, error)

GetCount is ... Get total count of contracts

* @return *CountResult

func (*ContractService) Update

func (s *ContractService) Update(contractDTOs *[]ContractDto) (*TaskIDResult, *Response, error)

Update is ... Update contract(s)

  • @param contractDTOs Contract Object(s)

* @return *TaskIDResult

type CountResult

type CountResult struct {
	Version  string `json:"version,omitempty"`
	Response int32  `json:"response,omitempty"`
}

CountResult is ...

type Date

type Date struct {
	Time    int64 `json:"time,omitempty"`
	Hours   int32 `json:"hours,omitempty"`
	Minutes int32 `json:"minutes,omitempty"`
	Seconds int32 `json:"seconds,omitempty"`
	Year    int32 `json:"year,omitempty"`
	Month   int32 `json:"month,omitempty"`
	Date    int32 `json:"date,omitempty"`
}

Date is ...

type DeleteApplicationQueryParams

type DeleteApplicationQueryParams struct {
	ScheduleAt     string `url:"scheduleAt,omitempty"`     // scheduleAt
	ScheduleDesc   string `url:"scheduleDesc,omitempty"`   // scheduleDesc
	ScheduleOrigin string `url:"scheduleOrigin,omitempty"` // scheduleOrigin
}

DeleteApplicationQueryParams is ...

type DeleteFilterPoliciesQueryParams

type DeleteFilterPoliciesQueryParams struct {
	PolicyScope          string `url:"policyScope,omitempty"`          // Delete policies for a given scope
	ScopeWirelessSegment string `url:"scopeWirelessSegment,omitempty"` // Delete policies for a given wireless segment, within a policyScope (policyScope is mandatory for this)
}

DeleteFilterPoliciesQueryParams is ...

type DeleteFlowsByClientReferenceQueryParams

type DeleteFlowsByClientReferenceQueryParams struct {
	ClientReference string `url:"clientReference,omitempty"` // clientReference
}

DeleteFlowsByClientReferenceQueryParams is ...

type DeletePolicyTagAssociationQueryParams

type DeletePolicyTagAssociationQueryParams struct {
	PolicyTag       string `url:"policyTag,omitempty"`       // Policy Tag
	NetworkDeviceID string `url:"networkDeviceId,omitempty"` // NetworkDeviceId
}

DeletePolicyTagAssociationQueryParams is ...

type DeletePolicyTagQueryParams

type DeletePolicyTagQueryParams struct {
	PolicyTag string `url:"policyTag,omitempty"` // Policy Tag
}

DeletePolicyTagQueryParams is ...

type DeleteTagFromResourceQueryParams

type DeleteTagFromResourceQueryParams struct {
	ResourceType string `url:"resourceType,omitempty"` // Type of resource. Supported resourceTypes are network-device, interface.
	ResourceID   string `url:"resourceId,omitempty"`   // Resource ID
}

DeleteTagFromResourceQueryParams is ...

type DetailedStatus

type DetailedStatus struct {
	AclTraceCalculation              string `json:"aclTraceCalculation,omitempty"`
	AclTraceCalculationFailureReason string `json:"aclTraceCalculationFailureReason,omitempty"`
}

DetailedStatus is ...

type DeviceIfDto

type DeviceIfDto struct {
	Description                 string `json:"description,omitempty"`                 // interface description
	Status                      string `json:"status,omitempty"`                      // Interface status as Down / Up
	InterfaceType               string `json:"interfaceType,omitempty"`               // Interface type as Physical or Virtual
	MacAddress                  string `json:"macAddress,omitempty"`                  // MAC address of interface
	IfIndex                     string `json:"ifIndex,omitempty"`                     // Interface index
	Speed                       string `json:"speed,omitempty"`                       // Speed of the interface
	Duplex                      string `json:"duplex,omitempty"`                      // Interface duplex as AutoNegotiate or FullDuplex
	PortMode                    string `json:"portMode,omitempty"`                    // Port mode as access, trunk, routed
	PortType                    string `json:"portType,omitempty"`                    // Port type as Ethernet Port / Ethernet SVI / Ethernet Sub Interface
	LastUpdated                 string `json:"lastUpdated,omitempty"`                 // Time when the device interface info last got updated
	PortName                    string `json:"portName,omitempty"`                    // Interface name
	VlanID                      string `json:"vlanId,omitempty"`                      // Vlan ID of interface
	DeviceID                    string `json:"deviceId,omitempty"`                    // ID of the device
	Series                      string `json:"series,omitempty"`                      // Series of the device
	Ipv4Address                 string `json:"ipv4Address,omitempty"`                 // IPv4 address assigned for interface
	Ipv4Mask                    string `json:"ipv4Mask,omitempty"`                    // Subnet mask for IPv4 address assigned for interface
	IsisSupport                 string `json:"isisSupport,omitempty"`                 // Flag for ISIS enabled / disabled
	MappedPhysicalInterfaceID   string `json:"mappedPhysicalInterfaceId,omitempty"`   // ID of physical interface mapped with the virtual interface of WLC
	MappedPhysicalInterfaceName string `json:"mappedPhysicalInterfaceName,omitempty"` // Physical interface name mapped with the virtual interface of WLC
	NativeVlanID                string `json:"nativeVlanId,omitempty"`                // Vlan to receive untagged frames on trunk port
	OspfSupport                 string `json:"ospfSupport,omitempty"`                 // Flag for OSPF enabled / disabled
	Pid                         string `json:"pid,omitempty"`                         // Platform ID of the device
	SerialNo                    string `json:"serialNo,omitempty"`                    // Serial number of the device
	InstanceUUID                string `json:"instanceUuid,omitempty"`
	ID                          string `json:"id,omitempty"`
}

DeviceIfDto is ...

type DeviceIfListResult

type DeviceIfListResult struct {
	Version  string        `json:"version,omitempty"`
	Response []DeviceIfDto `json:"response,omitempty"`
}

DeviceIfListResult is ...

type DeviceIfResult

type DeviceIfResult struct {
	Version  string      `json:"version,omitempty"`
	Response DeviceIfDto `json:"response,omitempty"`
}

DeviceIfResult is ...

type DeviceStatistics

type DeviceStatistics struct {
	MemoryStatistics MemoryStatistics `json:"memoryStatistics,omitempty"` // Device Memory statistics
	CPUStatistics    CPUStatistics    `json:"cpuStatistics,omitempty"`    // Device CPU statistics
}

DeviceStatistics is ...

type DiscoveryNio

type DiscoveryNio struct {
	Name                   string   `json:"name,omitempty"`                   // Name for the discovery
	SnmpRwCommunity        string   `json:"snmpRwCommunity,omitempty"`        // Snmp RW community of the devices to be discovered
	DiscoveryCondition     string   `json:"discoveryCondition,omitempty"`     // To indicate the discovery status. Available options: Complete or In Progress
	GlobalCredentialIDList []string `json:"globalCredentialIdList,omitempty"` // To get the list of global credential of the discovery
	IPFilterList           string   `json:"ipFilterList,omitempty"`           // IP addresses of the devices to be filtered
	IsAutoCdp              bool     `json:"isAutoCdp,omitempty"`              // Flag to mention if CDP discovery or not

	UserNameList       string `json:"userNameList,omitempty"`       // Username of the devices to be discovered
	PasswordList       string `json:"passwordList,omitempty"`       // Password of the devices to be discovered
	EnablePasswordList string `json:"enablePasswordList,omitempty"` // Enable Password of the devices to be discovered
	ProtocolOrder      string `json:"protocolOrder,omitempty"`      // Order of protocol in which device connection establishment to be tried
	CdpLevel           int32  `json:"cdpLevel,omitempty"`           // CDP level to which neighbor devices to be discovered
	SnmpRoCommunity    string `json:"snmpRoCommunity,omitempty"`    // Snmp RO community of the devices to be discovered
	NumDevices         int32  `json:"numDevices,omitempty"`         // Number of devices discovered in a discovery
	ID                 string `json:"id,omitempty"`                 // Unique identifier for discovery
	RetryCount         int32  `json:"retryCount,omitempty"`         // Number of times to try establishing connection to device
	DiscoveryType      string `json:"discoveryType,omitempty"`      // Available types are: single, auto cdp discovery, range, multi range
	TimeOut            int32  `json:"timeOut,omitempty"`            // Time to wait for device response.
	IPAddressList      string `json:"ipAddressList,omitempty"`      // Ip address of the device to be discovered
	DiscoveryStatus    string `json:"discoveryStatus,omitempty"`    // Available options are: active, inactive
	DeviceIDs          string `json:"deviceIds,omitempty"`          // IDs of the devices discovered in a discovery
	AttributeInfo      string `json:"attributeInfo,omitempty"`
	// contains filtered or unexported fields
}

DiscoveryNio is ...

type DiscoveryNioListResult

type DiscoveryNioListResult struct {
	Version  string         `json:"version,omitempty"`
	Response []DiscoveryNio `json:"response,omitempty"`
}

DiscoveryNioListResult is ...

type DiscoveryNioResult

type DiscoveryNioResult struct {
	Version  string       `json:"version,omitempty"`
	Response DiscoveryNio `json:"response,omitempty"`
}

DiscoveryNioResult is ...

type DiscoveryService

type DiscoveryService service

DiscoveryService is an interface with the Discovery API

func (*DiscoveryService) DeleteAllDiscovery

func (s *DiscoveryService) DeleteAllDiscovery(scope string) (*TaskIDResult, *Response, error)

DeleteAllDiscovery is ... Stops all the discoveries and removes them

  • @param scope Authorization Scope for RBAC

* @return *TaskIDResult

func (*DiscoveryService) DeleteDiscoveryByID

func (s *DiscoveryService) DeleteDiscoveryByID(id string, scope string) (*TaskIDResult, *Response, error)

DeleteDiscoveryByID is ... Stops the discovery for the given ID and removes it

  • @param scope Authorization Scope for RBAC

* @return *TaskIDResult

func (*DiscoveryService) DeleteDiscoveryByRange

func (s *DiscoveryService) DeleteDiscoveryByRange(startIndex int32, recordsToDelete int32, scope string) (*TaskIDResult, *Response, error)

DeleteDiscoveryByRange is ... Stops discovery for the given range and removes them

  • @param scope Authorization Scope for RBAC

* @return *TaskIDResult

func (*DiscoveryService) GetDiscoveryByID

func (s *DiscoveryService) GetDiscoveryByID(id string, scope string) (*DiscoveryNioResult, *Response, error)

GetDiscoveryByID is ... Retrieves discovery by ID

  • @param scope Authorization Scope for RBAC

* @return *DiscoveryNioResult

func (*DiscoveryService) GetDiscoveryByRange

func (s *DiscoveryService) GetDiscoveryByRange(startIndex int32, recordsToReturn int32, scope string) (*DiscoveryNioListResult, *Response, error)

GetDiscoveryByRange is ... Gets the discovery for the range specified

  • @param scope Authorization Scope for RBAC

* @return *DiscoveryNioListResult

func (*DiscoveryService) GetDiscoveryCount

func (s *DiscoveryService) GetDiscoveryCount(scope string) (*CountResult, *Response, error)

GetDiscoveryCount is ... Gets the count of all available discovery

  • @param scope Authorization Scope for RBAC

* @return *CountResult

func (*DiscoveryService) GetNetworkDeviceByDiscoveryID

func (s *DiscoveryService) GetNetworkDeviceByDiscoveryID(id string, scope string) (*NetworkDeviceNioListResult, *Response, error)

GetNetworkDeviceByDiscoveryID is ... Gets the network devices discovered for the given discovery

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceNioListResult

func (*DiscoveryService) GetNetworkDeviceByDiscoveryIDByRange

func (s *DiscoveryService) GetNetworkDeviceByDiscoveryIDByRange(id string, startIndex int32, recordsToReturn int32, scope string) (*NetworkDeviceNioListResult, *Response, error)

GetNetworkDeviceByDiscoveryIDByRange is ... Gets the network devices discovered for the given discovery and for the given range. The maximum number of records that could be retrieved is 500

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceNioListResult

func (*DiscoveryService) GetNetworkDeviceCountByDiscoveryID

func (s *DiscoveryService) GetNetworkDeviceCountByDiscoveryID(id string, scope string) (*CountResult, *Response, error)

GetNetworkDeviceCountByDiscoveryID is ... Gets the count of network devices discovered in the given discovery

  • @param scope Authorization Scope for RBAC

* @return *CountResult

func (*DiscoveryService) InsertDiscovery

func (s *DiscoveryService) InsertDiscovery(request InventoryRequest, scope string) (*TaskIDResult, *Response, error)

InsertDiscovery is ... Initiates discovery with the given parameters

  • @param scope Authorization Scope for RBAC
  • @param request Discovery request that holds the parameters required for discovery

* @return *TaskIDResult

func (*DiscoveryService) UpdateDiscovery

func (s *DiscoveryService) UpdateDiscovery(discovery DiscoveryNio, scope string) (*TaskIDResult, *Response, error)

UpdateDiscovery is ... Stops or starts an existing discovery

  • @param scope Authorization Scope for RBAC
  • @param discovery Discovery request that holds the status of discovery as active / inactive

* @return *TaskIDResult

type ErrorResponse

type ErrorResponse struct {
	// HTTP response that caused this error
	HTTPResponse *http.Response

	Message string
	Errors  []struct {
		Description string
	}
	TrackingID string
}

An ErrorResponse reports the error caused by an API request

func (*ErrorResponse) Error

func (r *ErrorResponse) Error() string

type EventAlarmCategoryEnum

type EventAlarmCategoryEnum struct {
	Value   string `json:"value,omitempty"`
	Ordinal int32  `json:"ordinal,omitempty"`
}

EventAlarmCategoryEnum is ...

type EventTypeEnum

type EventTypeEnum struct {
	Value   string `json:"value,omitempty"`
	Ordinal int32  `json:"ordinal,omitempty"`
}

EventTypeEnum is ...

type Field

type Field struct {
	Modifiers           int32        `json:"modifiers,omitempty"`
	Name                string       `json:"name,omitempty"`
	Synthetic           bool         `json:"synthetic,omitempty"`
	DeclaringClass      ClassObject  `json:"declaringClass,omitempty"`
	DeclaredAnnotations []Annotation `json:"declaredAnnotations,omitempty"`
	EnumConstant        bool         `json:"enumConstant,omitempty"`
	Type                ClassObject  `json:"type,omitempty"`
	GenericType         Type         `json:"genericType,omitempty"`
	Annotations         []Annotation `json:"annotations,omitempty"`
	Accessible          bool         `json:"accessible,omitempty"`
}

Field is ...

type FileObjectListResult

type FileObjectListResult struct {
	Version  string       `json:"version,omitempty"`
	Response []Filestring `json:"response,omitempty"`
}

FileObjectListResult is ...

type FileObjectResult

type FileObjectResult struct {
	Version  string     `json:"version,omitempty"`
	Response Filestring `json:"response,omitempty"`
}

FileObjectResult is ...

type Filestring

type Filestring struct {
	NameSpace     string `json:"nameSpace,omitempty"`    // A group of file IDs contained in a common nameSpace
	ID            string `json:"id,omitempty"`           // file indentification number
	Encrypted     bool   `json:"encrypted,omitempty"`    // isEncrypted of the file
	DownloadPath  string `json:"downloadPath,omitempty"` // Absolute path of the file
	FileFormat    string `json:"fileFormat,omitempty"`   // MIME Type of the File. e.g. text/plain, application/xml, audio/mpeg
	FileSize      string `json:"fileSize,omitempty"`     // Size of the file in bytes
	Md5Checksum   string `json:"md5Checksum,omitempty"`  // md5Checksum of the file
	Sha1Checksum  string `json:"sha1Checksum,omitempty"` // sha1Checksum of the file
	Name          string `json:"name,omitempty"`         // Name of the file
	AttributeInfo string `json:"attributeInfo,omitempty"`
}

Filestring is ...

type FlowAnalysis

type FlowAnalysis struct {
	ID              string   `json:"id,omitempty"`         //
	Status          string   `json:"status,omitempty"`     // Aggregated status of flow-analysis request. Value from a set of [INPROGRESS, COMPLETED, FAILED]
	CreateTime      int64    `json:"createTime,omitempty"` // Flow analysis request creation time
	FailureReason   string   `json:"failureReason,omitempty"`
	LastUpdateTime  int64    `json:"lastUpdateTime,omitempty"`  // Flow analysis request last update time
	Protocol        string   `json:"protocol,omitempty"`        // Protocol
	SourceIP        string   `json:"sourceIP,omitempty"`        // Source IP address
	DestIP          string   `json:"destIP,omitempty"`          // Destination IP address
	SourcePort      string   `json:"sourcePort,omitempty"`      // Source Port
	DestPort        string   `json:"destPort,omitempty"`        // Destination Port
	Inclusions      []string `json:"inclusions,omitempty"`      // Subset of {INTERFACE-STATS, QOS-STATS, DEVICE-STATS, PERFORMANCE-STATS, ACL-TRACE}
	PeriodicRefresh bool     `json:"periodicRefresh,omitempty"` // periodicRefresh of path for every 30 sec
}

FlowAnalysis is ...

type FlowAnalysisListOutput

type FlowAnalysisListOutput struct {
	Version  string         `json:"version,omitempty"`
	Response []FlowAnalysis `json:"response,omitempty"`
}

FlowAnalysisListOutput is ...

type FlowAnalysisRequest

type FlowAnalysisRequest struct {
	Protocol        string   `json:"protocol,omitempty"`        // Protocol
	SourceIP        string   `json:"sourceIP,omitempty"`        // Source IP address
	SourcePort      string   `json:"sourcePort,omitempty"`      // Source Port
	DestIP          string   `json:"destIP,omitempty"`          // Destination IP address
	DestPort        string   `json:"destPort,omitempty"`        // Destination Port
	PeriodicRefresh bool     `json:"periodicRefresh,omitempty"` // periodicRefresh of path for every 30 sec
	Inclusions      []string `json:"inclusions,omitempty"`      // Subset of {INTERFACE-STATS, QOS-STATS, DEVICE-STATS, PERFORMANCE-STATS, ACL-TRACE}
}

FlowAnalysisRequest is ...

type FlowAnalysisRequestResult

type FlowAnalysisRequestResult struct {
	URL            string `json:"url,omitempty"`
	TaskID         string `json:"taskId,omitempty"`
	FlowAnalysisID string `json:"flowAnalysisId,omitempty"`
}

FlowAnalysisRequestResult is ...

type FlowAnalysisRequestResultOutput

type FlowAnalysisRequestResultOutput struct {
	Version  string                    `json:"version,omitempty"`
	Response FlowAnalysisRequestResult `json:"response,omitempty"`
}

FlowAnalysisRequestResultOutput is ...

type FlowAnalysisService

type FlowAnalysisService service

FlowAnalysisService is an interface with the FlowAnalysis API

func (*FlowAnalysisService) DeleteFlowAnalysis

func (s *FlowAnalysisService) DeleteFlowAnalysis(flowAnalysisID string) (*TaskIDResult, *Response, error)

DeleteFlowAnalysis is ... Deletes a flow analysis request by its id

* @return *TaskIDResult

func (*FlowAnalysisService) GetAllFlowAnalysis

GetAllFlowAnalysis is ... Retrieves a summary of all flow analyses stored. Filters the results by given parameters.

  • @param queryParams

* @return *FlowAnalysisListOutput

func (*FlowAnalysisService) GetFullFlowAnalysisResult

func (s *FlowAnalysisService) GetFullFlowAnalysisResult(flowAnalysisID string) (*PathResponseResult, *Response, error)

GetFullFlowAnalysisResult is ... Retrieves result of a previously requested flow analysis by its Flow Analysis id

* @return *PathResponseResult

func (*FlowAnalysisService) InitiateFlowAnalysis

func (s *FlowAnalysisService) InitiateFlowAnalysis(flowAnalysisRequest FlowAnalysisRequest) (*FlowAnalysisRequestResultOutput, *Response, error)

InitiateFlowAnalysis is ... Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress.

  • @param flowAnalysisRequest flowAnalysisRequest

* @return *FlowAnalysisRequestResultOutput

type FlowDto

type FlowDto struct {
	Status            string `json:"status,omitempty"`
	Codec             string `json:"codec,omitempty"`             // codec
	SourcePort        string `json:"sourcePort,omitempty"`        // sourcePort
	DestPort          string `json:"destPort,omitempty"`          // destPort
	FlowType          string `json:"flowType,omitempty"`          // flowType
	SourceIP          string `json:"sourceIP,omitempty"`          // sourceIP
	DestIP            string `json:"destIP,omitempty"`            // destIP
	DetailedFlowType  string `json:"detailedFlowType,omitempty"`  // detailedFlowType (more detailed classification than flowType)
	AverageBandwidth  string `json:"averageBandwidth,omitempty"`  // averageBandwidth in kbps (min: 0, max: 2147483647 kbps)
	PeakBandwidth     string `json:"peakBandwidth,omitempty"`     // peakBandwidth in kbps (min: 0, max: 2147483647 kbps)
	ClientReference   string `json:"clientReference,omitempty"`   // clientReference (can be used by the client as a reference to this resource
	NetworkDeviceID   string `json:"networkDeviceId,omitempty"`   // networkDeviceId
	NetworkDeviceName string `json:"networkDeviceName,omitempty"` // networkDeviceName
	InterfaceID       string `json:"interfaceId,omitempty"`       // interfaceId
	InterfaceName     string `json:"interfaceName,omitempty"`     // interfaceName
	FailureReason     string `json:"failureReason,omitempty"`
	ID                string `json:"id,omitempty"`       // id
	Protocol          string `json:"protocol,omitempty"` // protocol
}

FlowDto is ...

type FlowIDResponse

type FlowIDResponse struct {
	TaskID string `json:"taskId,omitempty"`
	FlowID string `json:"flowId,omitempty"`
}

FlowIDResponse is ...

type FlowIDResult

type FlowIDResult struct {
	Response FlowIDResponse `json:"response,omitempty"`
	Version  string         `json:"version,omitempty"`
}

FlowIDResult is ...

type FlowListResult

type FlowListResult struct {
	Response []FlowDto `json:"response,omitempty"`
	Version  string    `json:"version,omitempty"`
}

FlowListResult is ...

type FlowResult

type FlowResult struct {
	Response FlowDto `json:"response,omitempty"`
	Version  string  `json:"version,omitempty"`
}

FlowResult is ...

type GenericDeclaration

type GenericDeclaration struct {
	TypeParameters []TypeVariable `json:"typeParameters,omitempty"`
}

GenericDeclaration is ...

type GetAllFlowAnalysisQueryParams

type GetAllFlowAnalysisQueryParams struct {
	PeriodicRefresh bool   `url:"periodicRefresh,omitempty"` // Is analysis periodically refreshed?
	SourceIP        string `url:"sourceIP,omitempty"`        // Source IP address
	DestIP          string `url:"destIP,omitempty"`          // Destination IP adress
	SourcePort      string `url:"sourcePort,omitempty"`      // Source port
	DestPort        string `url:"destPort,omitempty"`        // Destination port
	GtCreateTime    int64  `url:"gtCreateTime,omitempty"`    // Analyses requested after this time
	LtCreateTime    int64  `url:"ltCreateTime,omitempty"`    // Analyses requested before this time
	Protocol        string `url:"protocol,omitempty"`        // Protocol
	Status          string `url:"status,omitempty"`          // Status
	TaskID          string `url:"taskId,omitempty"`          // Task ID
	LastUpdateTime  string `url:"lastUpdateTime,omitempty"`  // Last update time
	Limit           string `url:"limit,omitempty"`           // Number of resources returned
	Offset          string `url:"offset,omitempty"`          // Start index of resources returned (1-based)
	Order           string `url:"order,omitempty"`           // Order by this field
	SortBy          string `url:"sortBy,omitempty"`          // Sort by this field
}

GetAllFlowAnalysisQueryParams is ...

type GetAllScheduledTasksQueryParams

type GetAllScheduledTasksQueryParams struct {
	SortBy    string `url:"sortBy,omitempty"`    // sortBy
	Order     string `url:"order,omitempty"`     // orderBy
	GroupName string `url:"groupName,omitempty"` // filterByGroup
	Origin    string `url:"origin,omitempty"`    // filterByOrigin
	Operation string `url:"operation,omitempty"` // filterByOperation
	TaskID    string `url:"taskId,omitempty"`    // filterByTaskID
	Limit     string `url:"limit,omitempty"`     // limit
	Offset    string `url:"offset,omitempty"`    // offset
}

GetAllScheduledTasksQueryParams is ...

type GetContractByFiltersQueryParams

type GetContractByFiltersQueryParams struct {
	Name         string `url:"name,omitempty"`         // Retrieve contracts for a given name
	AccessAction string `url:"accessAction,omitempty"` // Retrieve contracts for a given accessAction
	Offset       string `url:"offset,omitempty"`       // Starting index of the resources (1 based)
	Limit        string `url:"limit,omitempty"`        // Number of resources to return
}

GetContractByFiltersQueryParams is ...

type GetCountByPolicyScopeQueryParams

type GetCountByPolicyScopeQueryParams struct {
	PolicyScope          string `url:"policyScope,omitempty"`          // Retrieve count of policy status(es) based on a given policyScope
	ScopeWirelessSegment string `url:"scopeWirelessSegment,omitempty"` // Retrieve count of policy status(es) based on a given scopeWirelessSegment
}

GetCountByPolicyScopeQueryParams is ...

type GetDeviceVLANDataQueryParams

type GetDeviceVLANDataQueryParams struct {
	InterfaceType string `url:"interfaceType,omitempty"` // VLAN assocaited with sub-interface
}

GetDeviceVLANDataQueryParams is ...

type GetFilterApplicationQueryParams

type GetFilterApplicationQueryParams struct {
	IsCustom         string `url:"isCustom,omitempty"`         // Retrieve custom applications
	IsRepresentative string `url:"isRepresentative,omitempty"` // Retrieve representative applications
	CategoryID       string `url:"categoryId,omitempty"`       // Retrieve applications by categoryId
	Name             string `url:"name,omitempty"`             // name
	Offset           string `url:"offset,omitempty"`           // Starting index of the resources (1 based), This should be only used in conjuction with the limit param.
	Limit            string `url:"limit,omitempty"`            // Number of resources to return, WARNING: results may take an unexpectely long time with more than 50 results requested.
}

GetFilterApplicationQueryParams is ...

type GetFilterPoliciesQueryParams

type GetFilterPoliciesQueryParams struct {
	PolicyScope          string `url:"policyScope,omitempty"`          // Retrieve policies for a given scope
	ScopeWirelessSegment string `url:"scopeWirelessSegment,omitempty"` // Retrieve policies for a given wireless segment, within a policyScope (policyScope is mandatory for this)
	ApplicationID        string `url:"applicationId,omitempty"`        // Retrieve policies for a given Resource Application Id
	Offset               string `url:"offset,omitempty"`               // Starting index of the resources (1 based)
	Limit                string `url:"limit,omitempty"`                // Number of resources to return
}

GetFilterPoliciesQueryParams is ...

type GetFlowsQueryParams

type GetFlowsQueryParams struct {
	Offset string `url:"offset,omitempty"` // Starting index of the resources (1 based)
	Limit  string `url:"limit,omitempty"`  // Number of resources to return
}

GetFlowsQueryParams is ...

type GetGlobalCredentialQueryParams

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

GetGlobalCredentialQueryParams is ...

type GetHostsQueryParams

type GetHostsQueryParams struct {
	Limit                  string   `url:"limit,omitempty"`                  // limit
	Offset                 string   `url:"offset,omitempty"`                 // offset
	SortBy                 string   `url:"sortBy,omitempty"`                 // sortBy
	Order                  string   `url:"order,omitempty"`                  // order
	HostName               []string `url:"hostName,omitempty"`               // hostName
	HostMac                []string `url:"hostMac,omitempty"`                // hostMac
	HostType               []string `url:"hostType,omitempty"`               // hostType
	ConnectedInterfaceName []string `url:"connectedInterfaceName,omitempty"` // connectedInterfaceName
	HostIP                 []string `url:"hostIp,omitempty"`                 // hostIp
	ConnectedDeviceIP      []string `url:"connectedDeviceIp,omitempty"`      // connectedDeviceIp
}

GetHostsQueryParams is ...

type GetInterfaceByDeviceIDAndNameQueryParams

type GetInterfaceByDeviceIDAndNameQueryParams struct {
	Name string `url:"name,omitempty"` // Interface name
}

GetInterfaceByDeviceIDAndNameQueryParams is ...

type GetLicenseInfoCountQueryParams

type GetLicenseInfoCountQueryParams struct {
	CountedList                 []string `url:"countedList,omitempty"`                 // countedList
	DeployPendingList           []string `url:"deployPendingList,omitempty"`           // deployPendingList
	EulaStatusList              []string `url:"eulaStatusList,omitempty"`              // eulaStatusList
	EvalPeriodLeftList          []string `url:"evalPeriodLeftList,omitempty"`          // evalPeriodLeftList
	EvalPeriodUsedList          []string `url:"evalPeriodUsedList,omitempty"`          // evalPeriodUsedList
	ExpiredDateList             []string `url:"expiredDateList,omitempty"`             // expiredDateList
	ExpiredPeriodList           []string `url:"expiredPeriodList,omitempty"`           // expiredPeriodList
	FeatureVersionList          []string `url:"featureVersionList,omitempty"`          // featureVersionList
	HostIDList                  []string `url:"hostIdList,omitempty"`                  // hostIdList
	IsCountedList               []string `url:"isCountedList,omitempty"`               // isCountedList
	IsEulaAcceptedList          []string `url:"isEulaAcceptedList,omitempty"`          // isEulaAcceptedList
	IsEulaApplicableList        []string `url:"isEulaApplicableList,omitempty"`        // isEulaApplicableList
	IsTechnologyLicenseList     []string `url:"isTechnologyLicenseList,omitempty"`     // isTechnologyLicenseList
	LicenseFileCountList        []string `url:"licenseFileCountList,omitempty"`        // licenseFileCountList
	LicenseFileNameList         []string `url:"licenseFileNameList,omitempty"`         // licenseFileNameList
	LicenseIndexList            []string `url:"licenseIndexList,omitempty"`            // licenseIndexList
	MaxUsageCountList           []string `url:"maxUsageCountList,omitempty"`           // maxUsageCountList
	ParentIDList                []string `url:"parentIdList,omitempty"`                // parentIdList
	PhysicalIndexList           []string `url:"physicalIndexList,omitempty"`           // physicalIndexList
	PriorityList                []string `url:"priorityList,omitempty"`                // priorityList
	ProvisionStateList          []string `url:"provisionStateList,omitempty"`          // provisionStateList
	StatusList                  []string `url:"statusList,omitempty"`                  // statusList
	StoredUsedList              []string `url:"storedUsedList,omitempty"`              // storedUsedList
	StoreNameList               []string `url:"storeNameList,omitempty"`               // storeNameList
	TotalCountList              []string `url:"totalCountList,omitempty"`              // totalCountList
	LicenseTypeList             []string `url:"licenseTypeList,omitempty"`             // licenseTypeList
	UsageCountList              []string `url:"usageCountList,omitempty"`              // usageCountList
	UsageCountRemainingList     []string `url:"usageCountRemainingList,omitempty"`     // usageCountRemainingList
	ValidityPeriodList          []string `url:"validityPeriodList,omitempty"`          // validityPeriodList
	ValidityPeriodRemainingList []string `url:"validityPeriodRemainingList,omitempty"` // validityPeriodRemainingList
}

GetLicenseInfoCountQueryParams is ...

type GetLicenseInfoQueryParams

type GetLicenseInfoQueryParams struct {
	Limit                       string   `url:"limit,omitempty"`                       // limit
	Offset                      string   `url:"offset,omitempty"`                      // offset
	SortBy                      string   `url:"sortBy,omitempty"`                      // sortBy
	Order                       string   `url:"order,omitempty"`                       // order
	CountedList                 []string `url:"countedList,omitempty"`                 // countedList
	DeployPendingList           []string `url:"deployPendingList,omitempty"`           // deployPendingList
	EULAStatusList              []string `url:"eulaStatusList,omitempty"`              // eulaStatusList
	EvalPeriodLeftList          []string `url:"evalPeriodLeftList,omitempty"`          // evalPeriodLeftList
	EvalPeriodUsedList          []string `url:"evalPeriodUsedList,omitempty"`          // evalPeriodUsedList
	ExpiredDateList             []string `url:"expiredDateList,omitempty"`             // expiredDateList
	ExpiredPeriodList           []string `url:"expiredPeriodList,omitempty"`           // expiredPeriodList
	FeatureVersionList          []string `url:"featureVersionList,omitempty"`          // featureVersionList
	HostIDList                  []string `url:"hostIdList,omitempty"`                  // hostIdList
	IsCountedList               []string `url:"isCountedList,omitempty"`               // isCountedList
	IsEulaAcceptedList          []string `url:"isEulaAcceptedList,omitempty"`          // isEulaAcceptedList
	IsEulaApplicableList        []string `url:"isEulaApplicableList,omitempty"`        // isEulaApplicableList
	IsTechnologyLicenseList     []string `url:"isTechnologyLicenseList,omitempty"`     // isTechnologyLicenseList
	LicenseFileCountList        []string `url:"licenseFileCountList,omitempty"`        // licenseFileCountList
	LicenseFileNameList         []string `url:"licenseFileNameList,omitempty"`         // licenseFileNameList
	LicenseIndexList            []string `url:"licenseIndexList,omitempty"`            // licenseIndexList
	MaxUsageCountList           []string `url:"maxUsageCountList,omitempty"`           // maxUsageCountList
	ParentIDList                []string `url:"parentIdList,omitempty"`                // parentIdList
	PhysicalIndexList           []string `url:"physicalIndexList,omitempty"`           // physicalIndexList
	PriorityList                []string `url:"priorityList,omitempty"`                // priorityList
	ProvisionStateList          []string `url:"provisionStateList,omitempty"`          // provisionStateList
	StatusList                  []string `url:"statusList,omitempty"`                  // statusList
	StoredUsedList              []string `url:"storedUsedList,omitempty"`              // storedUsedList
	StoreNameList               []string `url:"storeNameList,omitempty"`               // storeNameList
	TotalCountList              []string `url:"totalCountList,omitempty"`              // totalCountList
	LicenseTypeList             []string `url:"licenseTypeList,omitempty"`             // licenseTypeList
	UsageCountList              []string `url:"usageCountList,omitempty"`              // usageCountList
	UsageCountRemainingList     []string `url:"usageCountRemainingList,omitempty"`     // usageCountRemainingList
	ValidityPeriodList          []string `url:"validityPeriodList,omitempty"`          // validityPeriodList
	ValidityPeriodRemainingList []string `url:"validityPeriodRemainingList,omitempty"` // validityPeriodRemainingList
}

GetLicenseInfoQueryParams is ...

type GetListQueryParams

type GetListQueryParams struct {
	Limit       string `url:"limit,omitempty"`       // limit
	Offset      string `url:"offset,omitempty"`      // offset
	ApicAppName string `url:"apicAppName,omitempty"` // Apic APP Name
}

GetListQueryParams is ...

type GetPolicyByFiltersQueryParams

type GetPolicyByFiltersQueryParams struct {
	Name                      string `url:"name,omitempty"`                      // Retrieve policies for a given name
	Contractname              string `url:"contractname,omitempty"`              // Retrieve policies for a given contract name
	ProducerscalableGroupName string `url:"producerscalableGroupName,omitempty"` // Retrieve policies for a given producer scalable group name
	ConsumerscalableGroupName string `url:"consumerscalableGroupName,omitempty"` // Retrieve policies for a given consumer scalable group name
	ScalableGroupName         string `url:"scalableGroupName,omitempty"`         // Retrieve policies for a given scalable group name (used within producer or consumer)
	Offset                    string `url:"offset,omitempty"`                    // Starting index of the resources (1 based)
	Limit                     string `url:"limit,omitempty"`                     // Number of resources to return
}

GetPolicyByFiltersQueryParams is ...

type GetPolicyDiffQueryParams

type GetPolicyDiffQueryParams struct {
	Version              string `url:"version,omitempty"`              // Retrieve policy diffs for the given version
	PolicyScope          string `url:"policyScope,omitempty"`          // Retrieve policy diffs for the given scope
	ScopeWirelessSegment string `url:"scopeWirelessSegment,omitempty"` // Retrieve policy diffs for the given scopeWirelessSegment
}

GetPolicyDiffQueryParams is ...

type GetPolicyStatusQueryParams

type GetPolicyStatusQueryParams struct {
	NetworkDeviceID string `url:"networkDeviceId,omitempty"` // Retrieve policies for a given networkDeviceId
	PolicyScope     string `url:"policyScope,omitempty"`     // Retrieve policies for a given scope
	Offset          string `url:"offset,omitempty"`          // Starting index of the resources (1 based)
	Limit           string `url:"limit,omitempty"`           // Number of resources to return (Use smaller limit value for better response times. Max 50)
}

GetPolicyStatusQueryParams is ...

type GetPolicyStatusSummaryQueryParams

type GetPolicyStatusSummaryQueryParams struct {
	PolicyScope string `url:"policyScope,omitempty"` // Retrieve policy status(es) for a given scope
	Offset      string `url:"offset,omitempty"`      // Starting index of the resources (1 based)
	Limit       string `url:"limit,omitempty"`       // Number of resources to return (Use smaller limit value for better response times. Max 50)
}

GetPolicyStatusSummaryQueryParams is ...

type GetPolicyTagAssociationQueryParams

type GetPolicyTagAssociationQueryParams struct {
	PolicyTag       string `url:"policyTag,omitempty"`       // Policy Tag
	NetworkDeviceID string `url:"networkDeviceId,omitempty"` // Network device Id
	Offset          string `url:"offset,omitempty"`          // Starting index of the resources (1 based)
	Limit           string `url:"limit,omitempty"`           // Number of resources to return
}

GetPolicyTagAssociationQueryParams is ...

type GetPolicyTagsQueryParams

type GetPolicyTagsQueryParams struct {
	PolicyTag       string `url:"policyTag,omitempty"`       // policyTag search substring
	FilterOperation string `url:"filterOperation,omitempty"` // type of search (startsWith, endsWith, contains
}

GetPolicyTagsQueryParams is ...

type GetPolicyVersionNumbersCountQueryParams

type GetPolicyVersionNumbersCountQueryParams struct {
	PolicyScope          string `url:"policyScope,omitempty"`          // Retrieve the count of policy version numbers for the given scope
	ScopeWirelessSegment string `url:"scopeWirelessSegment,omitempty"` // Retrieve the count of policy version numbers for the given scopeWirelessSegment
}

GetPolicyVersionNumbersCountQueryParams is ...

type GetPolicyVersionNumbersQueryParams

type GetPolicyVersionNumbersQueryParams struct {
	PolicyScope          string `url:"policyScope,omitempty"`          // Retrieve policy version numbers for the given scope
	ScopeWirelessSegment string `url:"scopeWirelessSegment,omitempty"` // Retrieve policy version numbers for the given scopeWirelessSegment
	Offset               string `url:"offset,omitempty"`               // Starting index of the resources (1 based)
	Limit                string `url:"limit,omitempty"`                // Number of resources to return
}

GetPolicyVersionNumbersQueryParams is ...

type GetScalableGroupByFiltersQueryParams

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

GetScalableGroupByFiltersQueryParams is ...

type GetSegmentInfoQueryParams

type GetSegmentInfoQueryParams struct {
	Type      string `url:"type,omitempty"`      // Type of segment
	PolicyTag string `url:"policyTag,omitempty"` // Policy tag
}

GetSegmentInfoQueryParams is ...

type GetTagsQueryParams

type GetTagsQueryParams struct {
	ResourceType string `url:"resourceType,omitempty"` // Type of resource (network-device)
	ResourceID   string `url:"resourceId,omitempty"`   // Resource ID
}

GetTagsQueryParams is ...

type GetUsersQueryParams

type GetUsersQueryParams struct {
	AuthSource string `url:"authSource,omitempty"` // authSource
}

GetUsersQueryParams is ...

type GlobalCredentialDTO

type GlobalCredentialDTO struct {
	Description    string `json:"description,omitempty"`    // Description of the credential
	Comments       string `json:"comments,omitempty"`       // Comments to identify the credential
	CredentialType string `json:"credentialType,omitempty"` // Credential type to identify the application that uses the credential
	InstanceUUID   string `json:"instanceUuid,omitempty"`
	ID             string `json:"id,omitempty"`
}

GlobalCredentialDTO is ...

type GlobalCredentialListResult

type GlobalCredentialListResult struct {
	Version  string                `json:"version,omitempty"`
	Response []GlobalCredentialDTO `json:"response,omitempty"`
}

GlobalCredentialListResult is ...

type GlobalCredentialService

type GlobalCredentialService service

GlobalCredentialService is an interface with the GlobalCredential API

func (*GlobalCredentialService) AddCliCredential

func (s *GlobalCredentialService) AddCliCredential(globalCredentialNioList *[]CliCredentialDTO, scope string) (*TaskIDResult, *Response, error)

AddCliCredential is ... This method is used to add global CLI credential

  • @param scope Authorization Scope for RBAC
  • @param globalCredentialNioList List of CLI credentials

* @return *TaskIDResult

func (*GlobalCredentialService) AddSnmpReadCommunity

func (s *GlobalCredentialService) AddSnmpReadCommunity(globalCredentialNioList []SNMPv2ReadCommunityDTO, scope string) (*TaskIDResult, *Response, error)

AddSnmpReadCommunity is ... This method is used to add global SNMP read community

  • @param scope Authorization Scope for RBAC
  • @param globalCredentialNioList List of SNMP read communities

* @return *TaskIDResult

func (*GlobalCredentialService) AddSnmpWriteCommunity

func (s *GlobalCredentialService) AddSnmpWriteCommunity(globalCredentialNioList []SNMPv2WriteCommunityDTO, scope string) (*TaskIDResult, *Response, error)

AddSnmpWriteCommunity is ... This method is used to add global SNMP write community

  • @param scope Authorization Scope for RBAC
  • @param globalCredentialNioList List of SNMP write communities

* @return *TaskIDResult

func (*GlobalCredentialService) AddSnmpv3Credential

func (s *GlobalCredentialService) AddSnmpv3Credential(globalCredentialNioList []SNMPv3CredentialDTO, scope string) (*TaskIDResult, *Response, error)

AddSnmpv3Credential is ... This method is used to add global SNMPv3 credential

  • @param scope Authorization Scope for RBAC
  • @param globalCredentialNioList List of SNMPv3 credentials

* @return *TaskIDResult

func (*GlobalCredentialService) DeleteGlobalCredential

func (s *GlobalCredentialService) DeleteGlobalCredential(globalCredentialID string, scope string) (*TaskIDResult, *Response, error)

DeleteGlobalCredential is ... This method is used to delete global credential for the given ID

  • @param scope Authorization Scope for RBAC

* @return *TaskIDResult

func (*GlobalCredentialService) GetGlobalCredential

GetGlobalCredential is ... This method is used to get global credential for the given credential sub type

  • @param queryParams
  • @param scope Authorization Scope for RBAC

* @return *GlobalCredentialListResult

func (*GlobalCredentialService) GetGlobalCredentialSubTypeByID

func (s *GlobalCredentialService) GetGlobalCredentialSubTypeByID(id string, scope string) (*GlobalCredentialSubTypeResult, *Response, error)

GetGlobalCredentialSubTypeByID is ... This method is used to get credential sub type for the given ID

  • @param scope Authorization Scope for RBAC

* @return *GlobalCredentialSubTypeResult

type GlobalCredentialSubTypeResult

type GlobalCredentialSubTypeResult struct {
	Version  string `json:"version,omitempty"`
	Response string `json:"response,omitempty"`
}

GlobalCredentialSubTypeResult is ...

type HashMapstringIPGeoModel

type HashMapstringIPGeoModel struct {
}

HashMapstringIPGeoModel is ...

type HostDto

type HostDto struct {
	HostName                        string `json:"hostName,omitempty"`                        // Name of the host
	Source                          string `json:"source,omitempty"`                          // Source from which the host gets collected. Available option:200 for inventory collection and 300 for trap based data collection
	LastUpdated                     string `json:"lastUpdated,omitempty"`                     // Time when the host info last got updated
	VlanID                          string `json:"vlanId,omitempty"`                          // Vlan Id of the host
	AvgUpdateFrequency              string `json:"avgUpdateFrequency,omitempty"`              // Frequency in which host info gets updated
	HostMac                         string `json:"hostMac,omitempty"`                         // Mac address of the host
	HostType                        string `json:"hostType,omitempty"`                        // Type of the host. Available options are: Wired, Wireless
	PointOfAttachment               string `json:"pointOfAttachment,omitempty"`               // Id of the Host's Point of attachment network device (wlc). Based on mobility
	PointOfPresence                 string `json:"pointOfPresence,omitempty"`                 // Id of the Host's Point of presence network device (wlc). Based on mobility
	HostIP                          string `json:"hostIp,omitempty"`                          // Ip address of the host
	ConnectedAPMacAddress           string `json:"connectedAPMacAddress,omitempty"`           // Mac address of the AP to which wireless host gets connected
	ConnectedAPName                 string `json:"connectedAPName,omitempty"`                 // Name of the AP to which wireless host gets connected
	ConnectedInterfaceID            string `json:"connectedInterfaceId,omitempty"`            // Id of the interface to which host gets connected
	ConnectedInterfaceName          string `json:"connectedInterfaceName,omitempty"`          // Name of the interface to which host gets connected
	ConnectedNetworkDeviceID        string `json:"connectedNetworkDeviceId,omitempty"`        // Id of the network device to which host gets connected
	ConnectedNetworkDeviceIPAddress string `json:"connectedNetworkDeviceIpAddress,omitempty"` // Ip address of the network device to which host gets connected
	AttributeInfo                   string `json:"attributeInfo,omitempty"`
	ID                              string `json:"id,omitempty"`
}

HostDto is ...

type HostListResult

type HostListResult struct {
	Version  string    `json:"version,omitempty"`
	Response []HostDto `json:"response,omitempty"`
}

HostListResult is ...

type HostResult

type HostResult struct {
	Version  string  `json:"version,omitempty"`
	Response HostDto `json:"response,omitempty"`
}

HostResult is ...

type HostService

type HostService service

HostService is an interface with the Host API

func (*HostService) GetHostByID

func (s *HostService) GetHostByID(id string, scope string) (*HostResult, *Response, error)

GetHostByID is ... Get host by id

  • @param scope Authorization Scope for RBAC

* @return *HostResult

func (*HostService) GetHostCount

func (s *HostService) GetHostCount(scope string) (*CountResult, *Response, error)

GetHostCount is ... Get host Count

  • @param scope Authorization Scope for RBAC

* @return *CountResult

func (*HostService) GetHosts

func (s *HostService) GetHosts(scope string, queryParams *GetHostsQueryParams) (*HostListResult, *Response, error)

GetHosts is ... Get Hosts

  • @param queryParams
  • @param scope Authorization Scope for RBAC

* @return *HostListResult

type IDRef

type IDRef struct {
	URL      string      `json:"url,omitempty"`
	ID       int64       `json:"id,omitempty"`
	Type     string      `json:"type,omitempty"`
	LongType ClassObject `json:"longType,omitempty"`
}

IDRef is ...

type IPGeoModel

type IPGeoModel struct {
	Latitude        string `json:"latitude,omitempty"`
	Longitude       string `json:"longitude,omitempty"`
	City            string `json:"city,omitempty"`
	Continent       string `json:"continent,omitempty"`
	SubDivision     string `json:"subDivision,omitempty"`
	SubDivisionCode string `json:"subDivisionCode,omitempty"`
	CountryCode     string `json:"countryCode,omitempty"`
	ContinentCode   string `json:"continentCode,omitempty"`
	Country         string `json:"country,omitempty"`
}

IPGeoModel is ...

type IPGeoModelResult

type IPGeoModelResult struct {
	Version  string                  `json:"version,omitempty"`
	Response HashMapstringIPGeoModel `json:"response,omitempty"`
}

IPGeoModelResult is ...

type IPGeoService

type IPGeoService service

IPGeoService is an interface with the IPgeowanIP API

func (*IPGeoService) GetCityInfo

func (s *IPGeoService) GetCityInfo(wanIP string, scope string) (*IPGeoModelResult, *Response, error)

GetCityInfo is ... This method is used to get the location details for a list of space-separated WAN IP addresses.

  • @param scope Authorization Scope for RBAC

* @return *IPGeoModelResult

type IPPoolInfo

type IPPoolInfo struct {
	Role                           string   `json:"role,omitempty"`                           // Used to group IP Address Pools
	CreateTime                     int64    `json:"createTime,omitempty"`                     // IP Address Pool creation time
	ID                             string   `json:"id,omitempty"`                             // UUID of IP Address Pool
	StartAddress                   string   `json:"startAddress,omitempty"`                   // First IP address in IP Address Pool
	NextAddress                    string   `json:"nextAddress,omitempty"`                    // Next available IP address in IP Address Pool
	EndAddress                     string   `json:"endAddress,omitempty"`                     // Last IP address in IP Address Pool
	IPPool                         string   `json:"ipPool,omitempty"`                         // IP subnet in CIDR format
	ApicAppName                    string   `json:"apicAppName,omitempty"`                    // APIC-EM App Name
	ExcludeNetworkBroadcastAddress bool     `json:"excludeNetworkBroadcastAddress,omitempty"` // If true then network and broadcast IP address will not be used in the usable range. Default value is false
	IPPoolName                     string   `json:"ipPoolName,omitempty"`                     // IP Address Pool name
	DHCPServerIP                   []string `json:"dhcpServerIp,omitempty"`                   // DHCP server hostname or IP address list
	Gateway                        []string `json:"gateway,omitempty"`                        // Gateway IP address list
	InterAppOverlap                bool     `json:"interAppOverlap,omitempty"`                // If true then overlapping IP pool is supported between APIC-EM Apps. Default value is false
	CreationOrder                  int32    `json:"creationOrder,omitempty"`                  // Creation order of IP Address Pool
	LastUpdateTime                 int64    `json:"lastUpdateTime,omitempty"`                 // IP Address Pool last updated time
	ParentID                       string   `json:"parentId,omitempty"`                       // Parent IP Address Pool UUID
	FreeIPCount                    int32    `json:"freeIpCount,omitempty"`                    // IP Address Pool free IP count
	UsagePercentage                int32    `json:"usagePercentage,omitempty"`                // Current usage percentage of IP Address Pool
	Shared                         bool     `json:"shared,omitempty"`                         // If true then duplicate/overlapping pool is supported. Default value is false
}

IPPoolInfo is ...

type IPPoolInfoListResult

type IPPoolInfoListResult struct {
	Version  string       `json:"version,omitempty"`
	Response []IPPoolInfo `json:"response,omitempty"`
}

IPPoolInfoListResult is ...

type IPPoolInfoResult

type IPPoolInfoResult struct {
	Version  string     `json:"version,omitempty"`
	Response IPPoolInfo `json:"response,omitempty"`
}

IPPoolInfoResult is ...

type IPPoolService

type IPPoolService service

IPPoolService is an interface with the IPPool API

func (*IPPoolService) CreateIPPool

func (s *IPPoolService) CreateIPPool(ipPoolInfoList *[]IPPoolInfo, scope string, username string) (*TaskIDResult, *Response, error)

CreateIPPool is ... This API is used to create global IP address pool(s).

  • @param scope Authorization Scope for RBAC * @param username requestorUsername
  • @param ipPoolInfoList List of IPPoolInfo objects

* @return *TaskIDResult

func (*IPPoolService) DeleteIPPool

func (s *IPPoolService) DeleteIPPool(id string, scope string, username string) (*TaskIDResult, *Response, error)

DeleteIPPool is ... This API is used to delete global IP address pool based on its ID.

  • @param scope Authorization Scope for RBAC * @param username requestorUsername

* @return *TaskIDResult

func (*IPPoolService) Get

func (s *IPPoolService) Get(id string, scope string) (*IPPoolInfoResult, *Response, error)

Get is ... This API is used to retrieve IP address pool based on its ID

  • @param scope Authorization Scope for RBAC

* @return *IPPoolInfoResult

func (*IPPoolService) GetCount

func (s *IPPoolService) GetCount(scope string) (*CountResult, *Response, error)

GetCount is ... This API is used to retrieve the number of configured IP address pools

  • @param scope Authorization Scope for RBAC

* @return *CountResult

func (*IPPoolService) GetList

func (s *IPPoolService) GetList(scope string, queryParams *GetListQueryParams) (*IPPoolInfoListResult, *Response, error)

GetList is ... This API is used to retrieve list of configured IP address pools.

  • @param queryParams
  • @param scope Authorization Scope for RBAC

* @return *IPPoolInfoListResult

type IdentityAuthFileInfoDto

type IdentityAuthFileInfoDto struct {
	FileID   string `json:"fileId,omitempty"`   // fileId
	FileType string `json:"fileType,omitempty"` // fileType
	ID       string `json:"id,omitempty"`       // id
	FileName string `json:"fileName,omitempty"` // fileName
}

IdentityAuthFileInfoDto is ...

type IdentityAuthFileInfoListResult

type IdentityAuthFileInfoListResult struct {
	Response []IdentityAuthFileInfoDto `json:"response,omitempty"`
	Version  string                    `json:"version,omitempty"`
}

IdentityAuthFileInfoListResult is ...

type ImportCertificateP12QueryParams

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

ImportCertificateP12QueryParams is ...

type ImportCertificateQueryParams

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

ImportCertificateQueryParams is ...

type InetAddress

type InetAddress struct {
	Address       string `json:"address,omitempty"`
	Octets        []byte `json:"octets,omitempty"`
	PaddedAddress string `json:"paddedAddress,omitempty"`
	AddressType   string `json:"addressType,omitempty"`
	AllZeros      bool   `json:"allZeros,omitempty"`
	AllOnes       bool   `json:"allOnes,omitempty"`
}

InetAddress is ...

type Interface

type Interface struct {
	Name                                  string                  `json:"name,omitempty"`        // Name of interface on a device
	ID                                    string                  `json:"id,omitempty"`          // ID of interface on a device
	VrfName                               string                  `json:"vrfName,omitempty"`     // Name of VRF that the interface on a device belongs to
	AclAnalysis                           AclAnalysisResponse     `json:"aclAnalysis,omitempty"` // Analysis of ACLs on an interface of a device
	QosStatsCollectionFailureReason       string                  `json:"qosStatsCollectionFailureReason,omitempty"`
	InterfaceStatistics                   InterfaceStatistics     `json:"interfaceStatistics,omitempty"`
	QosStatistics                         []QosClassMapStatistics `json:"qosStatistics,omitempty"`
	InterfaceStatsCollection              string                  `json:"interfaceStatsCollection,omitempty"` // A status value from [ INPROGRESS, SUCCESS, FAILED ]
	InterfaceStatsCollectionFailureReason string                  `json:"interfaceStatsCollectionFailureReason,omitempty"`
	QosStatsCollection                    string                  `json:"qosStatsCollection,omitempty"` // A status value from [ INPROGRESS, SUCCESS, FAILED ]
}

Interface is ...

type InterfaceContainer

type InterfaceContainer struct {
	VirtualInterface  []Interface `json:"virtualInterface,omitempty"`  // A list of Virtual interface IDs on a device
	PhysicalInterface Interface   `json:"physicalInterface,omitempty"` // ID of Physical interface on a device
}

InterfaceContainer is ...

type InterfaceService

type InterfaceService service

InterfaceService is an interface with the Interface API

func (*InterfaceService) GetInterface

func (s *InterfaceService) GetInterface(scope string) (*DeviceIfListResult, *Response, error)

GetInterface is ... Gets all available interfaces with a maximum limit of 500

  • @param scope Authorization Scope for RBAC

* @return *DeviceIfListResult

func (*InterfaceService) GetInterfaceByDeviceID

func (s *InterfaceService) GetInterfaceByDeviceID(deviceID string, scope string) (*DeviceIfListResult, *Response, error)

GetInterfaceByDeviceID is ... Gets list of interfaces for the given device

  • @param scope Authorization Scope for RBAC

* @return *DeviceIfListResult

func (*InterfaceService) GetInterfaceByDeviceIDAndName

func (s *InterfaceService) GetInterfaceByDeviceIDAndName(deviceID string, scope string, queryParams *GetInterfaceByDeviceIDAndNameQueryParams) (*DeviceIfResult, *Response, error)

GetInterfaceByDeviceIDAndName is ... Gets the interface for the given device ID and for the given interface name

  • @param queryParams
  • @param scope Authorization Scope for RBAC

* @return *DeviceIfResult

func (*InterfaceService) GetInterfaceByID

func (s *InterfaceService) GetInterfaceByID(id string, scope string) (*DeviceIfResult, *Response, error)

GetInterfaceByID is ... Gets the interface for the given interface ID

  • @param scope Authorization Scope for RBAC

* @return *DeviceIfResult

func (*InterfaceService) GetInterfaceByIsis

func (s *InterfaceService) GetInterfaceByIsis(scope string) (*DeviceIfListResult, *Response, error)

GetInterfaceByIsis is ... Gets the interfaces that has ISIS enabled

  • @param scope Authorization Scope for RBAC

* @return *DeviceIfListResult

func (*InterfaceService) GetInterfaceByOspf

func (s *InterfaceService) GetInterfaceByOspf(scope string) (*DeviceIfListResult, *Response, error)

GetInterfaceByOspf is ... Gets the interfaces that has OSPF enabled

  • @param scope Authorization Scope for RBAC

* @return *DeviceIfListResult

func (*InterfaceService) GetInterfaceCount

func (s *InterfaceService) GetInterfaceCount(scope string) (*CountResult, *Response, error)

GetInterfaceCount is ... Gets the count of interfaces for all devices

  • @param scope Authorization Scope for RBAC

* @return *CountResult

func (*InterfaceService) GetInterfaceCountByDevice

func (s *InterfaceService) GetInterfaceCountByDevice(deviceID string, scope string) (*CountResult, *Response, error)

GetInterfaceCountByDevice is ... Gets the interface count for the given device

  • @param scope Authorization Scope for RBAC

* @return *CountResult

func (*InterfaceService) GetInterfaceListByIP

func (s *InterfaceService) GetInterfaceListByIP(ipAddress string, scope string) (*DeviceIfListResult, *Response, error)

GetInterfaceListByIP is ... Gets list of interfaces with the given IP address

  • @param scope Authorization Scope for RBAC

* @return *DeviceIfListResult

func (*InterfaceService) GetInterfaceRangeByDevice

func (s *InterfaceService) GetInterfaceRangeByDevice(deviceID string, startIndex int32, recordsToReturn int32, scope string) (*DeviceIfListResult, *Response, error)

GetInterfaceRangeByDevice is ... Gets list of interfaces for the device and for the given range

  • @param scope Authorization Scope for RBAC

* @return *DeviceIfListResult

type InterfaceStatistics

type InterfaceStatistics struct {
	AdminStatus        string `json:"adminStatus,omitempty"`
	RefreshedAt        int64  `json:"refreshedAt,omitempty"`
	InputPackets       int64  `json:"inputPackets,omitempty"`
	InputQueueCount    int32  `json:"inputQueueCount,omitempty"`
	OutputDrop         int64  `json:"outputDrop,omitempty"`
	InputQueueDrops    int64  `json:"inputQueueDrops,omitempty"`
	InputQueueFlushes  int64  `json:"inputQueueFlushes,omitempty"`
	InputQueueMaxDepth int32  `json:"inputQueueMaxDepth,omitempty"`
	InputRatebps       int64  `json:"inputRatebps,omitempty"`
	OperationalStatus  string `json:"operationalStatus,omitempty"`
	OutputPackets      int64  `json:"outputPackets,omitempty"`
	OutputQueueCount   int32  `json:"outputQueueCount,omitempty"`
	OutputQueueDepth   int32  `json:"outputQueueDepth,omitempty"`
	OutputRatebps      int64  `json:"outputRatebps,omitempty"`
}

InterfaceStatistics is ...

type InventoryRequest

type InventoryRequest struct {
	SnmpROCommunity        string   `json:"snmpROCommunity,omitempty"`        // Snmp RO community of the devices to be discovered
	SnmpRWCommunity        string   `json:"snmpRWCommunity,omitempty"`        // Snmp RW community of the devices to be discovered
	SnmpUserName           string   `json:"snmpUserName,omitempty"`           // SNMP username of the device
	Name                   string   `json:"name,omitempty"`                   // Name for discovery
	EnablePasswordList     []string `json:"enablePasswordList,omitempty"`     // Enable Password of the devices to be discovered
	PasswordList           []string `json:"passwordList,omitempty"`           // Password of the devices to be discovered
	UserNameList           []string `json:"userNameList,omitempty"`           // Username of the devices to be discovered
	ProtocolOrder          string   `json:"protocolOrder,omitempty"`          // Order of protocol in which device connection establishment to be tried
	CdpLevel               int32    `json:"cdpLevel,omitempty"`               // CDP level to which neighbor devices to be discovered
	GlobalCredentialIDList []string `json:"globalCredentialIdList,omitempty"` // List of global credential ids to be used
	IPFilterList           []string `json:"ipFilterList,omitempty"`           // Username of the devices to be discovered
	SnmpAuthProtocol       string   `json:"snmpAuthProtocol,omitempty"`       // SNMP auth protocol. Available values:'SHA' or 'MD5'
	SnmpAuthPassphrase     string   `json:"snmpAuthPassphrase,omitempty"`     // Auth Pass phrase for SNMP
	SnmpPrivProtocol       string   `json:"snmpPrivProtocol,omitempty"`       // SNMP privacy protocol. Available values:'DES' or 'AES128'
	SnmpPrivPassphrase     string   `json:"snmpPrivPassphrase,omitempty"`     // Pass phrase for SNMP privacy
	ReDiscovery            bool     `json:"reDiscovery,omitempty"`            // Flag to indicate is rediscovery or not
	Retry                  int32    `json:"retry,omitempty"`                  // Number of times to try establishing connection to device
	Timeout                int32    `json:"timeout,omitempty"`                // Time to wait for device response in seconds
	DiscoveryType          string   `json:"discoveryType,omitempty"`          // Available types are: single, auto cdp discovery, range, multi range
	IPAddressList          string   `json:"ipAddressList,omitempty"`          // IP address of the device to be discovered
	SnmpVersion            string   `json:"snmpVersion,omitempty"`            // Version of SNMP. Can be v2 or v3
	SnmpMode               string   `json:"snmpMode,omitempty"`               // Mode of SNMP. Available values:'AUTHPRIV' or 'AUTHNOPRIV' or 'NOAUTHNOPRIV'
}

InventoryRequest is ...

type Iteratorstring

type Iteratorstring struct {
}

Iteratorstring is ...

type LicenseInfoDto

type LicenseInfoDto struct {
	Description             string `json:"description,omitempty"`             // Description about the license
	Name                    string `json:"name,omitempty"`                    // Name of the license feature
	Priority                string `json:"priority,omitempty"`                // License priority
	Type                    string `json:"type,omitempty"`                    // License type
	Status                  string `json:"status,omitempty"`                  // Status of the license
	DeployPending           int32  `json:"deployPending,omitempty"`           // Deploy Pending information of license
	TotalCount              int32  `json:"totalCount,omitempty"`              // Number of license installed in the device
	ParentID                int32  `json:"parentId,omitempty"`                // Parent Id of the license
	ProvisionState          int32  `json:"provisionState,omitempty"`          // Provision state of the license feature
	PhysicalIndex           string `json:"physicalIndex,omitempty"`           // Physical entity index
	LicenseIndex            int32  `json:"licenseIndex,omitempty"`            // Index of the license
	FeatureVersion          string `json:"featureVersion,omitempty"`          // Version of the license feature
	Counted                 bool   `json:"counted,omitempty"`                 // If license feature is counted as part of the license
	ValidityPeriod          int64  `json:"validityPeriod,omitempty"`          // Validity period the the license
	ValidityPeriodRemaining int64  `json:"validityPeriodRemaining,omitempty"` // Remaining validityPeriod
	MaxUsageCount           int64  `json:"maxUsageCount,omitempty"`           // Maximum usage of the license feature
	UsageCount              int32  `json:"usageCount,omitempty"`              // Usage count of the license feature
	EulaStatus              bool   `json:"eulaStatus,omitempty"`              // EULA status of the license
	UsageCountRemaining     int64  `json:"usageCountRemaining,omitempty"`     // Unused license count
	ExpiredPeriod           int32  `json:"expiredPeriod,omitempty"`           // License expired period
	EvalPeriodLeft          string `json:"evalPeriodLeft,omitempty"`          // Number of days remaining in the eval period
	EvalPeriodUsed          string `json:"evalPeriodUsed,omitempty"`          // Number of days used in the eval period
	ExpiredDate             string `json:"expiredDate,omitempty"`             // Expired date of the license
	IsCounted               bool   `json:"isCounted,omitempty"`               // If the license is counted as part of license usage
	IsEulaAccepted          bool   `json:"isEulaAccepted,omitempty"`          // If the EULA is accepted
	IsEulaApplicable        bool   `json:"isEulaApplicable,omitempty"`        // If the EULA is applicable
	IsTechnologyLicense     bool   `json:"isTechnologyLicense,omitempty"`     // If the license is technology license or not
	LicenseFileCount        int32  `json:"licenseFileCount,omitempty"`        // Number of license file
	LicenseFileName         string `json:"licenseFileName,omitempty"`         // Name of license file
	StoreName               string `json:"storeName,omitempty"`               // Name of the license Store
	StoredUsed              int32  `json:"storedUsed,omitempty"`              // License store usage detail
	HostID                  string `json:"hostId,omitempty"`                  // Device Id/Name of the license info
	AttributeInfo           string `json:"attributeInfo,omitempty"`
}

LicenseInfoDto is ...

type LicenseInfoListResult

type LicenseInfoListResult struct {
	Version  string           `json:"version,omitempty"`
	Response []LicenseInfoDto `json:"response,omitempty"`
}

LicenseInfoListResult is ...

type LicenseService

type LicenseService service

LicenseService is an interface with the API

func (*LicenseService) GetDeviceIDByFilename

func (s *LicenseService) GetDeviceIDByFilename(licenseFileName string, scope string) (*SuccessResultList, *Response, error)

GetDeviceIDByFilename is ... Gets the list of devices with licensefilename

  • @param scope Authorization Scope for RBAC

* @return *SuccessResultList

func (*LicenseService) GetLicenseInfo

func (s *LicenseService) GetLicenseInfo(scope string, deviceID string, queryParams *GetLicenseInfoQueryParams) (*LicenseInfoListResult, *Response, error)

GetLicenseInfo is ... Gets the list of licenses for network device with given filters

  • @param queryParams
  • @param scope Authorization Scope for RBAC

* @return *LicenseInfoListResult

func (*LicenseService) GetLicenseInfoCount

func (s *LicenseService) GetLicenseInfoCount(scope string, deviceID string, queryParams *GetLicenseInfoCountQueryParams) (*CountResult, *Response, error)

GetLicenseInfoCount is ... Gets the list of licenses for network device with given filters

  • @param queryParams
  • @param scope Authorization Scope for RBAC

* @return *CountResult

type LinkWrapper struct {
	Target               string `json:"target,omitempty"`               // Device ID corresponding to the target device
	Source               string `json:"source,omitempty"`               // Device ID correspondng to the source device
	Tag                  string `json:"tag,omitempty"`                  // Tag for the devices
	Id                   string `json:"id,omitempty"`                   // Unified identifier for device
	StartPortID          string `json:"startPortID,omitempty"`          // Device port ID corresponding to start devices
	EndPortID            string `json:"endPortID,omitempty"`            // Device port ID corresponding to end devices
	LinkStatus           string `json:"linkStatus,omitempty"`           // Indicates whether link is working
	EndPortName          string `json:"endPortName,omitempty"`          // Interface port name corresponding to end devices
	EndPortSpeed         string `json:"endPortSpeed,omitempty"`         // Interface port speed corresponding to end devices
	StartPortName        string `json:"startPortName,omitempty"`        // Interface port name corresponding to start devices
	StartPortSpeed       string `json:"startPortSpeed,omitempty"`       // Interface port speed corresponding to start devices
	GreyOut              bool   `json:"greyOut,omitempty"`              // Device greyout
	EndPortIpv4Address   string `json:"endPortIpv4Address,omitempty"`   // Interface port IPv4 address corresponding to end devices
	EndPortIpv4Mask      string `json:"endPortIpv4Mask,omitempty"`      // Interface port IPv4 mask corresponding to end devices
	StartPortIpv4Address string `json:"startPortIpv4Address,omitempty"` // Interface port IPv4 address corresponding to start devices
	StartPortIpv4Mask    string `json:"startPortIpv4Mask,omitempty"`    // Interface port IPv4 mask corresponding to start devices
	AttributeInfo        string `json:"attributeInfo,omitempty"`
}

LinkWrapper is ...

type ListAlarmDtoResponse

type ListAlarmDtoResponse struct {
	Version  string     `json:"version,omitempty"`
	Response []AlarmDto `json:"response,omitempty"`
}

ListAlarmDtoResponse is ...

type ListAuditResourceDtoResponse

type ListAuditResourceDtoResponse struct {
	Version  string                      `json:"version,omitempty"`
	Response []AugmentedAuditResourceDto `json:"response,omitempty"`
}

ListAuditResourceDtoResponse is ...

type ListOptions

type ListOptions struct {
	// For paginated result sets, page of results to retrieve.
	Page int `url:"page,omitempty"`

	// For paginated result sets, the number of results to include per page.
	PerPage int `url:"per_page,omitempty"`
}

ListOptions specifies the optional parameters to various List methods that support pagination.

type LocationNio

type LocationNio struct {
	CivicAddress        string `json:"civicAddress,omitempty"`        // Civic address of the location
	Description         string `json:"description,omitempty"`         // Description of the location
	LocationName        string `json:"locationName,omitempty"`        // Name of the location
	ID                  string `json:"id,omitempty"`                  // Unique identifier for location
	GeographicalAddress string `json:"geographicalAddress,omitempty"` // Geographic address of the location
	Tag                 string `json:"tag,omitempty"`                 // Tag associated with the location
}

LocationNio is ...

type LocationNioListResult

type LocationNioListResult struct {
	Version  string        `json:"version,omitempty"`
	Response []LocationNio `json:"response,omitempty"`
}

LocationNioListResult is ...

type LocationNioResult

type LocationNioResult struct {
	Version  string      `json:"version,omitempty"`
	Response LocationNio `json:"response,omitempty"`
}

LocationNioResult is ...

type LocationService

type LocationService service

LocationService is an interface with the API

func (*LocationService) AddLocation

func (s *LocationService) AddLocation(locationNIO LocationNio, scope string) (*TaskIDResult, *Response, error)

AddLocation is ... Creates a new location with the attributes given

  • @param scope Authorization Scope for RBAC
  • @param locationNIO Attributes of a location

* @return *TaskIDResult

func (*LocationService) DeleteLocationByID

func (s *LocationService) DeleteLocationByID(id string, scope string) (*TaskIDResult, *Response, error)

DeleteLocationByID is ... Deletes the location with the given ID

  • @param scope Authorization Scope for RBAC

* @return *TaskIDResult

func (*LocationService) GetAllLocation

func (s *LocationService) GetAllLocation(scope string) (*LocationNioListResult, *Response, error)

GetAllLocation is ... Gets list of locations

  • @param scope Authorization Scope for RBAC

* @return *LocationNioListResult

func (*LocationService) GetLocationByID

func (s *LocationService) GetLocationByID(id string, scope string) (*LocationNioResult, *Response, error)

GetLocationByID is ... Gets the location with the given ID

  • @param scope Authorization Scope for RBAC

* @return *LocationNioResult

func (*LocationService) GetLocationByName

func (s *LocationService) GetLocationByName(locationName string, scope string) (*LocationNioResult, *Response, error)

GetLocationByName is ... Gets the location with the given location name

  • @param scope Authorization Scope for RBAC

* @return *LocationNioResult

func (*LocationService) GetLocationByRange

func (s *LocationService) GetLocationByRange(startIndex int32, recordsToReturn int32, scope string) (*LocationNioListResult, *Response, error)

GetLocationByRange is ... Gets list of locations in the given range

  • @param scope Authorization Scope for RBAC

* @return *LocationNioListResult

func (*LocationService) GetLocationByTag

func (s *LocationService) GetLocationByTag(tagID string, scope string) (*LocationNioListResult, *Response, error)

GetLocationByTag is ... Gets list of locations associated with the given tag

  • @param scope Authorization Scope for RBAC

* @return *LocationNioListResult

func (*LocationService) GetLocationCount

func (s *LocationService) GetLocationCount(scope string) (*CountResult, *Response, error)

GetLocationCount is ... Gets the count of all locations

  • @param scope Authorization Scope for RBAC

* @return *CountResult

func (*LocationService) UpdateLocation

func (s *LocationService) UpdateLocation(locationNIO LocationNio, scope string) (*TaskIDResult, *Response, error)

UpdateLocation is ... Updates a location with the given attributes

  • @param scope Authorization Scope for RBAC
  • @param locationNIO Attributes of a location

* @return *TaskIDResult

func (*LocationService) UpdateLocationTag

func (s *LocationService) UpdateLocationTag(tagNIO TagNio, scope string) (*TaskIDResult, *Response, error)

UpdateLocationTag is ... Associates the given tag to the given location

  • @param scope Authorization Scope for RBAC
  • @param tagNIO TagNIO with tag ID and location ID

* @return *TaskIDResult

type MacAddress

type MacAddress struct {
	AllZeros bool   `json:"allZeros,omitempty"`
	AllOnes  bool   `json:"allOnes,omitempty"`
	Octets   []byte `json:"octets,omitempty"`
}

MacAddress is ...

type MemoryStatistics

type MemoryStatistics struct {
	MemoryUsage int64 `json:"memoryUsage,omitempty"`
	RefreshedAt int64 `json:"refreshedAt,omitempty"`
}

MemoryStatistics is ...

type Method

type Method struct {
	Modifiers             int32          `json:"modifiers,omitempty"`
	Name                  string         `json:"name,omitempty"`
	Synthetic             bool           `json:"synthetic,omitempty"`
	TypeParameters        []TypeVariable `json:"typeParameters,omitempty"`
	DeclaringClass        *ClassObject   `json:"declaringClass,omitempty"`
	DeclaredAnnotations   []Annotation   `json:"declaredAnnotations,omitempty"`
	ReturnType            *ClassObject   `json:"returnType,omitempty"`
	ParameterTypes        []Class        `json:"parameterTypes,omitempty"`
	GenericReturnType     Type           `json:"genericReturnType,omitempty"`
	GenericParameterTypes []Type         `json:"genericParameterTypes,omitempty"`
	ExceptionTypes        []Class        `json:"exceptionTypes,omitempty"`
	GenericExceptionTypes []Type         `json:"genericExceptionTypes,omitempty"`
	Bridge                bool           `json:"bridge,omitempty"`
	VarArgs               bool           `json:"varArgs,omitempty"`
	DefaultValue          string         `json:"defaultValue,omitempty"`
	ParameterAnnotations  []Annotation   `json:"parameterAnnotations,omitempty"` // Not sure about this type
	Annotations           []Annotation   `json:"annotations,omitempty"`
	Accessible            bool           `json:"accessible,omitempty"`
}

Method is ...

type NameSpaceListResult

type NameSpaceListResult struct {
	Version  string   `json:"version,omitempty"`
	Response []string `json:"response,omitempty"`
}

NameSpaceListResult is ...

type NeighborhoodDto

type NeighborhoodDto struct {
	Description          string   `json:"description,omitempty"`          // Description of the group
	ListofScalableGroups []string `json:"listofScalableGroups,omitempty"` // List of Scalable Groups
	Name                 string   `json:"name,omitempty"`                 // Neighborhood Name
	ID                   string   `json:"id,omitempty"`                   // UUID of the Neighborhood
	Type                 string   `json:"type,omitempty"`                 // Isolation Property
}

NeighborhoodDto is ...

type NeighborhoodListResult

type NeighborhoodListResult struct {
	Response []NeighborhoodDto `json:"response,omitempty"`
	Version  string            `json:"version,omitempty"`
}

NeighborhoodListResult is ...

type NeighborhoodResult

type NeighborhoodResult struct {
	Response NeighborhoodDto `json:"response,omitempty"`
	Version  string          `json:"version,omitempty"`
}

NeighborhoodResult is ...

type NeighborhoodService

type NeighborhoodService service

NeighborhoodService is an interface with the Neighborhood API

func (*NeighborhoodService) AddNeighbor

AddNeighbor is ... Create a Neighborhood

  • @param nbr Neighborhood Object

* @return *TaskIDResult

func (*NeighborhoodService) DeleteNeighbor

func (s *NeighborhoodService) DeleteNeighbor(id string) (*TaskIDResult, *Response, error)

DeleteNeighbor is ... Delete specific Neighborhood

* @return *TaskIDResult

func (*NeighborhoodService) GetAllNeighbors

func (s *NeighborhoodService) GetAllNeighbors() (*NeighborhoodListResult, *Response, error)

GetAllNeighbors is ... Get all Neighborhood(s)

* @return *NeighborhoodListResult

func (*NeighborhoodService) GetNeighbor

func (s *NeighborhoodService) GetNeighbor(id string) (*NeighborhoodResult, *Response, error)

GetNeighbor is ... Get specific Neighborhood

* @return *NeighborhoodResult

func (*NeighborhoodService) UpdateNeighbor

func (s *NeighborhoodService) UpdateNeighbor(nbr NeighborhoodDto) (*TaskIDResult, *Response, error)

UpdateNeighbor is ... Update a Neighborhood

  • @param nbr Neighborhood Object

* @return *TaskIDResult

type NetworkDeviceBrief

type NetworkDeviceBrief struct {
	ID       string `json:"id,omitempty"`
	HostName string `json:"hostName,omitempty"`
}

NetworkDeviceBrief is ...

type NetworkDeviceBriefNio

type NetworkDeviceBriefNio struct {
	ID         string `json:"id,omitempty"`         // Unique identifier of the network device
	Role       string `json:"role,omitempty"`       // Role of device as access, distribution, border router, core
	RoleSource string `json:"roleSource,omitempty"` // Role source as manual / auto
}

NetworkDeviceBriefNio is ...

type NetworkDeviceBriefNioResult

type NetworkDeviceBriefNioResult struct {
	Version  string                `json:"version,omitempty"`
	Response NetworkDeviceBriefNio `json:"response,omitempty"`
}

NetworkDeviceBriefNioResult is ...

type NetworkDeviceConfigService

type NetworkDeviceConfigService service

NetworkDeviceConfigService is an interface with the Networkdevice API

func (*NetworkDeviceConfigService) GetNetworkConfigCount

func (s *NetworkDeviceConfigService) GetNetworkConfigCount(scope string) (*CountResult, *Response, error)

GetNetworkConfigCount is ... Gets the count of device configs

  • @param scope Authorization Scope for RBAC

* @return *CountResult

func (*NetworkDeviceConfigService) GetRunningConfig

func (s *NetworkDeviceConfigService) GetRunningConfig(scope string) (*RawCliInfoNioListResult, *Response, error)

GetRunningConfig is ... Gets the config for all devices

  • @param scope Authorization Scope for RBAC

* @return *RawCliInfoNioListResult

func (*NetworkDeviceConfigService) GetRunningConfig1

func (s *NetworkDeviceConfigService) GetRunningConfig1(networkDeviceID string, scope string) (*SuccessResult, *Response, error)

GetRunningConfig1 is ... Gets the device config by device ID

  • @param scope Authorization Scope for RBAC

* @return *SuccessResult

type NetworkDeviceDto

type NetworkDeviceDto struct {
	Family                    string `json:"family,omitempty"`                // Family of device as switch, router, wireless lan controller, accesspoints
	Location                  string `json:"location,omitempty"`              // Location ID that is associated with the device
	Type                      string `json:"type,omitempty"`                  // Type of device as switch, router, wireless lan controller, accesspoints
	SerialNumber              string `json:"serialNumber,omitempty"`          // Serial number of device
	Role                      string `json:"role,omitempty"`                  // Role of device as access, distribution, border router, core
	MacAddress                string `json:"macAddress,omitempty"`            // MAC address of device
	UpTime                    string `json:"upTime,omitempty"`                // Time that shows for how long the device has been up
	SoftwareVersion           string `json:"softwareVersion,omitempty"`       // Software version on the device
	InventoryStatusDetail     string `json:"inventoryStatusDetail,omitempty"` // Status detail of inventory sync
	LastUpdateTime            int    `json:"lastUpdateTime,omitempty"`
	LocationName              string `json:"locationName,omitempty"`              // Name of the associated location
	LastUpdated               string `json:"lastUpdated,omitempty"`               // Time when the network device info last got updated
	TagCount                  string `json:"tagCount,omitempty"`                  // Number of tags associated with the device
	Hostname                  string `json:"hostname,omitempty"`                  // Device name
	ReachabilityFailureReason string `json:"reachabilityFailureReason,omitempty"` // Failure reason for unreachable devices
	ReachabilityStatus        string `json:"reachabilityStatus,omitempty"`        // Device reachability status as Reachable / Unreachable
	RoleSource                string `json:"roleSource,omitempty"`                // Role source as manual / auto
	Series                    string `json:"series,omitempty"`                    // Device series
	SnmpContact               string `json:"snmpContact,omitempty"`               // SNMP contact on device
	SnmpLocation              string `json:"snmpLocation,omitempty"`              // SNMP location on device
	TunnelUDPPort             string `json:"tunnelUdpPort,omitempty"`             // Mobility protocol port is stored as tunneludpport for WLC
	ApManagerInterfaceIP      string `json:"apManagerInterfaceIp,omitempty"`      // IP address of WLC on AP manager interface
	BootDateTime              string `json:"bootDateTime,omitempty"`              // Device boot time
	CollectionStatus          string `json:"collectionStatus,omitempty"`          // Collection status as Synchronizing, Could not synchronize, Not manageable, Managed, Partial Collection Failure, Incomplete, Unreachable, Wrong credential, Reachable, In Progress
	InterfaceCount            string `json:"interfaceCount,omitempty"`            // Number of interfaces on the device
	LineCardCount             string `json:"lineCardCount,omitempty"`             // Number of linecards on the device
	LineCardID                string `json:"lineCardId,omitempty"`                // IDs of linecards of the device
	ManagementIPAddress       string `json:"managementIpAddress,omitempty"`       // IP address of the device
	MemorySize                string `json:"memorySize,omitempty"`                // Processor memory size
	PlatformID                string `json:"platformId,omitempty"`                // Platform ID of device
	InstanceUUID              string `json:"instanceUuid,omitempty"`
	ID                        string `json:"id,omitempty"`
}

NetworkDeviceDto is ...

type NetworkDeviceListResult

type NetworkDeviceListResult struct {
	Version  string             `json:"version,omitempty"`
	Response []NetworkDeviceDto `json:"response,omitempty"`
}

NetworkDeviceListResult is ...

type NetworkDeviceManagementInfo

type NetworkDeviceManagementInfo struct {
	Family              string `json:"family,omitempty"`              // Family of device as switch, router, wireless lan controller, accesspoints
	ID                  string `json:"id,omitempty"`                  // Unique identifier of device
	Type                string `json:"type,omitempty"`                // Type of device as switch, router, wireless lan controller, accesspoints
	Hostname            string `json:"hostname,omitempty"`            // Device name
	Series              string `json:"series,omitempty"`              // Device series
	ManagementIPAddress string `json:"managementIpAddress,omitempty"` // IP address of the device
	Credentials         string `json:"credentials,omitempty"`         // Credential info
}

NetworkDeviceManagementInfo is ...

type NetworkDeviceNio

type NetworkDeviceNio struct {
	AnchorWlcForAp            string    `json:"anchorWlcForAp,omitempty"`            // Connected WLC device for AP
	AuthModelID               string    `json:"authModelId,omitempty"`               // Authentication model Id on device
	AvgUpdateFrequency        int32     `json:"avgUpdateFrequency,omitempty"`        // Frequency in which interface info gets updated
	BootDateTime              time.Time `json:"bootDateTime,omitempty"`              // Device boot time
	DuplicateDeviceID         string    `json:"duplicateDeviceId,omitempty"`         // Identifier of the duplicate ip of the same device discovered
	Family                    string    `json:"family,omitempty"`                    // Family of device as switch, router, wireless lan controller, accesspoints
	Hostname                  string    `json:"hostname,omitempty"`                  // Device name
	ID                        string    `json:"id,omitempty"`                        // Unique identifier of network device
	ImageName                 string    `json:"imageName,omitempty"`                 // Image details on the device
	IngressQueueConfig        string    `json:"ingressQueueConfig,omitempty"`        // Ingress queue config on device
	InterfaceCount            string    `json:"interfaceCount,omitempty"`            // Number of interfaces on the device
	LastUpdated               string    `json:"lastUpdated,omitempty"`               // Time when the network device info last got updated
	LineCardCount             string    `json:"lineCardCount,omitempty"`             // Number of linecards on the device
	LineCardID                string    `json:"lineCardId,omitempty"`                // IDs of linecards of the device
	Location                  string    `json:"location,omitempty"`                  // Location ID that is associated with the device
	LocationName              string    `json:"locationName,omitempty"`              // Name of the associated location
	MacAddress                string    `json:"macAddress,omitempty"`                // MAC address of device
	ManagementIPAddress       string    `json:"managementIpAddress,omitempty"`       // IP address of the device
	MemorySize                string    `json:"memorySize,omitempty"`                // Processor memory size
	NumUpdates                int32     `json:"numUpdates,omitempty"`                // Number of time network-device info got updated
	PlatformID                string    `json:"platformId,omitempty"`                // Platform ID of device
	PortRange                 string    `json:"portRange,omitempty"`                 // Range of ports on device
	QosStatus                 string    `json:"qosStatus,omitempty"`                 // Qos status on device
	ReachabilityFailureReason string    `json:"reachabilityFailureReason,omitempty"` // Failure reason for unreachable devices
	ReachabilityStatus        string    `json:"reachabilityStatus,omitempty"`        // Device reachability status as Reachable / Unreachable
	Role                      string    `json:"role,omitempty"`                      // Role of device as access, distribution, border router, core
	RoleSource                string    `json:"roleSource,omitempty"`                // Role source as manual / auto
	SerialNumber              string    `json:"serialNumber,omitempty"`              // Serial number of device
	SnmpContact               string    `json:"snmpContact,omitempty"`               // SNMP contact on device
	SnmpLocation              string    `json:"snmpLocation,omitempty"`              // SNMP location on device
	SoftwareVersion           string    `json:"softwareVersion,omitempty"`           // Software version on the device
	Tag                       string    `json:"tag,omitempty"`                       // Tag ID that is associated with the device
	TagCount                  int32     `json:"tagCount,omitempty"`                  // Number of tags associated with the device
	Type                      string    `json:"type,omitempty"`                      // Type of device as switch, router, wireless lan controller, accesspoints
	UpTime                    string    `json:"upTime,omitempty"`                    // Time that shows for how long the device has been up
	Vendor                    string    `json:"vendor,omitempty"`                    // Vendor information of the device
	WlcApDeviceStatus         string    `json:"wlcApDeviceStatus,omitempty"`         // Collection status of AP devices
}

NetworkDeviceNio is ...

type NetworkDeviceNioListResult

type NetworkDeviceNioListResult struct {
	Version  string             `json:"version,omitempty"`
	Response []NetworkDeviceNio `json:"response,omitempty"`
}

NetworkDeviceNioListResult is ...

type NetworkDeviceReachabilityInfoNio

type NetworkDeviceReachabilityInfoNio struct {
	SnmpCommunity             string `json:"snmpCommunity,omitempty"`             // SNMP community used for device connectivity
	MgmtIP                    string `json:"mgmtIp,omitempty"`                    // IP address of the device
	ProtocolList              string `json:"protocolList,omitempty"`              // Protocol order given for discovery
	ProtocolUsed              string `json:"protocolUsed,omitempty"`              // Protocol used for device discovery
	DiscoveryStartTime        string `json:"discoveryStartTime,omitempty"`        // Time when the discovery was started
	UserName                  string `json:"userName,omitempty"`                  // CLI username used for device connectivity
	Password                  string `json:"password,omitempty"`                  // CLI password used for device connectivity
	ID                        string `json:"id,omitempty"`                        // Unique identifier for reachability-info
	EnablePassword            string `json:"enablePassword,omitempty"`            // CLI enable password used for device connectivity
	DiscoveryID               string `json:"discoveryId,omitempty"`               // ID of discovery thorugh which device was discovered
	ReachabilityFailureReason string `json:"reachabilityFailureReason,omitempty"` // Reason for failure if the device is not discovered successfully
	ReachabilityStatus        string `json:"reachabilityStatus,omitempty"`        // Reachability status of the device as Reachable / Unreachable
	AttributeInfo             string `json:"attributeInfo,omitempty"`
}

NetworkDeviceReachabilityInfoNio is ...

type NetworkDeviceReachabilityInfoNioListResult

type NetworkDeviceReachabilityInfoNioListResult struct {
	Version  string                             `json:"version,omitempty"`
	Response []NetworkDeviceReachabilityInfoNio `json:"response,omitempty"`
}

NetworkDeviceReachabilityInfoNioListResult is ...

type NetworkDeviceReachabilityInfoNioResult

type NetworkDeviceReachabilityInfoNioResult struct {
	Version  string                           `json:"version,omitempty"`
	Response NetworkDeviceReachabilityInfoNio `json:"response,omitempty"`
}

NetworkDeviceReachabilityInfoNioResult is ...

type NetworkDeviceResult

type NetworkDeviceResult struct {
	Version  string           `json:"version,omitempty"`
	Response NetworkDeviceDto `json:"response,omitempty"`
}

NetworkDeviceResult is ...

type NetworkDeviceService

type NetworkDeviceService service

NetworkDeviceService is an interface with the Networkdevice API

func (*NetworkDeviceService) AddNetworkDeviceLocation

func (s *NetworkDeviceService) AddNetworkDeviceLocation(scope string, networkDeviceNIO NetworkDeviceNio) (*TaskIDResult, *Response, error)

AddNetworkDeviceLocation is ... Associates the given location to the given device

  • @param scope Authorization Scope for RBAC
  • @param networkDeviceNIO networkDeviceNIO

* @return *TaskIDResult

func (*NetworkDeviceService) DeleteDevicebyID

func (s *NetworkDeviceService) DeleteDevicebyID(id string, scope string) (*TaskIDResult, *Response, error)

DeleteDevicebyID is ... Removes the network device for the given ID

  • @param scope Authorization Scope for RBAC

* @return *TaskIDResult

func (*NetworkDeviceService) DeleteNetworkLocationByID

func (s *NetworkDeviceService) DeleteNetworkLocationByID(id string, scope string) (*TaskIDResult, *Response, error)

DeleteNetworkLocationByID is ... Removes the association between device and location for the given device

  • @param scope Authorization Scope for RBAC

* @return *TaskIDResult

func (*NetworkDeviceService) GetAllNetworkDevice

func (s *NetworkDeviceService) GetAllNetworkDevice(scope string) (*NetworkDeviceListResult, *Response, error)

GetAllNetworkDevice is ... Gets the list of network devices filtered using management IP address, mac address, hostname and location name

  • @param scope Authorization Scope for RBAC

* @return *string

func (*NetworkDeviceService) GetNetworkDeviceBrief

func (s *NetworkDeviceService) GetNetworkDeviceBrief(id string, scope string) (*NetworkDeviceBriefNioResult, *Response, error)

GetNetworkDeviceBrief is ... Gets brief network device info such as hostname, management IP address for the given device ID

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceBriefNioResult

func (*NetworkDeviceService) GetNetworkDeviceByID

func (s *NetworkDeviceService) GetNetworkDeviceByID(id string, scope string) (*NetworkDeviceResult, *Response, error)

GetNetworkDeviceByID is ... Gets the network device for the given device ID

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceResult

func (*NetworkDeviceService) GetNetworkDeviceByIP

func (s *NetworkDeviceService) GetNetworkDeviceByIP(ipAddress string, scope string) (*NetworkDeviceResult, *Response, error)

GetNetworkDeviceByIP is ... Gets the network device with the given IP address

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceResult

func (*NetworkDeviceService) GetNetworkDeviceByLocationByRange

func (s *NetworkDeviceService) GetNetworkDeviceByLocationByRange(locationID string, startIndex int32, recordsToReturn int32, scope string) (*NetworkDeviceListResult, *Response, error)

GetNetworkDeviceByLocationByRange is ... Gets network devices associated with the given location in the given range

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceListResult

func (*NetworkDeviceService) GetNetworkDeviceByLocationID

func (s *NetworkDeviceService) GetNetworkDeviceByLocationID(locationID string, scope string) (*NetworkDeviceListResult, *Response, error)

GetNetworkDeviceByLocationID is ... Gets list of network devices that are associated with the given location

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceListResult

func (*NetworkDeviceService) GetNetworkDeviceBySerialNumber

func (s *NetworkDeviceService) GetNetworkDeviceBySerialNumber(serialNumber string, scope string) (*NetworkDeviceResult, *Response, error)

GetNetworkDeviceBySerialNumber is ... Gets the network device with the given serial number

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceResult

func (*NetworkDeviceService) GetNetworkDeviceCount

func (s *NetworkDeviceService) GetNetworkDeviceCount(scope string) (*CountResult, *Response, error)

GetNetworkDeviceCount is ... Gets the count of network devices filtered by management IP address, mac address, hostname and location name

  • @param scope Authorization Scope for RBAC

* @return *CountResult

func (*NetworkDeviceService) GetNetworkDeviceLocation

func (s *NetworkDeviceService) GetNetworkDeviceLocation(scope string) (*NetworkDeviceListResult, *Response, error)

GetNetworkDeviceLocation is ... Gets the list of network devices that has a location

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceListResult

func (*NetworkDeviceService) GetNetworkDeviceLocationByID

func (s *NetworkDeviceService) GetNetworkDeviceLocationByID(id string, scope string) (*NetworkDeviceResult, *Response, error)

GetNetworkDeviceLocationByID is ... Gets the location for the given device ID

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceResult

func (*NetworkDeviceService) GetNetworkDeviceLocationByRange

func (s *NetworkDeviceService) GetNetworkDeviceLocationByRange(startIndex int32, recordsToReturn int32, scope string) (*NetworkDeviceListResult, *Response, error)

GetNetworkDeviceLocationByRange is ... Gets the location for the devices in the given range

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceListResult

func (*NetworkDeviceService) GetNetworkDeviceRange

func (s *NetworkDeviceService) GetNetworkDeviceRange(startIndex int32, recordsToReturn int32, scope string) (*NetworkDeviceListResult, *Response, error)

GetNetworkDeviceRange is ... Gets the list of network devices for the given range

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceListResult

func (*NetworkDeviceService) GetNetworkManagementInfo

func (s *NetworkDeviceService) GetNetworkManagementInfo(scope string) (*NetworkManagementInfoResult, *Response, error)

GetNetworkManagementInfo is ... Gets the managment information of network devices and sites. Maximum allowed limit is 100.

  • @param scope Authorization Scope for RBAC

* @return *NetworkManagementInfoResult

func (*NetworkDeviceService) GetNetworkManagementInfoCount

func (s *NetworkDeviceService) GetNetworkManagementInfoCount(scope string) (*CountResult, *Response, error)

GetNetworkManagementInfoCount is ... Gets the number of network devices or sites, whichever is maximum. This count is used to paginate and query the /network-device/management-info API

  • @param scope Authorization Scope for RBAC

* @return *CountResult

func (*NetworkDeviceService) UpdateNetworkDevice

func (s *NetworkDeviceService) UpdateNetworkDevice(scope string, networkDeviceBriefNIO NetworkDeviceBriefNio) (*TaskIDResult, *Response, error)

UpdateNetworkDevice is ... Updates the role of the device as access, core, distribution, border router

  • @param scope Authorization Scope for RBAC
  • @param networkDeviceBriefNIO networkDeviceBriefNIO

* @return *TaskIDResult

type NetworkElement

type NetworkElement struct {
	Name                               string                  `json:"name,omitempty"`                     // Network Device name
	ID                                 string                  `json:"id,omitempty"`                       // Network Device ID
	Type                               string                  `json:"type,omitempty"`                     // Network Device Type(can be switch,router,wired host or wireless host)
	Role                               string                  `json:"role,omitempty"`                     // Role of device in network(can be access,core,distribution or border router)
	IP                                 string                  `json:"ip,omitempty"`                       // Network Device IP
	IngressVirtualInterface            Interface               `json:"ingressVirtualInterface,omitempty"`  // Ingress virtual interface of the network device
	EgressVirtualInterface             Interface               `json:"egressVirtualInterface,omitempty"`   // Egress virtual interface of the network device
	IngressPhysicalInterface           Interface               `json:"ingressPhysicalInterface,omitempty"` // Igress physical interface of the network device
	EgressPhysicalInterface            Interface               `json:"egressPhysicalInterface,omitempty"`  // Egress physical interface of the network device
	LinkInformationSource              string                  `json:"linkInformationSource,omitempty"`    // The source of the link information to the next hop
	Tunnels                            []string                `json:"tunnels,omitempty"`                  // Tunnels this network element is in
	AccuracyList                       []Accuracy              `json:"accuracyList,omitempty"`
	PerfMonCollection                  string                  `json:"perfMonCollection,omitempty"` // A status value from [ INPROGRESS, SUCCESS, FAILED ]
	DeviceStatistics                   DeviceStatistics        `json:"deviceStatistics,omitempty"`
	PerfMonStatistics                  []PerfMonitorStatistics `json:"perfMonStatistics,omitempty"`
	DeviceStatsCollection              string                  `json:"deviceStatsCollection,omitempty"` // A status value from [ INPROGRESS, SUCCESS, FAILED ]
	PerfMonCollectionFailureReason     string                  `json:"perfMonCollectionFailureReason,omitempty"`
	DeviceStatsCollectionFailureReason string                  `json:"deviceStatsCollectionFailureReason,omitempty"`
	DetailedStatus                     DetailedStatus          `json:"detailedStatus,omitempty"`
}

NetworkElement is ...

type NetworkElementInfo

type NetworkElementInfo struct {
	Name                               string                  `json:"name,omitempty"`                  // Network Device name
	ID                                 string                  `json:"id,omitempty"`                    // Network Device ID
	Type                               string                  `json:"type,omitempty"`                  // Network Device Type(can be switch,router,wired host or wireless host)
	Role                               string                  `json:"role,omitempty"`                  // Role of device in network(can be access,core,distribution or border router)
	IP                                 string                  `json:"ip,omitempty"`                    // Network Device IP
	LinkInformationSource              string                  `json:"linkInformationSource,omitempty"` // The source of the link information to the next hop
	Tunnels                            []string                `json:"tunnels,omitempty"`               // Tunnels this network element is in
	AccuracyList                       []Accuracy              `json:"accuracyList,omitempty"`
	PerfMonCollection                  string                  `json:"perfMonCollection,omitempty"`     // A status value from [ INPROGRESS, SUCCESS, FAILED ]
	EgressInterface                    InterfaceContainer      `json:"egressInterface,omitempty"`       // Egress interface of the network device
	IngressInterface                   InterfaceContainer      `json:"ingressInterface,omitempty"`      // Ingress interface of the network device
	DeviceStatistics                   DeviceStatistics        `json:"deviceStatistics,omitempty"`      // Device statistics
	DeviceStatsCollection              string                  `json:"deviceStatsCollection,omitempty"` // A status value from [ INPROGRESS, SUCCESS, FAILED ]
	PerfMonCollectionFailureReason     string                  `json:"perfMonCollectionFailureReason,omitempty"`
	DeviceStatsCollectionFailureReason string                  `json:"deviceStatsCollectionFailureReason,omitempty"`
	DetailedStatus                     DetailedStatus          `json:"detailedStatus,omitempty"`
	PerfMonitorStatistics              []PerfMonitorStatistics `json:"perfMonitorStatistics,omitempty"` // perf mon statistics on the device for give flow
}

NetworkElementInfo is ...

type NetworkManagementInfo

type NetworkManagementInfo struct {
	NetworkDeviceManagementInfo []NetworkDeviceManagementInfo `json:"networkDeviceManagementInfo,omitempty"`
	SiteManagementInfo          []SiteManagementInfo          `json:"siteManagementInfo,omitempty"`
}

NetworkManagementInfo is ...

type NetworkManagementInfoResult

type NetworkManagementInfoResult struct {
	Version  string                `json:"version,omitempty"`
	Response NetworkManagementInfo `json:"response,omitempty"`
}

NetworkManagementInfoResult is ...

type NetworkUser

type NetworkUser struct {
	UserIdentifiers  []string                   `json:"userIdentifiers,omitempty"`
	DeviceTypes      []string                   `json:"deviceTypes,omitempty"`
	Locations        []string                   `json:"locations,omitempty"`
	Applications     []PolicyApplication        `json:"applications,omitempty"`
	ApplicationDiffs []PolicyApplicationDiffDto `json:"applicationDiffs,omitempty"`
	Categories       []CategoryDto              `json:"categories,omitempty"`
}

NetworkUser is ...

type NodeWrapper

type NodeWrapper struct {
	Tags            []string          `json:"tags,omitempty"`            // List of tags applied on this device
	Y               int32             `json:"y,omitempty"`               // Y position of the device on the displayed topology view
	X               int32             `json:"x,omitempty"`               // X position of the device on the displayed topology view
	Fixed           bool              `json:"fixed,omitempty"`           // Indication of whether the position is fixed or will use auto layout
	Family          string            `json:"family,omitempty"`          // Product family which is part of the product identifier
	NodeType        string            `json:"nodeType,omitempty"`        // Host or device
	Role            string            `json:"role,omitempty"`            // Role of the device
	Order           int32             `json:"order,omitempty"`           // Device order by link number
	Id              string            `json:"id,omitempty"`              // Unique identifier for device
	Label           string            `json:"label,omitempty"`           // Hostname of the device
	CustomParam     NodeWrapperCustom `json:"customParam,omitempty"`     // Device custom parameters
	PlatformId      string            `json:"platformId,omitempty"`      // Device platform description
	DeviceType      string            `json:"deviceType,omitempty"`      // Type of the device
	VlanId          string            `json:"vlanId,omitempty"`          // VLan id
	RoleSource      string            `json:"roleSource,omitempty"`      // Indicates whether role is assigned manually or automatically
	UserId          string            `json:"userId,omitempty"`          // ID of the host
	SoftwareVersion string            `json:"softwareVersion,omitempty"` // Device OS version
	NetworkType     string            `json:"networkType,omitempty"`     // Type of network
	Ip              string            `json:"ip,omitempty"`              // IP address of the device
	UpperNode       string            `json:"upperNode,omitempty"`       // Start node ID
	AclApplied      bool              `json:"aclApplied,omitempty"`      // Indicates if the ACL that is applied on the device
	GreyOut         bool              `json:"greyOut,omitempty"`         // Indicates if the device is active for this topology view
	OsType          string            `json:"osType,omitempty"`          // OS type of the device
	DataPathId      string            `json:"dataPathId,omitempty"`      // ID of the path between devices
	AttributeInfo   string            `json:"attributeInfo,omitempty"`
}

NodeWrapper is ...

type NodeWrapperCustom

type NodeWrapperCustom struct {
	Y             int32  `json:"y,omitempty"`            // Y - Coordinate for this Node in the topology View
	X             int32  `json:"x,omitempty"`            // X - Coordinate for this Node in the topology View
	Label         string `json:"label,omitempty"`        // Label for the node
	ParentNodeId  string `json:"parentNodeId,omitempty"` // Unique Id of the Node for ehich the custom properties are being represented
	AttributeInfo string `json:"attributeInfo,omitempty"`
	Id            string `json:"id,omitempty"`
}

NodeWrapperCustom is ...

type PKIBrokerService

type PKIBrokerService service

PKIBrokerService is an interface with the API

func (*PKIBrokerService) CheckPKCS12Downloaded

func (s *PKIBrokerService) CheckPKCS12Downloaded(trustPointID string, scope string, username string) (*SuccessResult, *Response, error)

CheckPKCS12Downloaded is ... This method is used to check if a specific trust-point has downloaded its PKCS#12 bundle

  • @param scope Authorization Scope for RBAC * @param username requestUsername

* @return *SuccessResult

func (*PKIBrokerService) LegacyUpdateDefaultCaPem

func (s *PKIBrokerService) LegacyUpdateDefaultCaPem(id string, pkiType string, param TrustpoolUpdateParam) (*TrustpoolUpdateStatusResult, *Response, error)

LegacyUpdateDefaultCaPem is ... This method is used to update the default certificate

  • @param param param

* @return *TrustpoolUpdateStatusResult

func (*PKIBrokerService) PkiTrustPointConfigGet

func (s *PKIBrokerService) PkiTrustPointConfigGet(trustPointID string) (*PkiTrustPointConfigResult, *Response, error)

PkiTrustPointConfigGet is ... This method is used to obtain a specific trust-point's configuration

* @return *PkiTrustPointConfigResult

func (*PKIBrokerService) PkiTrustPointCount

func (s *PKIBrokerService) PkiTrustPointCount() (*CountResult, *Response, error)

PkiTrustPointCount is ... This method is used to return count of trust-points

* @return *CountResult

func (*PKIBrokerService) PkiTrustPointDelete

func (s *PKIBrokerService) PkiTrustPointDelete(trustPointID string) (*TaskIDResult, *Response, error)

PkiTrustPointDelete is ... This method is used to delete a specific trust-point by its ID

* @return *TaskIDResult

func (*PKIBrokerService) PkiTrustPointDeleteByDeviceSN

func (s *PKIBrokerService) PkiTrustPointDeleteByDeviceSN(serialNumber string) (*TaskIDResult, *Response, error)

PkiTrustPointDeleteByDeviceSN is ... This method is used to delete a specific trust-point by its device serial-number

* @return *TaskIDResult

func (*PKIBrokerService) PkiTrustPointGet

func (s *PKIBrokerService) PkiTrustPointGet(trustPointID string) (*PkiTrustPointResult, *Response, error)

PkiTrustPointGet is ... This method is used to return a specific trust-point by its ID

* @return *PkiTrustPointResult

func (*PKIBrokerService) PkiTrustPointGetByDeviceSN

func (s *PKIBrokerService) PkiTrustPointGetByDeviceSN(serialNumber string) (*PkiTrustPointResult, *Response, error)

PkiTrustPointGetByDeviceSN is ... This method is used to return a specific trust-point by its device serial-number

* @return *PkiTrustPointResult

func (*PKIBrokerService) PkiTrustPointListGet

func (s *PKIBrokerService) PkiTrustPointListGet() (*PkiTrustPointListResult, *Response, error)

PkiTrustPointListGet is ... This method is used to return a list of trust-points

* @return *PkiTrustPointListResult

func (*PKIBrokerService) PkiTrustPointListGetByRange

func (s *PKIBrokerService) PkiTrustPointListGetByRange(startIndex int32, recordsToReturn int32) (*PkiTrustPointListResult, *Response, error)

PkiTrustPointListGetByRange is ... This method is used to return a list of trust-points by range

* @return *PkiTrustPointListResult

func (*PKIBrokerService) PkiTrustPointPost

func (s *PKIBrokerService) PkiTrustPointPost(pkiTrustPointInput PkiTrustPoint) (*TaskIDResult, *Response, error)

PkiTrustPointPost is ... This method is used to create a trust-point

  • @param pkiTrustPointInput pkiTrustPointInput

* @return *TaskIDResult

func (*PKIBrokerService) PkiTrustPointPush

func (s *PKIBrokerService) PkiTrustPointPush(trustPointID string) (*TaskIDResult, *Response, error)

PkiTrustPointPush is ... This method is used to push a created trust-point to its intended device

* @return *TaskIDResult

func (*PKIBrokerService) UpdateDefaultCaPem

func (s *PKIBrokerService) UpdateDefaultCaPem(id string, pkiType string, param TrustpoolUpdateParam) (*TrustpoolUpdateStatusResult, *Response, error)

UpdateDefaultCaPem is ... This method is used to update the default certificate

  • @param param param

* @return *TrustpoolUpdateStatusResult

type Package

type Package struct {
	Name                  string       `json:"name,omitempty"`
	Annotations           []Annotation `json:"annotations,omitempty"`
	DeclaredAnnotations   []Annotation `json:"declaredAnnotations,omitempty"`
	Sealed                bool         `json:"sealed,omitempty"`
	SpecificationTitle    string       `json:"specificationTitle,omitempty"`
	SpecificationVersion  string       `json:"specificationVersion,omitempty"`
	SpecificationVendor   string       `json:"specificationVendor,omitempty"`
	ImplementationTitle   string       `json:"implementationTitle,omitempty"`
	ImplementationVersion string       `json:"implementationVersion,omitempty"`
	ImplementationVendor  string       `json:"implementationVendor,omitempty"`
}

Package is ...

type PathResponse

type PathResponse struct {
	Properties          []string             `json:"properties,omitempty"` // Properties for path trace
	Request             FlowAnalysis         `json:"request,omitempty"`    // Describes the source and destination for a path trace
	NetworkElements     []NetworkElement     `json:"networkElements,omitempty"`
	LastUpdate          string               `json:"lastUpdate,omitempty"`          // Last updated time
	NetworkElementsInfo []NetworkElementInfo `json:"networkElementsInfo,omitempty"` // Nodes travesed along a path, including source and destination
	DetailedStatus      DetailedStatus       `json:"detailedStatus,omitempty"`      // Detailed Status of the calculation of Path Trace with its inclusions
}

PathResponse is ...

type PathResponseResult

type PathResponseResult struct {
	Version  string       `json:"version,omitempty"`
	Response PathResponse `json:"response,omitempty"`
}

PathResponseResult is ...

type PerfMonitorStatistics

type PerfMonitorStatistics struct {
	Protocol             string  `json:"protocol,omitempty"`
	SourcePort           string  `json:"sourcePort,omitempty"`
	DestPort             string  `json:"destPort,omitempty"`
	ByteRate             int64   `json:"byteRate,omitempty"`
	InputInterface       string  `json:"inputInterface,omitempty"`
	Ipv4DSCP             string  `json:"ipv4DSCP,omitempty"`
	Ipv4TTL              int64   `json:"ipv4TTL,omitempty"`
	OutputInterface      string  `json:"outputInterface,omitempty"`
	PacketCount          int64   `json:"packetCount,omitempty"`
	PacketLoss           int64   `json:"packetLoss,omitempty"`
	PacketLossPercentage float32 `json:"packetLossPercentage,omitempty"`
	RefreshedAt          int64   `json:"refreshedAt,omitempty"`
	RtpJitterMean        int64   `json:"rtpJitterMean,omitempty"`
	RtpJitterMax         int64   `json:"rtpJitterMax,omitempty"`
	SourceIPAddress      string  `json:"sourceIpAddress,omitempty"`
	DestIPAddress        string  `json:"destIpAddress,omitempty"`
	RtpJitterMin         int64   `json:"rtpJitterMin,omitempty"`
	PacketBytes          int64   `json:"packetBytes,omitempty"`
}

PerfMonitorStatistics is ...

type PermissionCollection

type PermissionCollection struct {
	ReadOnly bool `json:"readOnly,omitempty"`
}

PermissionCollection is ...

type PkiTrustPoint

type PkiTrustPoint struct {
	EntityName             string `json:"entityName,omitempty"`             // Devices hostname
	SerialNumber           string `json:"serialNumber,omitempty"`           // Devices serial-number
	ID                     string `json:"id,omitempty"`                     // Trust-point identification. Automatically generated
	TrustProfileName       string `json:"trustProfileName,omitempty"`       // Name of trust-profile (must already exist). Default: sdn-network-infra-iwan
	EntityType             string `json:"entityType,omitempty"`             // Available options: router, switch. Currently not used
	NetworkDeviceID        string `json:"networkDeviceId,omitempty"`        // Device identification. Currently not used
	CertificateAuthorityID string `json:"certificateAuthorityId,omitempty"` // CA identification. Automatically populated
	PlatformID             string `json:"platformId,omitempty"`             // Platform identification. Eg. ASR1006
	ControllerIPAddress    string `json:"controllerIpAddress,omitempty"`    // IP address device uses to connect to APIC-EM. Eg. Proxy server IP address. Automatically populated if not set
	AttributeInfo          string `json:"attributeInfo,omitempty"`
}

PkiTrustPoint is ...

type PkiTrustPointConfig

type PkiTrustPointConfig struct {
	SerialNumber     string   `json:"serialNumber,omitempty"`
	TrustProfileName string   `json:"trustProfileName,omitempty"`
	PlatformID       string   `json:"platformId,omitempty"`
	IosCli           []string `json:"iosCli,omitempty"`
	Pkcs12Password   string   `json:"pkcs12Password,omitempty"`
	ProvisionType    string   `json:"provisionType,omitempty"`
	SdnIP            string   `json:"sdnIp,omitempty"`
	CaFingerprint    string   `json:"caFingerprint,omitempty"`
	EnrollThreshold  string   `json:"enrollThreshold,omitempty"`
	IosSecureCli     []string `json:"iosSecureCli,omitempty"`
	Pkcs12URL        string   `json:"pkcs12Url,omitempty"`
	RsaKeySize       string   `json:"rsaKeySize,omitempty"`
	Fqdn             string   `json:"fqdn,omitempty"`
	EnrollSubjectDN  string   `json:"enrollSubjectDN,omitempty"`
	EnrollPort       string   `json:"enrollPort,omitempty"`
	EnrollURL        string   `json:"enrollUrl,omitempty"`
	EnrollPassword   string   `json:"enrollPassword,omitempty"`
	ID               string   `json:"id,omitempty"`
}

PkiTrustPointConfig is ...

type PkiTrustPointConfigResult

type PkiTrustPointConfigResult struct {
	Response PkiTrustPointConfig `json:"response,omitempty"`
	Version  string              `json:"version,omitempty"`
}

PkiTrustPointConfigResult is ...

type PkiTrustPointListResult

type PkiTrustPointListResult struct {
	Response []PkiTrustPoint `json:"response,omitempty"`
	Version  string          `json:"version,omitempty"`
}

PkiTrustPointListResult is ...

type PkiTrustPointResult

type PkiTrustPointResult struct {
	Response PkiTrustPoint `json:"response,omitempty"`
	Version  string        `json:"version,omitempty"`
}

PkiTrustPointResult is ...

type Policy

type Policy struct {
	ID                   string         `json:"id,omitempty"`           // id
	PolicyScope          string         `json:"policyScope,omitempty"`  // policyScope
	InstanceUUID         string         `json:"instanceUuid,omitempty"` //
	Resource             PolicyResource `json:"resource,omitempty"`     // Resource
	PolicyName           string         `json:"policyName,omitempty"`   // name of the policy
	TaskID               string         `json:"taskId,omitempty"`       // Task ID
	ScopeWirelessSegment string         `json:"scopeWirelessSegment,omitempty"`
	NetworkUser          NetworkUser    `json:"networkUser,omitempty"`    // Network User
	PolicyOwner          string         `json:"policyOwner,omitempty"`    // Policy Owner
	ActionProperty       ActionProperty `json:"actionProperty,omitempty"` // ActionProperty
	PolicyPriority       int32          `json:"policyPriority,omitempty"` // Policy Priority
	Actions              []string       `json:"actions,omitempty"`        // Action Set
	State                string         `json:"state,omitempty"`
}

Policy is ...

type PolicyApplication

type PolicyApplication struct {
	Raw     string `json:"raw,omitempty"` // Either raw Application of the form port:protocol should be specified or appID should be specified
	ID      string `json:"id,omitempty"`  // id
	AppName string `json:"appName,omitempty"`
}

PolicyApplication is ...

type PolicyApplicationDiffDto

type PolicyApplicationDiffDto struct {
	Operation         string            `json:"operation,omitempty"`         // operation
	PolicyApplication PolicyApplication `json:"policyApplication,omitempty"` // application
}

PolicyApplicationDiffDto is ...

type PolicyContractDto

type PolicyContractDto struct {
	ID   string `json:"id,omitempty"`   // id
	Name string `json:"name,omitempty"` // name
}

PolicyContractDto is ...

type PolicyDiffDto

type PolicyDiffDto struct {
	Policy    Policy `json:"policy,omitempty"`    // policy
	Operation string `json:"operation,omitempty"` // operation
}

PolicyDiffDto is ...

type PolicyDto

type PolicyDto struct {
	Description    string            `json:"description,omitempty"`    // description
	Contract       PolicyContractDto `json:"contract,omitempty"`       // contract
	Producer       ProducerDto       `json:"producer,omitempty"`       // producer
	Consumer       ConsumerDto       `json:"consumer,omitempty"`       // consumer
	Priority       int32             `json:"priority,omitempty"`       // priority
	Name           string            `json:"name,omitempty"`           // name
	ID             string            `json:"id,omitempty"`             // id
	CreateTime     int64             `json:"createTime,omitempty"`     // createTime
	LastUpdateTime int64             `json:"lastUpdateTime,omitempty"` // lastUpdateTime
}

PolicyDto is ...

type PolicyDtoListResult

type PolicyDtoListResult struct {
	Response []PolicyDto `json:"response,omitempty"`
	Version  string      `json:"version,omitempty"`
}

PolicyDtoListResult is ...

type PolicyDtoResult

type PolicyDtoResult struct {
	Response PolicyDto `json:"response,omitempty"`
	Version  string    `json:"version,omitempty"`
}

PolicyDtoResult is ...

type PolicyFlowSettingDto

type PolicyFlowSettingDto struct {
	FlowPolicyEnabled bool `json:"flowPolicyEnabled,omitempty"` // Allowed values are true, false
}

PolicyFlowSettingDto is ...

type PolicyFlowSettingResult

type PolicyFlowSettingResult struct {
	Response PolicyFlowSettingDto `json:"response,omitempty"`
	Version  string               `json:"version,omitempty"`
}

PolicyFlowSettingResult is ...

type PolicyListResult

type PolicyListResult struct {
	Response []Policy `json:"response,omitempty"`
	Version  string   `json:"version,omitempty"`
}

PolicyListResult is ...

type PolicyResource

type PolicyResource struct {
	UserIdentifiers  []string                   `json:"userIdentifiers,omitempty"`
	DeviceTypes      []string                   `json:"deviceTypes,omitempty"`
	Locations        []string                   `json:"locations,omitempty"`
	Applications     []PolicyApplication        `json:"applications,omitempty"`
	ApplicationDiffs []PolicyApplicationDiffDto `json:"applicationDiffs,omitempty"`
	Categories       []CategoryDto              `json:"categories,omitempty"`
}

PolicyResource is ...

type PolicyResult

type PolicyResult struct {
	Response Policy `json:"response,omitempty"`
	Version  string `json:"version,omitempty"`
}

PolicyResult is ...

type PolicyService

type PolicyService service

PolicyService is an interface with the Policy API

func (*PolicyService) Add

func (s *PolicyService) Add(policyList []*Policy, queryParams *AddQueryParams) (*TaskIDResult, *Response, error)

Add is ... Create a policy

  • @param queryParams

  • @param policyList Policy Object

* @return *TaskIDResult

func (*PolicyService) AddFlow

func (s *PolicyService) AddFlow(flowDTO FlowDto) (*FlowIDResult, *Response, error)

AddFlow is ... addFlow

  • @param flowDTO flowDTO

* @return *FlowIDResult

func (*PolicyService) AddPolicyDiff

func (s *PolicyService) AddPolicyDiff(versionDiffDTO VersionDiffDto) (*TaskIDResult, *Response, error)

AddPolicyDiff is ... Adds the policy diff

  • @param versionDiffDTO VersionDiff

* @return *TaskIDResult

func (*PolicyService) AddPolicyTag

func (s *PolicyService) AddPolicyTag(policyTagDTO PolicyTagDto) (*TaskIDResult, *Response, error)

AddPolicyTag is ... addPolicyTag

  • @param policyTagDTO policyTagDTO

* @return *TaskIDResult

func (*PolicyService) AddPolicyTagAssociation

func (s *PolicyService) AddPolicyTagAssociation(policyTagAssociationDTO PolicyTagAssociationDto) (*TaskIDResult, *Response, error)

AddPolicyTagAssociation is ... addPolicyTagAssociation

  • @param policyTagAssociationDTO policyTagAssociationDTO

* @return *TaskIDResult

func (*PolicyService) Delete

func (s *PolicyService) Delete(id string) (*TaskIDResult, *Response, error)

Delete is ... Delete a policy by id

* @return *TaskIDResult

func (*PolicyService) DeleteFilterPolicies

func (s *PolicyService) DeleteFilterPolicies(queryParams *DeleteFilterPoliciesQueryParams) (*TaskIDResult, *Response, error)

DeleteFilterPolicies is ... Delete policies based on a given filter

  • @param queryParams

* @return *TaskIDResult

func (*PolicyService) DeleteFlow

func (s *PolicyService) DeleteFlow(id string) (*TaskIDResult, *Response, error)

DeleteFlow is ... Delete a policy for the flow by its id

* @return *TaskIDResult

func (*PolicyService) DeleteFlowsByClientReference

func (s *PolicyService) DeleteFlowsByClientReference(queryParams *DeleteFlowsByClientReferenceQueryParams) (*TaskIDResult, *Response, error)

DeleteFlowsByClientReference is ... deleteFlowsByClientReference

  • @param queryParams

* @return *TaskIDResult

func (*PolicyService) DeletePolicyTag

func (s *PolicyService) DeletePolicyTag(queryParams *DeletePolicyTagQueryParams) (*TaskIDResult, *Response, error)

DeletePolicyTag is ... deletePolicyTag

  • @param queryParams

* @return *TaskIDResult

func (*PolicyService) DeletePolicyTagAssociation

func (s *PolicyService) DeletePolicyTagAssociation(queryParams *DeletePolicyTagAssociationQueryParams) (*TaskIDResult, *Response, error)

DeletePolicyTagAssociation is ... deletePolicyTagAssociation

  • @param queryParams

* @return *TaskIDResult

func (*PolicyService) Get

func (s *PolicyService) Get(id string) (*PolicyResult, *Response, error)

Get is ... Get a policy by id

* @return *PolicyResult

func (*PolicyService) GetCount

func (s *PolicyService) GetCount() (*CountResult, *Response, error)

GetCount is ... Get total count of policies

* @return *CountResult

func (*PolicyService) GetCountByPolicyScope

func (s *PolicyService) GetCountByPolicyScope(queryParams *GetCountByPolicyScopeQueryParams) (*CountResult, *Response, error)

GetCountByPolicyScope is ... Get count of policy status(es) based on a given policyScope & scopeWirelessSegment

  • @param queryParams

* @return *CountResult

func (*PolicyService) GetFilterPolicies

func (s *PolicyService) GetFilterPolicies(queryParams *GetFilterPoliciesQueryParams) (*PolicyListResult, *Response, error)

GetFilterPolicies is ... Get policy(s) based on a filter provided

  • @param queryParams

* @return *PolicyListResult

func (*PolicyService) GetFlow

func (s *PolicyService) GetFlow(id string) (*FlowResult, *Response, error)

GetFlow is ... getFlow

* @return *FlowResult

func (*PolicyService) GetFlowCount

func (s *PolicyService) GetFlowCount() (*CountResult, *Response, error)

GetFlowCount is ... getFlowCount

* @return *CountResult

func (*PolicyService) GetFlows

func (s *PolicyService) GetFlows(queryParams *GetFlowsQueryParams) (*FlowListResult, *Response, error)

GetFlows is ... getFlows

  • @param queryParams

* @return *FlowListResult

func (*PolicyService) GetPolicyDiff

func (s *PolicyService) GetPolicyDiff(queryParams *GetPolicyDiffQueryParams) (*VersionDiffResult, *Response, error)

GetPolicyDiff is ... Retrieves the policy diff

  • @param queryParams

* @return *VersionDiffResult

func (*PolicyService) GetPolicyFlowSetting

func (s *PolicyService) GetPolicyFlowSetting() (*PolicyFlowSettingResult, *Response, error)

GetPolicyFlowSetting is ... getPolicyFlowSetting

* @return *PolicyFlowSettingResult

func (*PolicyService) GetPolicyStatus

func (s *PolicyService) GetPolicyStatus(queryParams *GetPolicyStatusQueryParams) (*PolicyStatusListResult, *Response, error)

GetPolicyStatus is ... Get policy status(s) based on filter(s) provided. Either provide networkDeviceId or provide policyScope, offset, limit

  • @param queryParams

* @return *PolicyStatusListResult

func (*PolicyService) GetPolicyStatusSummary

func (s *PolicyService) GetPolicyStatusSummary(queryParams *GetPolicyStatusSummaryQueryParams) (*PolicyStatusListResult, *Response, error)

GetPolicyStatusSummary is ... Get policy status(s) summary based on a filter provided

  • @param queryParams

* @return *PolicyStatusListResult

func (*PolicyService) GetPolicyTagAssociation

func (s *PolicyService) GetPolicyTagAssociation(queryParams *GetPolicyTagAssociationQueryParams) (*PolicyTagAssociationListResult, *Response, error)

GetPolicyTagAssociation is ... getPolicyTagAssociation

  • @param queryParams

* @return *PolicyTagAssociationListResult

func (*PolicyService) GetPolicyTags

func (s *PolicyService) GetPolicyTags(queryParams *GetPolicyTagsQueryParams) (*PolicyTagListResult, *Response, error)

GetPolicyTags is ... getPolicyTags

  • @param queryParams

* @return *PolicyTagListResult

func (*PolicyService) GetPolicyTagsCount

func (s *PolicyService) GetPolicyTagsCount() (*CountResult, *Response, error)

GetPolicyTagsCount is ... getPolicyTagsCount

* @return *CountResult

func (*PolicyService) GetPolicyVersionNumbers

func (s *PolicyService) GetPolicyVersionNumbers(queryParams *GetPolicyVersionNumbersQueryParams) (*PolicyVersionNumberListResult, *Response, error)

GetPolicyVersionNumbers is ... Retrieves the policy version numbers

  • @param queryParams

* @return *PolicyVersionNumberListResult

func (*PolicyService) GetPolicyVersionNumbersCount

func (s *PolicyService) GetPolicyVersionNumbersCount(queryParams *GetPolicyVersionNumbersCountQueryParams) (*CountResult, *Response, error)

GetPolicyVersionNumbersCount is ... Retrieves the count of policy version numbers

  • @param queryParams

* @return *CountResult

func (*PolicyService) Update

func (s *PolicyService) Update(policyList []*Policy, queryParams *UpdateQueryParams) (*TaskIDResult, *Response, error)

Update is ... Update a policy

  • @param queryParams

  • @param policyList Policy Object

* @return *TaskIDResult

func (*PolicyService) UpdateFlowPolicySetting

func (s *PolicyService) UpdateFlowPolicySetting(policyFlowSettingDTO PolicyFlowSettingDto) (*TaskIDResult, *Response, error)

UpdateFlowPolicySetting is ... updateFlowPolicySetting

  • @param policyFlowSettingDTO policyFlowSettingDTO

* @return *TaskIDResult

type PolicyStatusDto

type PolicyStatusDto struct {
	Status                         string              `json:"status,omitempty"`
	InstanceUUID                   string              `json:"instanceUuid,omitempty"`
	PolicyScope                    string              `json:"policyScope,omitempty"`
	ScopeWirelessSegment           string              `json:"scopeWirelessSegment,omitempty"`
	NetworkDeviceID                string              `json:"networkDeviceId,omitempty"`
	NetworkDeviceName              string              `json:"networkDeviceName,omitempty"`
	FailureReason                  string              `json:"failureReason,omitempty"`
	LastUpdated                    string              `json:"lastUpdated,omitempty"`
	OutOfScope                     bool                `json:"outOfScope,omitempty"`
	BusinessRelevantApplications   []PolicyApplication `json:"businessRelevantApplications,omitempty"`
	BusinessIrrelevantApplications []PolicyApplication `json:"businessIrrelevantApplications,omitempty"`
	NetworkDeviceIP                string              `json:"networkDeviceIp,omitempty"`
	ApplicationPolicyCount         int32               `json:"applicationPolicyCount,omitempty"`
}

PolicyStatusDto is ...

type PolicyStatusListResult

type PolicyStatusListResult struct {
	Response []PolicyStatusDto `json:"response,omitempty"`
	Version  string            `json:"version,omitempty"`
}

PolicyStatusListResult is ...

type PolicyTagAssociationDeviceDto

type PolicyTagAssociationDeviceDto struct {
	DeviceID   string `json:"deviceId,omitempty"`
	DeviceName string `json:"deviceName,omitempty"`
	DeviceIP   string `json:"deviceIp,omitempty"`
}

PolicyTagAssociationDeviceDto is ...

type PolicyTagAssociationDto

type PolicyTagAssociationDto struct {
	NetworkDevices     []PolicyTagAssociationDeviceDto `json:"networkDevices,omitempty"`
	PolicyTag          string                          `json:"policyTag,omitempty"`
	UnModifiable       bool                            `json:"unModifiable,omitempty"`
	UnModifiableReason string                          `json:"unModifiableReason,omitempty"`
}

PolicyTagAssociationDto is ...

type PolicyTagAssociationListResult

type PolicyTagAssociationListResult struct {
	Response []PolicyTagAssociationDto `json:"response,omitempty"`
	Version  string                    `json:"version,omitempty"`
}

PolicyTagAssociationListResult is ...

type PolicyTagDto

type PolicyTagDto struct {
	PolicyTag string `json:"policyTag,omitempty"` // Policy Tag value
}

PolicyTagDto is ...

type PolicyTagListResult

type PolicyTagListResult struct {
	Response []PolicyTagDto `json:"response,omitempty"`
	Version  string         `json:"version,omitempty"`
}

PolicyTagListResult is ...

type PolicyV2Service

type PolicyV2Service service

PolicyV2Service is an interface with the Vpolicy API

func (*PolicyV2Service) Add

func (s *PolicyV2Service) Add(policyDTOs *[]PolicyDto) (*TaskIDResult, *Response, error)

Add is ... Create Policy(s)

  • @param policyDTOs Policy Object(s)

* @return *TaskIDResult

func (*PolicyV2Service) Delete

func (s *PolicyV2Service) Delete(id string) (*TaskIDResult, *Response, error)

Delete is ... Delete a policy by id

* @return *TaskIDResult

func (*PolicyV2Service) GetByID

func (s *PolicyV2Service) GetByID(id string) (*PolicyDtoResult, *Response, error)

GetByID is ... Get a policy by id

* @return *PolicyDtoResult

func (*PolicyV2Service) GetCount

func (s *PolicyV2Service) GetCount() (*CountResult, *Response, error)

GetCount is ... Get total count of policies

* @return *CountResult

func (*PolicyV2Service) GetPolicyByFilters

func (s *PolicyV2Service) GetPolicyByFilters(queryParams *GetPolicyByFiltersQueryParams) (*PolicyDtoListResult, *Response, error)

GetPolicyByFilters is ... Retrieves policies based on a given filter

  • @param queryParams

* @return *PolicyDtoListResult

func (*PolicyV2Service) Update

func (s *PolicyV2Service) Update(policyDTOs *[]PolicyDto) (*TaskIDResult, *Response, error)

Update is ... Update Policy(s)

  • @param policyDTOs Policy Object(s)

* @return *TaskIDResult

type PolicyVersionNumberListResult

type PolicyVersionNumberListResult struct {
	Response []VersionNumberDto `json:"response,omitempty"`
	Version  string             `json:"version,omitempty"`
}

PolicyVersionNumberListResult is ...

type Principal

type Principal struct {
	Name string `json:"name,omitempty"`
}

Principal is ...

type ProducerDto

type ProducerDto struct {
	ScalableGroups []ScalableGroupDto `json:"scalableGroups,omitempty"`
}

ProducerDto is ...

type ProtectionDomain

type ProtectionDomain struct {
	ClassLoader ClassLoader          `json:"classLoader,omitempty"`
	CodeSource  CodeSource           `json:"codeSource,omitempty"`
	Principals  []Principal          `json:"principals,omitempty"`
	Permissions PermissionCollection `json:"permissions,omitempty"`
}

ProtectionDomain is ...

type PublicKey

type PublicKey struct {
	Format    string `json:"format,omitempty"`
	Encoded   []byte `json:"encoded,omitempty"`
	Algorithm string `json:"algorithm,omitempty"`
}

PublicKey is ...

type QosClassMapStatistics

type QosClassMapStatistics struct {
	ClassMapName       string `json:"classMapName,omitempty"`
	RefreshedAt        int64  `json:"refreshedAt,omitempty"`
	DropRate           int64  `json:"dropRate,omitempty"`
	NumBytes           int64  `json:"numBytes,omitempty"`
	NumPackets         int64  `json:"numPackets,omitempty"`
	OfferedRate        int64  `json:"offeredRate,omitempty"`
	QueueBandwidthbps  string `json:"queueBandwidthbps,omitempty"`
	QueueDepth         int32  `json:"queueDepth,omitempty"`
	QueueNoBufferDrops int64  `json:"queueNoBufferDrops,omitempty"`
	QueueTotalDrops    int64  `json:"queueTotalDrops,omitempty"`
}

QosClassMapStatistics is ...

type RawCliInfoNio

type RawCliInfoNio struct {
	Snmp            string `json:"snmp,omitempty"`            // SNMP configuration info of the device
	Inventory       string `json:"inventory,omitempty"`       // Inventory configuration info of the device
	IPIntfBrief     string `json:"ipIntfBrief,omitempty"`     // IP interface brief configuration info of the device
	IntfDescription string `json:"intfDescription,omitempty"` // Interface configuration info of the device
	MacAddressTable string `json:"macAddressTable,omitempty"` // MAC address configuration info of the device
	HealthMonitor   string `json:"healthMonitor,omitempty"`   // Health monitor configuration info of the device
	Version         string `json:"version,omitempty"`         // Version configuration info of the device
	ID              string `json:"id,omitempty"`              // Unique identifier for config
	RunningConfig   string `json:"runningConfig,omitempty"`   // Running-config of the device
	CdpNeighbors    string `json:"cdpNeighbors,omitempty"`    // CDP configuration info of the device
	AttributeInfo   string `json:"attributeInfo,omitempty"`
}

RawCliInfoNio is ...

type RawCliInfoNioListResult

type RawCliInfoNioListResult struct {
	Version  string          `json:"version,omitempty"`
	Response []RawCliInfoNio `json:"response,omitempty"`
}

RawCliInfoNioListResult is ...

type ReachabilityInfoService

type ReachabilityInfoService service

ReachabilityInfoService is an interface with the Reachabilityinfo API

func (*ReachabilityInfoService) GetAllNetworkDevicesReachabilityInfo

func (s *ReachabilityInfoService) GetAllNetworkDevicesReachabilityInfo(scope string) (*NetworkDeviceReachabilityInfoNioListResult, *Response, error)

GetAllNetworkDevicesReachabilityInfo is ... Get reachability info of all devices

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceReachabilityInfoNioListResult

func (*ReachabilityInfoService) GetNetworkDeviceReachabilityInfoByRange

func (s *ReachabilityInfoService) GetNetworkDeviceReachabilityInfoByRange(startIndex int32, recordsToReturn int32, scope string) (*NetworkDeviceReachabilityInfoNioListResult, *Response, error)

GetNetworkDeviceReachabilityInfoByRange is ... Get reachability info of devices for the given range

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceReachabilityInfoNioListResult

func (*ReachabilityInfoService) GetNetworkDevicesReachabilityInfoCount

func (s *ReachabilityInfoService) GetNetworkDevicesReachabilityInfoCount(scope string) (*CountResult, *Response, error)

GetNetworkDevicesReachabilityInfoCount is ... Get the count of reachability-info of devices

  • @param scope Authorization Scope for RBAC

* @return *CountResult

func (*ReachabilityInfoService) GetNetworkReachabilityInfoByID

func (s *ReachabilityInfoService) GetNetworkReachabilityInfoByID(networkDeviceID string, scope string) (*NetworkDeviceReachabilityInfoNioResult, *Response, error)

GetNetworkReachabilityInfoByID is ... Get reachability info of the given device by ID

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceReachabilityInfoNioResult

func (*ReachabilityInfoService) GetNetworkReachabilityInfoByIPaddress

func (s *ReachabilityInfoService) GetNetworkReachabilityInfoByIPaddress(ipAddress string, scope string) (*NetworkDeviceReachabilityInfoNioResult, *Response, error)

GetNetworkReachabilityInfoByIPaddress is ... Get reachability info of the given device by IP address

  • @param scope Authorization Scope for RBAC

* @return *NetworkDeviceReachabilityInfoNioResult

type RelevanceListResult

type RelevanceListResult struct {
	Response []string `json:"response,omitempty"`
	Version  string   `json:"version,omitempty"`
}

RelevanceListResult is ...

type RelevanceService

type RelevanceService service

RelevanceService is an interface with the Relevance API

func (*RelevanceService) GetAllRelevanceLevels

func (s *RelevanceService) GetAllRelevanceLevels() (*RelevanceListResult, *Response, error)

GetAllRelevanceLevels is ... Get all Relevance(s)

* @return *RelevanceListResult

type RequestCompletionCallback

type RequestCompletionCallback func(*http.Request, *http.Response)

RequestCompletionCallback defines the type of the request callback function

type Response

type Response struct {
	*http.Response

	// Monitoring URI
	Monitor string
}

Response is a Cisco Spark response. This wraps the standard http.Response returned from Cisco Spark.

type Role

type Role struct {
	Role string `json:"role,omitempty"` // User Role
}

Role is ...

type RoleListResult

type RoleListResult struct {
	Version  string `json:"version,omitempty"`
	Response []Role `json:"response,omitempty"`
}

RoleListResult is ...

type RoleService

type RoleService service

RoleService is an interface with the Userrole API

func (*RoleService) GetRoles

func (s *RoleService) GetRoles() (*RoleListResult, *Response, error)

GetRoles is ... This method is used to get the list of roles

* @return *RoleListResult

type SNMPv2ReadCommunityDTO

type SNMPv2ReadCommunityDTO struct {
	ReadCommunity  string `json:"readCommunity,omitempty"`  // SNMP read community
	Description    string `json:"description,omitempty"`    // Description of the credential
	Comments       string `json:"comments,omitempty"`       // Comments to identify the credential
	CredentialType string `json:"credentialType,omitempty"` // Credential type to identify the application that uses the credential
	InstanceUUID   string `json:"instanceUuid,omitempty"`
	ID             string `json:"id,omitempty"`
}

SNMPv2ReadCommunityDTO is ...

type SNMPv2WriteCommunityDTO

type SNMPv2WriteCommunityDTO struct {
	WriteCommunity string `json:"writeCommunity,omitempty"` // SNMP write community
	Description    string `json:"description,omitempty"`    // Description of the credential
	Comments       string `json:"comments,omitempty"`       // Comments to identify the credential
	CredentialType string `json:"credentialType,omitempty"` // Credential type to identify the application that uses the credential
	InstanceUUID   string `json:"instanceUuid,omitempty"`
	ID             string `json:"id,omitempty"`
}

SNMPv2WriteCommunityDTO is ...

type SNMPv3CredentialDTO

type SNMPv3CredentialDTO struct {
	Username        string `json:"username,omitempty"`        // SNMP user name
	AuthType        string `json:"authType,omitempty"`        // Authentication type is required if SNMP mode is AuthPriv / AuthNoPriv
	AuthPassword    string `json:"authPassword,omitempty"`    // AuthPassword is required if SNMP mode is AuthPriv / AuthNoPriv
	PrivacyPassword string `json:"privacyPassword,omitempty"` // Privacy password is required if SNMP mode is AuthPriv
	PrivacyType     string `json:"privacyType,omitempty"`     // Privacy type is required if SNMP mode is AuthPriv
	SnmpMode        string `json:"snmpMode,omitempty"`        // SNMP mode
	Description     string `json:"description,omitempty"`     // Description of the credential
	Comments        string `json:"comments,omitempty"`        // Comments to identify the credential
	CredentialType  string `json:"credentialType,omitempty"`  // Credential type to identify the application that uses the credential
	InstanceUUID    string `json:"instanceUuid,omitempty"`
	ID              string `json:"id,omitempty"`
}

SNMPv3CredentialDTO is ...

type ScalableGroupDto

type ScalableGroupDto struct {
	Description                 string `json:"description,omitempty"`                 // description
	IdentitySourceIPAddress     string `json:"identitySourceIpAddress,omitempty"`     // identitySourceIpAddress
	CreateTime                  int64  `json:"createTime,omitempty"`                  // createTime
	ScalableGroupExternalHandle string `json:"scalableGroupExternalHandle,omitempty"` // scalableGroupExternalHandle
	LastUpdateTime              int64  `json:"lastUpdateTime,omitempty"`              // lastUpdateTime
	IdentitySourceID            string `json:"identitySourceId,omitempty"`            // identitySourceId
	IdentitySourceType          string `json:"identitySourceType,omitempty"`          // identitySourceType
	Name                        string `json:"name,omitempty"`                        // name
	ID                          string `json:"id,omitempty"`                          // id
}

ScalableGroupDto is ...

type ScalableGroupListResult

type ScalableGroupListResult struct {
	Response []ScalableGroupDto `json:"response,omitempty"`
	Version  string             `json:"version,omitempty"`
}

ScalableGroupListResult is ...

type ScalableGroupResult

type ScalableGroupResult struct {
	Response ScalableGroupDto `json:"response,omitempty"`
	Version  string           `json:"version,omitempty"`
}

ScalableGroupResult is ...

type ScalableGroupService

type ScalableGroupService service

ScalableGroupService is an interface with the Vscalablegroup API

func (*ScalableGroupService) GetCount

func (s *ScalableGroupService) GetCount() (*CountResult, *Response, error)

GetCount is ... This method is used to obtain the number of scalable groups known to APIC-EM

* @return *CountResult

func (*ScalableGroupService) GetEndPointGroupbyID

func (s *ScalableGroupService) GetEndPointGroupbyID(id string) (*ScalableGroupResult, *Response, error)

GetEndPointGroupbyID is ... Get Scalable group based on id

* @return *ScalableGroupResult

func (*ScalableGroupService) GetScalableGroupByFilters

func (s *ScalableGroupService) GetScalableGroupByFilters(queryParams *GetScalableGroupByFiltersQueryParams) (*ScalableGroupListResult, *Response, error)

GetScalableGroupByFilters is ... Retrieves scalable group based on a given filter

  • @param queryParams

* @return *ScalableGroupListResult

type ScheduleInfoOutput

type ScheduleInfoOutput struct {
	TaskID              string    `json:"taskId,omitempty"`              // UUID of the Task
	Description         string    `json:"description,omitempty"`         // Simple description to be shown to end-users
	Origin              string    `json:"origin,omitempty"`              // Contextual field used to identify work spcifications originating from the same source
	StartTime           time.Time `json:"startTime,omitempty"`           // The time at which the trigger should first fire. If the schedule has fired and will not fire again, this value will be null
	EndTime             time.Time `json:"endTime,omitempty"`             // The time at which the trigger should quit repeating
	Operation           string    `json:"operation,omitempty"`           // Contextual field used by the service to identify an operation
	GroupName           string    `json:"groupName,omitempty"`           // A grouping name that can be specified by the service to allow for filtered work spec retrieval
	ScheduledWorkSpecID string    `json:"scheduledWorkSpecId,omitempty"` // UUID of the ScheduledWorkSpec associated with the scheduled task
	NextTime            time.Time `json:"nextTime,omitempty"`            // The next time at which the trigger should fire
	PrevTime            time.Time `json:"prevTime,omitempty"`            // The previous time at which the trigger fired. If the trigger has not yet fired, null will be returned
}

ScheduleInfoOutput is ...

type ScheduleInfoOutputListResult

type ScheduleInfoOutputListResult struct {
	Version  string               `json:"version,omitempty"`
	Response []ScheduleInfoOutput `json:"response,omitempty"`
}

ScheduleInfoOutputListResult is ...

type ScheduleInfoOutputResult

type ScheduleInfoOutputResult struct {
	Version  string             `json:"version,omitempty"`
	Response ScheduleInfoOutput `json:"response,omitempty"`
}

ScheduleInfoOutputResult is ...

type SchedulerService

type SchedulerService service

SchedulerService is an interface with the Scheduledjob API

func (*SchedulerService) DeleteScheduledTask

func (s *SchedulerService) DeleteScheduledTask(scheduledWorkSpecID string, scope string) (*SuccessResult, *Response, error)

DeleteScheduledTask is ... deleteScheduledTask

  • @param scope Authorization Scope for RBAC

* @return *SuccessResult

func (*SchedulerService) GetAllScheduledTasks

func (s *SchedulerService) GetAllScheduledTasks(scope string, queryParams *GetAllScheduledTasksQueryParams) (*ScheduleInfoOutputListResult, *Response, error)

GetAllScheduledTasks is ... getAllScheduledTasks

  • @param queryParams
  • @param scope Authorization Scope for RBAC

* @return *ScheduleInfoOutputListResult

func (*SchedulerService) GetScheduledTask

func (s *SchedulerService) GetScheduledTask(scheduledWorkSpecID string, scope string) (*ScheduleInfoOutputResult, *Response, error)

GetScheduledTask is ... getScheduledTask

  • @param scope Authorization Scope for RBAC

* @return *ScheduleInfoOutputResult

type ScopeRole

type ScopeRole struct {
	Scope string `json:"scope,omitempty"` // Scope of Authorization. Added to support future implementations, supported value is only ALL
	Role  string `json:"role,omitempty"`  // Authorization Role. Supported values are ROLE_ADMIN, ROLE_OBSERVER and ROLE_INSTALLER
}

ScopeRole is ...

type SegmentDto

type SegmentDto struct {
	Name           string               `json:"name,omitempty"`
	NetworkDevices []NetworkDeviceBrief `json:"networkDevices,omitempty"`
}

SegmentDto is ...

type SegmentResult

type SegmentResult struct {
	Version  string       `json:"version,omitempty"`
	Response []SegmentDto `json:"response,omitempty"`
}

SegmentResult is ...

type SegmentService

type SegmentService service

SegmentService is an interface with the Segment API

func (*SegmentService) GetSegmentInfo

func (s *SegmentService) GetSegmentInfo(queryParams *GetSegmentInfoQueryParams) (*SegmentResult, *Response, error)

GetSegmentInfo is ... Gets list of segment info based on policyTag

  • @param queryParams

* @return *SegmentResult

type ServerID

type ServerID struct {
	ServerID string `json:"serverId,omitempty"`
}

ServerID is ...

type ServerIDListResult

type ServerIDListResult struct {
	Version  string     `json:"version,omitempty"`
	Response []ServerID `json:"response,omitempty"`
}

ServerIDListResult is ...

type ServiceTicketRBAC

type ServiceTicketRBAC struct {
	IdleTimeout    int32  `json:"idleTimeout,omitempty"`
	ServiceTicket  string `json:"serviceTicket,omitempty"` // Service Ticket to be used as authentication Ticket
	SessionTimeout int32  `json:"sessionTimeout,omitempty"`
}

ServiceTicketRBAC is ... Object used to retrieve the service ticket

type SiteManagementInfo

type SiteManagementInfo struct {
	Description string   `json:"description,omitempty"` // Description of site
	Name        string   `json:"name,omitempty"`        // Name of site
	Location    string   `json:"location,omitempty"`    // Location of site
	Properties  string   `json:"properties,omitempty"`  // Properties of site
	ID          string   `json:"id,omitempty"`          // Unique identifier of site
	DeviceIDs   []string `json:"deviceIds,omitempty"`   // Unique identifier of devices that are associated with site
}

SiteManagementInfo is ...

type SuccessResult

type SuccessResult struct {
	Version  string `json:"version,omitempty"`
	Response string `json:"response,omitempty"`
}

SuccessResult is ...

type SuccessResultList

type SuccessResultList struct {
	Version  string   `json:"version,omitempty"`
	Response []string `json:"response,omitempty"`
}

SuccessResultList is ...

type TagDto

type TagDto struct {
	ID           string `json:"id,omitempty"`           // Unique identifier for tag
	Tag          string `json:"tag,omitempty"`          // Name of the tag
	ResourceType string `json:"resourceType,omitempty"` // Type of the resource to which the tag to be associated
	ResourceID   string `json:"resourceId,omitempty"`   // Id of the resource to which the tag to be associated
}

TagDto is ...

type TagDtoListResult

type TagDtoListResult struct {
	Version  string   `json:"version,omitempty"`
	Response []TagDto `json:"response,omitempty"`
}

TagDtoListResult is ...

type TagDtoResult

type TagDtoResult struct {
	Version  string `json:"version,omitempty"`
	Response TagDto `json:"response,omitempty"`
}

TagDtoResult is ...

type TagNio

type TagNio struct {
	ID              string `json:"id,omitempty"`              // Unique identifier of tag
	LastUpdated     string `json:"lastUpdated,omitempty"`     // Time when the device interface info last got updated
	LocationID      string `json:"locationId,omitempty"`      // Unique identifier of location
	LinkID          string `json:"linkId,omitempty"`          // Unique identifier of link
	Tag             string `json:"tag,omitempty"`             // Tag ID
	InterfaceID     string `json:"interfaceId,omitempty"`     // Unique identifier of the interface
	NetworkDeviceID string `json:"networkDeviceId,omitempty"` // Unique identifier of device
}

TagNio is ...

type TagService

type TagService service

TagService is an interface with the Tag API

func (*TagService) AddTag

func (s *TagService) AddTag(tagDto TagDto, scope string) (*TaskIDResult, *Response, error)

AddTag is ... Adds a new tag to the controller. The {tag} field should contain the value of the tag.

  • @param scope Authorization Scope for RBAC
  • @param tagDto TagDto with the tag

* @return *TaskIDResult

func (*TagService) AddTagToResource

func (s *TagService) AddTagToResource(tagDto TagDto, scope string) (*TaskIDResult, *Response, error)

AddTagToResource is ... Associates a tag to a resource. The {id} field should be the id of the tag. The {resourceID} should the id of the resource. The {resourceType} should be the type of the resource. Supported resourceTypes are network-device, interface.

  • @param scope Authorization Scope for RBAC
  • @param tagDto TagDto with tag ID, resource ID and resource type

* @return *TaskIDResult

func (*TagService) DeleteTag

func (s *TagService) DeleteTag(id string, scope string) (*TaskIDResult, *Response, error)

DeleteTag is ... Deletes the tag by its id. The tag cannot be deleted when there is an existing association between the tag and a resource.

  • @param scope Authorization Scope for RBAC

* @return *TaskIDResult

func (*TagService) DeleteTagFromResource

func (s *TagService) DeleteTagFromResource(scope string, id string, queryParams *DeleteTagFromResourceQueryParams) (*TaskIDResult, *Response, error)

DeleteTagFromResource is ... Deletes the association of tag by its id.from resource of id {resourceID} which is of type {resourceType}. Supported resourceTypes are network-device, interface.

  • @param queryParams
  • @param scope Authorization Scope for RBAC

* @return *TaskIDResult

func (*TagService) GetTag

func (s *TagService) GetTag(id string, scope string) (*TagDtoResult, *Response, error)

GetTag is ... Gets the details of the tag by its id.

  • @param scope Authorization Scope for RBAC

* @return *TagDtoResult

func (*TagService) GetTags

func (s *TagService) GetTags(scope string, queryParams *GetTagsQueryParams) (*TagDtoListResult, *Response, error)

GetTags is ... Gets all the tags if no filters are provided. Gets all the tags that are associated with resources of {resourceType} if resourceType filter is provided. Gets all the tags that are associated with a resource with id {resourceID} and of resource type {resourceType} when resourceId and resourceType filters are provided.

  • @param queryParams
  • @param scope Authorization Scope for RBAC

* @return *TagDtoListResult

func (*TagService) UpdateTag

func (s *TagService) UpdateTag(tagDto TagDto, scope string) (*TaskIDResult, *Response, error)

UpdateTag is ... Updates the tag identified by {id} to a new value. The {id} field should be id of the old tag. The {tag} field should contain the new value of the tag.

  • @param scope Authorization Scope for RBAC
  • @param tagDto TagDto with the new tag

* @return *TaskIDResult

type TaskDtoListResponse

type TaskDtoListResponse struct {
	Version  string             `json:"version,omitempty"`
	Response []AugmentedTaskDto `json:"response,omitempty"`
}

TaskDtoListResponse is ...

type TaskDtoResponse

type TaskDtoResponse struct {
	Version  string           `json:"version,omitempty"`
	Response AugmentedTaskDto `json:"response,omitempty"`
}

TaskDtoResponse is ...

type TaskID

type TaskID struct {
}

TaskID is ...

type TaskIDResponse

type TaskIDResponse struct {
	URL    string `json:"url,omitempty"`
	TaskID TaskID `json:"taskId,omitempty"`
}

TaskIDResponse is ...

type TaskIDResult

type TaskIDResult struct {
	Version  string         `json:"version,omitempty"`
	Response TaskIDResponse `json:"response,omitempty"`
}

TaskIDResult is ...

type TaskService

type TaskService service

TaskService is an interface with the Task API

func (*TaskService) GetTask

func (s *TaskService) GetTask(taskID string) (*TaskDtoResponse, *Response, error)

GetTask is ... This method is used to retrieve a task based on their id

* @return *TaskDtoResponse

func (*TaskService) GetTaskByRange

func (s *TaskService) GetTaskByRange(offset int32, limit int32) (*TaskDtoListResponse, *Response, error)

GetTaskByRange is ... This method is used to list number of tasks (Pagination)

* @return *TaskDtoListResponse

func (*TaskService) GetTaskTree

func (s *TaskService) GetTaskTree(taskID string) (*TaskDtoListResponse, *Response, error)

GetTaskTree is ... This method is used to retrieve a task with its children tasks based on their id

* @return *TaskDtoListResponse

type TicketAttribute

type TicketAttribute struct {
	Attribute string `json:"attribute,omitempty"` // Service Ticket Attribute Name
	Value     int64  `json:"value,omitempty"`     // Service Ticket Attribute Value
}

TicketAttribute is ... Object used to retrieve the ticket attributes

type TicketAttributeResult

type TicketAttributeResult struct {
	Version  string          `json:"version,omitempty"`
	Response TicketAttribute `json:"response,omitempty"`
}

TicketAttributeResult is ...

type TicketRBACResult

type TicketRBACResult struct {
	Version  string            `json:"version,omitempty"`
	Response ServiceTicketRBAC `json:"response,omitempty"`
}

TicketRBACResult is ...

type TicketService

type TicketService service

TicketService is an interface with the Ticket API

func (*TicketService) AddTicket

func (s *TicketService) AddTicket(user *User) (*TicketRBACResult, *Response, error)

AddTicket is ... This method is used to create a new user ticket

  • @param user user

* @return *TicketRBACResult

func (*TicketService) CreateTicketAttribute

func (s *TicketService) CreateTicketAttribute(ticketAttribute TicketAttribute) (*SuccessResult, *Response, error)

CreateTicketAttribute is ... Create and update specific ticket attribute, Idle Timeout Minimum 60 seconds, Max 3600 seconds, default 900 seconds, Session Timeout Minimum 1800 seconds, Max 86400 seconds, default 21600 seconds

  • @param ticketAttribute ticketAttribute

* @return *SuccessResult

func (*TicketService) DeleteTicket

func (s *TicketService) DeleteTicket(ticket string) (*SuccessResult, *Response, error)

DeleteTicket is ... Revoke ticket, effectively sign out

* @return *SuccessResult

func (*TicketService) DeleteTicketAttribute

func (s *TicketService) DeleteTicketAttribute(attribute string) (*SuccessResult, *Response, error)

DeleteTicketAttribute is ... Delete Ticket Attribute

* @return *SuccessResult

func (*TicketService) GetIdleTimeout

func (s *TicketService) GetIdleTimeout() (*TicketAttributeResult, *Response, error)

GetIdleTimeout is ... Get Idle timeout

* @return *TicketAttributeResult

func (*TicketService) GetSessionTimeout

func (s *TicketService) GetSessionTimeout() (*TicketAttributeResult, *Response, error)

GetSessionTimeout is ... Get Session timeout

* @return *TicketAttributeResult

type Timestamp

type Timestamp struct {
	SignerCertPath CertPath `json:"signerCertPath,omitempty"`
	Timestamp      string   `json:"timestamp,omitempty"`
}

Timestamp is ...

type Topology

type Topology struct {
	Nodes         []NodeWrapper `json:"nodes,omitempty"` // List of devices and hosts
	Links         []LinkWrapper `json:"links,omitempty"` // List of link between devices
	AttributeInfo string        `json:"attributeInfo,omitempty"`
	Id            string        `json:"id,omitempty"`
}

Topology is ...

type TopologyApplicationDto

type TopologyApplicationDto struct {
	Name        string `json:"name,omitempty"`        // Name for this Application
	ID          string `json:"id,omitempty"`          // Unique identifier for this Application
	Description string `json:"description,omitempty"` // Description for this Application
}

TopologyApplicationDto is ...

type TopologyApplicationListResult

type TopologyApplicationListResult struct {
	Version  string                   `json:"version,omitempty"`
	Response []TopologyApplicationDto `json:"response,omitempty"`
}

TopologyApplicationListResult is ...

type TopologyApplicationResult

type TopologyApplicationResult struct {
	Version  string                 `json:"version,omitempty"`
	Response TopologyApplicationDto `json:"response,omitempty"`
}

TopologyApplicationResult is ...

type TopologyApplicationService

type TopologyApplicationService service

TopologyApplicationService is an interface with the Topology API

func (*TopologyApplicationService) CreateTopologyApplications

func (s *TopologyApplicationService) CreateTopologyApplications(topologyApplicationDtoList *[]TopologyApplicationDto) (*TaskIDResult, *Response, error)

CreateTopologyApplications is ... This method is used to create topology applications.

  • @param topologyApplicationDtoList application

* @return *TaskIDResult

func (*TopologyApplicationService) CreateTopologyApplications1

func (s *TopologyApplicationService) CreateTopologyApplications1(topologyApplicationDtoList *[]TopologyApplicationDto) (*TaskIDResult, *Response, error)

CreateTopologyApplications1 is ... This method is used to create topology applications.

  • @param topologyApplicationDtoList application

* @return *TaskIDResult

func (*TopologyApplicationService) CreateTopologyPages

func (s *TopologyApplicationService) CreateTopologyPages(applicationUUID string, topologyPageDtoList *[]TopologyPageDto) (*TaskIDResult, *Response, error)

CreateTopologyPages is ... This method is used to create topology pages.

  • @param topologyPageDtoList page

* @return *TaskIDResult

func (*TopologyApplicationService) CreateTopologyPages2

func (s *TopologyApplicationService) CreateTopologyPages2(applicationUUID string, topologyPageDtoList *[]TopologyPageDto) (*TaskIDResult, *Response, error)

CreateTopologyPages2 is ... This method is used to create topology pages.

  • @param topologyPageDtoList page

* @return *TaskIDResult

func (*TopologyApplicationService) CreateTopologyViews

func (s *TopologyApplicationService) CreateTopologyViews(applicationUUID string, pageUUID string, topologyViewDtoList *[]TopologyViewDto) (*TaskIDResult, *Response, error)

CreateTopologyViews is ... This method is used to create topology views.

  • @param topologyViewDtoList view

* @return *TaskIDResult

func (*TopologyApplicationService) CreateTopologyViews3

func (s *TopologyApplicationService) CreateTopologyViews3(applicationUUID string, pageUUID string, topologyViewDtoList *[]TopologyViewDto) (*TaskIDResult, *Response, error)

CreateTopologyViews3 is ... This method is used to create topology views.

  • @param topologyViewDtoList view

* @return *TaskIDResult

func (*TopologyApplicationService) DeleteTopologyApplication

func (s *TopologyApplicationService) DeleteTopologyApplication(applicationUUID string) (*TaskIDResult, *Response, error)

DeleteTopologyApplication is ... This method is used to delete a topology application.

* @return *TaskIDResult

func (*TopologyApplicationService) DeleteTopologyApplication4

func (s *TopologyApplicationService) DeleteTopologyApplication4(applicationUUID string) (*TaskIDResult, *Response, error)

DeleteTopologyApplication4 is ... This method is used to delete a topology application.

* @return *TaskIDResult

func (*TopologyApplicationService) DeleteTopologyPage

func (s *TopologyApplicationService) DeleteTopologyPage(applicationUUID string, pageUUID string) (*TaskIDResult, *Response, error)

DeleteTopologyPage is ... This method is used to delete a topology page.

* @return *TaskIDResult

func (*TopologyApplicationService) DeleteTopologyPage5

func (s *TopologyApplicationService) DeleteTopologyPage5(applicationUUID string, pageUUID string) (*TaskIDResult, *Response, error)

DeleteTopologyPage5 is ... This method is used to delete a topology page.

* @return *TaskIDResult

func (*TopologyApplicationService) DeleteTopologyView

func (s *TopologyApplicationService) DeleteTopologyView(applicationUUID string, pageUUID string, viewUUID string) (*TaskIDResult, *Response, error)

DeleteTopologyView is ... This method is used to delete a topology view.

* @return *TaskIDResult

func (*TopologyApplicationService) DeleteTopologyView6

func (s *TopologyApplicationService) DeleteTopologyView6(applicationUUID string, pageUUID string, viewUUID string) (*TaskIDResult, *Response, error)

DeleteTopologyView6 is ... This method is used to delete a topology view.

* @return *TaskIDResult

func (*TopologyApplicationService) GetTopologyApplication

func (s *TopologyApplicationService) GetTopologyApplication(applicationUUID string) (*TopologyApplicationResult, *Response, error)

GetTopologyApplication is ... This method is used to obtain a topology aplication

* @return *TopologyApplicationResult

func (*TopologyApplicationService) GetTopologyApplication11

func (s *TopologyApplicationService) GetTopologyApplication11(applicationUUID string) (*TopologyApplicationResult, *Response, error)

GetTopologyApplication11 is ... This method is used to obtain a topology aplication

* @return *TopologyApplicationResult

func (*TopologyApplicationService) GetTopologyApplicationPage

func (s *TopologyApplicationService) GetTopologyApplicationPage(applicationUUID string, pageUUID string) (*TopologyPageResult, *Response, error)

GetTopologyApplicationPage is ... This method is used to obtain a topology aplication page

* @return *TopologyPageResult

func (*TopologyApplicationService) GetTopologyApplicationPage9

func (s *TopologyApplicationService) GetTopologyApplicationPage9(applicationUUID string, pageUUID string) (*TopologyPageResult, *Response, error)

GetTopologyApplicationPage9 is ... This method is used to obtain a topology aplication page

* @return *TopologyPageResult

func (*TopologyApplicationService) GetTopologyApplicationPageView

func (s *TopologyApplicationService) GetTopologyApplicationPageView(applicationUUID string, pageUUID string, viewUUID string) (*TopologyViewResult, *Response, error)

GetTopologyApplicationPageView is ... This method is used to obtain a topology aplication page view

* @return *TopologyViewResult

func (*TopologyApplicationService) GetTopologyApplicationPageView7

func (s *TopologyApplicationService) GetTopologyApplicationPageView7(applicationUUID string, pageUUID string, viewUUID string) (*TopologyViewResult, *Response, error)

GetTopologyApplicationPageView7 is ... This method is used to obtain a topology aplication page view

* @return *TopologyViewResult

func (*TopologyApplicationService) GetTopologyApplicationPageViews

func (s *TopologyApplicationService) GetTopologyApplicationPageViews(applicationUUID string, pageUUID string) (*TopologyViewListResult, *Response, error)

GetTopologyApplicationPageViews is ... This method is used to obtain the list of topology aplication page Views for an topology application Page

* @return *TopologyViewListResult

func (*TopologyApplicationService) GetTopologyApplicationPageViews8

func (s *TopologyApplicationService) GetTopologyApplicationPageViews8(applicationUUID string, pageUUID string) (*TopologyViewListResult, *Response, error)

GetTopologyApplicationPageViews8 is ... This method is used to obtain the list of topology aplication page Views for an topology application Page

* @return *TopologyViewListResult

func (*TopologyApplicationService) GetTopologyApplicationPages

func (s *TopologyApplicationService) GetTopologyApplicationPages(applicationUUID string) (*TopologyPageListResult, *Response, error)

GetTopologyApplicationPages is ... This method is used to obtain the list of topology aplication pages for an topology application

* @return *TopologyPageListResult

func (*TopologyApplicationService) GetTopologyApplicationPages10

func (s *TopologyApplicationService) GetTopologyApplicationPages10(applicationUUID string) (*TopologyPageListResult, *Response, error)

GetTopologyApplicationPages10 is ... This method is used to obtain the list of topology aplication pages for an topology application

* @return *TopologyPageListResult

func (*TopologyApplicationService) GetTopologyApplications

func (s *TopologyApplicationService) GetTopologyApplications() (*TopologyApplicationListResult, *Response, error)

GetTopologyApplications is ... This method is used to obtain the list of topology aplications

* @return *TopologyApplicationListResult

func (*TopologyApplicationService) GetTopologyApplications12

func (s *TopologyApplicationService) GetTopologyApplications12() (*TopologyApplicationListResult, *Response, error)

GetTopologyApplications12 is ... This method is used to obtain the list of topology aplications

* @return *TopologyApplicationListResult

func (*TopologyApplicationService) UpdateTopologyApplication

func (s *TopologyApplicationService) UpdateTopologyApplication(topologyApplicationDtoList *[]TopologyApplicationDto) (*TaskIDResult, *Response, error)

UpdateTopologyApplication is ... This method is used to update topology applications.

  • @param topologyApplicationDtoList application

* @return *TaskIDResult

func (*TopologyApplicationService) UpdateTopologyApplication13

func (s *TopologyApplicationService) UpdateTopologyApplication13(topologyApplicationDtoList *[]TopologyApplicationDto) (*TaskIDResult, *Response, error)

UpdateTopologyApplication13 is ... This method is used to update topology applications.

  • @param topologyApplicationDtoList application

* @return *TaskIDResult

func (*TopologyApplicationService) UpdateTopologyPages

func (s *TopologyApplicationService) UpdateTopologyPages(applicationUUID string, topologyPageDtoList *[]TopologyPageDto) (*TaskIDResult, *Response, error)

UpdateTopologyPages is ... This method is used to update topology pages.

  • @param topologyPageDtoList page

* @return *TaskIDResult

func (*TopologyApplicationService) UpdateTopologyPages14

func (s *TopologyApplicationService) UpdateTopologyPages14(applicationUUID string, topologyPageDtoList *[]TopologyPageDto) (*TaskIDResult, *Response, error)

UpdateTopologyPages14 is ... This method is used to update topology pages.

  • @param topologyPageDtoList page

* @return *TaskIDResult

func (*TopologyApplicationService) UpdateTopologyViews

func (s *TopologyApplicationService) UpdateTopologyViews(applicationUUID string, pageUUID string, topologyViewDtoList *[]TopologyViewDto) (*TaskIDResult, *Response, error)

UpdateTopologyViews is ... This method is used to update topology views.

  • @param topologyViewDtoList page

* @return *TaskIDResult

func (*TopologyApplicationService) UpdateTopologyViews15

func (s *TopologyApplicationService) UpdateTopologyViews15(applicationUUID string, pageUUID string, topologyViewDtoList *[]TopologyViewDto) (*TaskIDResult, *Response, error)

UpdateTopologyViews15 is ... This method is used to update topology views.

  • @param topologyViewDtoList page

* @return *TaskIDResult

type TopologyPageDto

type TopologyPageDto struct {
	Description     string `json:"description,omitempty"`     // Description for this Page
	Name            string `json:"name,omitempty"`            // Name for this Page
	ID              string `json:"id,omitempty"`              // Unique identifier for this Page
	ApplicationUUID string `json:"applicationUuid,omitempty"` // Application unique identifier for this Page
	DefaultViewID   string `json:"defaultViewId,omitempty"`   // Default View unique identifier for this Page
}

TopologyPageDto is ...

type TopologyPageListResult

type TopologyPageListResult struct {
	Version  string            `json:"version,omitempty"`
	Response []TopologyPageDto `json:"response,omitempty"`
}

TopologyPageListResult is ...

type TopologyPageResult

type TopologyPageResult struct {
	Version  string          `json:"version,omitempty"`
	Response TopologyPageDto `json:"response,omitempty"`
}

TopologyPageResult is ...

type TopologyResult

type TopologyResult struct {
	Version  string   `json:"version,omitempty"`
	Response Topology `json:"response,omitempty"`
}

TopologyResult is ...

type TopologyService

type TopologyService service

TopologyService is an interface with the Topology API

func (*TopologyService) GetL2Topology

func (s *TopologyService) GetL2Topology(vlanID string) (*TopologyResult, *Response, error)

GetL2Topology is ... This method is used to obtain the Layer 2 topology by Vlan ID

* @return *TopologyResult

func (*TopologyService) GetL3Topology

func (s *TopologyService) GetL3Topology(topologyType string) (*TopologyResult, *Response, error)

GetL3Topology is ... This method is used to obtain Layer 3 device topology by routing protocol type

* @return *TopologyResult

func (*TopologyService) GetL3TopologyForVrf

func (s *TopologyService) GetL3TopologyForVrf(vrfName string) (*TopologyResult, *Response, error)

GetL3TopologyForVrf is ... This method is used to obtain Layer 3 device topology by vrf name

* @return *TopologyResult

func (*TopologyService) GetPhysicalTopology

func (s *TopologyService) GetPhysicalTopology() (*TopologyResult, *Response, error)

GetPhysicalTopology is ... This method is used to obtain the raw physical topology

* @return *TopologyResult

func (*TopologyService) LoadCustomTopology

func (s *TopologyService) LoadCustomTopology() (*TopologyResult, *Response, error)

LoadCustomTopology is ... This method is used to obtain the topology by customized layout

* @return *TopologyResult

func (*TopologyService) SaveCustomTopology

func (s *TopologyService) SaveCustomTopology(topo Topology) (*TaskIDResult, *Response, error)

SaveCustomTopology is ... This method is used to save the topology in canvas implementation

  • @param topo Topology

* @return *TaskIDResult

type TopologyVLANService

type TopologyVLANService service

TopologyVLANService is an interface with the API

func (*TopologyVLANService) GetVLANNames

func (s *TopologyVLANService) GetVLANNames() (*VLANNamesResult, *Response, error)

GetVLANNames is ... This method is used to obtain the list of vlan names

* @return *VLANNamesResult

func (*TopologyVLANService) GetVLANNames1

func (s *TopologyVLANService) GetVLANNames1() (*VLANNamesResult, *Response, error)

GetVLANNames1 is ... This method is used to obtain the list of vlan names

* @return *VLANNamesResult

type TopologyViewDto

type TopologyViewDto struct {
	Description     string   `json:"description,omitempty"`     // View description
	Name            string   `json:"name,omitempty"`            // View name
	ID              string   `json:"id,omitempty"`              // Unique Identifier for View
	Topology        Topology `json:"topology,omitempty"`        // Topology being represented by this view
	ApplicationUUID string   `json:"applicationUuid,omitempty"` // Application unique identifier for this view
	PageUUID        string   `json:"pageUuid,omitempty"`        // Page unique identifier for this view inside the corresponding application
}

TopologyViewDto is ...

type TopologyViewListResult

type TopologyViewListResult struct {
	Version  string            `json:"version,omitempty"`
	Response []TopologyViewDto `json:"response,omitempty"`
}

TopologyViewListResult is ...

type TopologyViewResult

type TopologyViewResult struct {
	Version  string          `json:"version,omitempty"`
	Response TopologyViewDto `json:"response,omitempty"`
}

TopologyViewResult is ...

type TrustpoolUpdateParam

type TrustpoolUpdateParam struct {
	Simulate bool   `json:"simulate,omitempty"`
	ID       string `json:"id,omitempty"`
}

TrustpoolUpdateParam is ...

type TrustpoolUpdateStatus

type TrustpoolUpdateStatus struct {
	Update        string `json:"update,omitempty"`
	AttributeInfo string `json:"attributeInfo,omitempty"`
	ID            string `json:"id,omitempty"`
}

TrustpoolUpdateStatus is ...

type TrustpoolUpdateStatusResult

type TrustpoolUpdateStatusResult struct {
	Response TrustpoolUpdateStatus `json:"response,omitempty"`
	Version  string                `json:"version,omitempty"`
}

TrustpoolUpdateStatusResult is ...

type Type

type Type struct {
}

Type is ...

type TypeVariable

type TypeVariable struct {
	Bounds             []Type             `json:"bounds,omitempty"`
	GenericDeclaration GenericDeclaration `json:"genericDeclaration,omitempty"`
	Name               string             `json:"name,omitempty"`
}

TypeVariable is ...

type URL

type URL struct {
	Path        string `json:"path,omitempty"`
	Authority   string `json:"authority,omitempty"`
	Query       string `json:"query,omitempty"`
	Protocol    string `json:"protocol,omitempty"`
	File        string `json:"file,omitempty"`
	Host        string `json:"host,omitempty"`
	Ref         string `json:"ref,omitempty"`
	UserInfo    string `json:"userInfo,omitempty"`
	Port        int32  `json:"port,omitempty"`
	DefaultPort int32  `json:"defaultPort,omitempty"`
	Content     string `json:"content,omitempty"`
}

URL is ...

type UpdateApplicationQueryParams

type UpdateApplicationQueryParams struct {
	ScheduleAt     string `url:"scheduleAt,omitempty"`     // scheduleAt
	ScheduleDesc   string `url:"scheduleDesc,omitempty"`   // scheduleDesc
	ScheduleOrigin string `url:"scheduleOrigin,omitempty"` // scheduleOrigin
}

UpdateApplicationQueryParams is ...

type UpdateQueryParams

type UpdateQueryParams struct {
	ScheduleAt     string `url:"scheduleAt,omitempty"`     // Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the policy should be scheduled (Optional)
	ScheduleDesc   string `url:"scheduleDesc,omitempty"`   // Custom Description (Optional)
	ScheduleOrigin string `url:"scheduleOrigin,omitempty"` // Originator of this call (Optional)
}

UpdateQueryParams is ...

type User

type User struct {
	Password string `json:"password,omitempty"` // password
	Username string `json:"username,omitempty"` // username
}

User is ...

type UserListResult

type UserListResult struct {
	Version  string       `json:"version,omitempty"`
	Response []UserReqRes `json:"response,omitempty"`
}

UserListResult is ...

type UserLockExpiryTime

type UserLockExpiryTime struct {
	LockExpiryTime int32 `json:"lockExpiryTime,omitempty"` // User Lock Expiry Timer
}

UserLockExpiryTime is ... Object used to retrieve the global user lock expiry timer

type UserLockExpiryTimeResult

type UserLockExpiryTimeResult struct {
	Version  string             `json:"version,omitempty"`
	Response UserLockExpiryTime `json:"response,omitempty"`
}

UserLockExpiryTimeResult is ...

type UserLoginInvalidAttemptCount

type UserLoginInvalidAttemptCount struct {
	LoginInvalidAttemptCount int32 `json:"loginInvalidAttemptCount,omitempty"` // User Invalid Attempt Count
}

UserLoginInvalidAttemptCount is ... Object used to retrieve the maximum user invalid attempts permitted before user account is locked.

type UserLoginInvalidAttemptCountResult

type UserLoginInvalidAttemptCountResult struct {
	Version  string                       `json:"version,omitempty"`
	Response UserLoginInvalidAttemptCount `json:"response,omitempty"`
}

UserLoginInvalidAttemptCountResult is ...

type UserReqRes

type UserReqRes struct {
	Username      string      `json:"username,omitempty"`      // Username
	Authorization []ScopeRole `json:"authorization,omitempty"` // User Authorization Scope
	AuthSource    string      `json:"authSource,omitempty"`    // User Authentication Source
}

UserReqRes is ...

type UserResult

type UserResult struct {
	Version  string     `json:"version,omitempty"`
	Response UserReqRes `json:"response,omitempty"`
}

UserResult is ...

type UserService

type UserService service

UserService is an interface with the User API

func (*UserService) AddUser

func (s *UserService) AddUser(user UserReqRes) (*SuccessResult, *Response, error)

AddUser is ... This method is used to add a new user. <b>The password is excluded from the json schema below, but will still need to be included.</b>

  • @param user user

* @return *SuccessResult

func (*UserService) DeleteUser

func (s *UserService) DeleteUser(username string) (*SuccessResult, *Response, error)

DeleteUser is ... This method is used to delete a user.<br/> Admin permission is required.<br/> It is possible to delete your own user.

* @return *SuccessResult

func (*UserService) GetAttemptCount

func (s *UserService) GetAttemptCount() (*UserLoginInvalidAttemptCountResult, *Response, error)

GetAttemptCount is ... This method is used to get the max user invalid attempts before the user account is locked.

* @return *UserLoginInvalidAttemptCountResult

func (*UserService) GetAutoPassphrase

func (s *UserService) GetAutoPassphrase() (*AutoPassphraseResult, *Response, error)

GetAutoPassphrase is ... This method is used to get an auto generated password.

* @return *AutoPassphraseResult

func (*UserService) GetAutoPassphraseWithSeedPhrase

func (s *UserService) GetAutoPassphraseWithSeedPhrase(seedPhrase string) (*AutoPassphraseResult, *Response, error)

GetAutoPassphraseWithSeedPhrase is ... This method is used to get an auto generated password with a seed phrase.

* @return *AutoPassphraseResult

func (*UserService) GetLockExpiry

func (s *UserService) GetLockExpiry() (*UserLockExpiryTimeResult, *Response, error)

GetLockExpiry is ... This method is used to get the lock expiration timer value which is used to unlock a user account.

* @return *UserLockExpiryTimeResult

func (*UserService) GetUser

func (s *UserService) GetUser(username string) (*UserResult, *Response, error)

GetUser is ... This method is used to get user data by username.

* @return *UserResult

func (*UserService) GetUserStatus

func (s *UserService) GetUserStatus(username string) (*UserStatusResult, *Response, error)

GetUserStatus is ... This method is used to retrieve a user's lock status.<br/> Admin permission is required.<br/>

* @return *UserStatusResult

func (*UserService) GetUsers

func (s *UserService) GetUsers(queryParams *GetUsersQueryParams) (*UserListResult, *Response, error)

GetUsers is ... This method is used to get the list of Users. If you are an admin user, this will return a list of all the users, if you have an observer role, it will only show your own user information.

  • @param queryParams

* @return *UserListResult

func (*UserService) UpdateAttemptCount

func (s *UserService) UpdateAttemptCount(attemptCount UserLoginInvalidAttemptCount) (*SuccessResult, *Response, error)

UpdateAttemptCount is ... This method is used to update the max user invalid attempts before the user account is locked.

  • @param attemptCount attemptCount

* @return *SuccessResult

func (*UserService) UpdateLockExpiryTimeout

func (s *UserService) UpdateLockExpiryTimeout(expiryTime UserLockExpiryTime) (*SuccessResult, *Response, error)

UpdateLockExpiryTimeout is ... This method is used to set the lock expiration timer value which is used to unlock a user account.

  • @param expiryTime expiryTime

* @return *SuccessResult

func (*UserService) UpdateUser

func (s *UserService) UpdateUser(user UserReqRes) (*SuccessResult, *Response, error)

UpdateUser is ... This method is used to update user data.<br /> To update the password, \"oldPassword\" will need to be provided and the new password can be represented as \"password\".<br /> <b>A user can only update their own password</b>.<br /> For an admin to update another admin or user's password, then the process is to delete and add a new user by the same name with the same permissions.

  • @param user user

* @return *SuccessResult

func (*UserService) UpdateUserStatus

func (s *UserService) UpdateUserStatus(userStatus UserStatus) (*SuccessResult, *Response, error)

UpdateUserStatus is ... This method is used to update a user's lock status from locked to un-locked.<br/> Admin permission is required.<br/>

  • @param userStatus userStatus

* @return *SuccessResult

type UserStatus

type UserStatus struct {
	Username       string `json:"username,omitempty"`
	AccountLocked  bool   `json:"accountLocked,omitempty"`
	LockedAt       string `json:"lockedAt,omitempty"`
	LockExpiration int64  `json:"lockExpiration,omitempty"`
}

UserStatus is ...

type UserStatusResult

type UserStatusResult struct {
	Version  string     `json:"version,omitempty"`
	Response UserStatus `json:"response,omitempty"`
}

UserStatusResult is ...

type VLANDto

type VLANDto struct {
	NumberOfIPs    int32  `json:"numberOfIPs,omitempty"`
	Mask           int32  `json:"mask,omitempty"`
	Prefix         string `json:"prefix,omitempty"`
	InterfaceName  string `json:"interfaceName,omitempty"`
	IPAddress      string `json:"ipAddress,omitempty"`
	NetworkAddress string `json:"networkAddress,omitempty"`
	VLANType       string `json:"vlanType,omitempty"`
	VLANNumber     int32  `json:"vlanNumber,omitempty"`
}

VLANDto is ...

type VLANListResult

type VLANListResult struct {
	Version  string    `json:"version,omitempty"`
	Response []VLANDto `json:"response,omitempty"`
}

VLANListResult is ...

type VLANNamesResult

type VLANNamesResult struct {
	Version  string   `json:"version,omitempty"`
	Response []string `json:"response,omitempty"`
}

VLANNamesResult is ...

type VLANService

type VLANService service

VLANService is an interface with the Networkdeviceidvlan API

func (*VLANService) GetDeviceVLANData

func (s *VLANService) GetDeviceVLANData(scope string, id string, queryParams *GetDeviceVLANDataQueryParams) (*VLANListResult, *Response, error)

GetDeviceVLANData is ... getDeviceVLANData

  • @param queryParams
  • @param scope Authorization Scope for RBAC

* @return *VLANListResult

type VRFService

type VRFService service

VRFService is an interface with the Topologyvrfvrfname API

func (*VRFService) GetVLANNames

func (s *VRFService) GetVLANNames() (*VrfNamesResult, *Response, error)

GetVLANNames is ... This method is used to obtain the list of vrf names

* @return *VrfNamesResult

type VersionDiffDto

type VersionDiffDto struct {
	ID       string          `json:"id,omitempty"`       // id
	Policies []PolicyDiffDto `json:"policies,omitempty"` // policies
}

VersionDiffDto is ...

type VersionDiffResult

type VersionDiffResult struct {
	Response VersionDiffDto `json:"response,omitempty"`
	Version  string         `json:"version,omitempty"`
}

VersionDiffResult is ...

type VersionNumberDto

type VersionNumberDto struct {
	Version    int64 `json:"version,omitempty"`
	CreateTime int64 `json:"createTime,omitempty"`
}

VersionNumberDto is ...

type Void

type Void struct {
}

Void is ...

type VrfNamesResult

type VrfNamesResult struct {
	Version  string   `json:"version,omitempty"`
	Response []string `json:"response,omitempty"`
}

VrfNamesResult is ...

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL