dnac

package
v5.0.11 Latest Latest
Warning

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

 Go to latest Published: Sep 4, 2023 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const DNAC_BASE_URL = "DNAC_BASE_URL"
View Source 
const DNAC_DEBUG = "DNAC_DEBUG"
View Source 
const DNAC_PASSWORD = "DNAC_PASSWORD"
View Source 
const DNAC_SSL_VERIFY = "DNAC_SSL_VERIFY"
View Source 
const DNAC_USERNAME = "DNAC_USERNAME"
View Source 
const DNAC_WAIT_TIME = "DNAC_WAIT_TIME"

Variables

View Source 
var Error map[string]interface{}

Error indicates an error from the invocation of a Cisco DNA Center API.

Functions

func SetOptions 

func SetOptions(baseURL string, username string, password string, debug string, sslVerify string, waitTimeToManyRequest *int) error

SetOptions sets the environment variables

Types

type AddSSIDToIPPoolMappingHeaderParams 

type AddSSIDToIPPoolMappingHeaderParams struct {
	Persistbapioutput string `url:"__persistbapioutput,omitempty"` //Expects type string. Enable this parameter to execute the API and return a response asynchronously.
}

type ApProvisionHeaderParams 

type ApProvisionHeaderParams struct {
	Persistbapioutput string `url:"__persistbapioutput,omitempty"` //Expects type string.
}

type ApplicationPolicyService 

type ApplicationPolicyService service

func (*ApplicationPolicyService) ApplicationPolicyIntent 

func (s *ApplicationPolicyService) ApplicationPolicyIntent(requestApplicationPolicyApplicationPolicyIntent *RequestApplicationPolicyApplicationPolicyIntent) (*ResponseApplicationPolicyApplicationPolicyIntent, *resty.Response, error)

ApplicationPolicyIntent Application Policy Intent - aea4-bb7b-4329-bd06 

Create/Update/Delete application policy

Documentation Link: https://developer.cisco.com/docs/dna-center/#!application-policy-intent

func (*ApplicationPolicyService) CreateApplication 

func (s *ApplicationPolicyService) CreateApplication(requestApplicationPolicyCreateApplication *RequestApplicationPolicyCreateApplication) (*ResponseApplicationPolicyCreateApplication, *resty.Response, error)

CreateApplication Create Application - fb9b-f80f-491a-9851 

Create new Custom application

Documentation Link: https://developer.cisco.com/docs/dna-center/#!create-application

func (*ApplicationPolicyService) CreateApplicationPolicyQueuingProfile 

func (s *ApplicationPolicyService) CreateApplicationPolicyQueuingProfile(requestApplicationPolicyCreateApplicationPolicyQueuingProfile *RequestApplicationPolicyCreateApplicationPolicyQueuingProfile) (*ResponseApplicationPolicyCreateApplicationPolicyQueuingProfile, *resty.Response, error)

CreateApplicationPolicyQueuingProfile Create Application Policy Queuing Profile - 78b7-ba71-4959-bbd2 

Create new custom application queuing profile

Documentation Link: https://developer.cisco.com/docs/dna-center/#!create-application-policy-queuing-profile

func (*ApplicationPolicyService) CreateApplicationSet 

func (s *ApplicationPolicyService) CreateApplicationSet(requestApplicationPolicyCreateApplicationSet *RequestApplicationPolicyCreateApplicationSet) (*ResponseApplicationPolicyCreateApplicationSet, *resty.Response, error)

CreateApplicationSet Create Application Set - 3e94-cb1b-485b-8b0e 

Create new custom application-set/s

Documentation Link: https://developer.cisco.com/docs/dna-center/#!create-application-set

func (*ApplicationPolicyService) CreateQosDeviceInterfaceInfo 

func (s *ApplicationPolicyService) CreateQosDeviceInterfaceInfo(requestApplicationPolicyCreateQosDeviceInterfaceInfo *RequestApplicationPolicyCreateQosDeviceInterfaceInfo) (*ResponseApplicationPolicyCreateQosDeviceInterfaceInfo, *resty.Response, error)

CreateQosDeviceInterfaceInfo Create Qos Device Interface Info - 3889-59af-4cf8-9fde 

Create qos device interface infos associate with network device id to allow the user to mark specific interfaces as WAN, to associate WAN interfaces with specific SP Profile and to be able to define a shaper on WAN interfaces

Documentation Link: https://developer.cisco.com/docs/dna-center/#!create-qos-device-interface-info

func (*ApplicationPolicyService) DeleteApplication 

func (s *ApplicationPolicyService) DeleteApplication(DeleteApplicationQueryParams *DeleteApplicationQueryParams) (*ResponseApplicationPolicyDeleteApplication, *resty.Response, error)

DeleteApplication Delete Application - d49a-f9b8-4c6a-a8ea 

Delete existing application by its id

@param DeleteApplicationQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!delete-application

func (*ApplicationPolicyService) DeleteApplicationPolicyQueuingProfile 

func (s *ApplicationPolicyService) DeleteApplicationPolicyQueuingProfile(id string) (*ResponseApplicationPolicyDeleteApplicationPolicyQueuingProfile, *resty.Response, error)

DeleteApplicationPolicyQueuingProfile Delete Application Policy Queuing Profile - 09a0-482f-422b-b325 

Delete existing custom application policy queuing profile by id

@param id id path parameter. Id of custom queuing profile to delete

Documentation Link: https://developer.cisco.com/docs/dna-center/#!delete-application-policy-queuing-profile

func (*ApplicationPolicyService) DeleteApplicationSet 

func (s *ApplicationPolicyService) DeleteApplicationSet(DeleteApplicationSetQueryParams *DeleteApplicationSetQueryParams) (*ResponseApplicationPolicyDeleteApplicationSet, *resty.Response, error)

DeleteApplicationSet Delete Application Set - 70b6-f8e1-40b8-b784 

Delete existing application-set by it's id

@param DeleteApplicationSetQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!delete-application-set

func (*ApplicationPolicyService) DeleteQosDeviceInterfaceInfo 

func (s *ApplicationPolicyService) DeleteQosDeviceInterfaceInfo(id string) (*ResponseApplicationPolicyDeleteQosDeviceInterfaceInfo, *resty.Response, error)

DeleteQosDeviceInterfaceInfo Delete Qos Device Interface Info - 51b1-b8bd-435b-9842 

Delete all qos device interface infos associate with network device id

@param id id path parameter. Id of the qos device info, this object holds all qos device interface infos associate with network device id

Documentation Link: https://developer.cisco.com/docs/dna-center/#!delete-qos-device-interface-info

func (*ApplicationPolicyService) EditApplication 

func (s *ApplicationPolicyService) EditApplication(requestApplicationPolicyEditApplication *RequestApplicationPolicyEditApplication) (*ResponseApplicationPolicyEditApplication, *resty.Response, error)

EditApplication Edit Application - 3986-6887-4439-a41d 

Edit the attributes of an existing application

func (*ApplicationPolicyService) GetApplicationPolicy 

func (s *ApplicationPolicyService) GetApplicationPolicy(GetApplicationPolicyQueryParams *GetApplicationPolicyQueryParams) (*ResponseApplicationPolicyGetApplicationPolicy, *resty.Response, error)

GetApplicationPolicy Get Application Policy - 3d9f-6b17-4879-8e45 

Get all existing application policies

@param GetApplicationPolicyQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-application-policy

func (*ApplicationPolicyService) GetApplicationPolicyDefault 

func (s *ApplicationPolicyService) GetApplicationPolicyDefault() (*ResponseApplicationPolicyGetApplicationPolicyDefault, *resty.Response, error)

GetApplicationPolicyDefault Get Application Policy Default - 21a2-4b5d-4f98-a730 

Get default application policy

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-application-policy-default

func (*ApplicationPolicyService) GetApplicationPolicyQueuingProfile 

func (s *ApplicationPolicyService) GetApplicationPolicyQueuingProfile(GetApplicationPolicyQueuingProfileQueryParams *GetApplicationPolicyQueuingProfileQueryParams) (*ResponseApplicationPolicyGetApplicationPolicyQueuingProfile, *resty.Response, error)

GetApplicationPolicyQueuingProfile Get Application Policy Queuing Profile - 1698-39cc-4bdb-8ed9 

Get all or by name, existing application policy queuing profiles

@param GetApplicationPolicyQueuingProfileQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-application-policy-queuing-profile

func (*ApplicationPolicyService) GetApplicationPolicyQueuingProfileCount 

func (s *ApplicationPolicyService) GetApplicationPolicyQueuingProfileCount() (*ResponseApplicationPolicyGetApplicationPolicyQueuingProfileCount, *resty.Response, error)

GetApplicationPolicyQueuingProfileCount Get Application Policy Queuing Profile Count - efa2-4afa-4578-88e9 

Get the number of all existing  application policy queuing profile

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-application-policy-queuing-profile-count

func (*ApplicationPolicyService) GetApplicationSets 

func (s *ApplicationPolicyService) GetApplicationSets(GetApplicationSetsQueryParams *GetApplicationSetsQueryParams) (*ResponseApplicationPolicyGetApplicationSets, *resty.Response, error)

GetApplicationSets Get Application Sets - cb86-8b21-4289-8159 

Get appllication-sets by offset/limit or by name

@param GetApplicationSetsQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-application-sets

func (*ApplicationPolicyService) GetApplicationSetsCount 

func (s *ApplicationPolicyService) GetApplicationSetsCount() (*ResponseApplicationPolicyGetApplicationSetsCount, *resty.Response, error)

GetApplicationSetsCount Get Application Sets Count - cfa0-49a6-44bb-8a07 

Get the number of existing application-sets

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-application-sets-count

func (*ApplicationPolicyService) GetApplications 

func (s *ApplicationPolicyService) GetApplications(GetApplicationsQueryParams *GetApplicationsQueryParams) (*ResponseApplicationPolicyGetApplications, *resty.Response, error)

GetApplications Get Applications - 8893-b834-445b-b29c 

Get applications by offset/limit or by name

@param GetApplicationsQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-applications

func (*ApplicationPolicyService) GetApplicationsCount 

func (s *ApplicationPolicyService) GetApplicationsCount() (*ResponseApplicationPolicyGetApplicationsCount, *resty.Response, error)

GetApplicationsCount Get Applications Count - 039d-e8b1-47a9-8690 

Get the number of all existing applications

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-applications-count

func (*ApplicationPolicyService) GetQosDeviceInterfaceInfo 

func (s *ApplicationPolicyService) GetQosDeviceInterfaceInfo(GetQosDeviceInterfaceInfoQueryParams *GetQosDeviceInterfaceInfoQueryParams) (*ResponseApplicationPolicyGetQosDeviceInterfaceInfo, *resty.Response, error)

GetQosDeviceInterfaceInfo Get Qos Device Interface Info - 42a6-e9eb-46bb-a197 

Get all or by network device id, existing qos device interface infos

@param GetQosDeviceInterfaceInfoQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-qos-device-interface-info

func (*ApplicationPolicyService) GetQosDeviceInterfaceInfoCount 

func (s *ApplicationPolicyService) GetQosDeviceInterfaceInfoCount() (*ResponseApplicationPolicyGetQosDeviceInterfaceInfoCount, *resty.Response, error)

GetQosDeviceInterfaceInfoCount Get Qos Device Interface Info Count - 729a-98e1-4a3b-91f2 

Get the number of all existing qos device interface infos group by network device id

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-qos-device-interface-info-count

func (*ApplicationPolicyService) UpdateApplicationPolicyQueuingProfile 

func (s *ApplicationPolicyService) UpdateApplicationPolicyQueuingProfile(requestApplicationPolicyUpdateApplicationPolicyQueuingProfile *RequestApplicationPolicyUpdateApplicationPolicyQueuingProfile) (*ResponseApplicationPolicyUpdateApplicationPolicyQueuingProfile, *resty.Response, error)

UpdateApplicationPolicyQueuingProfile Update Application Policy Queuing Profile - da98-38ea-44aa-8024 

Update existing custom application queuing profile

func (*ApplicationPolicyService) UpdateQosDeviceInterfaceInfo 

func (s *ApplicationPolicyService) UpdateQosDeviceInterfaceInfo(requestApplicationPolicyUpdateQosDeviceInterfaceInfo *RequestApplicationPolicyUpdateQosDeviceInterfaceInfo) (*ResponseApplicationPolicyUpdateQosDeviceInterfaceInfo, *resty.Response, error)

UpdateQosDeviceInterfaceInfo Update Qos Device Interface Info - 71b7-ba8c-47b8-95b6 

Update existing qos device interface infos associate with network device id

type ApplicationsQueryParams 

type ApplicationsQueryParams struct {
	SiteID            string  `url:"siteId,omitempty"`            //Assurance site UUID value (Cannot be submitted together with deviceId and clientMac)
	DeviceID          string  `url:"deviceId,omitempty"`          //Assurance device UUID value (Cannot be submitted together with siteId and clientMac)
	MacAddress        string  `url:"macAddress,omitempty"`        //Client device's MAC address (Cannot be submitted together with siteId and deviceId)
	StartTime         float64 `url:"startTime,omitempty"`         //Starting epoch time in milliseconds of time window
	EndTime           float64 `url:"endTime,omitempty"`           //Ending epoch time in milliseconds of time window
	ApplicationHealth string  `url:"applicationHealth,omitempty"` //Application health category (POOR, FAIR, or GOOD.  Optionally use with siteId only)
	Offset            float64 `url:"offset,omitempty"`            //The offset of the first application in the returned data (optionally used with siteId only)
	Limit             float64 `url:"limit,omitempty"`             //The max number of application entries in returned data [1, 1000] (optionally used with siteId only)
	ApplicationName   string  `url:"applicationName,omitempty"`   //The name of the application to get information on
}

type ApplicationsService 

type ApplicationsService service

func (*ApplicationsService) Applications 

func (s *ApplicationsService) Applications(ApplicationsQueryParams *ApplicationsQueryParams) (*ResponseApplicationsApplications, *resty.Response, error)

Applications Applications - 2db5-8a1f-4fea-9242 

Intent API to get a list of applications for a specific site, a device, or a client device's MAC address. For a combination of a specific application with site and/or device the API gets list of issues/devices/endpoints.

@param ApplicationsQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!applications

type AssignDeviceCredentialToSiteHeaderParams 

type AssignDeviceCredentialToSiteHeaderParams struct {
	Persistbapioutput string `url:"__persistbapioutput,omitempty"` //Expects type string. Persist bapi sync response
}

type AssignDevicesToSiteHeaderParams 

type AssignDevicesToSiteHeaderParams struct {
	Runsync           string `url:"__runsync,omitempty"`           //Expects type bool. Enable this parameter to execute the API and return a response synchronously
	Persistbapioutput string `url:"__persistbapioutput,omitempty"` //Expects type bool. Persist bapi sync response
	Runsynctimeout    string `url:"__runsynctimeout,omitempty"`    //Expects type float64. During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated
}

type AuthenticationAPIResponse 

type AuthenticationAPIResponse struct {
	Token string `json:"Token,omitempty"` //
}

AuthenticationAPIResponse is the AuthenticationAPIResponse definition

type AuthenticationManagementService 

type AuthenticationManagementService service

func (*AuthenticationManagementService) AuthenticationApI 

func (s *AuthenticationManagementService) AuthenticationApI() (*ResponseAuthenticationManagementAuthenticationApI, *resty.Response, error)

AuthenticationApI Authentication API - ac8a-e94c-4e69-a09d 

API to obtain an access token, which remains valid for 1 hour. The token obtained using this API is required to be set as value to the X-Auth-Token HTTP Header for all API calls to Cisco DNA Center.

Documentation Link: https://developer.cisco.com/docs/dna-center/#!authentication-api

func (*AuthenticationManagementService) ImportCertificate 

func (s *AuthenticationManagementService) ImportCertificate(ImportCertificateQueryParams *ImportCertificateQueryParams, ImportCertificateMultipartFields *ImportCertificateMultipartFields) (*ResponseAuthenticationManagementImportCertificate, *resty.Response, error)

ImportCertificate importCertificate - 2a9e-c8a4-454a-b942 

This method is used to upload a certificate

@param ImportCertificateQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!import-certificate

func (*AuthenticationManagementService) ImportCertificateP12 

func (s *AuthenticationManagementService) ImportCertificateP12(ImportCertificateP12QueryParams *ImportCertificateP12QueryParams, ImportCertificateP12MultipartFields *ImportCertificateP12MultipartFields) (*ResponseAuthenticationManagementImportCertificateP12, *resty.Response, error)

ImportCertificateP12 importCertificateP12 - 368e-79cf-4329-b63f 

This method is used to upload a PKCS#12 file

@param ImportCertificateP12QueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!import-certificate-p12

type AuthenticationService 

type AuthenticationService service

AuthenticationService is the service to communicate with the Authentication API endpoint

func (*AuthenticationService) AuthenticationAPI 

func (s *AuthenticationService) AuthenticationAPI(username string, password string) (*AuthenticationAPIResponse, *resty.Response, error)

AuthenticationAPI authenticationAPI 

API to obtain an access token. The token obtained using this API is required to be set as value to the X-Auth-Token HTTP Header for all API calls to Cisco DNA Center.

@param Content-Type Request body content type @param Authorization String composed of “Basic”, followed by a space, followed by the Base64 encoding of “username:password”, NOT including the quotes. For example “Basic YWRtaW46TWFnbGV2MTIz”, where YWRtaW46TWFnbGV2MTIz is the Base 64 encoding.

type CiscoDnaCenterSystemService 

type CiscoDnaCenterSystemService service

func (*CiscoDnaCenterSystemService) AuthorizeDevice 

func (s *CiscoDnaCenterSystemService) AuthorizeDevice(requestCiscoDnaCenterSystemAuthorizeDevice *RequestCiscoDnaCenterSystemAuthorizeDevice) (*ResponseCiscoDnaCenterSystemAuthorizeDevice, *resty.Response, error)

AuthorizeDevice Authorize Device - 2897-4ae4-4ae9-a1dc 

Authorizes one of more devices. A device can only be authorized if Authorization is set in Device Settings.

Documentation Link: https://developer.cisco.com/docs/dna-center/#!authorize-device

type ClearMacAddressTableQueryParams 

type ClearMacAddressTableQueryParams struct {
	DeploymentMode string `url:"deploymentMode,omitempty"` //Preview/Deploy ['Preview' means the configuration is not pushed to the device. 'Deploy' makes the configuration pushed to the device]
}

type Client 

type Client struct {

	// API Services
	Authentication              *AuthenticationService
	ApplicationPolicy           *ApplicationPolicyService
	Applications                *ApplicationsService
	AuthenticationManagement    *AuthenticationManagementService
	CiscoDnaCenterSystem        *CiscoDnaCenterSystemService
	Clients                     *ClientsService
	CommandRunner               *CommandRunnerService
	Compliance                  *ComplianceService
	ConfigurationArchive        *ConfigurationArchiveService
	ConfigurationTemplates      *ConfigurationTemplatesService
	DeviceOnboardingPnp         *DeviceOnboardingPnpService
	DeviceReplacement           *DeviceReplacementService
	Devices                     *DevicesService
	Discovery                   *DiscoveryService
	EoX                         *EoXService
	EventManagement             *EventManagementService
	FabricWireless              *FabricWirelessService
	File                        *FileService
	HealthAndPerformance        *HealthAndPerformanceService
	Itsm                        *ItsmService
	ItsmIntegration             *ItsmIntegrationService
	Issues                      *IssuesService
	LanAutomation               *LanAutomationService
	Licenses                    *LicensesService
	NetworkSettings             *NetworkSettingsService
	PathTrace                   *PathTraceService
	Platform                    *PlatformService
	Reports                     *ReportsService
	Sda                         *SdaService
	SecurityAdvisories          *SecurityAdvisoriesService
	Sensors                     *SensorsService
	SiteDesign                  *SiteDesignService
	Sites                       *SitesService
	SoftwareImageManagementSwim *SoftwareImageManagementSwimService
	SystemSettings              *SystemSettingsService
	Tag                         *TagService
	Task                        *TaskService
	Topology                    *TopologyService
	UserandRoles                *UserandRolesService
	Users                       *UsersService
	Wireless                    *WirelessService
	CustomCall                  *CustomCallService
	// contains filtered or unexported fields
}

Client manages communication with the Cisco DNA Center API

func NewClient 

func NewClient() (*Client, error)

NewClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func NewClientNoAuth 

func NewClientNoAuth() (*Client, error)

NewClientNoAuth returns the client object without trying to authenticate

func NewClientWithOptions 

func NewClientWithOptions(baseURL string, username string, password string, debug string, sslVerify string, waitTimeToManyRequest *int) (*Client, error)

NewClientWithOptions is the client with options passed with parameters

func NewClientWithOptionsNoAuth 

func NewClientWithOptionsNoAuth(baseURL string, username string, password string, debug string, sslVerify string, waitTimeToManyRequest *int) (*Client, error)

NewClientWithOptionsNoAuth returns the client object without trying to authenticate and sets environment variables

func (*Client) AuthClient 

func (s *Client) AuthClient() error

func (*Client) RestyClient 

func (s *Client) RestyClient() *resty.Client

RestyClient returns the resty.Client used by the sdk

func (*Client) SetAuthToken 

func (s *Client) SetAuthToken(accessToken string)

SetAuthToken defines the X-Auth-Token token sent in the request

func (*Client) SetDNACWaitTimeToManyRequest 

func (s *Client) SetDNACWaitTimeToManyRequest(waitTimeToManyRequest int) error

type ClientProximityQueryParams 

type ClientProximityQueryParams struct {
	Username       string  `url:"username,omitempty"`        //Wireless client username for which proximity information is required
	NumberDays     float64 `url:"number_days,omitempty"`     //Number of days to track proximity until current date. Defaults and maximum up to 14 days.
	TimeResolution float64 `url:"time_resolution,omitempty"` //Time interval (in minutes) to measure proximity. Defaults to 15 minutes with a minimum 5 minutes.
}

type ClientsService 

type ClientsService service

func (*ClientsService) ClientProximity 

func (s *ClientsService) ClientProximity(ClientProximityQueryParams *ClientProximityQueryParams) (*ResponseClientsClientProximity, *resty.Response, error)

ClientProximity Client Proximity - 4497-ebe2-4c88-84a1 

This intent API will provide client proximity information for a specific wireless user. Proximity is defined as presence on the same floor at the same time as the specified wireless user. The Proximity workflow requires the subscription to the following event (via the Event Notification workflow) prior to making this API call: NETWORK-CLIENTS-3-506 Client Proximity Report.

@param ClientProximityQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!client-proximity

func (*ClientsService) GetClientDetail 

func (s *ClientsService) GetClientDetail(GetClientDetailQueryParams *GetClientDetailQueryParams) (*ResponseClientsGetClientDetail, *resty.Response, error)

GetClientDetail Get Client Detail - e2ad-ba79-43ba-b3e9 

Returns detailed Client information retrieved by Mac Address for any given point of time.

@param GetClientDetailQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-client-detail

func (*ClientsService) GetClientEnrichmentDetails 

func (s *ClientsService) GetClientEnrichmentDetails(GetClientEnrichmentDetailsHeaderParams *GetClientEnrichmentDetailsHeaderParams) (*ResponseClientsGetClientEnrichmentDetails, *resty.Response, error)

GetClientEnrichmentDetails Get Client Enrichment Details - b199-685d-4d08-9a67 

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by

@param GetClientEnrichmentDetailsHeaderParams Custom header parameters

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-client-enrichment-details

func (*ClientsService) GetOverallClientHealth 

func (s *ClientsService) GetOverallClientHealth(GetOverallClientHealthQueryParams *GetOverallClientHealthQueryParams) (*ResponseClientsGetOverallClientHealth, *resty.Response, error)

GetOverallClientHealth Get Overall Client Health - 149a-a93b-4ddb-80dd 

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time

@param GetOverallClientHealthQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-overall-client-health

type CommandRunnerService 

type CommandRunnerService service

func (*CommandRunnerService) GetAllKeywordsOfCliSAcceptedByCommandRunner 

func (s *CommandRunnerService) GetAllKeywordsOfCliSAcceptedByCommandRunner() (*ResponseCommandRunnerGetAllKeywordsOfCliSAcceptedByCommandRunner, *resty.Response, error)

GetAllKeywordsOfCliSAcceptedByCommandRunner Get all keywords of CLIs accepted by command runner - 33bb-2b9d-4019-9e14 

Get valid keywords

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-all-keywords-of-c-l-is-accepted-by-command-runner

func (*CommandRunnerService) RunReadOnlyCommandsOnDevicesToGetTheirRealTimeConfiguration 

func (s *CommandRunnerService) RunReadOnlyCommandsOnDevicesToGetTheirRealTimeConfiguration(requestCommandRunnerRunReadOnlyCommandsOnDevicesToGetTheirRealTimeConfiguration *RequestCommandRunnerRunReadOnlyCommandsOnDevicesToGetTheirRealTimeConfiguration) (*ResponseCommandRunnerRunReadOnlyCommandsOnDevicesToGetTheirRealTimeConfiguration, *resty.Response, error)

RunReadOnlyCommandsOnDevicesToGetTheirRealTimeConfiguration Run read-only commands on devices to get their real-time configuration - d6b8-ca77-4739-adf4 

Submit request for read-only CLIs

Documentation Link: https://developer.cisco.com/docs/dna-center/#!run-read-only-commands-on-devices-to-get-their-real-time-configuration

type ComplianceDetailsOfDeviceQueryParams 

type ComplianceDetailsOfDeviceQueryParams struct {
	Category       string `url:"category,omitempty"`       //complianceCategory can have any value among 'INTENT', 'RUNNING_CONFIG'
	ComplianceType string `url:"complianceType,omitempty"` //complianceType can have any value among 'NETWORK_DESIGN', 'NETWORK_PROFILE', 'FABRIC', 'POLICY', 'RUNNING_CONFIG'
	DiffList       bool   `url:"diffList,omitempty"`       //diff list [ pass true to fetch the diff list ]
	Key            string `url:"key,omitempty"`            //extended attribute key
	Value          string `url:"value,omitempty"`          //extended attribute value
}

type ComplianceService 

type ComplianceService service

func (*ComplianceService) ComplianceDetailsOfDevice 

func (s *ComplianceService) ComplianceDetailsOfDevice(deviceUUID string, ComplianceDetailsOfDeviceQueryParams *ComplianceDetailsOfDeviceQueryParams) (*ResponseComplianceComplianceDetailsOfDevice, *resty.Response, error)

ComplianceDetailsOfDevice Compliance Details of Device - 52bf-e904-45aa-b017 

Return compliance detailed report for a device.

@param deviceUUID deviceUuid path parameter. @param ComplianceDetailsOfDeviceQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!compliance-details-of-device

func (*ComplianceService) DeviceComplianceStatus 

func (s *ComplianceService) DeviceComplianceStatus(deviceUUID string) (*ResponseComplianceDeviceComplianceStatus, *resty.Response, error)

DeviceComplianceStatus Device Compliance Status - 7aa8-5ad5-48ea-94a7 

Return compliance status of a device.

@param deviceUUID deviceUuid path parameter.

Documentation Link: https://developer.cisco.com/docs/dna-center/#!device-compliance-status

func (*ComplianceService) GetComplianceDetail 

func (s *ComplianceService) GetComplianceDetail(GetComplianceDetailQueryParams *GetComplianceDetailQueryParams) (*ResponseComplianceGetComplianceDetail, *resty.Response, error)

GetComplianceDetail Get Compliance Detail - dda1-1ae7-4788-9d49 

Return Compliance Detail

@param GetComplianceDetailQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-compliance-detail

func (*ComplianceService) GetComplianceDetailCount 

func (s *ComplianceService) GetComplianceDetailCount(GetComplianceDetailCountQueryParams *GetComplianceDetailCountQueryParams) (*ResponseComplianceGetComplianceDetailCount, *resty.Response, error)

GetComplianceDetailCount Get Compliance Detail Count - 3eb6-58c3-4549-94df 

Return  Compliance Count Detail

@param GetComplianceDetailCountQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-compliance-detail-count

func (*ComplianceService) GetComplianceStatus 

func (s *ComplianceService) GetComplianceStatus(GetComplianceStatusQueryParams *GetComplianceStatusQueryParams) (*ResponseComplianceGetComplianceStatus, *resty.Response, error)

GetComplianceStatus Get Compliance Status - dda5-cb9a-49aa-aef6 

Return compliance status of device(s).

@param GetComplianceStatusQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-compliance-status

func (*ComplianceService) GetComplianceStatusCount 

func (s *ComplianceService) GetComplianceStatusCount(GetComplianceStatusCountQueryParams *GetComplianceStatusCountQueryParams) (*ResponseComplianceGetComplianceStatusCount, *resty.Response, error)

GetComplianceStatusCount Get Compliance Status Count - db99-f919-424a-9f83 

Return Compliance Status Count

@param GetComplianceStatusCountQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-compliance-status-count

func (*ComplianceService) RunCompliance 

func (s *ComplianceService) RunCompliance(requestComplianceRunCompliance *RequestComplianceRunCompliance) (*ResponseComplianceRunCompliance, *resty.Response, error)

RunCompliance Run Compliance - f6ae-c8a7-4428-a9ff 

Run compliance check for device(s).

Documentation Link: https://developer.cisco.com/docs/dna-center/#!run-compliance

type ConfigurationArchiveService 

type ConfigurationArchiveService service

func (*ConfigurationArchiveService) ExportDeviceConfigurations 

func (s *ConfigurationArchiveService) ExportDeviceConfigurations(requestConfigurationArchiveExportDeviceConfigurations *RequestConfigurationArchiveExportDeviceConfigurations) (*ResponseConfigurationArchiveExportDeviceConfigurations, *resty.Response, error)

ExportDeviceConfigurations Export Device configurations - 51a4-0aba-4c68-ac17 

Export Device configurations to an encrypted zip file.

Documentation Link: https://developer.cisco.com/docs/dna-center/#!export-device-configurations

type ConfigurationTemplatesService 

type ConfigurationTemplatesService service

func (*ConfigurationTemplatesService) CreateProject 

func (s *ConfigurationTemplatesService) CreateProject(requestConfigurationTemplatesCreateProject *RequestConfigurationTemplatesCreateProject) (*ResponseConfigurationTemplatesCreateProject, *resty.Response, error)

CreateProject Create Project - 5788-a8a8-4aa9-b97a 

This API is used to create a new project.

Documentation Link: https://developer.cisco.com/docs/dna-center/#!create-project

func (*ConfigurationTemplatesService) CreateTemplate 

func (s *ConfigurationTemplatesService) CreateTemplate(projectID string, requestConfigurationTemplatesCreateTemplate *RequestConfigurationTemplatesCreateTemplate) (*ResponseConfigurationTemplatesCreateTemplate, *resty.Response, error)

CreateTemplate Create Template - ab94-a88b-4b0b-8d3d 

API to create a template by project id.

@param projectID projectId path parameter. UUID of the project in which the template needs to be created

Documentation Link: https://developer.cisco.com/docs/dna-center/#!create-template

func (*ConfigurationTemplatesService) CreatesACloneOfTheGivenTemplate 

func (s *ConfigurationTemplatesService) CreatesACloneOfTheGivenTemplate(name string, templateID string, projectID string, CreatesACloneOfTheGivenTemplateQueryParams *CreatesACloneOfTheGivenTemplateQueryParams) (*ResponseConfigurationTemplatesCreatesACloneOfTheGivenTemplate, *resty.Response, error)

CreatesACloneOfTheGivenTemplate Creates a clone of the given template - 0384-4a0a-4ee8-bfc2 

API to clone template

@param name name path parameter. Template name to clone template(Name should be different than existing template name within same project)

@param templateID templateId path parameter. UUID of the template to clone it

@param projectID projectId path parameter. @param CreatesACloneOfTheGivenTemplateQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!creates-a-clone-of-the-given-template

func (*ConfigurationTemplatesService) DeletesTheProject 

func (s *ConfigurationTemplatesService) DeletesTheProject(projectID string) (*ResponseConfigurationTemplatesDeletesTheProject, *resty.Response, error)

DeletesTheProject Deletes the project - 8cbb-79f4-4259-82d4 

Deletes the project by its id

@param projectID projectId path parameter. projectId(UUID) of project to be deleted

Documentation Link: https://developer.cisco.com/docs/dna-center/#!deletes-the-project

func (*ConfigurationTemplatesService) DeletesTheTemplate 

func (s *ConfigurationTemplatesService) DeletesTheTemplate(templateID string) (*ResponseConfigurationTemplatesDeletesTheTemplate, *resty.Response, error)

DeletesTheTemplate Deletes the template - a2bb-4afd-4699-8965 

Deletes the template by its id

@param templateID templateId path parameter. templateId(UUID) of template to be deleted

Documentation Link: https://developer.cisco.com/docs/dna-center/#!deletes-the-template

func (*ConfigurationTemplatesService) DeployTemplate 

func (s *ConfigurationTemplatesService) DeployTemplate(requestConfigurationTemplatesDeployTemplate *RequestConfigurationTemplatesDeployTemplate) (*ResponseConfigurationTemplatesDeployTemplate, *resty.Response, error)

DeployTemplate Deploy Template - 179f-09d8-430b-bee0 

API to deploy a template.

Documentation Link: https://developer.cisco.com/docs/dna-center/#!deploy-template

func (*ConfigurationTemplatesService) DeployTemplateV2 

func (s *ConfigurationTemplatesService) DeployTemplateV2(requestConfigurationTemplatesDeployTemplateV2 *RequestConfigurationTemplatesDeployTemplateV2) (*ResponseConfigurationTemplatesDeployTemplateV2, *resty.Response, error)

DeployTemplateV2 Deploy Template V2 - 02af-1bdf-4b48-9cbb 

V2 API to deploy a template.

Documentation Link: https://developer.cisco.com/docs/dna-center/#!deploy-template-v2

func (*ConfigurationTemplatesService) ExportsTheProjectsForAGivenCriteria 

func (s *ConfigurationTemplatesService) ExportsTheProjectsForAGivenCriteria(requestConfigurationTemplatesExportsTheProjectsForAGivenCriteria *RequestConfigurationTemplatesExportsTheProjectsForAGivenCriteria) (*ResponseConfigurationTemplatesExportsTheProjectsForAGivenCriteria, *resty.Response, error)

ExportsTheProjectsForAGivenCriteria Exports the projects for a given criteria. - 67bc-e964-45f8-b720 

Exports the projects for given projectNames.

Documentation Link: https://developer.cisco.com/docs/dna-center/#!exports-the-projects-for-a-given-criteria

func (*ConfigurationTemplatesService) ExportsTheTemplatesForAGivenCriteria 

func (s *ConfigurationTemplatesService) ExportsTheTemplatesForAGivenCriteria(requestConfigurationTemplatesExportsTheTemplatesForAGivenCriteria *RequestConfigurationTemplatesExportsTheTemplatesForAGivenCriteria) (*ResponseConfigurationTemplatesExportsTheTemplatesForAGivenCriteria, *resty.Response, error)

ExportsTheTemplatesForAGivenCriteria Exports the templates for a given criteria. - a3a9-498f-4f48-a3c7 

Exports the templates for given templateIds.

Documentation Link: https://developer.cisco.com/docs/dna-center/#!exports-the-templates-for-a-given-criteria

func (*ConfigurationTemplatesService) GetProjectsDetails 

func (s *ConfigurationTemplatesService) GetProjectsDetails(GetProjectsDetailsQueryParams *GetProjectsDetailsQueryParams) (*ResponseConfigurationTemplatesGetProjectsDetails, *resty.Response, error)

GetProjectsDetails Get project(s) details - 9a8c-aa6d-459b-a4a2 

Get project(s) details

@param GetProjectsDetailsQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-projects-details

func (*ConfigurationTemplatesService) GetTemplatesDetails 

func (s *ConfigurationTemplatesService) GetTemplatesDetails(GetTemplatesDetailsQueryParams *GetTemplatesDetailsQueryParams) (*ResponseConfigurationTemplatesGetTemplatesDetails, *resty.Response, error)

GetTemplatesDetails Get template(s) details - b0b6-ba49-43c8-9f45 

Get template(s) details

@param GetTemplatesDetailsQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-templates-details

func (*ConfigurationTemplatesService) GetsAListOfProjects 

func (s *ConfigurationTemplatesService) GetsAListOfProjects(GetsAListOfProjectsQueryParams *GetsAListOfProjectsQueryParams) (*ResponseConfigurationTemplatesGetsAListOfProjects, *resty.Response, error)

GetsAListOfProjects Gets a list of projects - 4f80-08c2-400b-98ee 

List the projects

@param GetsAListOfProjectsQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!gets-a-list-of-projects

func (*ConfigurationTemplatesService) GetsAllTheVersionsOfAGivenTemplate 

func (s *ConfigurationTemplatesService) GetsAllTheVersionsOfAGivenTemplate(templateID string) (*ResponseConfigurationTemplatesGetsAllTheVersionsOfAGivenTemplate, *resty.Response, error)

GetsAllTheVersionsOfAGivenTemplate Gets all the versions of a given template - 0191-2b65-45fb-8891 

Get all the versions of template by its id

@param templateID templateId path parameter. templateId(UUID) to get list of versioned templates

Documentation Link: https://developer.cisco.com/docs/dna-center/#!gets-all-the-versions-of-a-given-template

func (*ConfigurationTemplatesService) GetsDetailsOfAGivenTemplate 

func (s *ConfigurationTemplatesService) GetsDetailsOfAGivenTemplate(templateID string, GetsDetailsOfAGivenTemplateQueryParams *GetsDetailsOfAGivenTemplateQueryParams) (*ResponseConfigurationTemplatesGetsDetailsOfAGivenTemplate, *resty.Response, error)

GetsDetailsOfAGivenTemplate Gets details of a given template - 8c82-5900-40d9-8137 

Details of the template by its id

@param templateID templateId path parameter. TemplateId(UUID) to get details of the template

@param GetsDetailsOfAGivenTemplateQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!gets-details-of-a-given-template

func (*ConfigurationTemplatesService) GetsTheDetailsOfAGivenProject 

func (s *ConfigurationTemplatesService) GetsTheDetailsOfAGivenProject(projectID string) (*ResponseConfigurationTemplatesGetsTheDetailsOfAGivenProject, *resty.Response, error)

GetsTheDetailsOfAGivenProject Gets the details of a given project. - dd91-a8c0-436a-82d9 

Get the details of the given project by its id.

@param projectID projectId path parameter. projectId(UUID) of project to get project details

Documentation Link: https://developer.cisco.com/docs/dna-center/#!gets-the-details-of-a-given-project

func (*ConfigurationTemplatesService) GetsTheTemplatesAvailable 

func (s *ConfigurationTemplatesService) GetsTheTemplatesAvailable(GetsTheTemplatesAvailableQueryParams *GetsTheTemplatesAvailableQueryParams) (*ResponseConfigurationTemplatesGetsTheTemplatesAvailable, *resty.Response, error)

GetsTheTemplatesAvailable Gets the templates available - e286-e848-47bb-a77e 

List the templates available

@param GetsTheTemplatesAvailableQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!gets-the-templates-available

func (*ConfigurationTemplatesService) ImportsTheProjectsProvided 

func (s *ConfigurationTemplatesService) ImportsTheProjectsProvided(ImportsTheProjectsProvidedQueryParams *ImportsTheProjectsProvidedQueryParams) (*ResponseConfigurationTemplatesImportsTheProjectsProvided, *resty.Response, error)

ImportsTheProjectsProvided Imports the Projects provided - f59f-a8ad-42d9-8b4f 

Imports the Projects provided in the DTO

@param ImportsTheProjectsProvidedQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!imports-the-projects-provided

func (*ConfigurationTemplatesService) ImportsTheTemplatesProvided 

func (s *ConfigurationTemplatesService) ImportsTheTemplatesProvided(projectName string, requestConfigurationTemplatesImportsTheTemplatesProvided *RequestConfigurationTemplatesImportsTheTemplatesProvided, ImportsTheTemplatesProvidedQueryParams *ImportsTheTemplatesProvidedQueryParams) (*ResponseConfigurationTemplatesImportsTheTemplatesProvided, *resty.Response, error)

ImportsTheTemplatesProvided Imports the templates provided - 4d86-f92a-4a7b-90bb 

Imports the templates provided in the DTO by project Name

@param projectName projectName path parameter. Project name to create template under the project

@param ImportsTheTemplatesProvidedQueryParams Filtering parameter

Documentation Link: https://developer.cisco.com/docs/dna-center/#!imports-the-templates-provided

func (*ConfigurationTemplatesService) PreviewTemplate 

func (s *ConfigurationTemplatesService) PreviewTemplate(requestConfigurationTemplatesPreviewTemplate *RequestConfigurationTemplatesPreviewTemplate) (*ResponseConfigurationTemplatesPreviewTemplate, *resty.Response, error)

PreviewTemplate Preview Template - 41bc-aaa6-4669-853e 

API to preview a template.

func (*ConfigurationTemplatesService) StatusOfTemplateDeployment 

func (s *ConfigurationTemplatesService) StatusOfTemplateDeployment(deploymentID string) (*ResponseConfigurationTemplatesStatusOfTemplateDeployment, *resty.Response, error)

StatusOfTemplateDeployment Status of template deployment - 078e-f800-49b8-80f1 

API to retrieve the status of template deployment.

@param deploymentID deploymentId path parameter. UUID of deployment to retrieve template deployment status

Documentation Link: https://developer.cisco.com/docs/dna-center/#!status-of-template-deployment

func (*ConfigurationTemplatesService) UpdateProject 

func (s *ConfigurationTemplatesService) UpdateProject(requestConfigurationTemplatesUpdateProject *RequestConfigurationTemplatesUpdateProject) (*ResponseConfigurationTemplatesUpdateProject, *resty.Response, error)

UpdateProject Update Project - ecb8-8b89-4318-ac8d 

This API is used to update an existing project.

func (*ConfigurationTemplatesService) UpdateTemplate 

func (s *ConfigurationTemplatesService) UpdateTemplate(requestConfigurationTemplatesUpdateTemplate *RequestConfigurationTemplatesUpdateTemplate) (*ResponseConfigurationTemplatesUpdateTemplate, *resty.Response, error)

UpdateTemplate Update Template - 2a80-39f5-4aab-86be 

API to update a template.

func (*ConfigurationTemplatesService) VersionTemplate 

func (s *ConfigurationTemplatesService) VersionTemplate(requestConfigurationTemplatesVersionTemplate *RequestConfigurationTemplatesVersionTemplate) (*ResponseConfigurationTemplatesVersionTemplate, *resty.Response, error)

VersionTemplate Version Template - f2a4-4a7e-4d5b-ab78 

API to version the current contents of the template.

Documen