User API Doc

DNACenterAPI

The DNACenterAPI class creates “connection objects” for working with the DNA Center APIs and hierarchically organizes the DNA Center APIs and their endpoints underneath these connection objects.

DNACenterAPI summary structure

DNACenterAPI v2.3.5.3

application_policy

class ApplicationPolicy

Cisco DNA Center Application Policy API (version: 2.3.5.3).

Wraps the DNA Center Application Policy API and exposes the API as native Python methods that return native Python objects.

get_application_policy(policy_scope=None, headers=None, **request_parameters)

Get all existing application policies .

Parameters:

• policy_scope (str) – policyScope query parameter. policy scope name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_policy_default(headers=None, **request_parameters)

Get default application policy .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

application_policy_intent(createList=None, deleteList=None, updateList=None, headers=None, payload=None, active_validation=True, **request_parameters)

Create/Update/Delete application policy .

Parameters:

• createList (list) – Application Policy’s createList (list of objects).

• deleteList (list) – Application Policy’s Delete list of Group Based Policy ids (list of strings).

• updateList (list) – Application Policy’s updateList (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_policy_queuing_profile(name=None, headers=None, **request_parameters)

Get all or by name, existing application policy queuing profiles .

Parameters:

• name (str) – name query parameter. queuing profile name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

update_application_policy_queuing_profile(headers=None, payload=None, active_validation=True, **request_parameters)

Update existing custom application queuing profile .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_application_policy_queuing_profile(headers=None, payload=None, active_validation=True, **request_parameters)

Create new custom application queuing profile .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_policy_queuing_profile_count(headers=None, **request_parameters)

Get the number of all existing application policy queuing profile .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

delete_application_policy_queuing_profile(id, headers=None, **request_parameters)

Delete existing custom application policy queuing profile by id .

Parameters:

• id (str) – id path parameter. Id of custom queuing profile to delete .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_sets(limit=None, name=None, offset=None, headers=None, **request_parameters)

Get appllication-sets by offset/limit or by name .

Parameters:

• offset (int,str) – offset query parameter.

• limit (int,str) – limit query parameter.

• name (str) – name query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

delete_application_set(id, headers=None, **request_parameters)

Delete existing application-set by it’s id .

Parameters:

• id (str) – id query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_application_set(headers=None, payload=None, active_validation=True, **request_parameters)

Create new custom application-set/s .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_sets_count(headers=None, **request_parameters)

Get the number of existing application-sets .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_application(headers=None, payload=None, active_validation=True, **request_parameters)

Create new Custom application .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

edit_application(headers=None, payload=None, active_validation=True, **request_parameters)

Edit the attributes of an existing application .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!edit-application

delete_application(id, headers=None, **request_parameters)

Delete existing application by its id .

Parameters:

• id (str) – id query parameter. Application’s Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_applications(limit=None, name=None, offset=None, headers=None, **request_parameters)

Get applications by offset/limit or by name .

Parameters:

• offset (int,str) – offset query parameter. The offset of the first application to be returned .

• limit (int,str) – limit query parameter. The maximum number of applications to be returned .

• name (str) – name query parameter. Application’s name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_applications_count(headers=None, **request_parameters)

Get the number of all existing applications .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_qos_device_interface_info(network_device_id=None, headers=None, **request_parameters)

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

Parameters:

• network_device_id (str) – networkDeviceId query parameter. network device id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

update_qos_device_interface_info(headers=None, payload=None, active_validation=True, **request_parameters)

Update existing qos device interface infos associate with network device id .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_qos_device_interface_info(headers=None, payload=None, active_validation=True, **request_parameters)

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 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_qos_device_interface_info_count(headers=None, **request_parameters)

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

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

delete_qos_device_interface_info(id, headers=None, **request_parameters)

Delete all qos device interface infos associate with network device id .

Parameters:

• id (str) – id path parameter. Id of the qos device info, this object holds all qos device interface infos associate with network device id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

applications

class Applications

Cisco DNA Center Applications API (version: 2.3.5.3).

Wraps the DNA Center Applications API and exposes the API as native Python methods that return native Python objects.

applications(application_health=None, application_name=None, device_id=None, end_time=None, limit=None, mac_address=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)

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. .

Parameters:

• site_id (str) – siteId query parameter. Assurance site UUID value (Cannot be submitted together with deviceId and clientMac) .

• device_id (str) – deviceId query parameter. Assurance device UUID value (Cannot be submitted together with siteId and clientMac) .

• mac_address (str) – macAddress query parameter. Client device’s MAC address (Cannot be submitted together with siteId and deviceId) .

• start_time (int) – startTime query parameter. Starting epoch time in milliseconds of time window .

• end_time (int) – endTime query parameter. Ending epoch time in milliseconds of time window .

• application_health (str) – applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only) .

• offset (int,str) – offset query parameter. The offset of the first application in the returned data (optionally used with siteId only) .

• limit (int,str) – limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only) .

• application_name (str) – applicationName query parameter. The name of the application to get information on .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

authentication_management

class AuthenticationManagement

Cisco DNA Center Authentication Management API (version: 2.3.5.3).

Wraps the DNA Center Authentication Management API and exposes the API as native Python methods that return native Python objects.

import_certificate(multipart_fields, multipart_monitor_callback, list_of_users=None, pk_password=None, headers=None, **request_parameters)

This method is used to upload a certificate .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback

Parameters:

• pk_password (str) – pkPassword query parameter. Private Key Passsword .

• list_of_users (str, list, set, tuple) – listOfUsers query parameter.

• multipart_fields (dict) – Fields from which to create a multipart/form-data body.

• multipart_monitor_callback (function) – function used to monitor the progress of the upload.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

import_certificate_p12(multipart_fields, multipart_monitor_callback, list_of_users=None, p12_password=None, pk_password=None, headers=None, **request_parameters)

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

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback

Parameters:

• p12_password (str) – p12Password query parameter. P12 Passsword .

• pk_password (str) – pkPassword query parameter. Private Key Passsword .

• list_of_users (str, list, set, tuple) – listOfUsers query parameter.

• multipart_fields (dict) – Fields from which to create a multipart/form-data body.

• multipart_monitor_callback (function) – function used to monitor the progress of the upload.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

authentication_api(headers=None, **request_parameters)

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. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

cisco_dna_center_system

class CiscoDnaCenterSystem

Cisco DNA Center Cisco DNA Center System API (version: 2.3.5.3).

Wraps the DNA Center Cisco DNA Center System API and exposes the API as native Python methods that return native Python objects.

authorize_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)

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

Parameters:

• deviceIdList (list) – Cisco DNA Center System’s Device Id List (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

clients

class Clients

Cisco DNA Center Clients API (version: 2.3.5.3).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)

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

Parameters:

• timestamp (str) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

• mac_address (str) – macAddress query parameter. MAC Address of the client .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_client_enrichment_details(headers=None, **request_parameters)

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 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_overall_client_health(timestamp=None, headers=None, **request_parameters)

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

Parameters:

• timestamp (str) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

client_proximity(username, number_days=None, time_resolution=None, headers=None, **request_parameters)

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. .

Parameters:

• username (str) – username query parameter. Wireless client username for which proximity information is required .

• number_days (int) – number_days query parameter. Number of days to track proximity until current date. Defaults and maximum up to 14 days. .

• time_resolution (int) – time_resolution query parameter. Time interval (in minutes) to measure proximity. Defaults to 15 minutes with a minimum 5 minutes. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

command_runner

class CommandRunner

Cisco DNA Center Command Runner API (version: 2.3.5.3).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)

Get valid keywords .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-keywords-of-clis-accepted

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)

Submit request for read-only CLIs .

Parameters:

• commands (list) – Command Runner’s commands (list of strings).

• description (string) – Command Runner’s description.

• deviceUuids (list) – Command Runner’s deviceUuids (list of strings).

• name (string) – Command Runner’s name.

• timeout (integer) – Command Runner’s timeout.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!run-read-only-commands-on-devices

compliance

class Compliance

Cisco DNA Center Compliance API (version: 2.3.5.3).

Wraps the DNA Center Compliance API and exposes the API as native Python methods that return native Python objects.

get_compliance_status_(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)

Return compliance status of device(s). .

Parameters:

• compliance_status (str) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’ .

• device_uuid (str) – deviceUuid query parameter. Comma separated deviceUuids .

• offset (int,str) – offset query parameter. offset/starting row .

• limit (int,str) – limit query parameter. Number of records to be retrieved .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

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

get_compliance_status(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)

Return compliance status of device(s). .

Parameters:

• compliance_status (str) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’ .

• device_uuid (str) – deviceUuid query parameter. Comma separated deviceUuids .

• offset (int,str) – offset query parameter. offset/starting row .

• limit (int,str) – limit query parameter. Number of records to be retrieved .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

run_compliance(categories=None, deviceUuids=None, triggerFull=None, headers=None, payload=None, active_validation=True, **request_parameters)

Run compliance check for device(s). .

Parameters:

• categories (list) – Compliance’s categories (list of strings).

• deviceUuids (list) – Compliance’s deviceUuids (list of strings).

• triggerFull (boolean) – Compliance’s triggerFull.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_compliance_status_count(compliance_status=None, headers=None, **request_parameters)

Return Compliance Status Count .

Parameters:

• compliance_status (str) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_compliance_detail(compliance_status=None, compliance_type=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)

Return Compliance Detail .

Parameters:

• compliance_type (str) – complianceType query parameter. complianceType can have any value among ‘NETWORK_PROFILE’, ‘IMAGE’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’ .

• compliance_status (str) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

• device_uuid (str) – deviceUuid query parameter. Comma separated deviceUuids .

• offset (int,str) – offset query parameter. offset/starting row .

• limit (int,str) – limit query parameter. Number of records to be retrieved .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_compliance_detail_count(compliance_status=None, compliance_type=None, headers=None, **request_parameters)

Return Compliance Count Detail .

Parameters:

• compliance_type (str) – complianceType query parameter. complianceType can have any value among ‘NETWORK_PROFILE’, ‘IMAGE’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’. .

• compliance_status (str) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

device_compliance_status(device_uuid, headers=None, **request_parameters)

Return compliance status of a device. .

Parameters:

• device_uuid (str) – deviceUuid path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

compliance_details_of_device(device_uuid, category=None, compliance_type=None, diff_list=None, key=None, value=None, headers=None, **request_parameters)

Return compliance detailed report for a device. .

Parameters:

• device_uuid (str) – deviceUuid path parameter.

• category (str) – category query parameter. complianceCategory can have any value among ‘INTENT’, ‘RUNNING_CONFIG’ .

• compliance_type (str) – complianceType query parameter. complianceType can have any value among ‘NETWORK_DESIGN’, ‘NETWORK_PROFILE’, ‘FABRIC’, ‘POLICY’, ‘RUNNING_CONFIG’ .

• diff_list (bool) – diffList query parameter. diff list [ pass true to fetch the diff list ] .

• key (str) – key query parameter. extended attribute key .

• value (str) – value query parameter. extended attribute value .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

configuration_archive

class ConfigurationArchive

Cisco DNA Center Configuration Archive API (version: 2.3.5.3).

Wraps the DNA Center Configuration Archive API and exposes the API as native Python methods that return native Python objects.

export_device_configurations(deviceId=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)

Export Device configurations to an encrypted zip file. .

Parameters:

• deviceId (list) – Configuration Archive’s Device Id (list of strings).

• password (string) – Configuration Archive’s Password.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

configuration_templates

class ConfigurationTemplates

Cisco DNA Center Configuration Templates API (version: 2.3.5.3).

Wraps the DNA Center Configuration Templates API and exposes the API as native Python methods that return native Python objects.

clone_given_template(name, project_id, template_id, headers=None, **request_parameters)

API to clone template .

Parameters:

• name (str) – name path parameter. Template name to clone template(Name should be different than existing template name within same project) .

• template_id (str) – templateId path parameter. UUID of the template to clone it .

• project_id (str) – projectId path parameter.

• project_id – projectId query parameter. UUID of the project in which the template needs to be created .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!clone-given-template

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)

This API is used to create a new project. .

Parameters:

• createTime (integer) – Configuration Templates’s Create time of project .

• description (string) – Configuration Templates’s Description of project .

• id (string) – Configuration Templates’s UUID of project .

• lastUpdateTime (integer) – Configuration Templates’s Update time of project .

• name (string) – Configuration Templates’s Name of project .

• tags (list) – Configuration Templates’s tags (list of objects).

• templates (object) – Configuration Templates’s List of templates within the project .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)

This API is used to update an existing project. .

Parameters:

• createTime (integer) – Configuration Templates’s Create time of project .

• description (string) – Configuration Templates’s Description of project .

• id (string) – Configuration Templates’s UUID of project .

• lastUpdateTime (integer) – Configuration Templates’s Update time of project .

• name (string) – Configuration Templates’s Name of project .

• tags (list) – Configuration Templates’s tags (list of objects).

• templates (object) – Configuration Templates’s List of templates within the project .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-project

get_projects(name=None, sort_order=None, headers=None, **request_parameters)

List the projects .

Parameters:

• name (str) – name query parameter. Name of project to be searched .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

imports_the_projects_provided(do_version=None, headers=None, payload=None, active_validation=True, **request_parameters)

Imports the Projects provided in the DTO .

Parameters:

• do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload ((list, dict)) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

export_projects(headers=None, payload=None, **request_parameters)

Exports the projects for given projectNames. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!export-projects

exports_the_projects_for_a_given_criteria(headers=None, payload=None, **request_parameters)

This function is an alias of export_projects.

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of export_projects.

imports_the_templates_provided(project_name, author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, do_version=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

Imports the templates provided in the DTO by project Name .

Parameters:

• author (string) – Configuration Templates’s Author of template .

• composite (boolean) – Configuration Templates’s Is it composite template .

• containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

• createTime (integer) – Configuration Templates’s Create time of template .

• customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

• description (string) – Configuration Templates’s Description of template .

• deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

• failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

• id (string) – Configuration Templates’s UUID of template .

• language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

• lastUpdateTime (integer) – Configuration Templates’s Update time of template .

• latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

• name (string) – Configuration Templates’s Name of template .

• parentTemplateId (string) – Configuration Templates’s Parent templateID .

• projectId (string) – Configuration Templates’s Project UUID .

• projectName (string) – Configuration Templates’s Project name .

• rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

• rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

• softwareType (string) – Configuration Templates’s Applicable device software type .

• softwareVariant (string) – Configuration Templates’s Applicable device software variant .

• softwareVersion (string) – Configuration Templates’s Applicable device software version .

• tags (list) – Configuration Templates’s tags (list of objects).

• templateContent (string) – Configuration Templates’s Template content .

• templateParams (list) – Configuration Templates’s templateParams (list of objects).

• validationErrors (object) – Configuration Templates’s validationErrors.

• version (string) – Configuration Templates’s Current version of template .

• project_name (str) – projectName path parameter. Project name to create template under the project .

• do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_project_details(project_id, headers=None, **request_parameters)

Get the details of the given project by its id. .

Parameters:

• project_id (str) – projectId path parameter. projectId(UUID) of project to get project details .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-project-details

deletes_the_project(project_id, headers=None, **request_parameters)

Deletes the project by its id .

Parameters:

• project_id (str) – projectId path parameter. projectId(UUID) of project to be deleted .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create a template by project id. .

Parameters:

• author (string) – Configuration Templates’s Author of template .

• composite (boolean) – Configuration Templates’s Is it composite template .

• containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

• createTime (integer) – Configuration Templates’s Create time of template .

• customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

• description (string) – Configuration Templates’s Description of template .

• deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

• failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

• id (string) – Configuration Templates’s UUID of template .

• language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

• lastUpdateTime (integer) – Configuration Templates’s Update time of template .

• latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

• name (string) – Configuration Templates’s Name of template .

• parentTemplateId (string) – Configuration Templates’s Parent templateID .

• projectId (string) – Configuration Templates’s Project UUID .

• projectName (string) – Configuration Templates’s Project name .

• rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

• rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

• softwareType (string) – Configuration Templates’s Applicable device software type .

• softwareVariant (string) – Configuration Templates’s Applicable device software variant .

• softwareVersion (string) – Configuration Templates’s Applicable device software version .

• tags (list) – Configuration Templates’s tags (list of objects).

• templateContent (string) – Configuration Templates’s Template content .

• templateParams (list) – Configuration Templates’s templateParams (list of objects).

• validationErrors (object) – Configuration Templates’s validationErrors.

• version (string) – Configuration Templates’s Current version of template .

• project_id (str) – projectId path parameter. UUID of the project in which the template needs to be created .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, project_names=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)

List the templates available .

Parameters:

• project_id (str) – projectId query parameter. Filter template(s) based on project UUID .

• software_type (str) – softwareType query parameter. Filter template(s) based software type .

• software_version (str) – softwareVersion query parameter. Filter template(s) based softwareVersion .

• product_family (str) – productFamily query parameter. Filter template(s) based on device family .

• product_series (str) – productSeries query parameter. Filter template(s) based on device series .

• product_type (str) – productType query parameter. Filter template(s) based on device type .

• filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

• tags (str, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

• project_names (str, list, set, tuple) – projectNames query parameter. Filter template(s) based on project names .

• un_committed (bool) – unCommitted query parameter. Filter template(s) based on template commited or not .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

update_template(author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update a template. .

Parameters:

• author (string) – Configuration Templates’s Author of template .

• composite (boolean) – Configuration Templates’s Is it composite template .

• containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

• createTime (integer) – Configuration Templates’s Create time of template .

• customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

• description (string) – Configuration Templates’s Description of template .

• deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

• failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

• id (string) – Configuration Templates’s UUID of template .

• language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

• lastUpdateTime (integer) – Configuration Templates’s Update time of template .

• latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

• name (string) – Configuration Templates’s Name of template .

• parentTemplateId (string) – Configuration Templates’s Parent templateID .

• projectId (string) – Configuration Templates’s Project UUID .

• projectName (string) – Configuration Templates’s Project name .

• rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

• rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

• softwareType (string) – Configuration Templates’s Applicable device software type .

• softwareVariant (string) – Configuration Templates’s Applicable device software variant .

• softwareVersion (string) – Configuration Templates’s Applicable device software version .

• tags (list) – Configuration Templates’s tags (list of objects).

• templateContent (string) – Configuration Templates’s Template content .

• templateParams (list) – Configuration Templates’s templateParams (list of objects).

• validationErrors (object) – Configuration Templates’s validationErrors.

• version (string) – Configuration Templates’s Current version of template .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-template

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to deploy a template. .

Parameters:

• forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

• isComposite (boolean) – Configuration Templates’s Composite template flag .

• mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

• memberTemplateDeploymentInfo (string) – Configuration Templates’s memberTemplateDeploymentInfo .

• targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

• templateId (string) – Configuration Templates’s UUID of template to be provisioned .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_template_deployment_status(deployment_id, headers=None, **request_parameters)

API to retrieve the status of template deployment. .

Parameters:

• deployment_id (str) – deploymentId path parameter. UUID of deployment to retrieve template deployment status .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

export_templates(headers=None, payload=None, active_validation=True, **request_parameters)

Exports the templates for given templateIds. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!export-templates

preview_template(deviceId=None, params=None, resourceParams=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to preview a template. .

Parameters:

• deviceId (string) – Configuration Templates’s UUID of device to get template preview .

• params (object) – Configuration Templates’s Params to render preview .

• resourceParams (object) – Configuration Templates’s Resource params to render preview .

• templateId (string) – Configuration Templates’s UUID of template to get template preview .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!preview-template

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to version the current contents of the template. .

Parameters:

• comments (string) – Configuration Templates’s Template version comments .

• templateId (string) – Configuration Templates’s UUID of template .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!version-template

gets_all_the_versions_of_a_given_template(template_id, headers=None, **request_parameters)

Get all the versions of template by its id .

Parameters:

• template_id (str) – templateId path parameter. templateId(UUID) to get list of versioned templates .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_template_versions(template_id, headers=None, **request_parameters)

This function is an alias of gets_all_the_versions_of_a_given_template.

Parameters:

• template_id (str) – templateId path parameter. templateId(UUID) to get list of versioned templates .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_all_the_versions_of_a_given_template.

deletes_the_template(template_id, headers=None, **request_parameters)

Deletes the template by its id .

Parameters:

• template_id (str) – templateId path parameter. templateId(UUID) of template to be deleted .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)

Details of the template by its id .

Parameters:

• template_id (str) – templateId path parameter. TemplateId(UUID) to get details of the template .

• latest_version (bool) – latestVersion query parameter. latestVersion flag to get the latest versioned template .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-template-details

get_projects_details(id=None, limit=None, name=None, offset=None, sort_order=None, headers=None, **request_parameters)

Get project(s) details .

Parameters:

• id (str) – id query parameter. Id of project to be searched .

• name (str) – name query parameter. Name of project to be searched .

• offset (int,str) – offset query parameter. Index of first result .

• limit (int,str) – limit query parameter. Limits number of results .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_templates_details(all_template_attributes=None, filter_conflicting_templates=None, id=None, include_version_details=None, limit=None, name=None, offset=None, product_family=None, product_series=None, product_type=None, project_id=None, project_name=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)

Get template(s) details .

Parameters:

• id (str) – id query parameter. Id of template to be searched .

• name (str) – name query parameter. Name of template to be searched .

• project_id (str) – projectId query parameter. Filter template(s) based on project id .

• project_name (str) – projectName query parameter. Filter template(s) based on project name .

• software_type (str) – softwareType query parameter. Filter template(s) based software type .

• software_version (str) – softwareVersion query parameter. Filter template(s) based softwareVersion .

• product_family (str) – productFamily query parameter. Filter template(s) based on device family .

• product_series (str) – productSeries query parameter. Filter template(s) based on device series .

• product_type (str) – productType query parameter. Filter template(s) based on device type .

• filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

• tags (str, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

• un_committed (bool) – unCommitted query parameter. Return uncommitted template .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .

• all_template_attributes (bool) – allTemplateAttributes query parameter. Return all template attributes .

• include_version_details (bool) – includeVersionDetails query parameter. Include template version details .

• offset (int,str) – offset query parameter. Index of first result .

• limit (int,str) – limit query parameter. Limits number of results .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

deploy_template_v2(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)

V2 API to deploy a template. .

Parameters:

• forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

• isComposite (boolean) – Configuration Templates’s Composite template flag .

• mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

• memberTemplateDeploymentInfo (string) – Configuration Templates’s memberTemplateDeploymentInfo .

• targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

• templateId (string) – Configuration Templates’s UUID of template to be provisioned .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

device_onboarding_pnp

class DeviceOnboardingPnp

Cisco DNA Center Device Onboarding (PnP) API (version: 2.3.5.3).

Wraps the DNA Center Device Onboarding (PnP) API and exposes the API as native Python methods that return native Python objects.

add_device(_id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)

Adds a device to the PnP database. .

Parameters:

• _id (string) – Device Onboarding (PnP)’s _id.

• deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

• runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

• systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

• systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• version (integer) – Device Onboarding (PnP)’s version.

• workflow (object) – Device Onboarding (PnP)’s workflow.

• workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-device

get_device_list(cm_state=None, hostname=None, last_contact=None, limit=None, mac_address=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, site_name=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint .

Parameters:

• limit (int,str) – limit query parameter. Limits number of results .

• offset (int,str) – offset query parameter. Index of first result .

• sort (str, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• serial_number (str, list, set, tuple) – serialNumber query parameter. Device Serial Number .

• state (str, list, set, tuple) – state query parameter. Device State .

• onb_state (str, list, set, tuple) – onbState query parameter. Device Onboarding State .

• cm_state (str, list, set, tuple) – cmState query parameter. Device Connection Manager State .

• name (str, list, set, tuple) – name query parameter. Device Name .

• pid (str, list, set, tuple) – pid query parameter. Device ProductId .

• source (str, list, set, tuple) – source query parameter. Device Source .

• project_id (str, list, set, tuple) – projectId query parameter. Device Project Id .

• workflow_id (str, list, set, tuple) – workflowId query parameter. Device Workflow Id .

• project_name (str, list, set, tuple) – projectName query parameter. Device Project Name .

• workflow_name (str, list, set, tuple) – workflowName query parameter. Device Workflow Name .

• smart_account_id (str, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

• virtual_account_id (str, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

• last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

• mac_address (str) – macAddress query parameter. Device Mac Address .

• hostname (str) – hostname query parameter. Device Hostname .

• site_name (str) – siteName query parameter. Device Site Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-list

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Claims one of more devices with specified workflow .

Parameters:

• configFileUrl (string) – Device Onboarding (PnP)’s configFileUrl.

• configId (string) – Device Onboarding (PnP)’s configId.

• deviceClaimList (list) – Device Onboarding (PnP)’s deviceClaimList (list of objects).

• fileServiceId (string) – Device Onboarding (PnP)’s fileServiceId.

• imageId (string) – Device Onboarding (PnP)’s imageId.

• imageUrl (string) – Device Onboarding (PnP)’s imageUrl.

• populateInventory (boolean) – Device Onboarding (PnP)’s populateInventory.

• projectId (string) – Device Onboarding (PnP)’s projectId.

• workflowId (string) – Device Onboarding (PnP)’s workflowId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!claim-device

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)

Returns the device count based on filter criteria. This is useful for pagination .

Parameters:

• serial_number (str, list, set, tuple) – serialNumber query parameter. Device Serial Number .

• state (str, list, set, tuple) – state query parameter. Device State .

• onb_state (str, list, set, tuple) – onbState query parameter. Device Onboarding State .

• cm_state (str, list, set, tuple) – cmState query parameter. Device Connection Manager State .

• name (str, list, set, tuple) – name query parameter. Device Name .

• pid (str, list, set, tuple) – pid query parameter. Device ProductId .

• source (str, list, set, tuple) – source query parameter. Device Source .

• project_id (str, list, set, tuple) – projectId query parameter. Device Project Id .

• workflow_id (str, list, set, tuple) – workflowId query parameter. Device Workflow Id .

• project_name (str, list, set, tuple) – projectName query parameter. Device Project Name .

• workflow_name (str, list, set, tuple) – workflowName query parameter. Device Workflow Name .

• smart_account_id (str, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

• virtual_account_id (str, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

• last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-count

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)

Returns history for a specific device. Serial number is a required parameter .

Parameters:

• serial_number (str) – serialNumber query parameter. Device Serial Number .

• sort (str, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-history

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)

Add devices to PnP in bulk .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!import-devices-in-bulk

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Recovers a device from a Workflow Execution Error state .

Parameters:

• deviceResetList (list) – Device Onboarding (PnP)’s deviceResetList (list of objects).

• projectId (string) – Device Onboarding (PnP)’s projectId.

• workflowId (string) – Device Onboarding (PnP)’s workflowId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!reset-device

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)

Returns the summary of devices synced from the given smart account & virtual account with PnP .

Parameters:

• domain (str) – domain path parameter. Smart Account Domain .

• name (str) – name path parameter. Virtual Account Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-sync-result-for-virtual-account

claim_a_device_to_a_site(configInfo=None, deviceId=None, gateway=None, imageInfo=None, ipInterfaceName=None, rfProfile=None, sensorProfile=None, siteId=None, staticIP=None, subnetMask=None, type=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Claim a device based on DNA-C Site-based design process. Some required parameters differ based on device platform: Default/StackSwitch: imageInfo, configInfo. AccessPoints: rfProfile. Sensors: sensorProfile. DNAWLC/MobilityExpress/EWC: staticIP, subnetMask, gateway. vlanId and ipInterfaceName are also allowed for DNA 9800 WLCs. .

Parameters:

• configInfo (list) – Device Onboarding (PnP)’s configInfo (list of objects).

• deviceId (string) – Device Onboarding (PnP)’s Device Id.

• gateway (string) – Device Onboarding (PnP)’s for DNAWLC/MobilityExpress .

• imageInfo (object) – Device Onboarding (PnP)’s imageInfo.

• ipInterfaceName (string) – Device Onboarding (PnP)’s for DNA 9800 WLC .

• rfProfile (string) – Device Onboarding (PnP)’s for Access Points .

• sensorProfile (string) – Device Onboarding (PnP)’s for Sensors .

• siteId (string) – Device Onboarding (PnP)’s Site Id.

• staticIP (string) – Device Onboarding (PnP)’s for DNAWLC/MobilityExpress .

• subnetMask (string) – Device Onboarding (PnP)’s for DNAWLC/MobilityExpress .

• type (string) – Device Onboarding (PnP)’s Type. Available values are ‘Default’, ‘StackSwitch’, ‘AccessPoint’, ‘Sensor’, ‘DNAWLC’ and ‘MobilityExpress’.

• vlanId (string) – Device Onboarding (PnP)’s for DNA 9800 WLC .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!claim-a-device-to-a-site

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)

Triggers a preview for site-based Day 0 Configuration .

Parameters:

• deviceId (string) – Device Onboarding (PnP)’s deviceId.

• siteId (string) – Device Onboarding (PnP)’s siteId.

• type (string) – Device Onboarding (PnP)’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!preview-config

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)

Un-Claims one of more devices with specified workflow .

Parameters:

• deviceIdList (list) – Device Onboarding (PnP)’s deviceIdList (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!un-claim-device

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices .

Parameters:

• autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

• ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

• expiry (integer) – Device Onboarding (PnP)’s expiry.

• lastSync (integer) – Device Onboarding (PnP)’s lastSync.

• profile (object) – Device Onboarding (PnP)’s profile.

• smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

• syncResult (object) – Device Onboarding (PnP)’s syncResult.

• syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

• syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

• syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• token (string) – Device Onboarding (PnP)’s token.

• virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sync-virtual-account-devices

update_device(id, _id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates device details specified by device id in PnP database .

Parameters:

• _id (string) – Device Onboarding (PnP)’s _id.

• deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

• runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

• systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

• systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• version (integer) – Device Onboarding (PnP)’s version.

• workflow (object) – Device Onboarding (PnP)’s workflow.

• workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-device

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)

Deletes specified device from PnP database .

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-device-by-id-from-pnp

get_device_by_id(id, headers=None, **request_parameters)

Returns device details specified by device id .

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-by-id

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates the user’s list of global PnP settings .

Parameters:

• _id (string) – Device Onboarding (PnP)’s _id.

• aaaCredentials (object) – Device Onboarding (PnP)’s aaaCredentials.

• acceptEula (boolean) – Device Onboarding (PnP)’s acceptEula.

• defaultProfile (object) – Device Onboarding (PnP)’s defaultProfile.

• savaMappingList (list) – Device Onboarding (PnP)’s savaMappingList (list of objects).

• taskTimeOuts (object) – Device Onboarding (PnP)’s taskTimeOuts.

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• version (integer) – Device Onboarding (PnP)’s version.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-pnp-global-settings

get_pnp_global_settings(headers=None, **request_parameters)

Returns global PnP settings of the user .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-pnp-global-settings

get_smart_account_list(headers=None, **request_parameters)

Returns the list of Smart Account domains .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-smart-account-list

get_virtual_account_list(domain, headers=None, **request_parameters)

Returns list of virtual accounts associated with the specified smart account .

Parameters:

• domain (str) – domain path parameter. Smart Account Domain .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-virtual-account-list

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile .

Parameters:

• autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

• ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

• expiry (integer) – Device Onboarding (PnP)’s expiry.

• lastSync (integer) – Device Onboarding (PnP)’s lastSync.

• profile (object) – Device Onboarding (PnP)’s profile.

• smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

• syncResult (object) – Device Onboarding (PnP)’s syncResult.

• syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

• syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

• syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• token (string) – Device Onboarding (PnP)’s token.

• virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-virtual-account

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info .

Parameters:

• autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

• ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

• expiry (integer) – Device Onboarding (PnP)’s expiry.

• lastSync (integer) – Device Onboarding (PnP)’s lastSync.

• profile (object) – Device Onboarding (PnP)’s profile.

• smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

• syncResult (object) – Device Onboarding (PnP)’s syncResult.

• syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

• syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

• syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• token (string) – Device Onboarding (PnP)’s token.

• virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-pnp-server-profile

deregister_virtual_account(domain, name, headers=None, **request_parameters)

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information .

Parameters:

• domain (str) – domain query parameter. Smart Account Domain .

• name (str) – name query parameter. Virtual Account Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deregister-virtual-account

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint .

Parameters:

• limit (int,str) – limit query parameter. Limits number of results .

• offset (int,str) – offset query parameter. Index of first result .

• sort (str, list, set, tuple) – sort query parameter. Comma seperated lost of fields to sort on .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• type (str, list, set, tuple) – type query parameter. Workflow Type .

• name (str, list, set, tuple) – name query parameter. Workflow Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-workflows

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database .

Parameters:

• _id (string) – Device Onboarding (PnP)’s _id.

• addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

• addedOn (integer) – Device Onboarding (PnP)’s addedOn.

• configId (string) – Device Onboarding (PnP)’s configId.

• currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

• description (string) – Device Onboarding (PnP)’s description.

• endTime (integer) – Device Onboarding (PnP)’s endTime.

• execTime (integer) – Device Onboarding (PnP)’s execTime.

• imageId (string) – Device Onboarding (PnP)’s imageId.

• instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

• lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

• name (string) – Device Onboarding (PnP)’s name.

• startTime (integer) – Device Onboarding (PnP)’s startTime.

• state (string) – Device Onboarding (PnP)’s state.

• tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• type (string) – Device Onboarding (PnP)’s type.

• useState (string) – Device Onboarding (PnP)’s useState.

• version (integer) – Device Onboarding (PnP)’s version.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-a-workflow

get_workflow_count(name=None, headers=None, **request_parameters)

Returns the workflow count .

Parameters:

• name (str, list, set, tuple) – name query parameter. Workflow Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-workflow-count

get_workflow_by_id(id, headers=None, **request_parameters)

Returns a workflow specified by id .

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-workflow-by-id

delete_workflow_by_id(id, headers=None, **request_parameters)

Deletes a workflow specified by id .

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-workflow-by-id

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates an existing workflow .

Parameters:

• _id (string) – Device Onboarding (PnP)’s _id.

• addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

• addedOn (integer) – Device Onboarding (PnP)’s addedOn.

• configId (string) – Device Onboarding (PnP)’s configId.

• currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

• description (string) – Device Onboarding (PnP)’s description.

• endTime (integer) – Device Onboarding (PnP)’s endTime.

• execTime (integer) – Device Onboarding (PnP)’s execTime.

• imageId (string) – Device Onboarding (PnP)’s imageId.

• instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

• lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

• name (string) – Device Onboarding (PnP)’s name.

• startTime (integer) – Device Onboarding (PnP)’s startTime.

• state (string) – Device Onboarding (PnP)’s state.

• tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• type (string) – Device Onboarding (PnP)’s type.

• useState (string) – Device Onboarding (PnP)’s useState.

• version (integer) – Device Onboarding (PnP)’s version.

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-workflow

device_replacement

class DeviceReplacement

Cisco DNA Center Device Replacement API (version: 2.3.5.3).

Wraps the DNA Center Device Replacement API and exposes the API as native Python methods that return native Python objects.

return_replacement_devices_with_details(family=None, faulty_device_name=None, faulty_device_platform=None, faulty_device_serial_number=None, limit=None, offset=None, replacement_device_platform=None, replacement_device_serial_number=None, replacement_status=None, sort_by=None, sort_order=None, headers=None, **request_parameters)

Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device Serial Number, Device Replacement status, Product Family. .

Parameters:

• faulty_device_name (str) – faultyDeviceName query parameter. Faulty Device Name .

• faulty_device_platform (str) – faultyDevicePlatform query parameter. Faulty Device Platform .

• replacement_device_platform (str) – replacementDevicePlatform query parameter. Replacement Device Platform .

• faulty_device_serial_number (str) – faultyDeviceSerialNumber query parameter. Faulty Device Serial Number .

• replacement_device_serial_number (str) – replacementDeviceSerialNumber query parameter. Replacement Device Serial Number .

• replacement_status (str, list, set, tuple) – replacementStatus query parameter. Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED] .

• family (str, list, set, tuple) – family query parameter. List of families[Routers, Switches and Hubs, AP] .

• sort_by (str) – sortBy query parameter. SortBy this field. SortBy is mandatory when order is used. .

• sort_order (str) – sortOrder query parameter. Order on displayName[ASC,DESC] .

• offset (int,str) – offset query parameter.

• limit (int,str) – limit query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!return-replacement-devices-with-details

unmark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)

UnMarks device for replacement .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!unmark-device-for-replacement

mark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)

Marks device for replacement .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!mark-device-for-replacement

return_replacement_devices_count(replacement_status=None, headers=None, **request_parameters)

Get replacement devices count .

Parameters:

• replacement_status (str, list, set, tuple) – replacementStatus query parameter. Device Replacement status list[READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!return-replacement-devices-count

deploy_device_replacement_workflow(faultyDeviceSerialNumber=None, replacementDeviceSerialNumber=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images .

Parameters:

• faultyDeviceSerialNumber (string) – Device Replacement’s faultyDeviceSerialNumber.

• replacementDeviceSerialNumber (string) – Device Replacement’s replacementDeviceSerialNumber.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deploy-device-replacement-workflow

devices

class Devices

Cisco DNA Center Devices API (version: 2.3.5.3).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

get_planned_access_points_for_building(building_id, limit=None, offset=None, radios=None, headers=None, **request_parameters)

Provides a list of Planned Access Points for the Building it is requested for .

Parameters:

• building_id (str) – buildingId path parameter. Building Id .

• limit (int,str) – limit query parameter.

• offset (int,str) – offset query parameter.

• radios (bool) – radios query parameter. inlcude planned radio details .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-planned-access-points-for-building

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:

• timestamp (str) – timestamp query parameter. Epoch time(in milliseconds) when the device data is required .

• search_by (str) – searchBy query parameter. MAC Address or Device Name value or UUID of the network device .

• identifier (str) – identifier query parameter. One of keywords : macAddress or uuid or nwDeviceName .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-detail

get_device_enrichment_details(headers=None, **request_parameters)

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

devices(device_role=None, end_time=None, health=None, limit=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)

Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services. .

Parameters:

• device_role (str) – deviceRole query parameter. The device role (One of CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, AP) .

• site_id (str) – siteId query parameter. Assurance site UUID value .

• health (str) – health query parameter. The device overall health (One of POOR, FAIR, GOOD) .

• start_time (int) – startTime query parameter. UTC epoch time in milliseconds .

• end_time (int) – endTime query parameter. UTC epoch time in miliseconds .

• limit (int,str) – limit query parameter. Max number of device entries in the response (default to 50. Max at 1000) .

• offset (int,str) – offset query parameter. The offset of the first device in the returned data .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!devices

get_planned_access_points_for_floor(floor_id, limit=None, offset=None, radios=None, headers=None, **request_parameters)

Provides a list of Planned Access Points for the Floor it is requested for .

Parameters:

• floor_id (str) – floorId path parameter. Floor Id .

• limit (int,str) – limit query parameter.

• offset (int,str) – offset query parameter.

• radios (bool) – radios query parameter. inlcude planned radio details .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-planned-access-points-for-floor

get_all_interfaces(last_input_time=None, last_output_time=None, limit=None, offset=None, headers=None, **request_parameters)

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces .

Parameters:

• offset (int,str) – offset query parameter.

• limit (int,str) – limit query parameter.

• last_input_time (str) – lastInputTime query parameter. Last Input Time .

• last_output_time (str) – lastOutputTime query parameter. Last Output Time .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-interfaces

get_device_interface_count(headers=None, **request_parameters)

Returns the count of interfaces for all devices .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_interface_by_ip(ip_address, headers=None, **request_parameters)

Returns list of interfaces for specified device management IP address .

Parameters:

• ip_address (str) – ipAddress path parameter. IP address of the interface .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-by-ip

get_isis_interfaces(headers=None, **request_parameters)

Returns the interfaces that has ISIS enabled .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-isis-interfaces

get_interface_info_by_id(device_id, headers=None, **request_parameters)

Returns list of interfaces by specified device .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-info-by-id

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)

Returns the interface count for the given device .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-interface-count-by-id

get_interface_details(device_id, name, headers=None, **request_parameters)

Returns interface by specified device Id and interface name .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• name (str) – name query parameter. Interface name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-details

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)

Returns the list of interfaces for the device for the specified range .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• start_index (int) – startIndex path parameter. Start index .

• records_to_return (int) – recordsToReturn path parameter. Number of records to return .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-interfaces-by-specified-range

get_ospf_interfaces(headers=None, **request_parameters)

Returns the interfaces that has OSPF enabled .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-ospf-interfaces

get_interface_by_id(id, headers=None, **request_parameters)

Returns the interface for the given interface ID .

Parameters:

• id (str) – id path parameter. Interface ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-by-id

update_interface_details(interface_uuid, adminStatus=None, deployment_mode=None, description=None, vlanId=None, voiceVlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add/Update Interface description, VLAN membership, Voice VLAN and change Interface admin status (‘UP’/’DOWN’) from Request body. .

Parameters:

• adminStatus (string) – Devices’s Admin Status.

• description (string) – Devices’s Description.

• vlanId (integer) – Devices’s Vlan Id.

• voiceVlanId (integer) – Devices’s Voice Vlan Id.

• interface_uuid (str) – interfaceUuid path parameter. Interface ID .

• deployment_mode (str) – deploymentMode query parameter. Preview/Deploy [‘Preview’ means the configuration is not pushed to the device. ‘Deploy’ makes the configuration pushed to the device] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-interface-details

legit_operations_for_interface(interface_uuid, headers=None, **request_parameters)

Get list of all properties & operations valid for an interface. .

Parameters:

• interface_uuid (str) – interfaceUuid path parameter. Interface ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!legit-operations-for-interface

clear_mac_address_table(interface_uuid, deployment_mode=None, operation=None, payload=None, headers=None, active_validation=True, **request_parameters)

Clear mac-address on an individual port. In request body, operation needs to be specified as ‘ClearMacAddress’. In the future more possible operations will be added to this API .

Parameters:

• operation (string) – Devices’s Operation.

• payload (dict) – Devices’s Payload.

• interface_uuid (str) – interfaceUuid path parameter. Interface Id .

• deployment_mode (str) – deploymentMode query parameter. Preview/Deploy [‘Preview’ means the configuration is not pushed to the device. ‘Deploy’ makes the configuration pushed to the device] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!clear-mac-address-table

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, device_support_level=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, limit=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, offset=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc. You can use the .* in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET /dna/intent/api/v1/network-device?hostname=myhost.*&managementIpAddress=192.25.18..* If id parameter is provided with comma separated ids, it will return the list of network-devices for the given ids and ignores the other request parameters. You can also specify offset & limit to get the required list. .

Parameters:

• hostname (str, list, set, tuple) – hostname query parameter.

• management_ip_address (str, list, set, tuple) – managementIpAddress query parameter.

• mac_address (str, list, set, tuple) – macAddress query parameter.

• location_name (str, list, set, tuple) – locationName query parameter.

• serial_number (str, list, set, tuple) – serialNumber query parameter.

• location (str, list, set, tuple) – location query parameter.

• family (str, list, set, tuple) – family query parameter.

• type (str, list, set, tuple) – type query parameter.

• series (str, list, set, tuple) – series query parameter.

• collection_status (str, list, set, tuple) – collectionStatus query parameter.

• collection_interval (str, list, set, tuple) – collectionInterval query parameter.

• not_synced_for_minutes (str, list, set, tuple) – notSyncedForMinutes query parameter.

• error_code (str, list, set, tuple) – errorCode query parameter.

• error_description (str, list, set, tuple) – errorDescription query parameter.

• software_version (str, list, set, tuple) – softwareVersion query parameter.

• software_type (str, list, set, tuple) – softwareType query parameter.

• platform_id (str, list, set, tuple) – platformId query parameter.

• role (str, list, set, tuple) – role query parameter.

• reachability_status (str, list, set, tuple) – reachabilityStatus query parameter.

• up_time (str, list, set, tuple) – upTime query parameter.

• associated_wlc_ip (str, list, set, tuple) – associatedWlcIp query parameter.

• license_name (str, list, set, tuple) – license.name query parameter.

• license_type (str, list, set, tuple) – license.type query parameter.

• license_status (str, list, set, tuple) – license.status query parameter.

• module_name (str, list, set, tuple) – module+name query parameter.

• module_equpimenttype (str, list, set, tuple) – module+equpimenttype query parameter.

• module_servicestate (str, list, set, tuple) – module+servicestate query parameter.

• module_vendorequipmenttype (str, list, set, tuple) – module+vendorequipmenttype query parameter.

• module_partnumber (str, list, set, tuple) – module+partnumber query parameter.

• module_operationstatecode (str, list, set, tuple) – module+operationstatecode query parameter.

• id (str) – id query parameter. Accepts comma separated ids and return list of network-devices for the given ids. If invalid or not-found ids are provided, null entry will be returned in the list. .

• device_support_level (str) – deviceSupportLevel query parameter.

• offset (int,str) – offset query parameter. offset >= 1 [X gives results from Xth device onwards] .

• limit (int,str) – limit query parameter. 1 <= limit <= 500 [max. no. of devices to be returned in the result] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-list

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Adds the device with given credential .

Parameters:

• cliTransport (string) – Devices’s cliTransport.

• computeDevice (boolean) – Devices’s computeDevice.

• enablePassword (string) – Devices’s enablePassword.

• extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

• httpPassword (string) – Devices’s httpPassword.

• httpPort (string) – Devices’s httpPort.

• httpSecure (boolean) – Devices’s httpSecure.

• httpUserName (string) – Devices’s httpUserName.

• ipAddress (list) – Devices’s ipAddress (list of strings).

• merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

• netconfPort (string) – Devices’s netconfPort.

• password (string) – Devices’s password.

• serialNumber (string) – Devices’s serialNumber.

• snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

• snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

• snmpMode (string) – Devices’s snmpMode.

• snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

• snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

• snmpROCommunity (string) – Devices’s snmpROCommunity.

• snmpRWCommunity (string) – Devices’s snmpRWCommunity.

• snmpRetry (integer) – Devices’s snmpRetry.

• snmpTimeout (integer) – Devices’s snmpTimeout.

• snmpUserName (string) – Devices’s snmpUserName.

• snmpVersion (string) – Devices’s snmpVersion.

• type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

• updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

• userName (string) – Devices’s userName.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-device

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Sync the devices provided as input .

Parameters:

• cliTransport (string) – Devices’s cliTransport.

• computeDevice (boolean) – Devices’s computeDevice.

• enablePassword (string) – Devices’s enablePassword.

• extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

• httpPassword (string) – Devices’s httpPassword.

• httpPort (string) – Devices’s httpPort.

• httpSecure (boolean) – Devices’s httpSecure.

• httpUserName (string) – Devices’s httpUserName.

• ipAddress (list) – Devices’s ipAddress (list of strings).

• merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

• netconfPort (string) – Devices’s netconfPort.

• password (string) – Devices’s password.

• serialNumber (string) – Devices’s serialNumber.

• snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

• snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

• snmpMode (string) – Devices’s snmpMode.

• snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

• snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

• snmpROCommunity (string) – Devices’s snmpROCommunity.

• snmpRWCommunity (string) – Devices’s snmpRWCommunity.

• snmpRetry (integer) – Devices’s snmpRetry.

• snmpTimeout (integer) – Devices’s snmpTimeout.

• snmpUserName (string) – Devices’s snmpUserName.

• snmpVersion (string) – Devices’s snmpVersion.

• type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

• updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

• userName (string) – Devices’s userName.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sync-devices

get_device_values_that_match_fully_or_partially_an_attribute(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)

Returns the list of values of the first given required parameter. You can use the .* in any value to conduct a wildcard search. For example, to get all the devices with the management IP address starting with 10.10. , issue the following request: GET /dna/inten/api/v1/network- device/autocomplete?managementIpAddress=10.10..* It will return the device management IP addresses that match fully or partially the provided attribute. {[10.10.1.1, 10.10.20.2, …]}. .

Parameters:

• vrf_name (str) – vrfName query parameter.

• management_ip_address (str) – managementIpAddress query parameter.

• hostname (str) – hostname query parameter.

• mac_address (str) – macAddress query parameter.

• family (str) – family query parameter.

• collection_status (str) – collectionStatus query parameter.

• collection_interval (str) – collectionInterval query parameter.

• software_version (str) – softwareVersion query parameter.

• software_type (str) – softwareType query parameter.

• reachability_status (str) – reachabilityStatus query parameter.

• reachability_failure_reason (str) – reachabilityFailureReason query parameter.

• error_code (str) – errorCode query parameter.

• platform_id (str) – platformId query parameter.

• series (str) – series query parameter.

• type (str) – type query parameter.

• serial_number (str) – serialNumber query parameter.

• up_time (str) – upTime query parameter.

• role (str) – role query parameter.

• role_source (str) – roleSource query parameter.

• associated_wlc_ip (str) – associatedWlcIp query parameter.

• offset (int,str) – offset query parameter.

• limit (int,str) – limit query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-values-that-match-fully-or-partially-an-attribute

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)

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

Parameters:

• id (string) – Devices’s id.

• role (string) – Devices’s role.

• roleSource (string) – Devices’s roleSource.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-device-role

get_polling_interval_for_all_devices(headers=None, **request_parameters)

Returns polling interval of all devices .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-polling-interval-for-all-devices

get_device_config_for_all_devices(headers=None, **request_parameters)

Returns the config for all devices .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-config-for-all-devices

get_device_config_count(headers=None, **request_parameters)

Returns the count of device configs .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-config-count

get_device_count(headers=None, **request_parameters)

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-count

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)

Exports the selected network device to a file .

Parameters:

• deviceUuids (list) – Devices’s deviceUuids (list of strings).

• id (string) – Devices’s id.

• operationEnum (string) – Devices’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

• parameters (list) – Devices’s parameters (list of strings).

• password (string) – Devices’s password.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!export-device-list

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)

Returns the functional-capability for given devices .

Parameters:

• device_id (str) – deviceId query parameter. Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list. .

• function_name (str, list, set, tuple) – functionName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-functional-capability-for-devices

get_functional_capability_by_id(id, headers=None, **request_parameters)

Returns functional capability with given Id .

Parameters:

• id (str) – id path parameter. Functional Capability UUID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-functional-capability-by-id

inventory_insight_device_link_mismatch(category, site_id, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Find all devices with link mismatch (speed / vlan) .

Parameters:

• site_id (str) – siteId path parameter.

• offset (int,str) – offset query parameter. Row Number. Default value is 1 .

• limit (int,str) – limit query parameter. Default value is 500 .

• category (str) – category query parameter. Links mismatch category. Value can be speed-duplex or vlan. .

• sort_by (str) – sortBy query parameter. Sort By .

• order (str) – order query parameter. Order. Value can be asc or desc. Default value is asc .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!inventory-insight-device-link-mismatch

get_devices_with_snmpv3_des(site_id, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Returns devices added to Cisco DNA center with snmp v3 DES, where siteId is mandatory & accepts offset, limit, sortby, order which are optional. .

Parameters:

• site_id (str) – siteId path parameter.

• offset (int,str) – offset query parameter. Row Number. Default value is 1 .

• limit (int,str) – limit query parameter. Default value is 500 .

• sort_by (str) – sortBy query parameter. Sort By .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-devices-with-snmpv3-des

get_network_device_by_ip(ip_address, headers=None, **request_parameters)

Returns the network device by specified IP address .

Parameters:

• ip_address (str) – ipAddress path parameter. Device IP address .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network-device-by-ip

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)

Returns modules by specified device id .

Parameters:

• device_id (str) – deviceId query parameter.

• limit (int,str) – limit query parameter.

• offset (int,str) – offset query parameter.

• name_list (str, list, set, tuple) – nameList query parameter.

• vendor_equipment_type_list (str, list, set, tuple) – vendorEquipmentTypeList query parameter.

• part_number_list (str, list, set, tuple) – partNumberList query parameter.

• operational_state_code_list (str, list, set, tuple) – operationalStateCodeList query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-modules

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)

Returns Module Count .

Parameters:

• device_id (str) – deviceId query parameter.

• name_list (str, list, set, tuple) – nameList query parameter.

• vendor_equipment_type_list (str, list, set, tuple) – vendorEquipmentTypeList query parameter.

• part_number_list (str, list, set, tuple) – partNumberList query parameter.

• operational_state_code_list (str, list, set, tuple) – operationalStateCodeList query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-module-count

get_module_info_by_id(id, headers=None, **request_parameters)

Returns Module info by ‘module id’ .

Parameters:

• id (str) – id path parameter. Module id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-module-info-by-id

get_device_by_serial_number(serial_number, headers=None, **request_parameters)

Returns the network device if the given serial number matches with any of the serial numbers collected. .

Parameters:

• serial_number (str) – serialNumber path parameter. Device serial number .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-by-serial-number

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device .

Parameters:

• force_sync (bool) – forceSync query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sync-devices-using-forcesync

get_devices_registered_for_wsa_notification(macaddress=None, serial_number=None, headers=None, **request_parameters)

It fetches devices which are registered to receive WSA notifications. The device serial number and/or MAC address are required to be provided as query parameters. .

Parameters:

• serial_number (str) – serialNumber query parameter. Serial number of the device .

• macaddress (str) – macaddress query parameter. Mac addres of the device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-devices-registered-for-wsa-notification

get_all_user_defined_fields(id=None, name=None, headers=None, **request_parameters)

Gets existing global User Defined Fields. If no input is given, it fetches ALL the Global UDFs. Filter/search is supported either by UDF Id(s) or by UDF name(s), but not both. .

Parameters:

• id (str) – id query parameter. Comma-seperated id(s) used for search/filtering .

• name (str) – name query parameter. Comma-seperated name(s) used for search/filtering .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-user-defined-fields

create_user_defined_field(description=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)

Creates a new global User Defined Field, which can be assigned to devices .

Parameters:

• description (string) – Devices’s Description of UDF .

• name (string) – Devices’s Name of UDF .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-user-defined-field

update_user_defined_field(id, description=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates an existing global User Defined Field, using it’s id. .

Parameters:

• description (string) – Devices’s Description of UDF .

• name (string) – Devices’s Name of UDF .

• id (str) – id path parameter. UDF id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-user-defined-field

delete_user_defined_field(id, headers=None, **request_parameters)

Deletes an existing Global User-Defined-Field using it’s id. .

Parameters:

• id (str) – id path parameter. UDF id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-user-defined-field

get_chassis_details_for_device(device_id, headers=None, **request_parameters)

Returns chassis details for given device ID .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-chassis-details-for-device

get_stack_details_for_device(device_id, headers=None, **request_parameters)

Retrieves complete stack details for given device ID .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-stack-details-for-device

remove_user_defined_field_from_device(device_id, name, headers=None, **request_parameters)

Remove a User-Defined-Field from device. Name of UDF has to be passed as the query parameter. Please note that Global UDF will not be deleted by this operation. .

Parameters:

• device_id (str) – deviceId path parameter. UUID of device from which UDF has to be removed .

• name (str) – name query parameter. Name of UDF to be removed .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!remove-user-defined-field-from-device

add_user_defined_field_to_device(device_id, headers=None, payload=None, active_validation=True, **request_parameters)

Assigns an existing Global User-Defined-Field to a device. If the UDF is already assigned to the specific device, then it updates the device UDF value accordingly. Please note that the assigning UDF ‘name’ must be an existing global UDF. Otherwise error shall be shown. .

Parameters:

• device_id (str) – deviceId path parameter. UUID of device to which UDF has to be added .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-user-defined-field-to-device

return_power_supply_fan_details_for_the_given_device(device_uuid, type=None, headers=None, **request_parameters)

Return PowerSupply/ Fan details for the Given device .

Parameters:

• device_uuid (str) – deviceUuid path parameter.

• type (str) – type query parameter. Type value can be PowerSupply, Fan, Chassis, Backplane, Module, PROCESSOR, Other, SFP. If no type is mentioned, All equipments are fetched for the device. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!return-power-supply-fan-details-for-the-given-device

poe_interface_details(device_uuid, interface_name_list=None, headers=None, **request_parameters)

Returns POE interface details for the device, where deviceuuid is mandatory & accepts comma seperated interface names which is optional and returns information for that particular interfaces where(operStatus = operationalStatus) .

Parameters:

• device_uuid (str) – deviceUuid path parameter. uuid of the device .

• interface_name_list (str) – interfaceNameList query parameter. comma seperated interface names .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!poe-interface-details

get_connected_device_detail(device_uuid, interface_uuid, headers=None, **request_parameters)

Get connected device detail for given deviceUuid and interfaceUuid .

Parameters:

• device_uuid (str) – deviceUuid path parameter. instanceuuid of Device .

• interface_uuid (str) – interfaceUuid path parameter. instanceuuid of interface .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-connected-device-detail

get_linecard_details(device_uuid, headers=None, **request_parameters)

Get line card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:

• device_uuid (str) – deviceUuid path parameter. instanceuuid of device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-linecard-details

poe_details_(device_uuid, headers=None, **request_parameters)

Returns POE details for device. .

Parameters:

• device_uuid (str) – deviceUuid path parameter. uuid of the device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

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

poe_details(device_uuid, headers=None, **request_parameters)

Returns POE details for device. .

Parameters:

• device_uuid (str) – deviceUuid path parameter. uuid of the device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!poe-details

get_supervisor_card_detail(device_uuid, headers=None, **request_parameters)

Get supervisor card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:

• device_uuid (str) – deviceUuid path parameter. instanceuuid of device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-supervisor-card-detail

get_device_by_id(id, headers=None, **request_parameters)

Returns the network device details for the given device ID .

Parameters:

• id (str) – id path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-by-id

delete_device_by_id(id, clean_config=None, headers=None, **request_parameters)

Deletes the network device for the given Id .

Parameters:

• id (str) – id path parameter. Device ID .

• clean_config (bool) – cleanConfig query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-device-by-id

get_device_summary(id, headers=None, **request_parameters)

Returns brief summary of device info such as hostname, management IP address for the given device Id .

Parameters:

• id (str) – id path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-summary

get_polling_interval_by_id(id, headers=None, **request_parameters)

Returns polling interval by device id .

Parameters:

• id (str) – id path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-polling-interval-by-id

get_organization_list_for_meraki(id, headers=None, **request_parameters)

Returns list of organizations for meraki dashboard .

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-organization-list-for-meraki

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)

Returns Device Interface VLANs .

Parameters:

• id (str) – id path parameter.

• interface_type (str) – interfaceType query parameter. Vlan assocaited with sub-interface .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-interface-vlans

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)

Returns the wireless lan controller info with given device ID .

Parameters:

• id (str) – id path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-wireless-lan-controller-details-by-id

get_device_config_by_id(network_device_id, headers=None, **request_parameters)

Returns the device config by specified device ID .

Parameters:

• network_device_id (str) – networkDeviceId path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-config-by-id

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)

Returns the list of network devices for the given pagination range. The maximum number of records that can be retrieved is 500 .

Parameters:

• start_index (int) – startIndex path parameter. Start index [>=1] .

• records_to_return (int) – recordsToReturn path parameter. Number of records to return [1<= recordsToReturn <= 500] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network-device-by-pagination-range

discovery

class Discovery

Cisco DNA Center Discovery API (version: 2.3.5.3).

Wraps the DNA Center Discovery API and exposes the API as native Python methods that return native Python objects.

delete_all_discovery(headers=None, **request_parameters)

Stops all the discoveries and removes them .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-all-discovery

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)

Stops or starts an existing discovery .

Parameters:

• attributeInfo (object) – Discovery’s attributeInfo.

• cdpLevel (integer) – Discovery’s cdpLevel.

• deviceIds (string) – Discovery’s deviceIds.

• discoveryCondition (string) – Discovery’s discoveryCondition.

• discoveryStatus (string) – Discovery’s discoveryStatus.

• discoveryType (string) – Discovery’s discoveryType.

• enablePasswordList (string) – Discovery’s enablePasswordList.

• globalCredentialIdList (list) – Discovery’s globalCredentialIdList (list of strings).

• httpReadCredential (object) – Discovery’s httpReadCredential.

• httpWriteCredential (object) – Discovery’s httpWriteCredential.

• id (string) – Discovery’s id.

• ipAddressList (string) – Discovery’s ipAddressList.

• ipFilterList (string) – Discovery’s ipFilterList.

• isAutoCdp (boolean) – Discovery’s isAutoCdp.

• lldpLevel (integer) – Discovery’s lldpLevel.

• name (string) – Discovery’s name.

• netconfPort (string) – Discovery’s netconfPort.

• numDevices (integer) – Discovery’s numDevices.

• parentDiscoveryId (string) – Discovery’s parentDiscoveryId.

• passwordList (string) – Discovery’s passwordList.

• preferredMgmtIPMethod (string) – Discovery’s preferredMgmtIPMethod.

• protocolOrder (string) – Discovery’s protocolOrder.

• retryCount (integer) – Discovery’s retryCount.

• snmpAuthPassphrase (string) – Discovery’s snmpAuthPassphrase.

• snmpAuthProtocol (string) – Discovery’s snmpAuthProtocol.

• snmpMode (string) – Discovery’s snmpMode.

• snmpPrivPassphrase (string) – Discovery’s snmpPrivPassphrase.

• snmpPrivProtocol (string) – Discovery’s snmpPrivProtocol.

• snmpRoCommunity (string) – Discovery’s snmpRoCommunity.

• snmpRoCommunityDesc (string) – Discovery’s snmpRoCommunityDesc.

• snmpRwCommunity (string) – Discovery’s snmpRwCommunity.

• snmpRwCommunityDesc (string) – Discovery’s snmpRwCommunityDesc.

• snmpUserName (string) – Discovery’s snmpUserName.

• timeOut (integer) – Discovery’s timeOut.

• updateMgmtIp (boolean) – Discovery’s updateMgmtIp.

• userNameList (string) – Discovery’s userNameList.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!updates-discovery-by-id

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)

Initiates discovery with the given parameters .

Parameters:

• cdpLevel (integer) – Discovery’s CDP level to which neighbor devices to be discovered .

• discoveryType (string) – Discovery’s Type of Discovery. ‘SINGLE’, ‘RANGE’, ‘MULTI RANGE’, ‘CDP’, ‘LLDP’, ‘CIDR’ .

• enablePasswordList (list) – Discovery’s Enable Password of the devices to be discovered (list of strings).

• globalCredentialIdList (list) – Discovery’s Global Credential Ids to be used for discovery (list of strings).

• httpReadCredential (object) – Discovery’s httpReadCredential.

• httpWriteCredential (object) – Discovery’s httpWriteCredential.

• ipAddressList (string) – Discovery’s IP Address of devices to be discovered. Ex: ‘172.30.0.1’ for SINGLE, CDP and LLDP; ‘72.30.0.1-172.30.0.4’ for RANGE; ‘72.30.0.1-172.30.0.4,172.31.0.1-172.31.0.4’ for MULTI RANGE; ‘172.30.0.1/20’ for CIDR .

• ipFilterList (list) – Discovery’s IP Addresses of the devices to be filtered out during discovery (list of strings).

• lldpLevel (integer) – Discovery’s LLDP level to which neighbor devices to be discovered .

• name (string) – Discovery’s Name of the discovery .

• netconfPort (string) – Discovery’s Netconf Port. It will need valid SSH credentials to work .

• passwordList (list) – Discovery’s Password of the devices to be discovered (list of strings).

• preferredMgmtIPMethod (string) – Discovery’s Preferred Management IP Method.’None’ or ‘UseLoopBack’. Default is ‘None’ .

• protocolOrder (string) – Discovery’s Order of protocol (ssh/telnet) in which device connection will be tried. Ex: ‘telnet’: only telnet; ‘ssh,telnet’: ssh with higher order than telnet .

• retry (integer) – Discovery’s Number of times to try establishing connection to device .

• snmpAuthPassphrase (string) – Discovery’s Auth Pass phrase for SNMP .

• snmpAuthProtocol (string) – Discovery’s SNMP auth protocol. SHA’ or ‘MD5’ .

• snmpMode (string) – Discovery’s Mode of SNMP. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’ .

• snmpPrivPassphrase (string) – Discovery’s Pass phrase for SNMP privacy .

• snmpPrivProtocol (string) – Discovery’s SNMP privacy protocol. ‘DES’ or ‘AES128’ .

• snmpROCommunity (string) – Discovery’s Snmp RO community of the devices to be discovered .

• snmpROCommunityDesc (string) – Discovery’s Description for Snmp RO community .

• snmpRWCommunity (string) – Discovery’s Snmp RW community of the devices to be discovered .

• snmpRWCommunityDesc (string) – Discovery’s Description for Snmp RW community .

• snmpUserName (string) – Discovery’s SNMP username of the device .

• snmpVersion (string) – Discovery’s Version of SNMP. v2 or v3 .

• timeout (integer) – Discovery’s Time to wait for device response in seconds .

• userNameList (list) – Discovery’s Username of the devices to be discovered (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!start-discovery

get_count_of_all_discovery_jobs(headers=None, **request_parameters)

Returns the count of all available discovery jobs .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-count-of-all-discovery-jobs

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)

Returns the list of discovery jobs for the given IP .

Parameters:

• offset (int,str) – offset query parameter.

• limit (int,str) – limit query parameter.

• ip_address (str) – ipAddress query parameter.

• name (str) – name query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovery-jobs-by-ip

delete_discovery_by_id(id, headers=None, **request_parameters)

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-discovery-by-id

get_discovery_by_id(id, headers=None, **request_parameters)

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovery-by-id

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• offset (int,str) – offset query parameter.

• limit (int,str) – limit query parameter.

• ip_address (str) – ipAddress query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-list-of-discoveries-by-discovery-id

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• task_id (str) – taskId query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovered-network-devices-by-discovery-id

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• task_id (str) – taskId query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-devices-discovered-by-id

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• start_index (int) – startIndex path parameter. Start index .

• records_to_return (int) – recordsToReturn path parameter. Number of records to return .

• task_id (str) – taskId query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovered-devices-by-range

get_network_devices_from_discovery(id, clistatus=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• task_id (str) – taskId query parameter.

• sort_by (str) – sortBy query parameter.

• sort_order (str) – sortOrder query parameter.

• ip_address (str, list, set, tuple) – ipAddress query parameter.

• ping_status (str, list, set, tuple) – pingStatus query parameter.

• snmp_status (str, list, set, tuple) – snmpStatus query parameter.

• clistatus (str, list, set, tuple) – cliStatus query parameter.

• netconf_status (str, list, set, tuple) – netconfStatus query parameter.

• http_status (str, list, set, tuple) – httpStatus query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network-devices-from-discovery

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)

Stops discovery for the given range and removes them .

Parameters:

• start_index (int) – startIndex path parameter. Start index .

• records_to_delete (int) – recordsToDelete path parameter. Number of records to delete .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-discovery-by-specified-range

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)

Returns the discovery by specified range .

Parameters:

• start_index (int) – startIndex path parameter. Start index .

• records_to_return (int) – recordsToReturn path parameter. Number of records to return .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discoveries-by-range

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)

Returns global credential for the given credential sub type .

Parameters:

• credential_sub_type (str) – credentialSubType query parameter. Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF .

• sort_by (str) – sortBy query parameter.

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-global-credentials

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global CLI credentials .

Parameters:

• comments (string) – Discovery’s comments.

• credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s description.

• enablePassword (string) – Discovery’s enablePassword.

• id (string) – Discovery’s id.

• instanceTenantId (string) – Discovery’s instanceTenantId.

• instanceUuid (string) – Discovery’s instanceUuid.

• password (string) – Discovery’s password.

• username (string) – Discovery’s username.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-cli-credentials

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global CLI credential .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-cli-credentials

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)

Adds HTTP read credentials .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-http-read-credentials

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global HTTP Read credential .

Parameters:

• comments (string) – Discovery’s comments.

• credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s description.

• id (string) – Discovery’s id.

• instanceTenantId (string) – Discovery’s instanceTenantId.

• instanceUuid (string) – Discovery’s instanceUuid.

• password (string) – Discovery’s password.

• port (integer) – Discovery’s port.

• secure (boolean) – Discovery’s secure.

• username (string) – Discovery’s username.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-http-read-credential

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global HTTP write credentials .

Parameters:

• comments (string) – Discovery’s comments.

• credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s description.

• id (string) – Discovery’s id.

• instanceTenantId (string) – Discovery’s instanceTenantId.

• instanceUuid (string) – Discovery’s instanceUuid.

• password (string) – Discovery’s password.

• port (integer) – Discovery’s port.

• secure (boolean) – Discovery’s secure.

• username (string) – Discovery’s username.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-http-write-credentials

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global HTTP write credentials .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-http-write-credentials

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global netconf credentials .

Parameters:

• comments (string) – Discovery’s comments.

• credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s description.

• id (string) – Discovery’s id.

• instanceTenantId (string) – Discovery’s instanceTenantId.

• instanceUuid (string) – Discovery’s instanceUuid.

• netconfPort (string) – Discovery’s netconfPort.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-netconf-credentials

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global netconf credentials .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-netconf-credentials

update_snmp_read_community(comments=None, credentialType=None, description=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global SNMP read community .

Parameters:

• comments (string) – Discovery’s Comments to identify the credential .

• credentialType (string) – Discovery’s Credential type to identify the application that uses the credential . Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s Name/Description of the credential .

• instanceUuid (string) – Discovery’s instanceUuid.

• readCommunity (string) – Discovery’s SNMP read community. NO!$DATA!$ for no value change .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-snmp-read-community

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global SNMP read community .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-snmp-read-community

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global SNMP write community .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-snmp-write-community

update_snmp_write_community(comments=None, credentialType=None, description=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global SNMP write community .

Parameters:

• comments (string) – Discovery’s Comments to identify the credential .

• credentialType (string) – Discovery’s Credential type to identify the application that uses the credential . Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s Name/Description of the credential .

• instanceUuid (string) – Discovery’s instanceUuid.

• writeCommunity (string) – Discovery’s SNMP write community. NO!$DATA!$ for no value change .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-snmp-write-community

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global SNMPv3 credential .

Parameters:

• authPassword (string) – Discovery’s authPassword.

• authType (string) – Discovery’s authType. Available values are ‘SHA’ and ‘MD5’.

• comments (string) – Discovery’s comments.

• credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s description.

• id (string) – Discovery’s id.

• instanceTenantId (string) – Discovery’s instanceTenantId.

• instanceUuid (string) – Discovery’s instanceUuid.

• privacyPassword (string) – Discovery’s privacyPassword.

• privacyType (string) – Discovery’s privacyType. Available values are ‘DES’ and ‘AES128’.

• snmpMode (string) – Discovery’s snmpMode. Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

• username (string) – Discovery’s username.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-snmpv3-credentials

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global SNMPv3 credentials .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-snmpv3-credentials

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)

Deletes global credential for the given ID .

Parameters:

• global_credential_id (str) – globalCredentialId path parameter. ID of global-credential .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-global-credentials-by-id

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update global credential for network devices in site(s) .

Parameters:

• siteUuids (list) – Discovery’s siteUuids (list of strings).

• global_credential_id (str) – globalCredentialId path parameter. Global credential Uuid .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-global-credentials

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)

Returns the credential sub type for the given Id .

Parameters:

• id (str) – id path parameter. Global Credential ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-credential-sub-type-by-credential-id

get_snmp_properties(headers=None, **request_parameters)

Returns SNMP properties .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-snmp-properties

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)

Adds SNMP properties .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-update-snmp-properties

update_global_credentials_v2(cliCredential=None, httpsRead=None, httpsWrite=None, snmpV2cRead=None, snmpV2cWrite=None, snmpV3=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update device credentials. Multiple credentials can be passed at once, but only a single credential of a given type can be passed at once. Please refer sample Request Body for more information. .

Parameters:

• cliCredential (object) – Discovery’s cliCredential.

• httpsRead (object) – Discovery’s httpsRead.

• httpsWrite (object) – Discovery’s httpsWrite.

• snmpV2cRead (object) – Discovery’s snmpV2cRead.

• snmpV2cWrite (object) – Discovery’s snmpV2cWrite.

• snmpV3 (object) – Discovery’s snmpV3.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-global-credentials-v2

create_global_credentials_v2(cliCredential=None, httpsRead=None, httpsWrite=None, snmpV2cRead=None, snmpV2cWrite=None, snmpV3=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create new global credentials. Multiple credentials of various types can be passed at once. Please refer sample Request Body for more information. .

Parameters:

• cliCredential (list) – Discovery’s cliCredential (list of objects).

• httpsRead (list) – Discovery’s httpsRead (list of objects).

• httpsWrite (list) – Discovery’s httpsWrite (list of objects).

• snmpV2cRead (list) – Discovery’s snmpV2cRead (list of objects).

• snmpV2cWrite (list) – Discovery’s snmpV2cWrite (list of objects).

• snmpV3 (list) – Discovery’s snmpV3 (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-global-credentials-v2

get_all_global_credentials_v2(headers=None, **request_parameters)

API to get device credentials’ details. It fetches all global credentials of all types at once, without the need to pass any input parameters. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-global-credentials-v2

delete_global_credential_v2(id, headers=None, **request_parameters)

Delete a global credential. Only ‘id’ of the credential has to be passed. .

Parameters:

• id (str) – id path parameter. Global Credential id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-global-credential-v2

eox

event_management

class EventManagement

Cisco DNA Center Event Management API (version: 2.3.5.3).

Wraps the DNA Center Event Management API and exposes the API as native Python methods that return native Python objects.

get_auditlog_parent_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)

Get Parent Audit Log Event instances from the Event-Hub .

Parameters:

• instance_id (str) – instanceId query parameter. InstanceID of the Audit Log. .

• name (str) – name query parameter. Audit Log notification event name. .

• event_id (str) – eventId query parameter. Audit Log notification’s event ID. .

• category (str) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

• severity (str) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

• domain (str) – domain query parameter. Audit Log notification’s event domain. .

• sub_domain (str) – subDomain query parameter. Audit Log notification’s event sub-domain. .

• source (str) – source query parameter. Audit Log notification’s event source. .

• user_id (str) – userId query parameter. Audit Log notification’s event userId. .

• context (str) – context query parameter. Audit Log notification’s event correlationId. .

• event_hierarchy (str) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

• site_id (str) – siteId query parameter. Audit Log notification’s siteId. .

• device_id (str) – deviceId query parameter. Audit Log notification’s deviceId. .

• is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

• description (str) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

• offset (int,str) – offset query parameter. Position of a particular Audit Log record in the data. .

• limit (int,str) – limit query parameter. Number of Audit Log records to be returned per page. .

• start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

• end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

• sort_by (str) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

• order (str) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-auditlog-parent-records

get_auditlog_summary(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_parent_only=None, is_system_events=None, name=None, parent_instance_id=None, severity=None, site_id=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)

Get Audit Log Summary from the Event-Hub .

Parameters:

• parent_instance_id (str) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

• is_parent_only (bool) – isParentOnly query parameter. Parameter to filter parent only audit-logs. .

• instance_id (str) – instanceId query parameter. InstanceID of the Audit Log. .

• name (str) – name query parameter. Audit Log notification event name. .

• event_id (str) – eventId query parameter. Audit Log notification’s event ID. .

• category (str) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

• severity (str) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

• domain (str) – domain query parameter. Audit Log notification’s event domain. .

• sub_domain (str) – subDomain query parameter. Audit Log notification’s event sub-domain. .

• source (str) – source query parameter. Audit Log notification’s event source. .

• user_id (str) – userId query parameter. Audit Log notification’s event userId. .

• context (str) – context query parameter. Audit Log notification’s event correlationId. .

• event_hierarchy (str) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

• site_id (str) – siteId query parameter. Audit Log notification’s siteId. .

• device_id (str) – deviceId query parameter. Audit Log notification’s deviceId. .

• is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

• description (str) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

• start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

• end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-auditlog-summary

get_auditlog_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, parent_instance_id=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)

Get Audit Log Event instances from the Event-Hub .

Parameters:

• parent_instance_id (str) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

• instance_id (str) – instanceId query parameter. InstanceID of the Audit Log. .

• name (str) – name query parameter. Audit Log notification event name. .

• event_id (str) – eventId query parameter. Audit Log notification’s event ID. .

• category (str) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

• severity (str) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

• domain (str) – domain query parameter. Audit Log notification’s event domain. .

• sub_domain (str) – subDomain query parameter. Audit Log notification’s event sub-domain. .

• source (str) – source query parameter. Audit Log notification’s event source. .

• user_id (str) – userId query parameter. Audit Log notification’s event userId. .

• context (str) – context query parameter. Audit Log notification’s event correlationId. .

• event_hierarchy (str) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

• site_id (str) – siteId query parameter. Audit Log notification’s siteId. .

• device_id (str) – deviceId query parameter. Audit Log notification’s deviceId. .

• is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

• description (str) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

• offset (int,str) – offset query parameter. Position of a particular Audit Log record in the data. .

• limit (int,str) – limit query parameter. Number of Audit Log records to be returned per page. .

• start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

• end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

• sort_by (str) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

• order (str) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-auditlog-records

get_status_api_for_events(execution_id, headers=None, **request_parameters)

Get the Status of events API calls with provided executionId as mandatory path parameter .

Parameters:

• execution_id (str) – executionId path parameter. Execution ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-status-api-for-events

update_email_destination(emailConfigId=None, fromEmail=None, primarySMTPConfig=None, secondarySMTPConfig=None, subject=None, toEmail=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update Email Destination .

Parameters:

• emailConfigId (string) – Event Management’s Required only for update email configuration .

• fromEmail (string) – Event Management’s From Email.

• primarySMTPConfig (object) – Event Management’s primarySMTPConfig.

• secondarySMTPConfig (object) – Event Management’s secondarySMTPConfig.

• subject (string) – Event Management’s Subject.

• toEmail (string) – Event Management’s To Email.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-email-destination

get_email_destination(headers=None, **request_parameters)

Get Email Destination .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-email-destination

create_email_destination(emailConfigId=None, fromEmail=None, primarySMTPConfig=None, secondarySMTPConfig=None, subject=None, toEmail=None, headers=None, payload=None, active_validation=True, **request_parameters)

Create Email Destination .

Parameters:

• emailConfigId (string) – Event Management’s Required only for update email configuration .

• fromEmail (string) – Event Management’s From Email.

• primarySMTPConfig (object) – Event Management’s primarySMTPConfig.

• secondarySMTPConfig (object) – Event Management’s secondarySMTPConfig.

• subject (string) – Event Management’s Subject.

• toEmail (string) – Event Management’s To Email.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-email-destination

get_notifications(category=None, domain=None, end_time=None, event_ids=None, limit=None, namespace=None, offset=None, order=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, tags=None, type=None, headers=None, **request_parameters)

Get the list of Published Notifications .

Parameters:

• event_ids (str) – eventIds query parameter. The registered EventId should be provided .

• start_time (int) – startTime query parameter. Start Time in milliseconds .

• end_time (int) – endTime query parameter. End Time in milliseconds .

• category (str) – category query parameter.

• type (str) – type query parameter.

• severity (str) – severity query parameter.

• domain (str) – domain query parameter.

• sub_domain (str) – subDomain query parameter. Sub Domain .

• source (str) – source query parameter.

• offset (int,str) – offset query parameter. Start Offset .

• limit (int,str) – limit query parameter. # of records .

• sort_by (str) – sortBy query parameter. Sort By column .

• order (str) – order query parameter. Ascending/Descending order [asc/desc] .

• tags (str) – tags query parameter.

• namespace (str) – namespace query parameter.

• site_id (str) – siteId query parameter. Site Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-notifications

count_of_notifications(category=None, domain=None, end_time=None, event_ids=None, severity=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)

Get the Count of Published Notifications .

Parameters:

• event_ids (str) – eventIds query parameter. The registered EventId should be provided .

• start_time (int) – startTime query parameter. Start Time in milliseconds .

• end_time (int) – endTime query parameter. End Time in milliseconds .

• category (str) – category query parameter.

• type (str) – type query parameter.

• severity (str) – severity query parameter.

• domain (str) – domain query parameter.

• sub_domain (str) – subDomain query parameter. Sub Domain .

• source (str) – source query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!count-of-notifications

get_snmp_destination(config_id=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Get SNMP Destination .

Parameters:

• config_id (str) – configId query parameter. List of SNMP configurations .

• offset (int,str) – offset query parameter. The number of SNMP configuration’s to offset in the resultset whose default value 0 .

• limit (int,str) – limit query parameter. The number of SNMP configuration’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-snmp-destination

get_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Gets the list of Subscriptions’s based on provided offset and limit (Deprecated) .

Parameters:

• event_ids (str) – eventIds query parameter. List of subscriptions related to the respective eventIds .

• offset (int,str) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

• limit (int,str) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-event-subscriptions

delete_event_subscriptions(subscriptions, headers=None, **request_parameters)

Delete EventSubscriptions .

Parameters:

• subscriptions (str) – subscriptions query parameter. List of EventSubscriptionId’s for removal .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-event-subscriptions

update_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)

Update SubscriptionEndpoint to list of registered events(Deprecated) .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-event-subscriptions

create_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)

Subscribe SubscriptionEndpoint to list of registered events (Deprecated) .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-event-subscriptions

get_email_subscription_details(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Gets the list of subscription details for specified connectorType .

Parameters:

• name (str) – name query parameter. Name of the specific configuration .

• instance_id (str) – instanceId query parameter. Instance Id of the specific configuration .

• offset (int,str) – offset query parameter. The number of Email Subscription detail’s to offset in the resultset whose default value 0 .

• limit (int,str) – limit query parameter. The number of Email Subscription detail’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-email-subscription-details

get_rest_webhook_subscription_details(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Gets the list of subscription details for specified connectorType .

Parameters:

• name (str) – name query parameter. Name of the specific configuration .

• instance_id (str) – instanceId query parameter. Instance Id of the specific configuration .

• offset (int,str) – offset query parameter. The number of Rest/Webhook Subscription detail’s to offset in the resultset whose default value 0 .

• limit (int,str) – limit query parameter. The number of Rest/Webhook Subscription detail’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-rest-webhook-subscription-details

get_syslog_subscription_details(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Gets the list of subscription details for specified connectorType .

Parameters:

• name (str) – name query parameter. Name of the specific configuration .

• instance_id (str) – instanceId query parameter. Instance Id of the specific configuration .

• offset (int,str) – offset query parameter. The number of Syslog Subscription detail’s to offset in the resultset whose default value 0 .

• limit (int,str) – limit query parameter. The number of Syslog Subscription detail’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-syslog-subscription-details

count_of_event_subscriptions(event_ids, headers=None, **request_parameters)

Returns the Count of EventSubscriptions .

Parameters:

• event_ids (str) – eventIds query parameter. List of subscriptions related to the respective eventIds .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!count-of-event-subscriptions

create_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)

Create Email Subscription Endpoint for list of registered events. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-email-event-subscription

update_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)

Update Email Subscription Endpoint for list of registered events .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-email-event-subscription

get_email_event_subscriptions(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)

Gets the list of email Subscriptions’s based on provided query params .

Parameters:

• event_ids (str) – eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids) .

• offset (int,str) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

• limit (int,str) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• domain (str) – domain query parameter. List of email subscriptions related to the respective domain .

• sub_domain (str) – subDomain query parameter. List of email subscriptions related to the respective sub-domain .

• category (str) – category query parameter. List of email subscriptions related to the respective category .

• type (str) – type query parameter. List of email subscriptions related to the respective type .

• name (str) – name query parameter. List of email subscriptions related to the respective name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-email-event-subscriptions

create_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)

Create Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-rest-webhook-event-subscription

get_rest_webhook_event_subscriptions(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)

Gets the list of Rest/Webhook Subscriptions’s based on provided query params .

Parameters:

• event_ids (str) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

• offset (int,str) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

• limit (int,str) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• domain (str) – domain query parameter. List of subscriptions related to the respective domain .

• sub_domain (str) – subDomain query parameter. List of subscriptions related to the respective sub- domain .

• category (str) – category query parameter. List of subscriptions related to the respective category .

• type (str) – type query parameter. List of subscriptions related to the respective type .

• name (str) – name query parameter. List of subscriptions related to the respective name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-rest-webhook-event-subscriptions

update_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)

Update Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-rest-webhook-event-subscription

update_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)

Update Syslog Subscription Endpoint for list of registered events .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-syslog-event-subscription

create_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)

Create Syslog Subscription Endpoint for list of registered events .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-syslog-event-subscription

get_syslog_event_subscriptions(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)

Gets the list of Syslog Subscriptions’s based on provided offset and limit .

Parameters:

• event_ids (str) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

• offset (int,str) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

• limit (int,str) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• domain (str) – domain query parameter. List of subscriptions related to the respective domain .

• sub_domain (str) – subDomain query parameter. List of subscriptions related to the respective sub- domain .

• category (str) – category query parameter. List of subscriptions related to the respective category .

• type (str) – type query parameter. List of subscriptions related to the respective type .

• name (str) – name query parameter. List of subscriptions related to the respective name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-syslog-event-subscriptions

update_syslog_destination(configId=None, description=None, host=None, name=None, port=None, protocol=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update Syslog Destination .

Parameters:

• configId (string) – Event Management’s Required only for update syslog configuration .

• description (string) – Event Management’s Description.

• host (string) – Event Management’s Host.

• name (string) – Event Management’s Name.

• port (string) – Event Management’s Port.

• protocol (string) – Event Management’s Protocol. Available values are ‘UDP’ and ‘TCP’.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-syslog-destination

get_syslog_destination(config_id=None, limit=None, name=None, offset=None, order=None, protocol=None, sort_by=None, headers=None, **request_parameters)

Get Syslog Destination .

Parameters:

• config_id (str) – configId query parameter. Config id of syslog server .

• name (str) – name query parameter. Name of syslog server .

• protocol (str) – protocol query parameter. Protocol of syslog server .

• offset (int,str) – offset query parameter. The number of syslog configuration’s to offset in the resultset whose default value 0 .

• limit (int,str) – limit query parameter. The number of syslog configuration’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-syslog-destination

create_syslog_destination(configId=None, description=None, host=None, name=None, port=None, protocol=None, headers=None, payload=None, active_validation=True, **request_parameters)

Create Syslog Destination .

Parameters:

• configId (string) – Event Management’s Required only for update syslog configuration .

• description (string) – Event Management’s Description.

• host (string) – Event Management’s Host.

• name (string) – Event Management’s Name.

• port (string) – Event Management’s Port.

• protocol (string) – Event Management’s Protocol. Available values are ‘UDP’ and ‘TCP’.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-syslog-destination

create_webhook_destination(description=None, headers=None, method=None, name=None, trustCert=None, url=None, webhookId=None, http_headers=None, payload=None, active_validation=True, **request_parameters)

Create Webhook Destination .

Parameters:

• description (string) – Event Management’s Description.

• headers (list) – Event Management’s headers (list of objects).

• method (string) – Event Management’s Method. Available values are ‘POST’ and ‘PUT’.

• name (string) – Event Management’s Name.

• trustCert (boolean) – Event Management’s Trust Cert.

• url (string) – Event Management’s Url.

• webhookId (string) – Event Management’s Required only for update webhook configuration .

• http_headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-webhook-destination

update_webhook_destination(description=None, headers=None, method=None, name=None, trustCert=None, url=None, webhookId=None, http_headers=None, payload=None, active_validation=True, **request_parameters)

Update Webhook Destination .

Parameters:

• description (string) – Event Management’s Description.

• headers (list) – Event Management’s headers (list of objects).

• method (string) – Event Management’s Method. Available values are ‘POST’ and ‘PUT’.

• name (string) – Event Management’s Name.

• trustCert (boolean) – Event Management’s Trust Cert.

• url (string) – Event Management’s Url.

• webhookId (string) – Event Management’s Required only for update webhook configuration .

• http_headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-webhook-destination

get_webhook_destination(limit=None, offset=None, order=None, sort_by=None, webhook_ids=None, headers=None, **request_parameters)

Get Webhook Destination .

Parameters:

• webhook_ids (str) – webhookIds query parameter. List of webhook configurations .

• offset (int,str) – offset query parameter. The number of webhook configuration’s to offset in the resultset whose default value 0 .

• limit (int,str) – limit query parameter. The number of webhook configuration’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-webhook-destination

get_events(tags, event_id=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Gets the list of registered Events with provided eventIds or tags as mandatory .

Parameters:

• event_id (str) – eventId query parameter. The registered EventId should be provided .

• tags (str) – tags query parameter. The registered Tags should be provided .

• offset (int,str) – offset query parameter. The number of Registries to offset in the resultset whose default value 0 .

• limit (int,str) – limit query parameter. The number of Registries to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-events

count_of_events(tags, event_id=None, headers=None, **request_parameters)

Get the count of registered events with provided eventIds or tags as mandatory .

Parameters:

• event_id (str) – eventId query parameter. The registered EventId should be provided .

• tags (str) – tags query parameter. The registered Tags should be provided .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!count-of-events

get_eventartifacts(event_ids=None, limit=None, offset=None, order=None, search=None, sort_by=None, tags=None, headers=None, **request_parameters)

Gets the list of artifacts based on provided offset and limit .

Parameters:

• event_ids (str) – eventIds query parameter. List of eventIds .

• tags (str) – tags query parameter. Tags defined .

• offset (int,str) – offset query parameter. Record start offset .

• limit (int,str) – limit query parameter. # of records to return in result set .

• sort_by (str) – sortBy query parameter. Sort by field .

• order (str) – order query parameter. sorting order (asc/desc) .

• search (str) – search query parameter. findd matches in name, description, eventId, type, category .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-eventartifacts

eventartifact_count(headers=None, **request_parameters)

Get the count of registered event artifacts with provided eventIds or tags as mandatory .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!eventartifact-count

get_connector_types(headers=None, **request_parameters)

Get the list of connector types .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-connector-types

fabric_wireless

class FabricWireless

Cisco DNA Center Fabric Wireless API (version: 2.3.5.3).

Wraps the DNA Center Fabric Wireless API and exposes the API as native Python methods that return native Python objects.

add_ssid_to_ip_pool_mapping(scalableGroupName=None, siteNameHierarchy=None, ssidNames=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add SSID to IP Pool Mapping. .

Parameters:

• scalableGroupName (string) – Fabric Wireless’s Scalable Group Name .

• siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

• ssidNames (list) – Fabric Wireless’s List of SSIDs (list of strings).

• vlanName (string) – Fabric Wireless’s VLAN Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-ssid-to-ip-pool-mapping

update_ssid_to_ip_pool_mapping(scalableGroupName=None, siteNameHierarchy=None, ssidNames=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update SSID to IP Pool Mapping. .

Parameters:

• scalableGroupName (string) – Fabric Wireless’s Scalable Group Name .

• siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

• ssidNames (list) – Fabric Wireless’s List of SSIDs (list of strings).

• vlanName (string) – Fabric Wireless’s VLAN Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-ssid-to-ip-pool-mapping

get_ssid_to_ip_pool_mapping(site_name_hierarchy, vlan_name, headers=None, **request_parameters)

Get SSID to IP Pool Mapping .

Parameters:

• vlan_name (str) – vlanName query parameter. VLAN Name .

• site_name_hierarchy (str) – siteNameHierarchy query parameter. Site Name Heirarchy .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-ssid-to-ip-pool-mapping

remove_w_l_c_from_fabric_domain(device_ipaddress, headers=None, **request_parameters)

Remove WLC from Fabric Domain .

Parameters:

• device_ipaddress (str) – deviceIPAddress query parameter. Device Management IP Address .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!remove-w-l-c-from-fabric-domain

add_w_l_c_to_fabric_domain(deviceName=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add WLC to Fabric Domain .

Parameters:

• deviceName (string) – Fabric Wireless’s EWLC Device Name .

• siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-w-l-c-to-fabric-domain

file

class File

Cisco DNA Center File API (version: 2.3.5.3).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)

Returns list of available namespaces .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-list-of-available-namespaces

get_list_of_files(name_space, headers=None, **request_parameters)

Returns list of files under a specific namespace .

Parameters:

• name_space (str) – nameSpace path parameter. A listing of fileId’s .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-list-of-files

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)

Downloads a file specified by fileId .

Parameters:

• file_id (str) – fileId path parameter. File Identification number .

• dirpath (str) – Directory absolute path. Defaults to os.getcwd().

• save_file (bool) – Enable or disable automatic file creation of raw response.

• filename (str) – The filename used to save the download file.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

• DownloadFailure – If was not able to download the raw

• response to a file. –

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!download-a-file-by-fileid

upload_file(multipart_fields, multipart_monitor_callback, name_space, headers=None, **request_parameters)

Uploads a new file within a specific nameSpace .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback

Parameters:

• name_space (str) – nameSpace path parameter.

• multipart_fields (dict) – Fields from which to create a multipart/form-data body.

• multipart_monitor_callback (function) – function used to monitor the progress of the upload.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!upload-file

health_and_performance

class HealthAndPerformance

Cisco DNA Center Health and Performance API (version: 2.3.5.3).

Wraps the DNA Center Health and Performance API and exposes the API as native Python methods that return native Python objects.

system_health(domain=None, limit=None, offset=None, subdomain=None, summary=None, headers=None, **request_parameters)

This API retrieves the latest system events .

Parameters:

• summary (bool) – summary query parameter. Fetch the latest high severity event .

• domain (str) – domain query parameter. Fetch system events with this domain. Possible values of domain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events .

• subdomain (str) – subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events .

• limit (int,str) – limit query parameter.

• offset (int,str) – offset query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!system-health

system_health_count(domain=None, subdomain=None, headers=None, **request_parameters)

This API gives the count of the latest system events .

Parameters:

• domain (str) – domain query parameter. Fetch system events with this domain. Possible values of domain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events .

• subdomain (str) – subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!system-health-count

system_performance(end_time=None, function=None, kpi=None, start_time=None, headers=None, **request_parameters)

This API gives the aggregated performance indicators. The data can be retrieved for the last 3 months. .

Parameters:

• kpi (str) – kpi query parameter. Valid values: cpu,memory,network .

• function (str) – function query parameter. Valid values: sum,average,max .

• start_time (int) – startTime query parameter. This is the epoch start time in milliseconds from which performance indicator need to be fetched .

• end_time (int) – endTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!system-performance

system_performance_historical(end_time=None, kpi=None, start_time=None, headers=None, **request_parameters)

This API retrieves the historical performance indicators . The data can be retrieved for the last 3 months. .

Parameters:

• kpi (str) – kpi query parameter. Fetch historical data for this kpi. Valid values: cpu,memory,network .

• start_time (int) – startTime query parameter. This is the epoch start time in milliseconds from which performance indicator need to be fetched .

• end_time (int) – endTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!system-performance-historical

itsm

class Itsm

Cisco DNA Center ITSM API (version: 2.3.5.3).

Wraps the DNA Center ITSM API and exposes the API as native Python methods that return native Python objects.

get_cmdb_sync_status(date=None, status=None, headers=None, **request_parameters)

This API allows to retrieve the detail of CMDB sync status.It accepts two query parameter “status”,”date”.The supported values for status field are “Success”,”Failed”,”Unknown” and date field should be in “YYYY-MM- DD” format. By default all the cmdb sync status will be send as response and based on the query parameter filtered detail will be send as response. .

Parameters:

• status (str) – status query parameter. Supported values are “Success”,”Failed” and “Unknown”. Providing other values will result in all the available sync job status. .

• date (str) – date query parameter. Provide date in “YYYY-MM-DD” format .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-cmdb-sync-status

get_failed_itsm_events(instance_id=None, headers=None, **request_parameters)

Used to retrieve the list of integration events that failed to create tickets in ITSM .

Parameters:

• instance_id (str) – instanceId query parameter. Instance Id of the failed event as in the Runtime Dashboard .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-failed-itsm-events

retry_integration_events(headers=None, payload=None, active_validation=True, **request_parameters)

Allows retry of multiple failed ITSM event instances. The retry request payload can be given as a list of strings: [“instance1”,”instance2”,”instance3”,..] A minimum of one instance Id is mandatory. The list of failed event instance Ids can be retrieved using the ‘Get Failed ITSM Events’ API in the ‘instanceId’ attribute. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retry-integration-events

itsm_integration

class ItsmIntegration

Cisco DNA Center ITSM Integration API (version: 2.3.5.3).

Wraps the DNA Center ITSM Integration API and exposes the API as native Python methods that return native Python objects.

create_itsm_integration_setting(data=None, description=None, dypName=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)

Creates ITSM Integration setting .

Parameters:

• data (object) – ITSM Integration’s data.

• description (string) – ITSM Integration’s Description of the setting instance .

• dypName (string) – ITSM Integration’s It should be ServiceNowConnection .

• name (string) – ITSM Integration’s Name of the setting instance .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-itsm-integration-setting

update_itsm_integration_setting(instance_id, data=None, description=None, dypName=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates the ITSM Integration setting .

Parameters:

• data (object) – ITSM Integration’s data.

• description (string) – ITSM Integration’s Description of the setting instance .

• dypName (string) – ITSM Integration’s It should be ServiceNowConnection .

• name (string) – ITSM Integration’s Name of the setting instance .

• instance_id (str) – instanceId path parameter. Instance Id of the Integration setting instance .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-itsm-integration-setting

get_itsm_integration_setting_by_id(instance_id, headers=None, **request_parameters)

Fetches ITSM Integration setting by ID .

Parameters:

• instance_id (str) – instanceId path parameter. Instance Id of the Integration setting instance .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-itsm-integration-setting-by-id

delete_itsm_integration_setting(instance_id, headers=None, **request_parameters)

Deletes the ITSM Integration setting .

Parameters:

• instance_id (str) – instanceId path parameter. Instance Id of the Integration setting instance .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-itsm-integration-setting

get_all_itsm_integration_settings(headers=None, **request_parameters)

Fetches all ITSM Integration settings .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-itsm-integration-settings

issues

class Issues

Cisco DNA Center Issues API (version: 2.3.5.3).

Wraps the DNA Center Issues API and exposes the API as native Python methods that return native Python objects.

execute_suggested_actions_commands(entity_type=None, entity_value=None, headers=None, payload=None, active_validation=True, **request_parameters)

This API triggers the execution of the suggested actions for an issue, given the Issue Id. It will return an execution Id. At the completion of the execution, the output of the commands associated with the suggested actions will be provided Invoking this API would provide the execution id. Execute the ‘Get Business API Execution Details’ API with this execution id, to receive the suggested actions commands output. .

Parameters:

• entity_type (string) – Issues’s Commands provided as part of the suggested actions for an issue can be executed based on issue id. The value here must be issue_id .

• entity_value (string) – Issues’s Contains the actual value for the entity type that has been defined .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!execute-suggested-actions-commands

get_issue_enrichment_details(headers=None, **request_parameters)

Enriches a given network issue context (an issue id or end user’s Mac Address) with details about the issue(s), impacted hosts and suggested actions for remediation .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

issues(ai_driven=None, device_id=None, end_time=None, issue_status=None, mac_address=None, priority=None, site_id=None, start_time=None, headers=None, **request_parameters)

Intent API to get a list of global issues, issues for a specific device, or issue for a specific client device’s MAC address. .

Parameters:

• start_time (int) – startTime query parameter. Starting epoch time in milliseconds of query time window .

• end_time (int) – endTime query parameter. Ending epoch time in milliseconds of query time window .

• site_id (str) – siteId query parameter. Assurance UUID value of the site in the issue content .

• device_id (str) – deviceId query parameter. Assurance UUID value of the device in the issue content .

• mac_address (str) – macAddress query parameter. Client’s device MAC address of the issue (format xx:xx:xx:xx:xx:xx) .

• priority (str) – priority query parameter. The issue’s priority value (One of P1, P2, P3, or P4)(Use only when macAddress and deviceId are not provided) .

• ai_driven (str) – aiDriven query parameter. The issue’s AI driven value (Yes or No)(Use only when macAddress and deviceId are not provided) .

• issue_status (str) – issueStatus query parameter. The issue’s status value (One of ACTIVE, IGNORED, RESOLVED) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!issues

lan_automation

class LanAutomation

Cisco DNA Center LAN Automation API (version: 2.3.5.3).

Wraps the DNA Center LAN Automation API and exposes the API as native Python methods that return native Python objects.

lan_automation_start(headers=None, payload=None, active_validation=True, **request_parameters)

Invoke this API to start LAN Automation for the given site. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-start

start(headers=None, payload=None, active_validation=True, **query_parameters)

Alias for lan_automation_start

lan_automation_session_count(headers=None, **request_parameters)

Invoke this API to get the total count of LAN Automation sessions. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-session-count

session_count(headers=None, **query_parameters)

Alias for lan_automation_session_count

lan_automation_log(limit=None, offset=None, headers=None, **request_parameters)

Invoke this API to get the LAN Automation session logs. .

Parameters:

• offset (int,str) – offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. .

• limit (int,str) – limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-log

log(limit=None, offset=None, headers=None, **query_parameters)

Alias for lan_automation_log

lan_automation_log_by_id(id, headers=None, **request_parameters)

Invoke this API to get the LAN Automation session logs based on the given LAN Automation session id. .

Parameters:

• id (str) – id path parameter. LAN Automation session identifier. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-log-by-id

log_by_id(id, headers=None, **query_parameters)

Alias for lan_automation_log_by_id

lan_automation_logs_for_individual_devices(id, serial_number, log_level=None, headers=None, **request_parameters)

Invoke this API to get the LAN Automation session logs for individual devices based on the given LAN Automation session id and device serial number. .

Parameters:

• id (str) – id path parameter. LAN Automation session identifier. .

• serial_number (str) – serialNumber path parameter. Device serial number. .

• log_level (str) – logLevel query parameter. Supported levels are ERROR, INFO, WARNING, TRACE, CONFIG and ALL. Specifying ALL will display device specific logs with the exception of CONFIG logs. In order to view CONFIG logs along with the remaining logs, please leave the query parameter blank. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-logs-for-individual-devices

lan_automation_active_sessions(headers=None, **request_parameters)

Invoke this API to get the LAN Automation active session information .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-active-sessions

lan_automation_status(limit=None, offset=None, headers=None, **request_parameters)

Invoke this API to get the LAN Automation session status. .

Parameters:

• offset (int,str) – offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. .

• limit (int,str) – limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-status

status(limit=None, offset=None, headers=None, **query_parameters)

Alias for lan_automation_status

lan_automation_status_by_id(id, headers=None, **request_parameters)

Invoke this API to get the LAN Automation session status based on the given Lan Automation session id. .

Parameters:

• id (str) – id path parameter. LAN Automation session identifier. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-status-by-id

status_by_id(id, headers=None, **query_parameters)

Alias for lan_automation_status_by_id

lan_automation_stop(id, headers=None, **request_parameters)

Invoke this API to stop LAN Automation for the given site. .

Parameters:

• id (str) – id path parameter. LAN Automation id can be obtained from /dna/intent/api/v1/lan- automation/status. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-stop

stop(id, headers=None, **query_parameters)

Alias for lan_automation_stop

licenses

class Licenses

Cisco DNA Center Licenses API (version: 2.3.5.3).

Wraps the DNA Center Licenses API and exposes the API as native Python methods that return native Python objects.

device_count_details2(device_type=None, dna_level=None, registration_status=None, smart_account_id=None, virtual_account_name=None, headers=None, **request_parameters)

Get total number of managed device(s). .

Parameters:

• device_type (str) – device_type query parameter. Type of device .

• registration_status (str) – registration_status query parameter. Smart license registration status of device .

• dna_level (str) – dna_level query parameter. Device Cisco DNA License Level .

• virtual_account_name (str) – virtual_account_name query parameter. Virtual account name .

• smart_account_id (str) – smart_account_id query parameter. Smart account id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!device-count-details

device_count_details(device_type=None, dna_level=None, registration_status=None, smart_account_id=None, virtual_account_name=None, headers=None, **request_parameters)

device_license_summary2(limit, order, page_number, device_type=None, device_uuid=None, dna_level=None, registration_status=None, smart_account_id=None, sort_by=None, virtual_account_name=None, headers=None, **request_parameters)

Show license summary of device(s). .

Parameters:

• page_number (int) – page_number query parameter. Page number of response .

• order (str) – order query parameter. Sorting order .

• sort_by (str) – sort_by query parameter. Sort result by field .

• dna_level (str) – dna_level query parameter. Device Cisco DNA license level .

• device_type (str) – device_type query parameter. Type of device .

• limit (int,str) – limit query parameter.

• registration_status (str) – registration_status query parameter. Smart license registration status of device .

• virtual_account_name (str) – virtual_account_name query parameter. Name of virtual account .

• smart_account_id (int) – smart_account_id query parameter. Id of smart account .

• device_uuid (str) – device_uuid query parameter. Id of device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!device-license-summary2

device_license_summary(limit, order, page_number, device_type=None, device_uuid=None, dna_level=None, registration_status=None, smart_account_id=None, sort_by=None, virtual_account_name=None, headers=None, **request_parameters)

device_license_details2(device_uuid, headers=None, **request_parameters)

Get detailed license information of a device. .

Parameters:

• device_uuid (str) – device_uuid path parameter. Id of device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!device-license-details2

device_license_details(device_uuid, headers=None, **request_parameters)

device_deregistration2(device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)

Deregister device(s) from CSSM(Cisco Smart Software Manager). .

Parameters:

• device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!device-deregistration2

device_registration2(virtual_account_name, device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)

Register device(s) in CSSM(Cisco Smart Software Manager). .

Parameters:

• device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

• virtual_account_name (str) – virtual_account_name path parameter. Name of virtual account .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!device-registration2

change_virtual_account2(smart_account_id, virtual_account_name, device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)

Transfer device(s) from one virtual account to another within same smart account. .

Parameters:

• device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

• smart_account_id (str) – smart_account_id path parameter. Id of smart account .

• virtual_account_name (str) – virtual_account_name path parameter. Name of target virtual account .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!change-virtual-account2

virtual_account_details2(smart_account_id, headers=None, **request_parameters)

Get virtual account details of a smart account. .

Parameters:

• smart_account_id (str) – smart_account_id path parameter. Id of smart account .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!virtual-account-details2

smart_account_details(headers=None, **request_parameters)

Get detail of all smart accounts. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!smart-account-details

license_term_details2(device_type, smart_account_id, virtual_account_name, headers=None, **request_parameters)

Get license term details. .

Parameters:

• smart_account_id (str) – smart_account_id path parameter. Id of smart account .

• virtual_account_name (str) – virtual_account_name path parameter. Name of virtual account. Putting “All” will give license term detail for all virtual accounts. .

• device_type (str) – device_type query parameter. Type of device like router, switch, wireless or ise .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!license-term-details2

license_usage_details2(device_type, smart_account_id, virtual_account_name, headers=None, **request_parameters)

Get count of purchased and in use Cisco DNA and Network licenses. .

Parameters:

• smart_account_id (str) – smart_account_id path parameter. Id of smart account .

• virtual_account_name (str) – virtual_account_name path parameter. Name of virtual account. Putting “All” will give license term detail for all virtual accounts. .

• device_type (str) – device_type query parameter. Type of device like router, switch, wireless or ise .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!license-usage-details2

network_settings

class NetworkSettings

Cisco DNA Center Network Settings API (version: 2.3.5.3).

Wraps the DNA Center Network Settings API and exposes the API as native Python methods that return native Python objects.

assign_device_credential_to_site(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)

Assign Device Credential to a site. .

Parameters:

• cliId (string) – Network Settings’s Cli Id.

• httpRead (string) – Network Settings’s Http Read.

• httpWrite (string) – Network Settings’s Http Write.

• snmpV2ReadId (string) – Network Settings’s Snmp V2 Read Id.

• snmpV2WriteId (string) – Network Settings’s Snmp V2 Write Id.

• snmpV3Id (string) – Network Settings’s Snmp V3 Id.

• site_id (str) – siteId path parameter. site id to assign credential. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!assign-device-credential-to-site

assign_credential_to_site(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)

create_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create device credentials. .

Parameters:

• settings (object) – Network Settings’s settings.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-device-credentials

update_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update device credentials. .

Parameters:

• settings (object) – Network Settings’s settings.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-device-credentials

get_device_credential_details(site_id=None, headers=None, **request_parameters)

API to get device credential details. .

Parameters:

• site_id (str) – siteId query parameter. Site id to retrieve the credential details associated with the site. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-credential-details

delete_device_credential(id, headers=None, **request_parameters)

Delete device credential. .

Parameters:

• id (str) – id path parameter. global credential id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-device-credential

get_global_pool(limit=None, offset=None, headers=None, **request_parameters)

API to get global pool. .

Parameters:

• offset (int,str) – offset query parameter. offset/starting row .

• limit (int,str) – limit query parameter. No of Global Pools to be retrieved .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-global-pool

update_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update global pool .

Parameters:

• settings (object) – Network Settings’s settings.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-global-pool

create_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create global pool. .

Parameters:

• settings (object) – Network Settings’s settings.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-global-pool

delete_global_ip_pool(id, headers=None, **request_parameters)

API to delete global IP pool. .

Parameters:

• id (str) – id path parameter. global pool id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-global-ip-pool

get_network(site_id=None, headers=None, **request_parameters)

API to get DHCP and DNS center server details. .

Parameters:

• site_id (str) – siteId query parameter. Site id to get the network settings associated with the site. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network

create_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create a network for DHCP, Syslog, SNMP, NTP, Network AAA, Client and EndPoint AAA, and/or DNS center server settings. .

Parameters:

• settings (object) – Network Settings’s settings.

• site_id (str) – siteId path parameter. Site id to which site details to associate with the network settings. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-network

update_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update network settings for DHCP, Syslog, SNMP, NTP, Network AAA, Client and EndPoint AAA, and/or DNS server settings. .

Parameters:

• settings (object) – Network Settings’s settings.

• site_id (str) – siteId path parameter. Site id to update the network settings which is associated with the site .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-network

get_reserve_ip_subpool(limit=None, offset=None, site_id=None, headers=None, **request_parameters)

API to get the ip subpool info. .

Parameters:

• site_id (str) – siteId query parameter. site id to get the reserve ip associated with the site .

• offset (int,str) – offset query parameter. offset/starting row .

• limit (int,str) – limit query parameter. No of Global Pools to be retrieved .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-reserve-ip-subpool

release_reserve_ip_subpool(id, headers=None, **request_parameters)

API to delete the reserved ip subpool .

Parameters:

• id (str) – id path parameter. Id of reserve ip subpool to be deleted. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!release-reserve-ip-subpool

reserve_ip_subpool(site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv4GateWay=None, ipv4GlobalPool=None, ipv4Prefix=None, ipv4PrefixLength=None, ipv4Subnet=None, ipv4TotalHost=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to reserve an ip subpool from the global pool .

Parameters:

• ipv4DhcpServers (list) – Network Settings’s IPv4 input for dhcp server ip example: 1.1.1.1 (list of strings).

• ipv4DnsServers (list) – Network Settings’s IPv4 input for dns server ip example: 4.4.4.4 (list of strings).

• ipv4GateWay (string) – Network Settings’s Gateway ip address details, example: 175.175.0.1 .

• ipv4GlobalPool (string) – Network Settings’s IP v4 Global pool address with cidr, example: 175.175.0.0/16 .

• ipv4Prefix (boolean) – Network Settings’s IPv4 prefix value is true, the ip4 prefix length input field is enabled , if it is false ipv4 total Host input is enable .

• ipv4PrefixLength (integer) – Network Settings’s The ipv4 prefix length is required when ipv4prefix value is true. .

• ipv4Subnet (string) – Network Settings’s IPv4 Subnet address, example: 175.175.0.0 .

• ipv4TotalHost (integer) – Network Settings’s IPv4 total host is required when ipv4prefix value is false. .

• ipv6AddressSpace (boolean) – Network Settings’s If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required .

• ipv6DhcpServers (list) – Network Settings’s IPv6 format dhcp server as input example : 2001:db8::1234 (list of strings).

• ipv6DnsServers (list) – Network Settings’s IPv6 format dns server input example: 2001:db8::1234 (list of strings).

• ipv6GateWay (string) – Network Settings’s Gateway ip address details, example: 2001:db8:85a3:0:100::1 .

• ipv6GlobalPool (string) – Network Settings’s IPv6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example: 2001:db8:85a3::/64 .

• ipv6Prefix (boolean) – Network Settings’s Ipv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable .

• ipv6PrefixLength (integer) – Network Settings’s IPv6 prefix length is required when the ipv6prefix value is true .

• ipv6Subnet (string) – Network Settings’s IPv6 Subnet address, example :2001:db8:85a3:0:100:: .

• ipv6TotalHost (integer) – Network Settings’s IPv6 total host is required when ipv6prefix value is false. .

• name (string) – Network Settings’s Name of the reserve ip sub pool .

• slaacSupport (boolean) – Network Settings’s Slaac Support.

• type (string) – Network Settings’s Type of the reserve ip sub pool . Available values are ‘Generic’, ‘LAN’, ‘WAN’, ‘management’ and ‘service’.

• site_id (str) – siteId path parameter. Site id to reserve the ip sub pool. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!reserve-ip-subpool

update_reserve_ip_subpool(id, site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv4GateWay=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update ip subpool from the global pool .

Parameters:

• ipv4DhcpServers (list) – Network Settings’s IPv4 input for dhcp server ip example: 1.1.1.1 (list of strings).

• ipv4DnsServers (list) – Network Settings’s IPv4 input for dns server ip example: 4.4.4.4 (list of strings).

• ipv4GateWay (string) – Network Settings’s Ipv4 Gate Way.

• ipv6AddressSpace (boolean) – Network Settings’s If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required .

• ipv6DhcpServers (list) – Network Settings’s IPv6 format dhcp server as input example : 2001:db8::1234 (list of strings).

• ipv6DnsServers (list) – Network Settings’s IPv6 format dns server input example: 2001:db8::1234 (list of strings).

• ipv6GateWay (string) – Network Settings’s Gateway ip address details, example: 2001:db8:85a3:0:100::1 .

• ipv6GlobalPool (string) – Network Settings’s IP v6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example: 2001:db8:85a3::/64 .

• ipv6Prefix (boolean) – Network Settings’s IPv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable .

• ipv6PrefixLength (integer) – Network Settings’s IPv6 prefix length is required when the ipv6prefix value is true .

• ipv6Subnet (string) – Network Settings’s IPv6 Subnet address, example :2001:db8:85a3:0:100:: .

• ipv6TotalHost (integer) – Network Settings’s IPv6 total host is required when ipv6prefix value is false. .

• name (string) – Network Settings’s Name of the reserve ip sub pool .

• slaacSupport (boolean) – Network Settings’s Slaac Support.

• site_id (str) – siteId path parameter. Site id of site to update sub pool. .

• id (str) – id query parameter. Id of subpool to be associated with the site .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-reserve-ip-subpool

get_service_provider_details(headers=None, **request_parameters)

API to get service provider details (QoS). .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-service-provider-details

create_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create Service Provider Profile(QOS). .

Parameters:

• settings (object) – Network Settings’s settings.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-sp-profile

update_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update Service Provider Profile (QoS). .

Parameters:

• settings (object) – Network Settings’s settings.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-sp-profile

delete_sp_profile(sp_profile_name, headers=None, **request_parameters)

API to delete Service Provider Profile (QoS). .

Parameters:

• sp_profile_name (str) – spProfileName path parameter. sp profile name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-sp-profile

assign_device_credential_to_site_v2(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to assign Device Credential to a site. .

Parameters:

• cliId (string) – Network Settings’s CLI Credential Id .

• httpRead (string) – Network Settings’s HTTP(S) Read Credential Id .

• httpWrite (string) – Network Settings’s HTTP(S) Write Credential Id .

• snmpV2ReadId (string) – Network Settings’s SNMPv2c Read Credential Id .

• snmpV2WriteId (string) – Network Settings’s SNMPv2c Write Credential Id .

• snmpV3Id (string) – Network Settings’s SNMPv3 Credential Id .

• site_id (str) – siteId path parameter. Site Id to assign credential. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!assign-device-credential-to-site-v2

get_network_v2(site_id=None, headers=None, **request_parameters)

API to get SNMP, NTP, Network AAA, Client and Endpoint AAA, and/or DNS center server settings. .

Parameters:

• site_id (str) – siteId query parameter. Site Id to get the network settings associated with the site. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network-v2

create_network_v2(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create network settings for DHCP, Syslog, SNMP, NTP, Network AAA, Client and Endpoint AAA, and/or DNS center server settings. .

Parameters:

• settings (object) – Network Settings’s settings.

• site_id (str) – siteId path parameter. Site Id to which site details to associate with the network settings. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-network-v2

update_network_v2(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update network settings for DHCP, Syslog, SNMP, NTP, Network AAA, Client and Endpoint AAA, and/or DNS center server settings. .

Parameters:

• settings (object) – Network Settings’s settings.

• site_id (str) – siteId path parameter. Site Id to update the network settings which is associated with the site .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-network-v2

create_sp_profile_v2(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create Service Provider Profile(QOS). .

Parameters:

• settings (object) – Network Settings’s settings.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-sp-profile-v2

update_sp_profile_v2(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update Service Provider Profile (QoS). .

Parameters:

• settings (object) – Network Settings’s settings.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-sp-profile-v2

get_service_provider_details_v2(headers=None, **request_parameters)

API to get Service Provider details (QoS). .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-service-provider-details-v2

delete_sp_profile_v2(sp_profile_name, headers=None, **request_parameters)

API to delete Service Provider Profile (QoS). .

Parameters:

• sp_profile_name (str) – spProfileName path parameter. sp profile name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-sp-profile-v2

path_trace

class PathTrace

Cisco DNA Center Path Trace API (version: 2.3.5.3).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters. .

Parameters:

• periodic_refresh (bool) – periodicRefresh query parameter. Is analysis periodically refreshed? .

• source_ip (str) – sourceIP query parameter. Source IP address .

• dest_ip (str) – destIP query parameter. Destination IP adress .

• source_port (str) – sourcePort query parameter. Source port .

• dest_port (str) – destPort query parameter. Destination port .

• gt_create_time (str) – gtCreateTime query parameter. Analyses requested after this time .

• lt_create_time (str) – ltCreateTime query parameter. Analyses requested before this time .

• protocol (str) – protocol query parameter.

• status (str) – status query parameter.

• task_id (str) – taskId query parameter. Task ID .

• last_update_time (str) – lastUpdateTime query parameter. Last update time .

• limit (int,str) – limit query parameter. Number of resources returned .

• offset (int,str) – offset query parameter. Start index of resources returned (1-based) .

• order (str) – order query parameter. Order by this field .

• sort_by (str) – sortBy query parameter. Sort by this field .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrives-all-previous-pathtraces-summary

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)

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. .

Parameters:

• controlPath (boolean) – Path Trace’s Control path tracing .

• destIP (string) – Path Trace’s Destination IP address .

• destPort (string) – Path Trace’s Destination Port .

• inclusions (list) – Path Trace’s Subset of {INTERFACE-STATS, QOS-STATS, DEVICE-STATS, PERFORMANCE-STATS, ACL-TRACE} (list of strings).

• periodicRefresh (boolean) – Path Trace’s Periodic refresh of path for every 30 sec .

• protocol (string) – Path Trace’s Protocol .

• sourceIP (string) – Path Trace’s Source IP address .

• sourcePort (string) – Path Trace’s Source Port .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!initiate-a-new-pathtrace

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)

Returns result of a previously requested flow analysis by its Flow Analysis id .

Parameters:

• flow_analysis_id (str) – flowAnalysisId path parameter. Flow analysis request id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieves-previous-pathtrace

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)

Deletes a flow analysis request by its id .

Parameters:

• flow_analysis_id (str) – flowAnalysisId path parameter. Flow analysis request id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deletes-pathtrace-by-id

platform

class Platform

Cisco DNA Center Platform API (version: 2.3.5.3).

Wraps the DNA Center Platform API and exposes the API as native Python methods that return native Python objects.

cisco_dna_center_packages_summary(headers=None, **request_parameters)

Provides information such as name, version of packages installed on the DNA center. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!cisco-dna-center-packages-summary

release_summary(headers=None, **request_parameters)

Provides information such as API version, mandatory core packages for installation or upgrade, optional packages, Cisco DNA Center name and version, supported direct updates, and tenant ID. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!release-summary

nodes_configuration_summary(headers=None, **request_parameters)

Provides details about the current Cisco DNA Center node configuration, such as API version, node name, NTP server, intracluster link, LACP mode, network static routes, DNS server, subnet mask, host IP, default gateway, and interface information. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!nodes-configuration-summary

reports

class Reports

Cisco DNA Center Reports API (version: 2.3.5.3).

Wraps the DNA Center Reports API and exposes the API as native Python methods that return native Python objects.

create_or_schedule_a_report(dataCategory=None, deliveries=None, name=None, schedule=None, tags=None, view=None, viewGroupId=None, viewGroupVersion=None, headers=None, payload=None, active_validation=True, **request_parameters)

Create/Schedule a report configuration. Use “Get view details for a given view group & view” API to get the metadata required to configure a report. .

Parameters:

• dataCategory (string) – Reports’s category of viewgroup for the report.

• deliveries (list) – Reports’s Array of available delivery channels (list of objects).

• name (string) – Reports’s report name .

• schedule (object) – Reports’s schedule.

• tags (list) – Reports’s array of tags for report (list of strings).

• view (object) – Reports’s view.

• viewGroupId (string) – Reports’s viewGroupId of the viewgroup for the report .

• viewGroupVersion (string) – Reports’s version of viewgroup for the report .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-or-schedule-a-report

get_list_of_scheduled_reports(view_group_id=None, view_id=None, headers=None, **request_parameters)

Get list of scheduled report configurations. .

Parameters:

• view_group_id (str) – viewGroupId query parameter. viewGroupId of viewgroup for report .

• view_id (str) – viewId query parameter. viewId of view for report .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-list-of-scheduled-reports

get_a_scheduled_report(report_id, headers=None, **request_parameters)

Get scheduled report configuration by reportId .

Parameters:

• report_id (str) – reportId path parameter. reportId of report .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-a-scheduled-report

delete_a_scheduled_report(report_id, headers=None, **request_parameters)

Delete a scheduled report configuration. Deletes the report executions also. .

Parameters:

• report_id (str) – reportId path parameter. reportId of report .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-a-scheduled-report

get_all_execution_details_for_a_given_report(report_id, headers=None, **request_parameters)

Get details of all executions for a given report .

Parameters:

• report_id (str) – reportId path parameter. reportId of report .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-execution-details-for-a-given-report

download_report_content(execution_id, report_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)

Returns report content. Save the response to a file by converting the response data as a blob and setting the file format available from content-disposition response header. .

Parameters:

• report_id (str) – reportId path parameter. reportId of report .

• execution_id (str) – executionId path parameter. executionId of report execution .

• dirpath (str) – Directory absolute path. Defaults to os.getcwd().

• save_file (bool) – Enable or disable automatic file creation of raw response.

• filename (str) – The filename used to save the download file.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

• DownloadFailure – If was not able to download the raw

• response to a file. –

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!download-report-content

get_all_view_groups(headers=None, **request_parameters)

Gives a list of summary of all view groups. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-view-groups

get_views_for_a_given_view_group(view_group_id, headers=None, **request_parameters)

Gives a list of summary of all views in a viewgroup. Use “Get all view groups” API to get the viewGroupIds (required as a query param for this API) for available viewgroups. .

Parameters:

• view_group_id (str) – viewGroupId path parameter. viewGroupId of viewgroup. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-views-for-a-given-view-group

get_view_details_for_a_given_view_group_and_view(view_group_id, view_id, headers=None, **request_parameters)

Gives complete information of the view that is required to configure a report. Use “Get views for a given view group” API to get the viewIds (required as a query param for this API) for available views. .

Parameters:

• view_group_id (str) – viewGroupId path parameter. viewGroupId of viewgroup .

• view_id (str) – viewId path parameter. view id of view .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-view-details-for-a-given-view-group-and-view

sda

class Sda

Cisco DNA Center SDA API (version: 2.3.5.3).

Wraps the DNA Center SDA API and exposes the API as native Python methods that return native Python objects.

get_default_authentication_profile(site_name_hierarchy, authenticate_template_name=None, headers=None, **request_parameters)

Get default authentication profile from SDA Fabric .

Parameters:

• site_name_hierarchy (str) – siteNameHierarchy query parameter.

• authenticate_template_name (str) – authenticateTemplateName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-default-authentication-profile

add_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)

Add default authentication template in SDA Fabric .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-default-authentication-profile

update_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)

Update default authentication profile in SDA Fabric .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-default-authentication-profile

delete_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)

Delete default authentication profile in SDA Fabric .

Parameters:

• site_name_hierarchy (str) – siteNameHierarchy query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-default-authentication-profile

adds_border_device(headers=None, payload=None, active_validation=True, **request_parameters)

Add border device in SDA Fabric .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!adds-border-device

gets_border_device_detail(device_management_ip_address, headers=None, **request_parameters)

Get border device detail from SDA Fabric .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-border-device-detail

deletes_border_device(device_management_ip_address, headers=None, **request_parameters)

Delete border device from SDA Fabric .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deletes-border-device

delete_control_plane_device(device_management_ip_address, headers=None, **request_parameters)

Delete control plane device in SDA Fabric .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-control-plane-device

get_control_plane_device(device_management_ip_address, headers=None, **request_parameters)

Get control plane device from SDA Fabric .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-control-plane-device

add_control_plane_device(deviceManagementIpAddress=None, routeDistributionProtocol=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add control plane device in SDA Fabric .

Parameters:

• deviceManagementIpAddress (string) – SDA’s Management Ip Address of the Device which is provisioned successfully .

• routeDistributionProtocol (string) – SDA’s Route Distribution Protocol for Control Plane Device. Allowed values are “LISP_BGP” or “LISP_PUB_SUB”. Default value is “LISP_BGP” .

• siteNameHierarchy (string) – SDA’s siteNameHierarchy of the Provisioned Device(site should be part of Fabric Site) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-control-plane-device

get_device_info(device_management_ip_address, headers=None, **request_parameters)

Get device info from SDA Fabric .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_device_role_in_sda_fabric(device_management_ip_address, headers=None, **request_parameters)

Get device role in SDA Fabric .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter. Device Management IP Address .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-role-in-sda-fabric

add_edge_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add edge device in SDA Fabric .

Parameters:

• deviceManagementIpAddress (string) – SDA’s Management Ip Address of the Device which is provisioned successfully .

• siteNameHierarchy (string) – SDA’s siteNameHierarchy of the Provisioned Device(site should be part of Fabric Site) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-edge-device

delete_edge_device(device_management_ip_address, headers=None, **request_parameters)

Delete edge device from SDA Fabric. .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-edge-device

get_edge_device(device_management_ip_address, headers=None, **request_parameters)

Get edge device from SDA Fabric .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-edge-device

get_site(site_name_hierarchy, headers=None, **request_parameters)

Get Site info from SDA Fabric .

Parameters:

• site_name_hierarchy (str) – siteNameHierarchy query parameter. Site Name Hierarchy .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-site

delete_site(site_name_hierarchy, headers=None, **request_parameters)

Delete Site from SDA Fabric .

Parameters:

• site_name_hierarchy (str) – siteNameHierarchy query parameter. Site Name Hierarchy .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-site

add_site(fabricName=None, fabricType=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add Site in SDA Fabric .

Parameters:

• fabricName (string) – SDA’s Warning Starting DNA Center 2.2.3.5 release, this field has been deprecated. SD-Access Fabric does not need it anymore. It will be removed in future DNA Center releases. .

• fabricType (string) – SDA’s Type of SD-Access Fabric. Allowed values are “FABRIC_SITE” or “FABRIC_ZONE”. Default value is “FABRIC_SITE”. .

• siteNameHierarchy (string) – SDA’s Existing site name hierarchy available at global level. For Example “Global/Chicago/Building21/Floor1” .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-site

add_port_assignment_for_access_point(authenticateTemplateName=None, dataIpAddressPoolName=None, deviceManagementIpAddress=None, interfaceDescription=None, interfaceName=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add Port assignment for access point in SDA Fabric .

Parameters:

• authenticateTemplateName (string) – SDA’s Authenticate TemplateName associated to Fabric Site . Available values are ‘No Authentication’, ‘Open Authentication’, ‘Closed Authentication ‘ and ‘Low Impact ‘.

• dataIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to INFRA_VN .

• deviceManagementIpAddress (string) – SDA’s Management Ip Address of the edge device .

• interfaceDescription (string) – SDA’s Details or note of interface port assignment .

• interfaceName (string) – SDA’s Interface Name of the edge device .

• siteNameHierarchy (string) – SDA’s Path of sda Fabric Site .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-port-assignment-for-access-point

delete_port_assignment_for_access_point(device_management_ip_address, interface_name, headers=None, **request_parameters)

Delete Port assignment for access point in SDA Fabric .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• interface_name (str) – interfaceName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-port-assignment-for-access-point

get_port_assignment_for_access_point(device_management_ip_address, interface_name, headers=None, **request_parameters)

Get Port assignment for access point in SDA Fabric .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• interface_name (str) – interfaceName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-port-assignment-for-access-point

delete_port_assignment_for_user_device(device_management_ip_address, interface_name, headers=None, **request_parameters)

Delete Port assignment for user device in SDA Fabric. .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• interface_name (str) – interfaceName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-port-assignment-for-user-device

add_port_assignment_for_user_device(authenticateTemplateName=None, dataIpAddressPoolName=None, deviceManagementIpAddress=None, interfaceDescription=None, interfaceName=None, interfaceNames=None, scalableGroupName=None, siteNameHierarchy=None, voiceIpAddressPoolName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add Port assignment for user device in SDA Fabric. .

Parameters:

• authenticateTemplateName (string) – SDA’s Authenticate TemplateName associated with siteNameHierarchy . Available values are ‘Open Authentication’, ‘Closed Authentication’, ‘Low Impact’ and ‘No Authentication’.

• dataIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to virtual network with traffic type as DATA(can’t be empty if voiceIpAddressPoolName is empty) .

• deviceManagementIpAddress (string) – SDA’s Management Ip Address of the Edge Node Device. .

• interfaceDescription (string) – SDA’s User defined text message for port assignment .

• interfaceName (string) – SDA’s Interface Name on the Edge Node Device. .

• interfaceNames (list) – SDA’s List of Interface Names on the Edge Node Device. E.g.[“GigabitEthernet1/0/3”,”GigabitEthernet1/0/4”] (list of strings).

• scalableGroupName (string) – SDA’s Scalable Group name associated with VN .

• siteNameHierarchy (string) – SDA’s Complete Path of SD-Access Fabric Site. .

• voiceIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to virtual network with traffic type as VOICE(can’t be empty if dataIpAddressPoolName is empty) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-port-assignment-for-user-device

get_port_assignment_for_user_device(device_management_ip_address, interface_name, headers=None, **request_parameters)

Get Port assignment for user device in SDA Fabric. .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• interface_name (str) – interfaceName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-port-assignment-for-user-device

add_multicast_in_sda_fabric(multicastMethod=None, multicastType=None, multicastVnInfo=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add multicast in SDA fabric .

Parameters:

• multicastMethod (string) – SDA’s Multicast Method . Available values are ‘native_multicast’.

• multicastType (string) – SDA’s Multicast Type . Available values are ‘ssm’, ‘asm_with_internal_rp’ and ‘asm_with_external_rp’.

• multicastVnInfo (list) – SDA’s multicastVnInfo (list of objects).

• siteNameHierarchy (string) – SDA’s Full path of sda Fabric Site .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-multicast-in-sda-fabric

get_multicast_details_from_sda_fabric(site_name_hierarchy, headers=None, **request_parameters)

Get multicast details from SDA fabric .

Parameters:

• site_name_hierarchy (str) – siteNameHierarchy query parameter. fabric site name hierarchy .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-multicast-details-from-sda-fabric

delete_multicast_from_sda_fabric(site_name_hierarchy, headers=None, **request_parameters)

Delete multicast from SDA fabric .

Parameters:

• site_name_hierarchy (str) – siteNameHierarchy query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-multicast-from-sda-fabric

delete_provisioned_wired_device(device_management_ip_address, headers=None, **request_parameters)

Delete provisioned Wired Device .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter. Valid IP address of the device currently provisioned in a fabric site .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-provisioned-wired-device

re_provision_wired_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)

Re-Provision Wired Device .

Parameters:

• deviceManagementIpAddress (string) – SDA’s Management Ip Address of the device to be re-provisioned .

• siteNameHierarchy (string) – SDA’s siteNameHierarchy of the provisioned device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!re-provision-wired-device

provision_wired_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)

Provision Wired Device .

Parameters:

• deviceManagementIpAddress (string) – SDA’s Management Ip Address of the device to be provisioned .

• siteNameHierarchy (string) – SDA’s Site Name Hierarchy for device location(only building / floor level) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!provision-wired-device

get_provisioned_wired_device(device_management_ip_address, headers=None, **request_parameters)

Get Provisioned Wired Device .

Parameters:

• device_management_ip_address (str) – deviceManagementIpAddress query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-provisioned-wired-device

delete_transit_peer_network(transit_peer_network_name, headers=None, **request_parameters)

Delete Transit Peer Network from SD-Access .

Parameters:

• transit_peer_network_name (str) – transitPeerNetworkName query parameter. Transit Peer Network Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-transit-peer-network

get_transit_peer_network_info(transit_peer_network_name, headers=None, **request_parameters)

Get Transit Peer Network Info from SD-Access .

Parameters:

• transit_peer_network_name (str) – transitPeerNetworkName query parameter. Transit or Peer Network Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-transit-peer-network-info

add_transit_peer_network(ipTransitSettings=None, sdaTransitSettings=None, transitPeerNetworkName=None, transitPeerNetworkType=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add Transit Peer Network in SD-Access .

Parameters:

• ipTransitSettings (object) – SDA’s ipTransitSettings.

• sdaTransitSettings (object) – SDA’s sdaTransitSettings.

• transitPeerNetworkName (string) – SDA’s Transit Peer Network Name .

• transitPeerNetworkType (string) – SDA’s Transit Peer Network Type . Available values are ‘ip_transit’, ‘sda_transit_with_lisp_bgp’ and ‘sda_transit_with_pub_sub’.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-transit-peer-network

delete_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)

Delete virtual network (VN) from SDA Fabric .

Parameters:

• virtual_network_name (str) – virtualNetworkName query parameter.

• site_name_hierarchy (str) – siteNameHierarchy query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-vn

get_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)

Get virtual network (VN) from SDA Fabric .

Parameters:

• virtual_network_name (str) – virtualNetworkName query parameter.

• site_name_hierarchy (str) – siteNameHierarchy query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-vn

add_vn(siteNameHierarchy=None, virtualNetworkName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add virtual network (VN) in SDA Fabric .

Parameters:

• siteNameHierarchy (string) – SDA’s Path of sda Fabric Site .

• virtualNetworkName (string) – SDA’s Virtual Network Name, that is created at Global level .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-vn

get_virtual_network_summary(site_name_hierarchy, headers=None, **request_parameters)

Get Virtual Network Summary .

Parameters:

• site_name_hierarchy (str) – siteNameHierarchy query parameter. Complete fabric siteNameHierarchy Path .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-virtual-network-summary

get_ip_pool_from_sda_virtual_network(ip_pool_name, site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)

Get IP Pool from SDA Virtual Network .

Parameters:

• site_name_hierarchy (str) – siteNameHierarchy query parameter.

• virtual_network_name (str) – virtualNetworkName query parameter.

• ip_pool_name (str) – ipPoolName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-ip-pool-from-sda-virtual-network

delete_ip_pool_from_sda_virtual_network(ip_pool_name, site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)

Delete IP Pool from SDA Virtual Network .

Parameters:

• site_name_hierarchy (str) – siteNameHierarchy query parameter.

• virtual_network_name (str) – virtualNetworkName query parameter.

• ip_pool_name (str) – ipPoolName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-ip-pool-from-sda-virtual-network

add_ip_pool_in_sda_virtual_network(autoGenerateVlanName=None, ipPoolName=None, isBridgeModeVm=None, isCommonPool=None, isIpDirectedBroadcast=None, isL2FloodingEnabled=None, isLayer2Only=None, isThisCriticalPool=None, isWirelessPool=None, poolType=None, scalableGroupName=None, siteNameHierarchy=None, trafficType=None, virtualNetworkName=None, vlanId=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add IP Pool in SDA Virtual Network .

Parameters:

• autoGenerateVlanName (boolean) – SDA’s It will auto generate vlanName, if vlanName is empty(applicable for L3 and INFRA_VN) .

• ipPoolName (string) – SDA’s Ip Pool Name, that is reserved to Fabric Site for (applicable for L3 and INFRA_VN) .

• isBridgeModeVm (boolean) – SDA’s Bridge Mode Vm enablement flag (applicable for L3 and L2 and default value is False ) .

• isCommonPool (boolean) – SDA’s Common Pool enablement flag(applicable for L3 and L2 and default value is False ) .

• isIpDirectedBroadcast (boolean) – SDA’s Ip Directed Broadcast enablement flag(applicable for L3 and default value is False ) .

• isL2FloodingEnabled (boolean) – SDA’s Layer2 flooding enablement flag(applicable for L3 , L2 and always true for L2 and default value is False ) .

• isLayer2Only (boolean) – SDA’s Layer2 Only enablement flag and default value is False .

• isThisCriticalPool (boolean) – SDA’s Critical pool enablement flag(applicable for L3 and default value is False ) .

• isWirelessPool (boolean) – SDA’s Wireless Pool enablement flag(applicable for L3 and L2 and default value is False ) .

• poolType (string) – SDA’s Pool Type (applicable for INFRA_VN) . Available values are ‘AP’ and ‘Extended’.

• scalableGroupName (string) – SDA’s Scalable Group Name(applicable for L3) .

• siteNameHierarchy (string) – SDA’s Path of sda Fabric Site .

• trafficType (string) – SDA’s Traffic type(applicable for L3 and L2) . Available values are ‘Data’ and ‘Voice’.

• virtualNetworkName (string) – SDA’s Virtual Network Name, that is associated to Fabric Site .

• vlanId (string) – SDA’s vlan Id(applicable for L3 , L2 and INFRA_VN) .

• vlanName (string) – SDA’s Vlan name represent the segment name, if empty, vlanName would be auto generated by API .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-ip-pool-in-sda-virtual-network

add_virtual_network_with_scalable_groups(isGuestVirtualNetwork=None, scalableGroupNames=None, vManageVpnId=None, virtualNetworkName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add virtual network with scalable groups at global level .

Parameters:

• isGuestVirtualNetwork (boolean) – SDA’s Guest Virtual Network enablement flag, default value is False. .

• scalableGroupNames (list) – SDA’s Scalable Group to be associated to virtual network (list of strings).

• vManageVpnId (string) – SDA’s vManage vpn id for SD-WAN .

• virtualNetworkName (string) – SDA’s Virtual Network Name to be assigned at global level .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-virtual-network-with-scalable-groups

delete_virtual_network_with_scalable_groups(virtual_network_name, headers=None, **request_parameters)

Delete virtual network with scalable groups .

Parameters:

• virtual_network_name (str) – virtualNetworkName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-virtual-network-with-scalable-groups

get_virtual_network_with_scalable_groups(virtual_network_name, headers=None, **request_parameters)

Get virtual network with scalable groups .

Parameters:

• virtual_network_name (str) – virtualNetworkName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-virtual-network-with-scalable-groups

update_virtual_network_with_scalable_groups(isGuestVirtualNetwork=None, scalableGroupNames=None, vManageVpnId=None, virtualNetworkName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update virtual network with scalable groups .

Parameters:

• isGuestVirtualNetwork (boolean) – SDA’s Indicates whether to set this as guest virtual network or not, default value is False. .

• scalableGroupNames (list) – SDA’s Scalable Group Name to be associated to virtual network (list of strings).

• vManageVpnId (string) – SDA’s vManage vpn id for SD-WAN .

• virtualNetworkName (string) – SDA’s Virtual Network Name to be assigned global level .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-virtual-network-with-scalable-groups

security_advisories

class SecurityAdvisories

Cisco DNA Center Security Advisories API (version: 2.3.5.3).

Wraps the DNA Center Security Advisories API and exposes the API as native Python methods that return native Python objects.

get_advisories_list(headers=None, **request_parameters)

Retrieves list of advisories on the network .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-advisories-list

get_advisories_summary(headers=None, **request_parameters)

Retrieves summary of advisories on the network. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-advisories-summary

get_devices_per_advisory(advisory_id, headers=None, **request_parameters)

Retrieves list of devices for an advisory .

Parameters:

• advisory_id (str) – advisoryId path parameter. Advisory ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-devices-per-advisory

get_advisory_ids_per_device(device_id, headers=None, **request_parameters)

Retrieves list of advisory IDs for a device .

Parameters:

• device_id (str) – deviceId path parameter. Device instance UUID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-advisory-ids-per-device

get_advisories_per_device(device_id, headers=None, **request_parameters)

Retrieves list of advisories for a device .

Parameters:

• device_id (str) – deviceId path parameter. Device instance UUID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-advisories-per-device

sensors

class Sensors

Cisco DNA Center Sensors API (version: 2.3.5.3).

Wraps the DNA Center Sensors API and exposes the API as native Python methods that return native Python objects.

edit_sensor_test_template(locationInfoList=None, schedule=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Intent API to deploy, schedule, or edit and existing SENSOR test template .

Parameters:

• locationInfoList (list) – Sensors’s locationInfoList (list of objects).

• schedule (object) – Sensors’s schedule.

• templateName (string) – Sensors’s Template Name.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!edit-sensor-test-template

create_sensor_test_template(apCoverage=None, connection=None, modelVersion=None, name=None, ssids=None, headers=None, payload=None, active_validation=True, **request_parameters)

Intent API to create a SENSOR test template with a new SSID, existing SSID, or both new and existing SSID .

Parameters:

• apCoverage (list) – Sensors’s apCoverage (list of objects).

• connection (string) – Sensors’s Connection.

• modelVersion (integer) – Sensors’s Model Version.

• name (string) – Sensors’s Name.

• ssids (list) – Sensors’s ssids (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-sensor-test-template

delete_sensor_test(template_name=None, headers=None, **request_parameters)

Intent API to delete an existing SENSOR test template .

Parameters:

• template_name (str) – templateName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-sensor-test

sensors(site_id=None, headers=None, **request_parameters)

Intent API to get a list of SENSOR devices .

Parameters:

• site_id (str) – siteId query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sensors

run_now_sensor_test(templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Intent API to run a deployed SENSOR test .

Parameters:

• templateName (string) – Sensors’s Template Name.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!run-now-sensor-test

duplicate_sensor_test_template(newTemplateName=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Intent API to duplicate an existing SENSOR test template .

Parameters:

• newTemplateName (string) – Sensors’s New Template Name.

• templateName (string) – Sensors’s Template Name.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!duplicate-sensor-test-template

site_design

class SiteDesign

Cisco DNA Center Site Design API (version: 2.3.5.3).

Wraps the DNA Center Site Design API and exposes the API as native Python methods that return native Python objects.

provision_nfv(provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)

Design and Provision single/multi NFV device with given site/area/building/floor . .

Parameters:

• provisioning (list) – Site Design’s provisioning (list of objects).

• siteProfile (list) – Site Design’s siteProfile (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!provision-nfv

get_device_details_by_ip(device_ip, headers=None, **request_parameters)

Returns provisioning device information for the specified IP address. .

Parameters:

• device_ip (str) – deviceIp query parameter. Device to which the provisioning detail has to be retrieved .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-details-by-ip

associate(network_profile_id, site_id, headers=None, **request_parameters)

Associate Site to a Network Profile .

Parameters:

• network_profile_id (str) – networkProfileId path parameter. Network-Profile Id to be associated .

• site_id (str) – siteId path parameter. Site Id to be associated .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!associate

disassociate(network_profile_id, site_id, headers=None, **request_parameters)

Disassociate a Site from a Network Profile .

Parameters:

• network_profile_id (str) – networkProfileId path parameter. Network-Profile Id to be associated .

• site_id (str) – siteId path parameter. Site Id to be associated .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!disassociate

nfv_provisioning_detail(device_ip=None, headers=None, payload=None, active_validation=True, **request_parameters)

Checks the provisioning detail of an ENCS device including log information. .

Parameters:

• device_ip (string) – Site Design’s Device Ip.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!nfv-provisioning-detail

create_nfv_profile(device=None, profileName=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create network profile for different NFV topologies .

Parameters:

• device (list) – Site Design’s device (list of objects).

• profileName (string) – Site Design’s Name of the profile to create NFV profile .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-nfv-profile

update_nfv_profile(id, device=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update a NFV Network profile .

Parameters:

• device (list) – Site Design’s device (list of objects).

• id (str) – id path parameter. Id of the NFV profile to be updated .

• name (str) – name query parameter. Name of the profile to be updated .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-nfv-profile

get_nfv_profile(id, limit=None, name=None, offset=None, headers=None, **request_parameters)

API to get NFV network profile. .

Parameters:

• id (str) – id path parameter. ID of network profile to retrieve. .

• offset (int,str) – offset query parameter. offset/starting row .

• limit (int,str) – limit query parameter. Number of profile to be retrieved .

• name (str) – name query parameter. Name of network profile to be retrieved .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-nfv-profile

delete_nfv_profile(id, name=None, headers=None, **request_parameters)

API to delete nfv network profile. .

Parameters:

• id (str) – id path parameter. Id of nfv network profile to delete. .

• name (str) – name query parameter. Nameof nfv network profile to delete. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-nfv-profile

sites

class Sites

Cisco DNA Center Sites API (version: 2.3.5.3).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

assign_devices_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)

Assigns unassigned devices to a site. This API does not move assigned devices to other sites. .

Parameters:

• device (list) – Sites’s device (list of objects).

• site_id (str) – siteId path parameter. Site id to which site the device to assign .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!assign-devices-to-site

get_membership(site_id, device_family=None, limit=None, offset=None, serial_number=None, headers=None, **request_parameters)

Getting the site children details and device details. .

Parameters:

• site_id (str) – siteId path parameter. Site id to retrieve device associated with the site. .

• offset (int,str) – offset query parameter. offset/starting row .

• limit (int,str) – limit query parameter. Number of sites to be retrieved .

• device_family (str) – deviceFamily query parameter. Device family name .

• serial_number (str) – serialNumber query parameter. Device serial number .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-membership

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)

Creates site with area/building/floor with specified hierarchy. .

Parameters:

• site (object) – Sites’s site.

• type (string) – Sites’s Type of site to create (eg: area, building, floor) . Available values are ‘area’, ‘building’ and ‘floor’.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-site

get_site(limit=None, name=None, offset=None, site_id=None, type=None, headers=None, **request_parameters)

Get site using siteNameHierarchy/siteId/type ,return all sites if these parameters are not given as input. .

Parameters:

• name (str) – name query parameter. siteNameHierarchy (ex: global/groupName) .

• site_id (str) – siteId query parameter. Site id to which site details to retrieve. .

• type (str) – type query parameter. type (ex: area, building, floor) .

• offset (int,str) – offset query parameter. offset/starting row. The default value is 1 .

• limit (int,str) – limit query parameter. Number of sites to be retrieved. The default value is 500 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-site

get_site_health(limit=None, offset=None, site_type=None, timestamp=None, headers=None, **request_parameters)

Returns Overall Health information for all sites .

Parameters:

• timestamp (str) – timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required .

• site_type (str) – siteType query parameter. Type of the site to return. AREA or BUILDING. Default to AREA .

• offset (int,str) – offset query parameter. The offset value, starting from 1, of the first returned site entry. Default is 1. .

• limit (int,str) – limit query parameter. The max number of sites in the returned data set. Default is 25, and max at 50 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-site-health

get_site_count(site_id=None, headers=None, **request_parameters)

API to get site count .

Parameters:

• site_id (str) – siteId query parameter. Site id to retrieve site count. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-site-count

update_site(site_id, site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update site area/building/floor with specified hierarchy and new values .

Parameters:

• site (object) – Sites’s site.

• type (string) – Sites’s Type. Available values are ‘area’, ‘building’ and ‘floor’.

• site_id (str) – siteId path parameter. Site id to which site details to be updated. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-site

delete_site(site_id, headers=None, **request_parameters)

Delete site with area/building/floor by siteId. .

Parameters:

• site_id (str) – siteId path parameter. Site id to which site details to be deleted. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-site

software_image_management_swim

class SoftwareImageManagementSwim

Cisco DNA Center Software Image Management (SWIM) API (version: 2.3.5.3).

Wraps the DNA Center Software Image Management (SWIM) API and exposes the API as native Python methods that return native Python objects.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)

Activates a software image on a given device. Software image must be present in the device flash .

Parameters:

• schedule_validate (bool) – scheduleValidate query parameter. scheduleValidate, validates data before schedule (Optional) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!trigger-software-image-activation

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!trigger-software-image-distribution

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order=None, version=None, headers=None, **request_parameters)

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%” .

Parameters:

• image_uuid (str) – imageUuid query parameter.

• name (str) – name query parameter.

• family (str) – family query parameter.

• application_type (str) – applicationType query parameter.

• image_integrity_status (str) – imageIntegrityStatus query parameter. imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED .

• version (str) – version query parameter. software Image Version .

• image_series (str) – imageSeries query parameter. image Series .

• image_name (str) – imageName query parameter. image Name .

• is_tagged_golden (bool) – isTaggedGolden query parameter. is Tagged Golden .

• is_cco_recommended (bool) – isCCORecommended query parameter. is recommended from cisco.com .

• is_cco_latest (bool) – isCCOLatest query parameter. is latest from cisco.com .

• created_time (int) – createdTime query parameter. time in milliseconds (epoch format) .

• image_size_greater_than (int) – imageSizeGreaterThan query parameter. size in bytes .

• image_size_lesser_than (int) – imageSizeLesserThan query parameter. size in bytes .

• sort_by (str) – sortBy query parameter. sort results by this field .

• sort_order (str) – sortOrder query parameter. sort order ‘asc’ or ‘des’. Default is asc .

• limit (int,str) – limit query parameter.

• offset (int,str) – offset query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-software-image-details

get_device_family_identifiers(headers=None, **request_parameters)

API to get Device Family Identifiers for all Device Families that can be used for tagging an image golden. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-family-identifiers

tag_as_golden_image(deviceFamilyIdentifier=None, deviceRole=None, imageId=None, siteId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Golden Tag image. Set siteId as -1 for Global site. .

Parameters:

• deviceFamilyIdentifier (string) – Software Image Management (SWIM)’s Device Family Identifier e.g. : 277696480-283933147, 277696480 .

• deviceRole (string) – Software Image Management (SWIM)’s Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

• imageId (string) – Software Image Management (SWIM)’s imageId in uuid format. .

• siteId (string) – Software Image Management (SWIM)’s SiteId in uuid format. For Global Site “-1” to be used. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!tag-as-golden-image

remove_golden_tag_for_image(device_family_identifier, device_role, image_id, site_id, headers=None, **request_parameters)

Remove golden tag. Set siteId as -1 for Global site. .

Parameters:

• site_id (str) – siteId path parameter. Site Id in uuid format. Set siteId as -1 for Global site. .

• device_family_identifier (str) – deviceFamilyIdentifier path parameter. Device family identifier e.g. : 277696480-283933147, e.g. : 277696480 .

• device_role (str) – deviceRole path parameter. Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

• image_id (str) – imageId path parameter. Image Id in uuid format. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!remove-golden-tag-for-image

get_golden_tag_status_of_an_image(device_family_identifier, device_role, image_id, site_id, headers=None, **request_parameters)

Get golden tag status of an image. Set siteId as -1 for Global site. .

Parameters:

• site_id (str) – siteId path parameter. Site Id in uuid format. Set siteId as -1 for Global site. .

• device_family_identifier (str) – deviceFamilyIdentifier path parameter. Device family identifier e.g. : 277696480-283933147, e.g. : 277696480 .

• device_role (str) – deviceRole path parameter. Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

• image_id (str) – imageId path parameter. Image Id in uuid format. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-golden-tag-status-of-an-image

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2 .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback

Parameters:

• is_third_party (bool) – isThirdParty query parameter. Third party Image check .

• third_party_vendor (str) – thirdPartyVendor query parameter. Third Party Vendor .

• third_party_image_family (str) – thirdPartyImageFamily query parameter. Third Party image family .

• third_party_application_type (str) – thirdPartyApplicationType query parameter. Third Party Application Type .

• multipart_fields (dict) – Fields from which to create a multipart/form-data body.

• multipart_monitor_callback (function) – function used to monitor the progress of the upload.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!import-local-software-image

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2 .

Parameters:

• schedule_at (str) – scheduleAt query parameter. Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

• schedule_desc (str) – scheduleDesc query parameter. Custom Description (Optional) .

• schedule_origin (str) – scheduleOrigin query parameter. Originator of this call (Optional) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!import-software-image-via-url

system_settings

class SystemSettings

Cisco DNA Center System Settings API (version: 2.3.5.3).

Wraps the DNA Center System Settings API and exposes the API as native Python methods that return native Python objects.

get_authentication_and_policy_servers(is_ise_enabled=None, role=None, state=None, headers=None, **request_parameters)

API to get Authentication and Policy Servers .

Parameters:

• is_ise_enabled (bool) – isIseEnabled query parameter. Valid values are : true, false .

• state (str) – state query parameter. Valid values are: INPROGRESS, ACTIVE, DELETED, RBAC-FAILURE, FAILED .

• role (str) – role query parameter. Authentication and Policy Server Role (Example: primary, secondary) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-authentication-and-policy-servers

custom_prompt_support_g_e_t_api(headers=None, **request_parameters)

Returns supported custom prompts by Cisco DNA Center .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!custom-prompt-support-g-e-t-api

custom_prompt_p_o_s_t_api(passwordPrompt=None, usernamePrompt=None, headers=None, payload=None, active_validation=True, **request_parameters)

Save custom prompt added by user in Cisco DNA Center. API will always override the existing prompts. User should provide all the custom prompt in case of any update .

Parameters:

• passwordPrompt (string) – System Settings’s Password Prompt.

• usernamePrompt (string) – System Settings’s Username Prompt.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!custom-prompt-p-o-s-t-api

tag

class Tag

Cisco DNA Center Tag API (version: 2.3.5.3).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates a tag specified by id .

Parameters:

• description (string) – Tag’s description.

• dynamicRules (list) – Tag’s dynamicRules (list of objects).

• id (string) – Tag’s id.

• instanceTenantId (string) – Tag’s instanceTenantId.

• name (string) – Tag’s name.

• systemTag (boolean) – Tag’s systemTag.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-tag

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)

Returns the tags for given filter criteria .

Parameters:

• name (str) – name query parameter. Tag name is mandatory when filter operation is used. .

• additional_info_name_space (str) – additionalInfo.nameSpace query parameter.

• additional_info_attributes (str) – additionalInfo.attributes query parameter.

• level (str) – level query parameter.

• offset (int,str) – offset query parameter.

• limit (int,str) – limit query parameter.

• size (str) – size query parameter. size in kilobytes(KB) .

• field (str) – field query parameter. Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’ .

• sort_by (str) – sortBy query parameter. Only supported attribute is name. SortyBy is mandatory when order is used. .

• order (str) – order query parameter. Available values are asc and des .

• system_tag (str) – systemTag query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)

Creates tag with specified tag attributes .

Parameters:

• description (string) – Tag’s description.

• dynamicRules (list) – Tag’s dynamicRules (list of objects).

• id (string) – Tag’s id.

• instanceTenantId (string) – Tag’s instanceTenantId.

• name (string) – Tag’s name.

• systemTag (boolean) – Tag’s systemTag.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-tag

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)

Returns tag count .

Parameters:

• name (str) – name query parameter.

• name_space (str) – nameSpace query parameter.

• attribute_name (str) – attributeName query parameter.

• level (str) – level query parameter.

• size (str) – size query parameter. size in kilobytes(KB) .

• system_tag (str) – systemTag query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag-count

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API .

Parameters:

• memberToTags (object) – Tag’s memberToTags.

• memberType (string) – Tag’s memberType.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!updates-tag-membership

get_tag_resource_types(headers=None, **request_parameters)

Returns list of supported resource types .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag-resource-types

delete_tag(id, headers=None, **request_parameters)

Deletes a tag specified by id .

Parameters:

• id (str) – id path parameter. Tag ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-tag

get_tag_by_id(id, headers=None, **request_parameters)

Returns tag specified by Id .

Parameters:

• id (str) – id path parameter. Tag ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag-by-id

get_tag_members_by_id(id, member_type, level=None, limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)

Returns tag members specified by id .

Parameters:

• id (str) – id path parameter. Tag ID .

• member_type (str) – memberType query parameter. Entity type of the member. Possible values can be retrieved by using /tag/member/type API .

• offset (str,int) – offset query parameter. Used for pagination. It indicates the starting row number out of available member records .

• limit (str,int) – limit query parameter. Used to Number of maximum members to return in the result .

• member_association_type (str) – memberAssociationType query parameter. Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag .

• level (str) – level query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag-members-by-id

add_members_to_the_tag(id, object=None, headers=None, payload=None, active_validation=True, **request_parameters)

Adds members to the tag specified by id .

Parameters:

• object (string) – Tag’s object.

• id (str) – id path parameter. Tag ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-members-to-the-tag

get_tag_member_count(id, member_type, level=None, member_association_type=None, headers=None, **request_parameters)

Returns the number of members in a given tag .

Parameters:

• id (str) – id path parameter. Tag ID .

• member_type (str) – memberType query parameter.

• member_association_type (str) – memberAssociationType query parameter.

• level (str) – level query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag-member-count

remove_tag_member(id, member_id, headers=None, **request_parameters)

Removes Tag member from the tag specified by id .

Parameters:

• id (str) – id path parameter. Tag ID .

• member_id (str) – memberId path parameter. TagMember id to be removed from tag .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!remove-tag-member

task

class Task

Cisco DNA Center Task API (version: 2.3.5.3).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_business_api_execution_details(execution_id, headers=None, **request_parameters)

Retrieves the execution details of a Business API .

Parameters:

• execution_id (str) – executionId path parameter. Execution Id of API .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-business-api-execution-details

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)

Returns task(s) based on filter criteria .

Parameters:

• start_time (str) – startTime query parameter. This is the epoch start time from which tasks need to be fetched .

• end_time (str) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched .

• data (str) – data query parameter. Fetch tasks that contains this data .

• error_code (str) – errorCode query parameter. Fetch tasks that have this error code .

• service_type (str) – serviceType query parameter. Fetch tasks with this service type .

• username (str) – username query parameter. Fetch tasks with this username .

• progress (str) – progress query parameter. Fetch tasks that contains this progress .

• is_error (str) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false .

• failure_reason (str) – failureReason query parameter. Fetch tasks that contains this failure reason .

• parent_id (str) – parentId query parameter. Fetch tasks that have this parent Id .

• offset (int,str) – offset query parameter.

• limit (int,str) – limit query parameter.

• sort_by (str) – sortBy query parameter. Sort results by this field .

• order (str) – order query parameter. Sort order asc or dsc .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tasks

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)

Returns Task count .

Parameters:

• start_time (str) – startTime query parameter. This is the epoch start time from which tasks need to be fetched .

• end_time (str) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched .

• data (str) – data query parameter. Fetch tasks that contains this data .

• error_code (str) – errorCode query parameter. Fetch tasks that have this error code .

• service_type (str) – serviceType query parameter. Fetch tasks with this service type .

• username (str) – username query parameter. Fetch tasks with this username .

• progress (str) – progress query parameter. Fetch tasks that contains this progress .

• is_error (str) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false .

• failure_reason (str) – failureReason query parameter. Fetch tasks that contains this failure reason .

• parent_id (str) – parentId query parameter. Fetch tasks that have this parent Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-task-count

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)

Returns root tasks associated with an Operationid .

Parameters:

• operation_id (str) – operationId path parameter.

• offset (int,str) – offset path parameter. Index, minimum value is 0 .

• limit (int,str) – limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-task-by-operationid

get_task_by_id(task_id, headers=None, **request_parameters)

Returns a task by specified id .

Parameters:

• task_id (str) – taskId path parameter. UUID of the Task .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-task-by-id

get_task_tree(task_id, headers=None, **request_parameters)

Returns a task with its children tasks by based on their id .

Parameters:

• task_id (str) – taskId path parameter. UUID of the Task .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-task-tree

topology

class Topology

Cisco DNA Center Topology API (version: 2.3.5.3).

Wraps the DNA Center Topology API and exposes the API as native Python methods that return native Python objects.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time .

Parameters:

• timestamp (str) – timestamp query parameter. Epoch time(in milliseconds) when the Network health data is required .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_topology_details(vlan_id, headers=None, **request_parameters)

Returns Layer 2 network topology by specified VLAN ID .

Parameters:

• vlan_id (str) – vlanID path parameter. Vlan Name for e.g Vlan1, Vlan23 etc .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-topology-details

get_l3_topology_details(topology_type, headers=None, **request_parameters)

Returns the Layer 3 network topology by routing protocol .

Parameters:

• topology_type (str) – topologyType path parameter. Type of topology(OSPF,ISIS,etc) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-l3-topology-details

get_physical_topology(node_type=None, headers=None, **request_parameters)

Returns the raw physical topology by specified criteria of nodeType .

Parameters:

• node_type (str) – nodeType query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-physical-topology

get_site_topology(headers=None, **request_parameters)

Returns site topology .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-site-topology

get_vlan_details(headers=None, **request_parameters)

Returns the list of VLAN names .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-vlan-details

user_and_roles

class UserandRoles

Cisco DNA Center User and Roles API (version: 2.3.5.3).

Wraps the DNA Center User and Roles API and exposes the API as native Python methods that return native Python objects.

get_permissions_api(headers=None, **request_parameters)

Get permissions for a role from Cisco DNA Center System .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-permissions-api

get_roles_api(headers=None, **request_parameters)

Get all roles for the Cisco DNA Center system .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-roles-api

get_users_api(invoke_source, headers=None, **request_parameters)

Get all users for the Cisco DNA Center system .

Parameters:

• invoke_source (str) – invokeSource query parameter. The source that invokes this API .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-users-api

add_user_api(email=None, firstName=None, lastName=None, password=None, roleList=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add a new user for Cisco DNA Center system .

Parameters:

• email (string) – User and Roles’s Email.

• firstName (string) – User and Roles’s First Name.

• lastName (string) – User and Roles’s Last Name.

• password (string) – User and Roles’s Password.

• roleList (list) – User and Roles’s Role id list (list of strings).

• username (string) – User and Roles’s Username.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-user-api

update_user_api(email=None, firstName=None, lastName=None, roleList=None, userId=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update a user for Cisco DNA Center system .

Parameters:

• email (string) – User and Roles’s email should be set if the original value is not empty .

• firstName (string) – User and Roles’s firstName should be set if the original value is not empty .

• lastName (string) – User and Roles’s lastName should be set if the original value is not empty .

• roleList (list) – User and Roles’s Role id list (list of strings).

• userId (string) – User and Roles’s User Id.

• username (string) – User and Roles’s Username.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-user-api

get_external_authentication_servers_api(invoke_source, headers=None, **request_parameters)

Get external users authentication servers .

Parameters:

• invoke_source (str) – invokeSource query parameter. The source that invokes this API .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-external-authentication-servers-api

users

class Users

Cisco DNA Center Users API (version: 2.3.5.3).

Wraps the DNA Center Users API and exposes the API as native Python methods that return native Python objects.

get_user_enrichment_details(headers=None, **request_parameters)

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

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

wireless

class Wireless

Cisco DNA Center Wireless API (version: 2.3.5.3).

Wraps the DNA Center Wireless API and exposes the API as native Python methods that return native Python objects.

sensor_test_results(end_time=None, site_id=None, start_time=None, test_failure_by=None, headers=None, **request_parameters)

Intent API to get SENSOR test result summary .

Parameters:

• site_id (str) – siteId query parameter. Assurance site UUID .

• start_time (int) – startTime query parameter. The epoch time in milliseconds .

• end_time (int) – endTime query parameter. The epoch time in milliseconds .

• test_failure_by (str) – testFailureBy query parameter. Obtain failure statistics group by “area”, “building”, or “floor” .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sensor-test-results

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters)

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites .

Parameters:

• enableFabric (boolean) – Wireless’s Enable SSID for Fabric .

• flexConnect (object) – Wireless’s flexConnect.

• managedAPLocations (list) – Wireless’s Managed AP Locations (Enter entire Site(s) hierarchy) (list of strings).

• ssidDetails (object) – Wireless’s ssidDetails.

• ssidType (string) – Wireless’s SSID Type . Available values are ‘Guest’ and ‘Enterprise’.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-and-provision-ssid

delete_ssid_and_provision_it_to_devices(managed_aplocations, ssid_name, headers=None, **request_parameters)

Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center .

Parameters:

• ssid_name (str) – ssidName path parameter.

• managed_aplocations (str) – managedAPLocations path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-ssid-and-provision-it-to-devices

reboot_access_points(apMacAddresses=None, headers=None, payload=None, active_validation=True, **request_parameters)

Users can reboot multiple access points up-to 200 at a time using this API .

Parameters:

• apMacAddresses (list) – Wireless’s The ethernet MAC address of the access point. (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!reboot-access-points

get_access_point_reboot_task_result(parent_task_id=None, headers=None, **request_parameters)

Users can query the access point reboot status using this intent API .

Parameters:

• parent_task_id (str) – parentTaskId query parameter. task id of ap reboot request .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-access-point-reboot-task-result

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)

Gets either one or all the enterprise SSID .

Parameters:

• ssid_name (str) – ssidName query parameter. Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-enterprise-ssid

create_enterprise_ssid(basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, nasOptions=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)

Creates enterprise SSID .

Parameters:

• basicServiceSetClientIdleTimeout (integer) – Wireless’s Basic Service Set Client Idle Timeout.

• clientExclusionTimeout (integer) – Wireless’s Client Exclusion Timeout .

• enableBasicServiceSetMaxIdle (boolean) – Wireless’s Enable Basic Service Set Max Idle .

• enableBroadcastSSID (boolean) – Wireless’s Enable Broadcase SSID .

• enableClientExclusion (boolean) – Wireless’s Enable Client Exclusion .

• enableDirectedMulticastService (boolean) – Wireless’s Enable Directed Multicast Service.

• enableFastLane (boolean) – Wireless’s Enable FastLane .

• enableMACFiltering (boolean) – Wireless’s Enable MAC Filtering .

• enableNeighborList (boolean) – Wireless’s Enable Neighbor List.

• enableSessionTimeOut (boolean) – Wireless’s Enable Session Timeout .

• fastTransition (string) – Wireless’s Fast Transition . Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

• mfpClientProtection (string) – Wireless’s Management Frame Protection Client. Available values are ‘Optional’, ‘Disabled’ and ‘Required’.

• name (string) – Wireless’s SSID NAME .

• nasOptions (list) – Wireless’s Nas Options (list of strings).

• passphrase (string) – Wireless’s Passphrase .

• radioPolicy (string) – Wireless’s Radio Policy Enum (enum: Triple band operation (2.4GHz, 5GHz and 6GHz), Triple band operation with band select, 5GHz only, 2.4GHz only, 6GHz only) . Available values are ‘Triple band operation (2.4GHz, 5GHz and 6GHz)’, ‘Triple band operation with band select’, ‘5GHz only’, ‘2.4GHz only’ and ‘6GHz only’.

• securityLevel (string) – Wireless’s Security Level . Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’, ‘OPEN’, ‘WPA3_ENTERPRISE’, ‘WPA3_PERSONAL’, ‘WPA2_WPA3_PERSONAL’ and ‘WPA2_WPA3_ENTERPRISE’.

• sessionTimeOut (integer) – Wireless’s Session Time Out .

• trafficType (string) – Wireless’s Traffic Type Enum (voicedata or data ) . Available values are ‘voicedata’ and ‘data’.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-enterprise-ssid

update_enterprise_ssid(basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, nasOptions=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update enterprise SSID .

Parameters:

• basicServiceSetClientIdleTimeout (integer) – Wireless’s Basic Service Set Client Idle Timeout.

• clientExclusionTimeout (integer) – Wireless’s Client Exclusion Timeout .

• enableBasicServiceSetMaxIdle (boolean) – Wireless’s Enable Basic Service Set Max Idle .

• enableBroadcastSSID (boolean) – Wireless’s Enable Broadcase SSID .

• enableClientExclusion (boolean) – Wireless’s Enable Client Exclusion .

• enableDirectedMulticastService (boolean) – Wireless’s Enable Directed Multicast Service.

• enableFastLane (boolean) – Wireless’s Enable FastLane .

• enableMACFiltering (boolean) – Wireless’s Enable MAC Filtering .

• enableNeighborList (boolean) – Wireless’s Enable Neighbor List.

• enableSessionTimeOut (boolean) – Wireless’s Enable Session Timeout .

• fastTransition (string) – Wireless’s Fast Transition . Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

• mfpClientProtection (string) – Wireless’s Management Frame Protection Client. Available values are ‘Optional’, ‘Disabled’ and ‘Required’.

• name (string) – Wireless’s SSID NAME .

• nasOptions (list) – Wireless’s Nas Options (list of strings).

• passphrase (string) – Wireless’s Passphrase .

• radioPolicy (string) – Wireless’s Radio Policy Enum (enum: Triple band operation (2.4GHz, 5GHz and 6GHz), Triple band operation with band select, 5GHz only, 2.4GHz only, 6GHz only) . Available values are ‘Triple band operation (2.4GHz, 5GHz and 6GHz)’, ‘Triple band operation with band select’, ‘5GHz only’, ‘2.4GHz only’ and ‘6GHz only’.

• securityLevel (string) – Wireless’s Security Level . Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’, ‘OPEN’, ‘WPA3_ENTERPRISE’, ‘WPA3_PERSONAL’, ‘WPA2_WPA3_PERSONAL’ and ‘WPA2_WPA3_ENTERPRISE’.

• sessionTimeOut (integer) – Wireless’s Session Time Out .

• trafficType (string) – Wireless’s Traffic Type Enum (voicedata or data ) . Available values are ‘voicedata’ and ‘data’.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-enterprise-ssid

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)

Deletes given enterprise SSID .

Parameters:

• ssid_name (str) – ssidName path parameter. Enter the SSID name to be deleted .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-enterprise-ssid

delete_wireless_profile(wireless_profile_name, headers=None, **request_parameters)

Delete the Wireless Profile from Cisco DNA Center whose name is provided. .

Parameters:

• wireless_profile_name (str) – wirelessProfileName path parameter. Wireless Profile Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-wireless-profile

configure_access_points(adminStatus=None, apHeight=None, apList=None, apMode=None, configureAdminStatus=None, configureApHeight=None, configureApMode=None, configureFailoverPriority=None, configureHAController=None, configureLedBrightnessLevel=None, configureLedStatus=None, configureLocation=None, failoverPriority=None, ledBrightnessLevel=None, ledStatus=None, location=None, primaryControllerName=None, primaryIpAddress=None, radioConfigurations=None, secondaryControllerName=None, secondaryIpAddress=None, tertiaryControllerName=None, tertiaryIpAddress=None, headers=None, payload=None, active_validation=True, **request_parameters)

User can configure multiple access points with required options using this intent API .

Parameters:

• adminStatus (boolean) – Wireless’s Configure the access point’s admin status. Set this parameter’s value to “true” to enable it and “false” to disable it. .

• apHeight (number) – Wireless’s Configure the height of the access point by setting a value between 3 and height of the floor. .

• apList (list) – Wireless’s apList (list of objects).

• apMode (integer) – Wireless’s Configure the access point’s mode: for local/flexconnect mode, set “0”; for monitor mode, set “1”; for sniffer mode, set “4”; and for bridge/flex+bridge mode, set “5”. .

• configureAdminStatus (boolean) – Wireless’s To change the access point’s admin status, set this parameter’s value to “true”. .

• configureApHeight (boolean) – Wireless’s To change the access point’s height, set this parameter’s value to “true”. .

• configureApMode (boolean) – Wireless’s To change the access point’s mode, set this parameter’s value to “true”. .

• configureFailoverPriority (boolean) – Wireless’s To change the access point’s failover priority, set this parameter’s value to “true”. .

• configureHAController (boolean) – Wireless’s To change the access point’s HA controller, set this parameter’s value to “true”. .

• configureLedBrightnessLevel (boolean) – Wireless’s To change the access point’s LED brightness level, set this parameter’s value to “true”. .

• configureLedStatus (boolean) – Wireless’s To change the access point’s LED status, set this parameter’s value to “true”. .

• configureLocation (boolean) – Wireless’s To change the access point’s location, set this parameter’s value to “true”. .

• failoverPriority (integer) – Wireless’s Configure the acess point’s failover priority: for low, set “1”; for medium, set “2”; for high, set “3”; and for critical, set “4”. .

• ledBrightnessLevel (integer) – Wireless’s Configure the access point’s LED brightness level by setting a value between 1 and 8. .

• ledStatus (boolean) – Wireless’s Configure the access point’s LED status. Set “true” to enable its status and “false” to disable it. .

• location (string) – Wireless’s Configure the access point’s location. .

• primaryControllerName (string) – Wireless’s Configure the hostname for an access point’s primary controller. .

• primaryIpAddress (object) – Wireless’s primaryIpAddress.

• radioConfigurations (list) – Wireless’s radioConfigurations (list of objects).

• secondaryControllerName (string) – Wireless’s Configure the hostname for an access point’s secondary controller. .

• secondaryIpAddress (object) – Wireless’s secondaryIpAddress.

• tertiaryControllerName (string) – Wireless’s Configure the hostname for an access point’s tertiary controller. .

• tertiaryIpAddress (object) – Wireless’s tertiaryIpAddress.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!configure-access-points

get_access_point_configuration_task_result(task_id, headers=None, **request_parameters)

Users can query the access point configuration result using this intent API .

Parameters:

• task_id (str) – task_id path parameter. task id information of ap config .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-access-point-configuration-task-result

get_access_point_configuration(key, headers=None, **request_parameters)

Users can query the access point configuration information per device using the ethernet MAC address .

Parameters:

• key (str) – key query parameter. The ethernet MAC address of Access point .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-access-point-configuration

ap_provision(headers=None, payload=None, active_validation=True, **request_parameters)

Access Point Provision and ReProvision .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!ap-provision

create_update_dynamic_interface(interfaceName=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create or update an dynamic interface .

Parameters:

• interfaceName (string) – Wireless’s dynamic-interface name .

• vlanId (number) – Wireless’s Vlan Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-update-dynamic-interface

get_dynamic_interface(interface_name=None, headers=None, **request_parameters)

Get one or all dynamic interface(s) .

Parameters:

• interface_name (str) – interface-name query parameter. dynamic-interface name, if not specified all the existing dynamic interfaces will be retrieved .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-dynamic-interface

delete_dynamic_interface(interface_name, headers=None, **request_parameters)

Delete a dynamic interface .

Parameters:

• interface_name (str) – interfaceName path parameter. valid interface-name to be deleted .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-dynamic-interface

update_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided. .

Parameters:

• profileDetails (object) – Wireless’s profileDetails.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-wireless-profile

create_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)

Creates Wireless Network Profile on Cisco DNA Center and associates sites and SSIDs to it. .

Parameters:

• profileDetails (object) – Wireless’s profileDetails.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-wireless-profile

get_wireless_profile(profile_name=None, headers=None, **request_parameters)

Gets either one or all the wireless network profiles if no name is provided for network-profile. .

Parameters:

• profile_name (str) – profileName query parameter. Wireless Network Profile Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-wireless-profile

provision_update(headers=None, payload=None, active_validation=True, **request_parameters)

Updates wireless provisioning .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!provision-update

provision(headers=None, payload=None, active_validation=True, **request_parameters)

Provision wireless devices .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!provision

psk_override(headers=None, payload=None, active_validation=True, **request_parameters)

Update/override pass phrase of enterprise SSID .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!psk-override

retrieve_rf_profiles(rf_profile_name=None, headers=None, **request_parameters)

Retrieve all RF profiles .

Parameters:

• rf_profile_name (str) – rf-profile-name query parameter. RF Profile Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieve-rf-profiles

create_or_update_rf_profile(channelWidth=None, defaultRfProfile=None, enableBrownField=None, enableCustom=None, enableRadioTypeA=None, enableRadioTypeB=None, enableRadioTypeC=None, name=None, radioTypeAProperties=None, radioTypeBProperties=None, radioTypeCProperties=None, headers=None, payload=None, active_validation=True, **request_parameters)

Create or Update RF profile .

Parameters:

• channelWidth (string) – Wireless’s Channel Width .

• defaultRfProfile (boolean) – Wireless’s is Default Rf Profile .

• enableBrownField (boolean) – Wireless’s Enable Brown Field .

• enableCustom (boolean) – Wireless’s Enable Custom .

• enableRadioTypeA (boolean) – Wireless’s Enable Radio Type A .

• enableRadioTypeB (boolean) – Wireless’s Enable Radio Type B .

• enableRadioTypeC (boolean) – Wireless’s Enable Radio Type C (6GHz) .

• name (string) – Wireless’s RF Profile Name .

• radioTypeAProperties (object) – Wireless’s radioTypeAProperties.

• radioTypeBProperties (object) – Wireless’s radioTypeBProperties.

• radioTypeCProperties (object) – Wireless’s radioTypeCProperties.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-or-update-rf-profile

delete_rf_profiles(rf_profile_name, headers=None, **request_parameters)

Delete RF profile(s) .

Parameters:

• rf_profile_name (str) – rfProfileName path parameter. RF profile name to be deleted(required) *non- custom RF profile cannot be deleted .

• headers (dict) – Dictionary of HTTP Headers to send with the Request.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-rf-profiles

DNACenterAPI v2.3.7.6

ai_endpoint_analytics

class AIEndpointAnalytics

Cisco DNA Center AI Endpoint Analytics API (version: 2.3.7.6).

Wraps the DNA Center AI Endpoint Analytics API and exposes the API as native Python methods that return native Python objects.

get_anc_policies_v1(headers=None, **request_parameters)

Fetches the list of ANC policies available in ISE. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-anc-policies

process_cmdb_endpoints_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Processes incoming CMDB endpoints data and imports the same in AI Endpoint Analytics. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!process-cmdb-endpoints

get_ai_endpoint_analytics_attribute_dictionaries_v1(include_attributes=None, headers=None, **request_parameters)

Fetches the list of attribute dictionaries. .

Parameters:

• include_attributes (bool) – includeAttributes query parameter. Flag to indicate whether attribute list for each dictionary should be included in response. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-ai-endpoint-analytics-attribute-dictionaries

register_an_endpoint_v1(deviceType=None, hardwareManufacturer=None, hardwareModel=None, macAddress=None, headers=None, payload=None, active_validation=True, **request_parameters)

Register a new endpoint in the system. .

Parameters:

• deviceType (string) – AI Endpoint Analytics’s Type of the device represented by this endpoint. .

• hardwareManufacturer (string) – AI Endpoint Analytics’s Hardware manufacturer for the endpoint. .

• hardwareModel (string) – AI Endpoint Analytics’s Hardware model of the endpoint. .

• macAddress (string) – AI Endpoint Analytics’s MAC address of the endpoint. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!register-an-endpoint

query_the_endpoints_v1(ai_spoofing_trust_level=None, anc_policy=None, auth_method=None, changed_profile_trust_level=None, concurrent_mac_trust_level=None, device_type=None, hardware_manufacturer=None, hardware_model=None, include=None, ip=None, ip_blocklist_detected=None, limit=None, mac_address=None, mac_addresses=None, nat_trust_level=None, offset=None, operating_system=None, order=None, posture_status=None, profiling_status=None, random_mac=None, registered=None, sort_by=None, trust_score=None, unauth_port_detected=None, weak_cred_detected=None, headers=None, **request_parameters)

Query the endpoints, optionally using various filter and pagination criteria. ‘GET /endpoints/count’ API can be used to find out the total number of endpoints matching the filter criteria. .

Parameters:

• profiling_status (str) – profilingStatus query parameter. Profiling status of the endpoint. Possible values are ‘profiled’, ‘partialProfiled’, ‘notProfiled’. .

• mac_address (str) – macAddress query parameter. MAC address to search for. Partial string is allowed. .

• mac_addresses (str, list, set, tuple) – macAddresses query parameter. List of MAC addresses to filter on. Only exact matches will be returned. .

• ip (str) – ip query parameter. IP address to search for. Partial string is allowed. .

• device_type (str) – deviceType query parameter. Type of device to search for. Partial string is allowed. .

• hardware_manufacturer (str) – hardwareManufacturer query parameter. Hardware manufacturer to search for. Partial string is allowed. .

• hardware_model (str) – hardwareModel query parameter. Hardware model to search for. Partial string is allowed. .

• operating_system (str) – operatingSystem query parameter. Operating system to search for. Partial string is allowed. .

• registered (bool) – registered query parameter. Flag to fetch manually registered or non-registered endpoints. .

• random_mac (bool) – randomMac query parameter. Flag to fetch endpoints having randomized MAC or not. .

• trust_score (str) – trustScore query parameter. Overall trust score of the endpoint. It can be provided either as a number value (e.g. 5), or as a range (e.g. 3-7). Provide value as ‘-’ if you want to search for all endpoints where trust score is not assigned. .

• auth_method (str) – authMethod query parameter. Authentication method. Partial string is allowed. .

• posture_status (str) – postureStatus query parameter. Posture status. .

• ai_spoofing_trust_level (str) – aiSpoofingTrustLevel query parameter. Trust level of the endpoint due to AI spoofing. Possible values are ‘low’, ‘medium’, ‘high’. .

• changed_profile_trust_level (str) – changedProfileTrustLevel query parameter. Trust level of the endpoint due to changing profile labels. Possible values are ‘low’, ‘medium’, ‘high’. .

• nat_trust_level (str) – natTrustLevel query parameter. Trust level of the endpoint due to NAT access. Possible values are ‘low’, ‘medium’, ‘high’. .

• concurrent_mac_trust_level (str) – concurrentMacTrustLevel query parameter. Trust level of the endpoint due to concurrent MAC address. Possible values are ‘low’, ‘medium’, ‘high’. .

• ip_blocklist_detected (bool) – ipBlocklistDetected query parameter. Flag to fetch endpoints hitting IP blocklist or not. .

• unauth_port_detected (bool) – unauthPortDetected query parameter. Flag to fetch endpoints exposing unauthorized ports or not. .

• weak_cred_detected (bool) – weakCredDetected query parameter. Flag to fetch endpoints having weak credentials or not. .

• anc_policy (str) – ancPolicy query parameter. ANC policy. Only exact match will be returned. .

• limit (int) – limit query parameter. Maximum number of records to be fetched. If not provided, 50 records will be fetched by default. Maximum 1000 records can be fetched at a time. Use pagination if more records need to be fetched. .

• offset (int) – offset query parameter. Record offset to start data fetch at. Offset starts at zero. .

• sort_by (str) – sortBy query parameter. Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested. Possible values are ‘macAddress’, ‘ip’. .

• order (str) – order query parameter. Order to be used for sorting. Possible values are ‘asc’, ‘desc’. .

• include (str) – include query parameter. The datasets that should be included in the response. By default, value of this parameter is blank, and the response will include only basic details of the endpoint. To include other datasets or dictionaries, send comma separated list of following values: ‘ALL’ Include all attributes. ‘CDP’, ‘DHCP’, etc. Include attributes from given dictionaries. To get full list of dictionaries, use corresponding GET API. ‘ANC’ Include ANC policy related details. ‘TRUST’ Include trust score details. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!query-the-endpoints

fetch_the_count_of_endpoints_v1(ai_spoofing_trust_level=None, anc_policy=None, auth_method=None, changed_profile_trust_level=None, concurrent_mac_trust_level=None, device_type=None, hardware_manufacturer=None, hardware_model=None, ip=None, ip_blocklist_detected=None, mac_address=None, mac_addresses=None, nat_trust_level=None, operating_system=None, posture_status=None, profiling_status=None, random_mac=None, registered=None, trust_score=None, unauth_port_detected=None, weak_cred_detected=None, headers=None, **request_parameters)

Fetch the total count of endpoints that match the given filter criteria. .

Parameters:

• profiling_status (str) – profilingStatus query parameter. Profiling status of the endpoint. Possible values are ‘profiled’, ‘partialProfiled’, ‘notProfiled’. .

• mac_address (str) – macAddress query parameter. MAC address to search for. Partial string is allowed. .

• mac_addresses (str, list, set, tuple) – macAddresses query parameter. List of MAC addresses to filter on. Only exact matches will be returned. .

• ip (str) – ip query parameter. IP address to search for. Partial string is allowed. .

• device_type (str) – deviceType query parameter. Type of device to search for. Partial string is allowed. .

• hardware_manufacturer (str) – hardwareManufacturer query parameter. Hardware manufacturer to search for. Partial string is allowed. .

• hardware_model (str) – hardwareModel query parameter. Hardware model to search for. Partial string is allowed. .

• operating_system (str) – operatingSystem query parameter. Operating system to search for. Partial string is allowed. .

• registered (bool) – registered query parameter. Flag to fetch manually registered or non-registered endpoints. .

• random_mac (bool) – randomMac query parameter. Flag to fetch endpoints having randomized MAC or not. .

• trust_score (str) – trustScore query parameter. Overall trust score of the endpoint. It can be provided either as a number value (e.g. 5), or as a range (e.g. 3-7). Provide value as ‘-’ if you want to search for all endpoints where trust score is not assigned. .

• auth_method (str) – authMethod query parameter. Authentication method. Partial string is allowed. .

• posture_status (str) – postureStatus query parameter. Posture status. .

• ai_spoofing_trust_level (str) – aiSpoofingTrustLevel query parameter. Trust level of the endpoint due to AI spoofing. Possible values are ‘low’, ‘medium’, ‘high’. .

• changed_profile_trust_level (str) – changedProfileTrustLevel query parameter. Trust level of the endpoint due to changing profile labels. Possible values are ‘low’, ‘medium’, ‘high’. .

• nat_trust_level (str) – natTrustLevel query parameter. Trust level of the endpoint due to NAT access. Possible values are ‘low’, ‘medium’, ‘high’. .

• concurrent_mac_trust_level (str) – concurrentMacTrustLevel query parameter. Trust level of the endpoint due to concurrent MAC address. Possible values are ‘low’, ‘medium’, ‘high’. .

• ip_blocklist_detected (bool) – ipBlocklistDetected query parameter. Flag to fetch endpoints hitting IP blocklist or not. .

• unauth_port_detected (bool) – unauthPortDetected query parameter. Flag to fetch endpoints exposing unauthorized ports or not. .

• weak_cred_detected (bool) – weakCredDetected query parameter. Flag to fetch endpoints having weak credentials or not. .

• anc_policy (str) – ancPolicy query parameter. ANC policy. Only exact match will be returned. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!fetch-the-count-of-endpoints

update_a_registered_endpoint_v1(ep_id, deviceType=None, hardwareManufacturer=None, hardwareModel=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update attributes of a registered endpoint. .

Parameters:

• deviceType (string) – AI Endpoint Analytics’s Type of the device represented by this endpoint. .

• hardwareManufacturer (string) – AI Endpoint Analytics’s Hardware manufacturer for the endpoint. .

• hardwareModel (string) – AI Endpoint Analytics’s Hardware model of the endpoint. .

• ep_id (str) – epId path parameter. Unique identifier for the endpoint. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-a-registered-endpoint

get_endpoint_details_v1(ep_id, include=None, headers=None, **request_parameters)

Fetches details of the endpoint for the given unique identifier ‘epId’. .

Parameters:

• ep_id (str) – epId path parameter. Unique identifier for the endpoint. .

• include (str) – include query parameter. The datasets that should be included in the response. By default, value of this parameter is blank, and the response will include only basic details of the endpoint. To include other datasets or dictionaries, send comma separated list of following values: ‘ALL’ Include all attributes. ‘CDP’, ‘DHCP’, etc. Include attributes from given dictionaries. To get full list of dictionaries, use corresponding GET API. ‘ANC’ Include ANC policy related details. ‘TRUST’ Include trust score details. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-endpoint-details

delete_an_endpoint_v1(ep_id, headers=None, **request_parameters)

Deletes the endpoint for the given unique identifier ‘epId’. .

Parameters:

• ep_id (str) – epId path parameter. Unique identifier for the endpoint. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-an-endpoint

apply_anc_policy_v1(ep_id, ancPolicy=None, granularAncPolicy=None, headers=None, payload=None, active_validation=True, **request_parameters)

Applies given ANC policy to the endpoint. .

Parameters:

• ancPolicy (string) – AI Endpoint Analytics’s ANC policy name. .

• granularAncPolicy (list) – AI Endpoint Analytics’s granularAncPolicy (list of objects).

• ep_id (str) – epId path parameter. Unique identifier for the endpoint. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!apply-anc-policy

revoke_anc_policy_v1(ep_id, headers=None, **request_parameters)

Revokes given ANC policy from the endpoint. .

Parameters:

• ep_id (str) – epId path parameter. Unique identifier for the endpoint. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!revoke-anc-policy

create_a_profiling_rule_v1(clusterId=None, conditionGroups=None, isDeleted=None, lastModifiedBy=None, lastModifiedOn=None, pluginId=None, rejected=None, result=None, ruleId=None, ruleName=None, rulePriority=None, ruleType=None, ruleVersion=None, sourcePriority=None, usedAttributes=None, headers=None, payload=None, active_validation=True, **request_parameters)

Creates profiling rule from the request body. .

Parameters:

• clusterId (string) – AI Endpoint Analytics’s Unique identifier for ML cluster. Only applicable for ‘ML Rule’. .

• conditionGroups (object) – AI Endpoint Analytics’s conditionGroups.

• isDeleted (boolean) – AI Endpoint Analytics’s Flag to indicate whether the rule was deleted. .

• lastModifiedBy (string) – AI Endpoint Analytics’s User that last modified the rule. It is read-only, and is ignored if provided as part of input request. .

• lastModifiedOn (integer) – AI Endpoint Analytics’s Timestamp (in epoch milliseconds) of last modification. It is read-only, and is ignored if provided as part of input request. .

• pluginId (string) – AI Endpoint Analytics’s Plugin for the rule. Only applicable for ‘Cisco Default’ rules. .

• rejected (boolean) – AI Endpoint Analytics’s Flag to indicate whether rule has been rejected by user or not. Only applicable for ‘ML Rule’. .

• result (object) – AI Endpoint Analytics’s result.

• ruleId (string) – AI Endpoint Analytics’s Unique identifier for the rule. This is normally generated by the system, and client does not need to provide it for rules that need to be newly created. .

• ruleName (string) – AI Endpoint Analytics’s Human readable name for the rule. .

• rulePriority (integer) – AI Endpoint Analytics’s Priority for the rule. .

• ruleType (string) – AI Endpoint Analytics’s Type of the rule. . Available values are ‘Cisco Default - Static’, ‘Cisco Default - Dynamic’, ‘Custom Rule’ and ‘ML Rule’.

• ruleVersion (integer) – AI Endpoint Analytics’s Version of the rule. .

• sourcePriority (integer) – AI Endpoint Analytics’s Source priority for the rule. .

• usedAttributes (list) – AI Endpoint Analytics’s List of attributes used in the rule. Only applicable for ‘Cisco Default’ rules. (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-a-profiling-rule

get_list_of_profiling_rules_v1(include_deleted=None, limit=None, offset=None, order=None, rule_type=None, sort_by=None, headers=None, **request_parameters)

This API fetches the list of profiling rules. It can be used to show profiling rules in client applications, or export those from an environment. ‘POST /profiling-rules/bulk’ API can be used to import such exported rules into another environment. If this API is used to export rules to be imported into another Cisco DNACenter system, then ensure that ‘includeDeleted’ parameter is ‘true’, so that deleted rules get synchronized correctly. Use query parameters to filter the data, as required. If no filter is provided, then it will include only rules of type ‘Custom Rule’ in the response. By default, the response is limited to 500 records. Use ‘limit’ parameter to fetch higher number of records, if required. ‘GET /profiling-rules/count’ API can be used to find out the total number of rules in the system. .

Parameters:

• rule_type (str) – ruleType query parameter. Use comma-separated list of rule types to filter the data. Defaults to ‘Custom Rule’. .

• include_deleted (bool) – includeDeleted query parameter. Flag to indicate whether deleted rules should be part of the records fetched. .

• limit (int) – limit query parameter. Maximum number of records to be fetched. If not provided, 500 records will be fetched by default. To fetch all the records in the system, provide a large value for this parameter. .

• offset (int) – offset query parameter. Record offset to start data fetch at. Offset starts at zero. .

• sort_by (str) – sortBy query parameter. Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested. .

• order (str) – order query parameter. Order to be used for sorting. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-list-of-profiling-rules

import_profiling_rules_in_bulk_v1(profilingRules=None, headers=None, payload=None, active_validation=True, **request_parameters)

This API imports the given list of profiling rules. For each record, 1) If ‘ruleType’ for a record is not ‘Custom Rule’, then it is rejected. 2) If ‘ruleId’ is provided in the input record, 2a) Record with same ‘ruleId’ exists in the system, then it is replaced with new data. 2b) Record with same ‘ruleId’ does not exist, then it is inserted in the database. 3) If ‘ruleId’ is not provided in the input record, then new ‘ruleId’ is generated by the system, and record is inserted. .

Parameters:

• profilingRules (list) – AI Endpoint Analytics’s profilingRules (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!import-profiling-rules-in-bulk

get_count_of_profiling_rules_v1(include_deleted=None, rule_type=None, headers=None, **request_parameters)

This API fetches the count of profiling rules based on the filter values provided in the query parameters. The filter parameters are same as that of ‘GET /profiling-rules’ API, excluding the pagination and sort parameters. .

Parameters:

• rule_type (str) – ruleType query parameter. Use comma-separated list of rule types to filter the data. Defaults to ‘Custom Rule’. .

• include_deleted (bool) – includeDeleted query parameter. Flag to indicate whether deleted rules should be part of the records fetched. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-count-of-profiling-rules

update_an_existing_profiling_rule_v1(rule_id, clusterId=None, conditionGroups=None, isDeleted=None, lastModifiedBy=None, lastModifiedOn=None, pluginId=None, rejected=None, result=None, ruleId=None, ruleName=None, rulePriority=None, ruleType=None, ruleVersion=None, sourcePriority=None, usedAttributes=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates the profiling rule for the given ‘ruleId’. .

Parameters:

• clusterId (string) – AI Endpoint Analytics’s Unique identifier for ML cluster. Only applicable for ‘ML Rule’. .

• conditionGroups (object) – AI Endpoint Analytics’s conditionGroups.

• isDeleted (boolean) – AI Endpoint Analytics’s Flag to indicate whether the rule was deleted. .

• lastModifiedBy (string) – AI Endpoint Analytics’s User that last modified the rule. It is read-only, and is ignored if provided as part of input request. .

• lastModifiedOn (integer) – AI Endpoint Analytics’s Timestamp (in epoch milliseconds) of last modification. It is read-only, and is ignored if provided as part of input request. .

• pluginId (string) – AI Endpoint Analytics’s Plugin for the rule. Only applicable for ‘Cisco Default’ rules. .

• rejected (boolean) – AI Endpoint Analytics’s Flag to indicate whether rule has been rejected by user or not. Only applicable for ‘ML Rule’. .

• result (object) – AI Endpoint Analytics’s result.

• ruleId (string) – AI Endpoint Analytics’s Unique identifier for the rule. This is normally generated by the system, and client does not need to provide it for rules that need to be newly created. .

• ruleName (string) – AI Endpoint Analytics’s Human readable name for the rule. .

• rulePriority (integer) – AI Endpoint Analytics’s Priority for the rule. .

• ruleType (string) – AI Endpoint Analytics’s Type of the rule. . Available values are ‘Cisco Default - Static’, ‘Cisco Default - Dynamic’, ‘Custom Rule’ and ‘ML Rule’.

• ruleVersion (integer) – AI Endpoint Analytics’s Version of the rule. .

• sourcePriority (integer) – AI Endpoint Analytics’s Source priority for the rule. .

• usedAttributes (list) – AI Endpoint Analytics’s List of attributes used in the rule. Only applicable for ‘Cisco Default’ rules. (list of strings).

• rule_id (str) – ruleId path parameter. Unique rule identifier .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-an-existing-profiling-rule

get_details_of_a_single_profiling_rule_v1(rule_id, headers=None, **request_parameters)

Fetches details of the profiling rule for the given ‘ruleId’. .

Parameters:

• rule_id (str) – ruleId path parameter. Unique rule identifier .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-details-of-a-single-profiling-rule

delete_an_existing_profiling_rule_v1(rule_id, headers=None, **request_parameters)

Deletes the profiling rule for the given ‘ruleId’. .

Parameters:

• rule_id (str) – ruleId path parameter. Unique rule identifier .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-an-existing-profiling-rule

get_task_details_v1(task_id, headers=None, **request_parameters)

Fetches the details of backend task. Task is typically created by making call to some other API that takes longer time to execute. .

Parameters:

• task_id (str) – taskId path parameter. Unique identifier for the task. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-task-details

update_an_existing_profiling_rule(rule_id, clusterId=None, conditionGroups=None, isDeleted=None, lastModifiedBy=None, lastModifiedOn=None, pluginId=None, rejected=None, result=None, ruleId=None, ruleName=None, rulePriority=None, ruleType=None, ruleVersion=None, sourcePriority=None, usedAttributes=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_an_existing_profiling_rule_v1. .

Parameters:

• clusterId (string) – AI Endpoint Analytics’s Unique identifier for ML cluster. Only applicable for ‘ML Rule’. .

• conditionGroups (object) – AI Endpoint Analytics’s conditionGroups.

• isDeleted (boolean) – AI Endpoint Analytics’s Flag to indicate whether the rule was deleted. .

• lastModifiedBy (string) – AI Endpoint Analytics’s User that last modified the rule. It is read-only, and is ignored if provided as part of input request. .

• lastModifiedOn (integer) – AI Endpoint Analytics’s Timestamp (in epoch milliseconds) of last modification. It is read-only, and is ignored if provided as part of input request. .

• pluginId (string) – AI Endpoint Analytics’s Plugin for the rule. Only applicable for ‘Cisco Default’ rules. .

• rejected (boolean) – AI Endpoint Analytics’s Flag to indicate whether rule has been rejected by user or not. Only applicable for ‘ML Rule’. .

• result (object) – AI Endpoint Analytics’s result.

• ruleId (string) – AI Endpoint Analytics’s Unique identifier for the rule. This is normally generated by the system, and client does not need to provide it for rules that need to be newly created. .

• ruleName (string) – AI Endpoint Analytics’s Human readable name for the rule. .

• rulePriority (integer) – AI Endpoint Analytics’s Priority for the rule. .

• ruleType (string) – AI Endpoint Analytics’s Type of the rule. . Available values are ‘Cisco Default - Static’, ‘Cisco Default - Dynamic’, ‘Custom Rule’ and ‘ML Rule’.

• ruleVersion (integer) – AI Endpoint Analytics’s Version of the rule. .

• sourcePriority (integer) – AI Endpoint Analytics’s Source priority for the rule. .

• usedAttributes (list) – AI Endpoint Analytics’s List of attributes used in the rule. Only applicable for ‘Cisco Default’ rules. (list of strings).

• rule_id (str) – ruleId path parameter. Unique rule identifier .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of the function update_an_existing_profiling_rule_v1.

update_a_registered_endpoint(ep_id, deviceType=None, hardwareManufacturer=None, hardwareModel=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_a_registered_endpoint_v1. .

Parameters:

• deviceType (string) – AI Endpoint Analytics’s Type of the device represented by this endpoint. .

• hardwareManufacturer (string) – AI Endpoint Analytics’s Hardware manufacturer for the endpoint. .

• hardwareModel (string) – AI Endpoint Analytics’s Hardware model of the endpoint. .

• ep_id (str) – epId path parameter. Unique identifier for the endpoint. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of the function update_a_registered_endpoint_v1.

register_an_endpoint(deviceType=None, hardwareManufacturer=None, hardwareModel=None, macAddress=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of register_an_endpoint_v1. .

Parameters:

• deviceType (string) – AI Endpoint Analytics’s Type of the device represented by this endpoint. .

• hardwareManufacturer (string) – AI Endpoint Analytics’s Hardware manufacturer for the endpoint. .

• hardwareModel (string) – AI Endpoint Analytics’s Hardware model of the endpoint. .

• macAddress (string) – AI Endpoint Analytics’s MAC address of the endpoint. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of the function register_an_endpoint_v1.

apply_anc_policy(ep_id, ancPolicy=None, granularAncPolicy=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of apply_anc_policy_v1. .

Parameters:

• ancPolicy (string) – AI Endpoint Analytics’s ANC policy name. .

• granularAncPolicy (list) – AI Endpoint Analytics’s granularAncPolicy (list of objects).

• ep_id (str) – epId path parameter. Unique identifier for the endpoint. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of the apply_anc_policy_v1.

process_cmdb_endpoints(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of process_cmdb_endpoints_v1. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of the process_cmdb_endpoints_v1.

get_details_of_a_single_profiling_rule(rule_id, headers=None, **request_parameters)

This function is an alias of get_details_of_a_single_profiling_rule_v1. .

Parameters:

• rule_id (str) – ruleId path parameter. Unique rule identifier .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of the get_details_of_a_single_profiling_rule_v1.

get_anc_policies(headers=None, **request_parameters)

This function is an alias of get_anc_policies_v1. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_anc_policies_v1.

create_a_profiling_rule(clusterId=None, conditionGroups=None, isDeleted=None, lastModifiedBy=None, lastModifiedOn=None, pluginId=None, rejected=None, result=None, ruleId=None, ruleName=None, rulePriority=None, ruleType=None, ruleVersion=None, sourcePriority=None, usedAttributes=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_a_profiling_rule_v1. .

Parameters:

• clusterId (string) – AI Endpoint Analytics’s Unique identifier for ML cluster. Only applicable for ‘ML Rule’. .

• conditionGroups (object) – AI Endpoint Analytics’s conditionGroups.

• isDeleted (boolean) – AI Endpoint Analytics’s Flag to indicate whether the rule was deleted. .

• lastModifiedBy (string) – AI Endpoint Analytics’s User that last modified the rule. It is read-only, and is ignored if provided as part of input request. .

• lastModifiedOn (integer) – AI Endpoint Analytics’s Timestamp (in epoch milliseconds) of last modification. It is read-only, and is ignored if provided as part of input request. .

• pluginId (string) – AI Endpoint Analytics’s Plugin for the rule. Only applicable for ‘Cisco Default’ rules. .

• rejected (boolean) – AI Endpoint Analytics’s Flag to indicate whether rule has been rejected by user or not. Only applicable for ‘ML Rule’. .

• result (object) – AI Endpoint Analytics’s result.

• ruleId (string) – AI Endpoint Analytics’s Unique identifier for the rule. This is normally generated by the system, and client does not need to provide it for rules that need to be newly created. .

• ruleName (string) – AI Endpoint Analytics’s Human readable name for the rule. .

• rulePriority (integer) – AI Endpoint Analytics’s Priority for the rule. .

• ruleType (string) – AI Endpoint Analytics’s Type of the rule. . Available values are ‘Cisco Default - Static’, ‘Cisco Default - Dynamic’, ‘Custom Rule’ and ‘ML Rule’.

• ruleVersion (integer) – AI Endpoint Analytics’s Version of the rule. .

• sourcePriority (integer) – AI Endpoint Analytics’s Source priority for the rule. .

• usedAttributes (list) – AI Endpoint Analytics’s List of attributes used in the rule. Only applicable for ‘Cisco Default’ rules. (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_a_profiling_rule_v1.

query_the_endpoints(ai_spoofing_trust_level=None, anc_policy=None, auth_method=None, changed_profile_trust_level=None, concurrent_mac_trust_level=None, device_type=None, hardware_manufacturer=None, hardware_model=None, include=None, ip=None, ip_blocklist_detected=None, limit=None, mac_address=None, mac_addresses=None, nat_trust_level=None, offset=None, operating_system=None, order=None, posture_status=None, profiling_status=None, random_mac=None, registered=None, sort_by=None, trust_score=None, unauth_port_detected=None, weak_cred_detected=None, headers=None, **request_parameters)

This function is an alias of query_the_endpoints_v1. .

Parameters:

• profiling_status (str) – profilingStatus query parameter. Profiling status of the endpoint. Possible values are ‘profiled’, ‘partialProfiled’, ‘notProfiled’. .

• mac_address (str) – macAddress query parameter. MAC address to search for. Partial string is allowed. .

• mac_addresses (str, list, set, tuple) – macAddresses query parameter. List of MAC addresses to filter on. Only exact matches will be returned. .

• ip (str) – ip query parameter. IP address to search for. Partial string is allowed. .

• device_type (str) – deviceType query parameter. Type of device to search for. Partial string is allowed. .

• hardware_manufacturer (str) – hardwareManufacturer query parameter. Hardware manufacturer to search for. Partial string is allowed. .

• hardware_model (str) – hardwareModel query parameter. Hardware model to search for. Partial string is allowed. .

• operating_system (str) – operatingSystem query parameter. Operating system to search for. Partial string is allowed. .

• registered (bool) – registered query parameter. Flag to fetch manually registered or non-registered endpoints. .

• random_mac (bool) – randomMac query parameter. Flag to fetch endpoints having randomized MAC or not. .

• trust_score (str) – trustScore query parameter. Overall trust score of the endpoint. It can be provided either as a number value (e.g. 5), or as a range (e.g. 3-7). Provide value as ‘-’ if you want to search for all endpoints where trust score is not assigned. .

• auth_method (str) – authMethod query parameter. Authentication method. Partial string is allowed. .

• posture_status (str) – postureStatus query parameter. Posture status. .

• ai_spoofing_trust_level (str) – aiSpoofingTrustLevel query parameter. Trust level of the endpoint due to AI spoofing. Possible values are ‘low’, ‘medium’, ‘high’. .

• changed_profile_trust_level (str) – changedProfileTrustLevel query parameter. Trust level of the endpoint due to changing profile labels. Possible values are ‘low’, ‘medium’, ‘high’. .

• nat_trust_level (str) – natTrustLevel query parameter. Trust level of the endpoint due to NAT access. Possible values are ‘low’, ‘medium’, ‘high’. .

• concurrent_mac_trust_level (str) – concurrentMacTrustLevel query parameter. Trust level of the endpoint due to concurrent MAC address. Possible values are ‘low’, ‘medium’, ‘high’. .

• ip_blocklist_detected (bool) – ipBlocklistDetected query parameter. Flag to fetch endpoints hitting IP blocklist or not. .

• unauth_port_detected (bool) – unauthPortDetected query parameter. Flag to fetch endpoints exposing unauthorized ports or not. .

• weak_cred_detected (bool) – weakCredDetected query parameter. Flag to fetch endpoints having weak credentials or not. .

• anc_policy (str) – ancPolicy query parameter. ANC policy. Only exact match will be returned. .

• limit (int) – limit query parameter. Maximum number of records to be fetched. If not provided, 50 records will be fetched by default. Maximum 1000 records can be fetched at a time. Use pagination if more records need to be fetched. .

• offset (int) – offset query parameter. Record offset to start data fetch at. Offset starts at zero. .

• sort_by (str) – sortBy query parameter. Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested. Possible values are ‘macAddress’, ‘ip’. .

• order (str) – order query parameter. Order to be used for sorting. Possible values are ‘asc’, ‘desc’. .

• include (str) – include query parameter. The datasets that should be included in the response. By default, value of this parameter is blank, and the response will include only basic details of the endpoint. To include other datasets or dictionaries, send comma separated list of following values: ‘ALL’ Include all attributes. ‘CDP’, ‘DHCP’, etc. Include attributes from given dictionaries. To get full list of dictionaries, use corresponding GET API. ‘ANC’ Include ANC policy related details. ‘TRUST’ Include trust score details. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of query_the_endpoints_v1.

revoke_anc_policy(ep_id, headers=None, **request_parameters)

This function is an alias of revoke_anc_policy_v1. .

Parameters:

• ep_id (str) – epId path parameter. Unique identifier for the endpoint. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of revoke_anc_policy_v1.

get_list_of_profiling_rules(include_deleted=None, limit=None, offset=None, order=None, rule_type=None, sort_by=None, headers=None, **request_parameters)

This function is an alias of get_list_of_profiling_rules_v1. .

Parameters:

• rule_type (str) – ruleType query parameter. Use comma-separated list of rule types to filter the data. Defaults to ‘Custom Rule’. .

• include_deleted (bool) – includeDeleted query parameter. Flag to indicate whether deleted rules should be part of the records fetched. .

• limit (int) – limit query parameter. Maximum number of records to be fetched. If not provided, 500 records will be fetched by default. To fetch all the records in the system, provide a large value for this parameter. .

• offset (int) – offset query parameter. Record offset to start data fetch at. Offset starts at zero. .

• sort_by (str) – sortBy query parameter. Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested. .

• order (str) – order query parameter. Order to be used for sorting. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_list_of_profiling_rules_v1.

get_task_details(task_id, headers=None, **request_parameters)

This function is an alias of get_task_details_v1. .

Parameters:

• task_id (str) – taskId path parameter. Unique identifier for the task. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_task_details_v1.

get_ai_endpoint_analytics_attribute_dictionaries(include_attributes=None, headers=None, **request_parameters)

This function is an alias of get_ai_endpoint_analytics_attribute_dictionaries_v1. .

Parameters:

• include_attributes (bool) – includeAttributes query parameter. Flag to indicate whether attribute list for each dictionary should be included in response. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_ai_endpoint_analytics_attribute_dictionaries_v1.

fetch_the_count_of_endpoints(ai_spoofing_trust_level=None, anc_policy=None, auth_method=None, changed_profile_trust_level=None, concurrent_mac_trust_level=None, device_type=None, hardware_manufacturer=None, hardware_model=None, ip=None, ip_blocklist_detected=None, mac_address=None, mac_addresses=None, nat_trust_level=None, operating_system=None, posture_status=None, profiling_status=None, random_mac=None, registered=None, trust_score=None, unauth_port_detected=None, weak_cred_detected=None, headers=None, **request_parameters)

This function is an alias of fetch_the_count_of_endpoints_v1. .

Parameters:

• profiling_status (str) – profilingStatus query parameter. Profiling status of the endpoint. Possible values are ‘profiled’, ‘partialProfiled’, ‘notProfiled’. .

• mac_address (str) – macAddress query parameter. MAC address to search for. Partial string is allowed. .

• mac_addresses (str, list, set, tuple) – macAddresses query parameter. List of MAC addresses to filter on. Only exact matches will be returned. .

• ip (str) – ip query parameter. IP address to search for. Partial string is allowed. .

• device_type (str) – deviceType query parameter. Type of device to search for. Partial string is allowed. .

• hardware_manufacturer (str) – hardwareManufacturer query parameter. Hardware manufacturer to search for. Partial string is allowed. .

• hardware_model (str) – hardwareModel query parameter. Hardware model to search for. Partial string is allowed. .

• operating_system (str) – operatingSystem query parameter. Operating system to search for. Partial string is allowed. .

• registered (bool) – registered query parameter. Flag to fetch manually registered or non-registered endpoints. .

• random_mac (bool) – randomMac query parameter. Flag to fetch endpoints having randomized MAC or not. .

• trust_score (str) – trustScore query parameter. Overall trust score of the endpoint. It can be provided either as a number value (e.g. 5), or as a range (e.g. 3-7). Provide value as ‘-’ if you want to search for all endpoints where trust score is not assigned. .

• auth_method (str) – authMethod query parameter. Authentication method. Partial string is allowed. .

• posture_status (str) – postureStatus query parameter. Posture status. .

• ai_spoofing_trust_level (str) – aiSpoofingTrustLevel query parameter. Trust level of the endpoint due to AI spoofing. Possible values are ‘low’, ‘medium’, ‘high’. .

• changed_profile_trust_level (str) – changedProfileTrustLevel query parameter. Trust level of the endpoint due to changing profile labels. Possible values are ‘low’, ‘medium’, ‘high’. .

• nat_trust_level (str) – natTrustLevel query parameter. Trust level of the endpoint due to NAT access. Possible values are ‘low’, ‘medium’, ‘high’. .

• concurrent_mac_trust_level (str) – concurrentMacTrustLevel query parameter. Trust level of the endpoint due to concurrent MAC address. Possible values are ‘low’, ‘medium’, ‘high’. .

• ip_blocklist_detected (bool) – ipBlocklistDetected query parameter. Flag to fetch endpoints hitting IP blocklist or not. .

• unauth_port_detected (bool) – unauthPortDetected query parameter. Flag to fetch endpoints exposing unauthorized ports or not. .

• weak_cred_detected (bool) – weakCredDetected query parameter. Flag to fetch endpoints having weak credentials or not. .

• anc_policy (str) – ancPolicy query parameter. ANC policy. Only exact match will be returned. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of fetch_the_count_of_endpoints_v1.

import_profiling_rules_in_bulk(profilingRules=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of import_profiling_rules_in_bulk_v1. .

Parameters:

• profilingRules (list) – AI Endpoint Analytics’s profilingRules (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of import_profiling_rules_in_bulk_v1.

delete_an_existing_profiling_rule(rule_id, headers=None, **request_parameters)

This function is an alias of delete_an_existing_profiling_rule_v1. .

Parameters:

• rule_id (str) – ruleId path parameter. Unique rule identifier .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_an_existing_profiling_rule_v1.

get_endpoint_details(ep_id, include=None, headers=None, **request_parameters)

This function is an alias of get_endpoint_details_v1. .

Parameters:

• ep_id (str) – epId path parameter. Unique identifier for the endpoint. .

• include (str) – include query parameter. The datasets that should be included in the response. By default, value of this parameter is blank, and the response will include only basic details of the endpoint. To include other datasets or dictionaries, send comma separated list of following values: ‘ALL’ Include all attributes. ‘CDP’, ‘DHCP’, etc. Include attributes from given dictionaries. To get full list of dictionaries, use corresponding GET API. ‘ANC’ Include ANC policy related details. ‘TRUST’ Include trust score details. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_endpoint_details_v1 .

get_count_of_profiling_rules(include_deleted=None, rule_type=None, headers=None, **request_parameters)

This function is an alias of get_count_of_profiling_rules_v1. .

Parameters:

• rule_type (str) – ruleType query parameter. Use comma-separated list of rule types to filter the data. Defaults to ‘Custom Rule’. .

• include_deleted (bool) – includeDeleted query parameter. Flag to indicate whether deleted rules should be part of the records fetched. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_count_of_profiling_rules_v1.

delete_an_endpoint(ep_id, headers=None, **request_parameters)

This function is an alias of delete_an_endpoint_v1. .

Parameters:

• ep_id (str) – epId path parameter. Unique identifier for the endpoint. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_an_endpoint_v1.

application_policy

class ApplicationPolicy

Cisco DNA Center Application Policy API (version: 2.3.7.6).

Wraps the DNA Center Application Policy API and exposes the API as native Python methods that return native Python objects.

get_application_policy_v1(policy_scope=None, headers=None, **request_parameters)

Get all existing application policies .

Parameters:

• policy_scope (str) – policyScope query parameter. policy scope name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_policy_default_v1(headers=None, **request_parameters)

Get default application policy .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

application_policy_intent_v1(createList=None, deleteList=None, updateList=None, headers=None, payload=None, active_validation=True, **request_parameters)

Create/Update/Delete application policy .

Parameters:

• createList (list) – Application Policy’s createList (list of objects).

• deleteList (list) – Application Policy’s Delete list of Group Based Policy ids (list of strings).

• updateList (list) – Application Policy’s updateList (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_policy_queuing_profile_v1(name=None, headers=None, **request_parameters)

Get all or by name, existing application policy queuing profiles .

Parameters:

• name (str) – name query parameter. queuing profile name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

update_application_policy_queuing_profile_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Update existing custom application queuing profile .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_application_policy_queuing_profile_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Create new custom application queuing profile .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_policy_queuing_profile_count_v1(headers=None, **request_parameters)

Get the number of all existing application policy queuing profile .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

delete_application_policy_queuing_profile_v1(id, headers=None, **request_parameters)

Delete existing custom application policy queuing profile by id .

Parameters:

• id (str) – id path parameter. Id of custom queuing profile to delete .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_sets_v1(limit=None, name=None, offset=None, headers=None, **request_parameters)

Get appllication-sets by offset/limit or by name .

Parameters:

• offset (int) – offset query parameter.

• limit (int) – limit query parameter.

• name (str) – name query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

delete_application_set_v1(id, headers=None, **request_parameters)

Delete existing application-set by it’s id .

Parameters:

• id (str) – id query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_application_set_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Create new custom application-set/s .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_sets_count_v1(headers=None, **request_parameters)

Get the number of existing application-sets .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_application_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Create new Custom application .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

edit_application_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Edit the attributes of an existing application .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!edit-application

delete_application_v1(id, headers=None, **request_parameters)

Delete existing application by its id .

Parameters:

• id (str) – id query parameter. Application’s Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_applications_v1(limit=None, name=None, offset=None, headers=None, **request_parameters)

Get applications by offset/limit or by name .

Parameters:

• offset (int) – offset query parameter. The offset of the first application to be returned .

• limit (int) – limit query parameter. The maximum number of applications to be returned .

• name (str) – name query parameter. Application’s name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_applications_count_v1(headers=None, **request_parameters)

Get the number of all existing applications .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_qos_device_interface_info_v1(network_device_id=None, headers=None, **request_parameters)

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

Parameters:

• network_device_id (str) – networkDeviceId query parameter. network device id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

update_qos_device_interface_info_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Update existing qos device interface infos associate with network device id .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_qos_device_interface_info_v1(headers=None, payload=None, active_validation=True, **request_parameters)

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 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_qos_device_interface_info_count_v1(headers=None, **request_parameters)

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

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

delete_qos_device_interface_info_v1(id, headers=None, **request_parameters)

Delete all qos device interface infos associate with network device id .

Parameters:

• id (str) – id path parameter. Id of the qos device info, this object holds all qos device interface infos associate with network device id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_application_sets_v2(headers=None, payload=None, active_validation=True, **request_parameters)

Create new custom application set/s .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_sets_v2(attributes, limit, offset, name=None, headers=None, **request_parameters)

Get application set/s by offset/limit or by name .

Parameters:

• attributes (str) – attributes query parameter. Attributes to retrieve, valid value applicationSet .

• name (str) – name query parameter. Application set name .

• offset (int) – offset query parameter. The starting point or index from where the paginated results should begin. .

• limit (int) – limit query parameter. The limit which is the maximum number of items to include in a single page of results, max value 500 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_set_count_v2(scalable_group_type, headers=None, **request_parameters)

Get the number of all existing application sets .

Parameters:

• scalable_group_type (str) – scalableGroupType query parameter. Scalable group type to retrieve, valid value APPLICATION_GROUP .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

delete_application_set_v2(id, headers=None, **request_parameters)

Delete existing custom application set by id .

Parameters:

• id (str) – id path parameter. Id of custom application set to delete .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

edit_applications_v2(headers=None, payload=None, active_validation=True, **request_parameters)

Edit the attributes of an existing application .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_applications_v2(headers=None, payload=None, active_validation=True, **request_parameters)

Create new custom application/s .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_applications_v2(attributes, limit, offset, name=None, headers=None, **request_parameters)

Get application/s by offset/limit or by name .

Parameters:

• attributes (str) – attributes query parameter. Attributes to retrieve, valid value application .

• name (str) – name query parameter. The application name .

• offset (int) – offset query parameter. The starting point or index from where the paginated results should begin. .

• limit (int) – limit query parameter. The limit which is the maximum number of items to include in a single page of results, max value 500 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_count_v2(scalable_group_type, headers=None, **request_parameters)

Get the number of all existing applications .

Parameters:

• scalable_group_type (str) – scalableGroupType query parameter. scalable group type to retrieve, valid value APPLICATION .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

delete_application_v2(id, headers=None, **request_parameters)

Delete existing custom application by id .

Parameters:

• id (str) – id path parameter. Id of custom application to delete .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_application_policy_default(headers=None, **request_parameters)

This function is an alias of get_application_policy_default_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_application_policy_default_v1.

get_qos_device_interface_info(network_device_id=None, headers=None, **request_parameters)

This function is an alias of get_qos_device_interface_info_v1 .

Parameters:

• network_device_id (str) – networkDeviceId query parameter. network device id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_qos_device_interface_info_v1.

create_application(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_application_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_application_v1.

delete_application(id, headers=None, **request_parameters)

This function is an alias of delete_application_v1 .

Parameters:

• id (str) – id query parameter. Application’s Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_application_v1.

get_application_policy(policy_scope=None, headers=None, **request_parameters)

This function is an alias of get_application_policy_v1 .

Parameters:

• policy_scope (str) – policyScope query parameter. policy scope name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_application_policy_v1.

get_application_count(scalable_group_type, headers=None, **request_parameters)

This function is an alias of get_application_count_v2 .

Parameters:

• scalable_group_type (str) – scalableGroupType query parameter. scalable group type to retrieve, valid value APPLICATION .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_application_count_v2.

get_application_sets_count(headers=None, **request_parameters)

This function is an alias of get_application_sets_count_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_application_sets_count_v1.

edit_application(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of edit_application_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of edit_application_v1.

get_application_policy_queuing_profile_count(headers=None, **request_parameters)

This function is an alias of get_application_policy_queuing_profile_count_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_application_policy_queuing_profile_count_v1.

create_application_sets(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_application_sets_v2 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_application_sets_v2.

edit_applications(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of edit_applications_v2 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of edit_applications_v2.

get_application_set_count(scalable_group_type, headers=None, **request_parameters)

This function is an alias of get_application_set_count_v2 .

Parameters:

• scalable_group_type (str) – scalableGroupType query parameter. Scalable group type to retrieve, valid value APPLICATION_GROUP .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_application_set_count_v2.

create_applications(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_applications_v2 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_applications_v2.

get_applications(limit=None, name=None, offset=None, headers=None, **request_parameters)

This function is an alias of get_applications_v1 .

Parameters:

• offset (int) – offset query parameter. The offset of the first application to be returned .

• limit (int) – limit query parameter. The maximum number of applications to be returned .

• name (str) – name query parameter. Application’s name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_applications_v1.

delete_qos_device_interface_info(id, headers=None, **request_parameters)

This function is an alias of delete_qos_device_interface_info_v1 .

Parameters:

• id (str) – id path parameter. Id of the qos device info, this object holds all qos device interface infos associate with network device id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_qos_device_interface_info_v1.

get_qos_device_interface_info_count(headers=None, **request_parameters)

This function is an alias of get_qos_device_interface_info_count_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_qos_device_interface_info_count_v1.

application_policy_intent(createList=None, deleteList=None, updateList=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of application_policy_intent_v1 .

Parameters:

• createList (list) – Application Policy’s createList (list of objects).

• deleteList (list) – Application Policy’s Delete list of Group Based Policy ids (list of strings).

• updateList (list) – Application Policy’s updateList (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of application_policy_intent_v1.

get_application_policy_queuing_profile(name=None, headers=None, **request_parameters)

This function is an alias of get_application_policy_queuing_profile_v1 .

Parameters:

• name (str) – name query parameter. queuing profile name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_application_policy_queuing_profile_v1.

update_application_policy_queuing_profile(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_application_policy_queuing_profile_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_application_policy_queuing_profile_v1.

delete_application_set(id, headers=None, **request_parameters)

This function is an alias of delete_application_set_v1 .

Parameters:

• id (str) – id query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_application_set_v1.

get_application_sets(limit=None, name=None, offset=None, headers=None, **request_parameters)

This function is an alias of get_application_sets_v1 .

Parameters:

• offset (int) – offset query parameter.

• limit (int) – limit query parameter.

• name (str) – name query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_application_sets_v1.

update_qos_device_interface_info(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_qos_device_interface_info_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_qos_device_interface_info_v1.

get_applications_count(headers=None, **request_parameters)

This function is an alias of get_applications_count_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_applications_count_v1.

create_qos_device_interface_info(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_qos_device_interface_info_v1. :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_qos_device_interface_info_v1.

create_application_policy_queuing_profile(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_application_policy_queuing_profile_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_application_policy_queuing_profile_v1.

delete_application_policy_queuing_profile(id, headers=None, **request_parameters)

This function is an alias of delete_application_policy_queuing_profile_v1 .

Parameters:

• id (str) – id path parameter. Id of custom queuing profile to delete .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_application_policy_queuing_profile_v1.

create_application_set(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_application_set_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_application_set_v1.

applications

class Applications

Cisco DNA Center Applications API (version: 2.3.7.6).

Wraps the DNA Center Applications API and exposes the API as native Python methods that return native Python objects.

applications_v1(application_health=None, application_name=None, device_id=None, end_time=None, limit=None, mac_address=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)

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. .

Parameters:

• site_id (str) – siteId query parameter. Assurance site UUID value (Cannot be submitted together with deviceId and clientMac) .

• device_id (str) – deviceId query parameter. Assurance device UUID value (Cannot be submitted together with siteId and clientMac) .

• mac_address (str) – macAddress query parameter. Client device’s MAC address (Cannot be submitted together with siteId and deviceId) .

• start_time (int) – startTime query parameter. Starting epoch time in milliseconds of time window .

• end_time (int) – endTime query parameter. Ending epoch time in milliseconds of time window .

• application_health (str) – applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only) .

• offset (int) – offset query parameter. The offset of the first application in the returned data (optionally used with siteId only) .

• limit (int) – limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only) .

• application_name (str) – applicationName query parameter. The name of the application to get information on .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

applications(application_health=None, application_name=None, device_id=None, end_time=None, limit=None, mac_address=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)

This function is an alias of applications_v1. .

Parameters:

• site_id (str) – siteId query parameter. Assurance site UUID value (Cannot be submitted together with deviceId and clientMac) .

• device_id (str) – deviceId query parameter. Assurance device UUID value (Cannot be submitted together with siteId and clientMac) .

• mac_address (str) – macAddress query parameter. Client device’s MAC address (Cannot be submitted together with siteId and deviceId) .

• start_time (int) – startTime query parameter. Starting epoch time in milliseconds of time window .

• end_time (int) – endTime query parameter. Ending epoch time in milliseconds of time window .

• application_health (str) – applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only) .

• offset (int) – offset query parameter. The offset of the first application in the returned data (optionally used with siteId only) .

• limit (int) – limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only) .

• application_name (str) – applicationName query parameter. The name of the application to get information on .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of applications_v1.

authentication_management

class AuthenticationManagement

Cisco DNA Center Authentication Management API (version: 2.3.7.6).

Wraps the DNA Center Authentication Management API and exposes the API as native Python methods that return native Python objects.

import_certificate_v1(list_of_users=None, pk_password=None, headers=None, **request_parameters)

This API enables a user to import a PEM certificate and its key for the controller and/or disaster recovery. .

Parameters:

• pk_password (str) – pkPassword query parameter. Password for encrypted private key .

• list_of_users (str, list, set, tuple) – listOfUsers query parameter. Specify whether the certificate will be used for controller (“server”), disaster recovery (“ipsec”) or both (“server, ipsec”). If no value is provided, the default value taken will be “server” .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!importcertificate

import_certificate_p12_v1(p12_password, list_of_users=None, pk_password=None, headers=None, **request_parameters)

This API enables a user to import a PKCS12 certificate bundle for the controller and/or disaster recovery. .

Parameters:

• p12_password (str) – p12Password query parameter. The password for PKCS12 certificate bundle .

• pk_password (str) – pkPassword query parameter. Password for encrypted private key .

• list_of_users (str, list, set, tuple) – listOfUsers query parameter. Specify whether the certificate will be used for controller (“server”), disaster recovery (“ipsec”) or both (“server, ipsec”). If no value is provided, the default value taken will be “server” .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!importcertificatep12

authentication_api_v1(headers=None, **request_parameters)

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. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

authentication_api(headers=None, **request_parameters)

This function is an alias of authentication_api_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of authentication_api_v1 .

import_certificate_p12(p12_password, list_of_users=None, pk_password=None, headers=None, **request_parameters)

This function is an alias of import_certificate_p12_v1 . :param p12_password: p12Password query parameter. The password for PKCS12 certificate bundle . :type p12_password: str :param pk_password: pkPassword query parameter. Password for encrypted private key . :type pk_password: str :param list_of_users: listOfUsers query parameter. Specify whether the

certificate will be used for controller (“server”), disaster recovery (“ipsec”) or both (“server, ipsec”). If no value is provided, the default value taken will be “server” .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of import_certificate_p12_v1 .

import_certificate(list_of_users=None, pk_password=None, headers=None, **request_parameters)

This function is an alias of import_certificate_v1 . :param pk_password: pkPassword query parameter. Password for encrypted private key . :type pk_password: str :param list_of_users: listOfUsers query parameter. Specify whether the

certificate will be used for controller (“server”), disaster recovery (“ipsec”) or both (“server, ipsec”). If no value is provided, the default value taken will be “server” .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of import_certificate_v1 .

cisco_trusted_certificates

class CiscoTrustedCertificates

Cisco DNA Center Cisco Trusted Certificates API (version: 2.3.7.6).

Wraps the DNA Center Cisco Trusted Certificates API and exposes the API as native Python methods that return native Python objects.

import_trusted_certificate_v1(headers=None, **request_parameters)

Imports trusted certificate into a truststore. Accepts .pem or .der file as input. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

import_trusted_certificate(headers=None, **request_parameters)

This function is an alias of import_trusted_certificate_v1. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of import_trusted_certificate_v1.

clients

class Clients

Cisco DNA Center Clients API (version: 2.3.7.6).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

retrieves_the_list_of_clients_while_also_offering_basic_filtering_and_sorting_capabilities_v1(attribute=None, band=None, connected_network_device_name=None, end_time=None, ipv4_address=None, ipv6_address=None, limit=None, mac_address=None, offset=None, order=None, os_type=None, os_version=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, sort_by=None, ssid=None, start_time=None, type=None, view=None, wlc_name=None, headers=None, **request_parameters)

Retrieves the list of clients, while also offering basic filtering and sorting capabilities. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-clients1-1.0.0-resolved.yaml .

Parameters:

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• limit (int) – limit query parameter. Maximum number of records to return .

• offset (int) – offset query parameter. Specifies the starting point within all records returned by the API. It’s one based offset. The starting value is 1. .

• sort_by (str) – sortBy query parameter. A field within the response to sort by. .

• order (str) – order query parameter. The sort order of the field ascending or descending. .

• type (str) – type query parameter. The client device type whether client is connected to network through Wired or Wireless medium. .

• os_type (str) – osType query parameter. Client device operating system type. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *iOS* or iOS* or *iOS Examples: osType=iOS (single osType requested) osType=iOS&osType=Android (multiple osType requested) .

• os_version (str) – osVersion query parameter. Client device operating system version This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *14.3* or 14.3* or *14.3 Examples: osVersion=14.3 (single osVersion requested) osVersion=14.3&osVersion=10.1 (multiple osVersion requested) .

• site_hierarchy (str) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. “Global/AreaName/BuildingName/FloorName”) This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *BuildingName* or BuildingName* or *BuildingName Examples: siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) siteHierarchy=Global/AreaName/BuildingName1/FloorName1&siteHierarchy=Global/AreaName/Bu ildingName1/FloorName2 (multiple siteHierarchy requested) .

• site_hierarchy_id (str) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. “globalUuid/areaUuid/buildingUuid/floorUuid”) This field supports wildcard (*) character-based search. Ex: *buildingUuid* or buildingUuid* or *buildingUuid Examples: siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid (single siteHierarchyId requested) siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid1 &siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid2 (multiple siteHierarchyId requested) .

• site_id (str) – siteId query parameter. The site UUID without the top level hierarchy. (Ex.”floorUuid”) Examples: siteId=floorUuid (single siteId requested) siteId=floorUuid1&siteId=floorUuid2 (multiple siteId requested) .

• ipv4_address (str) – ipv4Address query parameter. IPv4 Address of the network entity either network device or client This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: ipv4Address=1.1.1.1 (single ipv4Address requested) ipv4Address=1.1.1.1&ipv4Address=2.2.2.2 (multiple ipv4Address requested) .

• ipv6_address (str) – ipv6Address query parameter. IPv6 Address of the network entity either network device or client This field supports wildcard (*) character-based search. Ex: *2001:db8* or 2001:db8* or *2001:db8 Examples: ipv6Address=2001:db8:0:0:0:0:2:1 (single ipv6Address requested) ipv6Address=2001:db8:0:0:0:0:2:1&ipv6Address=2001:db8:85a3:8d3:1319:8a2e:370:7348 (multiple ipv6Address requested) .

• mac_address (str) – macAddress query parameter. The macAddress of the network device or client This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: macAddress=AB:AB:AB:CD:CD:CD (single macAddress requested) macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE (multiple macAddress requested) .

• wlc_name (str) – wlcName query parameter. Wireless Controller name that reports the wireless client. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *wlc-25* or wlc-25* or *wlc-25 Examples: wlcName=wlc-25 (single wlcName requested) wlcName=wlc-25&wlc-34 (multiple wlcName requested) .

• connected_network_device_name (str) – connectedNetworkDeviceName query parameter. Name of the neighbor network device that client is connected to. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *ap-25* or ap-25* or *ap-25 Examples: connectedNetworkDeviceName=ap-25 (single connectedNetworkDeviceName requested) connectedNetworkDeviceName=ap-25&ap-34 (multiple connectedNetworkDeviceName requested) .

• ssid (str) – ssid query parameter. SSID is the name of wireless network to which client connects to. It is also referred to as WLAN ID Wireless Local Area Network Identifier. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *Alpha* or Alpha* or *Alpha Examples: ssid=Alpha (single ssid requested) ssid=Alpha&ssid=Guest (multiple ssid requested) .

• band (str) – band query parameter. WiFi frequency band that client or Access Point operates. Band value is represented in Giga Hertz GHz Examples: band=5GHZ (single band requested) band=2.4GHZ&band=6GHZ (multiple band requested) .

• view (str) – view query parameter. Client related Views Refer to ClientView schema for list of views supported Examples: view=Wireless (single view requested) view=WirelessHealth&view=WirelessTraffic (multiple view requested) .

• attribute (str) – attribute query parameter. List of attributes related to resource that can be requested to only be part of the response along with the required attributes. Refer to ClientAttribute schema for list of attributes supported Examples: attribute=band (single attribute requested) attribute=band&attribute=ssid&attribute=overallScore (multiple attribute requested) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieves-the-list-of-clients-while-also-offering-basic-filtering-and-sorting-capabilities

retrieves_the_total_count_of_clients_by_applying_basic_filtering_v1(band=None, connected_network_device_name=None, end_time=None, ipv4_address=None, ipv6_address=None, mac_address=None, os_type=None, os_version=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, ssid=None, start_time=None, type=None, wlc_name=None, headers=None, **request_parameters)

Retrieves the number of clients by applying basic filtering. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- clients1-1.0.0-resolved.yaml .

Parameters:

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• type (str) – type query parameter. The client device type whether client is connected to network through Wired or Wireless medium. .

• os_type (str) – osType query parameter. Client device operating system type. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *iOS* or iOS* or *iOS Examples: osType=iOS (single osType requested) osType=iOS&osType=Android (multiple osType requested) .

• os_version (str) – osVersion query parameter. Client device operating system version This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *14.3* or 14.3* or *14.3 Examples: osVersion=14.3 (single osVersion requested) osVersion=14.3&osVersion=10.1 (multiple osVersion requested) .

• site_hierarchy (str) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. “Global/AreaName/BuildingName/FloorName”) This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *BuildingName* or BuildingName* or *BuildingName Examples: siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) siteHierarchy=Global/AreaName/BuildingName1/FloorName1&siteHierarchy=Global/AreaName/Bu ildingName1/FloorName2 (multiple siteHierarchy requested) .

• site_hierarchy_id (str) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. “globalUuid/areaUuid/buildingUuid/floorUuid”) This field supports wildcard (*) character-based search. Ex: *buildingUuid* or buildingUuid* or *buildingUuid Examples: siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid (single siteHierarchyId requested) siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid1 &siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid2 (multiple siteHierarchyId requested) .

• site_id (str) – siteId query parameter. The site UUID without the top level hierarchy. (Ex.”floorUuid”) Examples: siteId=floorUuid (single siteId requested) siteId=floorUuid1&siteId=floorUuid2 (multiple siteId requested) .

• ipv4_address (str) – ipv4Address query parameter. IPv4 Address of the network entity either network device or client This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: ipv4Address=1.1.1.1 (single ipv4Address requested) ipv4Address=1.1.1.1&ipv4Address=2.2.2.2 (multiple ipv4Address requested) .

• ipv6_address (str) – ipv6Address query parameter. IPv6 Address of the network entity either network device or client This field supports wildcard (*) character-based search. Ex: *2001:db8* or 2001:db8* or *2001:db8 Examples: ipv6Address=2001:db8:0:0:0:0:2:1 (single ipv6Address requested) ipv6Address=2001:db8:0:0:0:0:2:1&ipv6Address=2001:db8:85a3:8d3:1319:8a2e:370:7348 (multiple ipv6Address requested) .

• mac_address (str) – macAddress query parameter. The macAddress of the network device or client This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: macAddress=AB:AB:AB:CD:CD:CD (single macAddress requested) macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE (multiple macAddress requested) .

• wlc_name (str) – wlcName query parameter. Wireless Controller name that reports the wireless client. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *wlc-25* or wlc-25* or *wlc-25 Examples: wlcName=wlc-25 (single wlcName requested) wlcName=wlc-25&wlc-34 (multiple wlcName requested) .

• connected_network_device_name (str) – connectedNetworkDeviceName query parameter. Name of the neighbor network device that client is connected to. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *ap-25* or ap-25* or *ap-25 Examples: connectedNetworkDeviceName=ap-25 (single connectedNetworkDeviceName requested) connectedNetworkDeviceName=ap-25&ap-34 (multiple connectedNetworkDeviceName requested) .

• ssid (str) – ssid query parameter. SSID is the name of wireless network to which client connects to. It is also referred to as WLAN ID Wireless Local Area Network Identifier. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *Alpha* or Alpha* or *Alpha Examples: ssid=Alpha (single ssid requested) ssid=Alpha&ssid=Guest (multiple ssid requested) .

• band (str) – band query parameter. WiFi frequency band that client or Access Point operates. Band value is represented in Giga Hertz GHz Examples: band=5GHZ (single band requested) band=2.4GHZ&band=6GHZ (multiple band requested) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieves-the-total-count-of-clients-by-applying-basic-filtering

retrieves_the_list_of_clients_by_applying_complex_filters_while_also_supporting_aggregate_attributes_v1(aggregateAttributes=None, attributes=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

Retrieves the list of clients by applying complex filters while also supporting aggregate attributes. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-clients1-1.0.0-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Clients’s aggregateAttributes (list of objects).

• attributes (list) – Clients’s Attributes (list of strings).

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• page (object) – Clients’s page.

• startTime (integer) – Clients’s Start Time.

• views (list) – Clients’s Views (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieves-the-list-of-clients-by-applying-complex-filters-while-also-supporting-aggregate-attributes

retrieves_the_number_of_clients_by_applying_complex_filters_v1(endTime=None, filters=None, startTime=None, headers=None, payload=None, active_validation=True, **request_parameters)

Retrieves the number of clients by applying complex filters. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- clients1-1.0.0-resolved.yaml .

Parameters:

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• startTime (integer) – Clients’s Start Time.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieves-the-number-of-clients-by-applying-complex-filters

retrieves_summary_analytics_data_related_to_clients_v1(aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, headers=None, payload=None, active_validation=True, **request_parameters)

Retrieves summary analytics data related to clients while applying complex filtering, aggregate functions, and grouping. This API facilitates obtaining consolidated insights into the performance and status of the clients. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-clients1-1.0.0-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Clients’s aggregateAttributes (list of objects).

• attributes (list) – Clients’s Attributes (list of strings).

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• groupBy (list) – Clients’s Group By (list of strings).

• page (object) – Clients’s page.

• startTime (integer) – Clients’s Start Time.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieves-summary-analytics-data-related-to-clients

retrieves_the_top_n_analytics_data_related_to_clients_v1(aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, topN=None, headers=None, payload=None, active_validation=True, **request_parameters)

Retrieves the top N analytics data related to clients based on the provided input data. This API facilitates obtaining insights into the top-performing or most impacted clients. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- clients1-1.0.0-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Clients’s aggregateAttributes (list of objects).

• attributes (list) – Clients’s Attributes (list of strings).

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• groupBy (list) – Clients’s Group By (list of strings).

• page (object) – Clients’s page.

• startTime (integer) – Clients’s Start Time.

• topN (integer) – Clients’s Top N.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieves-the-top-n-analytics-data-related-to-clients

retrieves_the_trend_analytics_data_related_to_clients_v1(aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, trendInterval=None, headers=None, payload=None, active_validation=True, **request_parameters)

Retrieves the trend analytics of client data for the specified time range. The data will be grouped based on the given trend time interval. This API facilitates obtaining consolidated insights into the performance and status of the clients over the specified start and end time. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- clients1-1.0.0-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Clients’s aggregateAttributes (list of objects).

• attributes (list) – Clients’s Attributes (list of strings).

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• groupBy (list) – Clients’s Group By (list of strings).

• page (object) – Clients’s page.

• startTime (integer) – Clients’s Start Time.

• trendInterval (string) – Clients’s Trend Interval.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieves-the-trend-analytics-data-related-to-clients

retrieves_specific_client_information_matching_the_macaddress_v1(id, attribute=None, end_time=None, start_time=None, view=None, headers=None, **request_parameters)

Retrieves specific client information matching the MAC address. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- clients1-1.0.0-resolved.yaml .

Parameters:

• id (str) – id path parameter. id is the client mac address. It can be specified is any notational conventions 01:23:45:67:89:AB or 01-23-45-67-89-AB or 0123.4567.89AB and is case insensitive .

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• view (str) – view query parameter. Client related Views Refer to ClientView schema for list of views supported Examples: view=Wireless (single view requested) view=WirelessHealth&view=WirelessTraffic (multiple view requested) .

• attribute (str) – attribute query parameter. List of attributes related to resource that can be requested to only be part of the response along with the required attributes. Refer to ClientAttribute schema for list of attributes supported Examples: attribute=band (single attribute requested) attribute=band&attribute=ssid&attribute=overallScore (multiple attribute requested) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieves-specific-client-information-matching-the-mac-address

retrieves_specific_client_information_over_a_specified_period_of_time_v1(id, aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, trendInterval=None, headers=None, payload=None, active_validation=True, **request_parameters)

Retrieves the time series information of a specific client by applying complex filters, aggregate functions, and grouping. The data will be grouped based on the specified trend time interval. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-clients1-1.0.0-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Clients’s aggregateAttributes (list of objects).

• attributes (list) – Clients’s Attributes (list of strings).

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• groupBy (list) – Clients’s Group By (list of strings).

• page (object) – Clients’s page.

• startTime (integer) – Clients’s Start Time.

• trendInterval (string) – Clients’s Trend Interval.

• id (str) – id path parameter. id is the client mac address. It can be specified in one of the notational conventions 01:23:45:67:89:AB or 01-23-45-67-89-AB or 0123.4567.89AB and is case insensitive .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieves-specific-client-information-over-a-specified-period-of-time

get_client_detail_v1(mac_address, timestamp=None, headers=None, **request_parameters)

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

Parameters:

• mac_address (str) – macAddress query parameter. MAC Address of the client .

• timestamp (int) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_client_enrichment_details_v1(headers=None, **request_parameters)

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 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_overall_client_health_v1(timestamp=None, headers=None, **request_parameters)

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

Parameters:

• timestamp (int) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

client_proximity_v1(username, number_days=None, time_resolution=None, headers=None, **request_parameters)

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. .

Parameters:

• username (str) – username query parameter. Wireless client username for which proximity information is required .

• number_days (int) – number_days query parameter. Number of days to track proximity until current date. Defaults and maximum up to 14 days. .

• time_resolution (int) – time_resolution query parameter. Time interval (in minutes) to measure proximity. Defaults to 15 minutes with a minimum 5 minutes. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)

This function is an alias of get_client_detail_v1. .

Parameters:

• mac_address (str) – macAddress query parameter. MAC Address of the client .

• timestamp (int) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_client_detail_v1.

get_client_enrichment_details(headers=None, **request_parameters)

This function is an alias of get_client_enrichment_details_v1.

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_client_enrichment_details_v1.

retrieves_the_list_of_clients_while_also_offering_basic_filtering_and_sorting_capabilities(attribute=None, band=None, connected_network_device_name=None, end_time=None, ipv4_address=None, ipv6_address=None, limit=None, mac_address=None, offset=None, order=None, os_type=None, os_version=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, sort_by=None, ssid=None, start_time=None, type=None, view=None, wlc_name=None, headers=None, **request_parameters)

This function is an alias of retrieves_the_list_of_clients_while_also_offering_basic_filtering_and_sorting_capabilities_v1.

Parameters:

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• limit (int) – limit query parameter. Maximum number of records to return .

• offset (int) – offset query parameter. Specifies the starting point within all records returned by the API. It’s one based offset. The starting value is 1. .

• sort_by (str) – sortBy query parameter. A field within the response to sort by. .

• order (str) – order query parameter. The sort order of the field ascending or descending. .

• type (str) – type query parameter. The client device type whether client is connected to network through Wired or Wireless medium. .

• os_type (str) – osType query parameter. Client device operating system type. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *iOS* or iOS* or *iOS Examples: osType=iOS (single osType requested) osType=iOS&osType=Android (multiple osType requested) .

• os_version (str) – osVersion query parameter. Client device operating system version This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *14.3* or 14.3* or *14.3 Examples: osVersion=14.3 (single osVersion requested) osVersion=14.3&osVersion=10.1 (multiple osVersion requested) .

• site_hierarchy (str) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. “Global/AreaName/BuildingName/FloorName”) This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *BuildingName* or BuildingName* or *BuildingName Examples: siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) siteHierarchy=Global/AreaName/BuildingName1/FloorName1&siteHierarchy=Global/AreaName/Bu ildingName1/FloorName2 (multiple siteHierarchy requested) .

• site_hierarchy_id (str) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. “globalUuid/areaUuid/buildingUuid/floorUuid”) This field supports wildcard (*) character-based search. Ex: *buildingUuid* or buildingUuid* or *buildingUuid Examples: siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid (single siteHierarchyId requested) siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid1 &siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid2 (multiple siteHierarchyId requested) .

• site_id (str) – siteId query parameter. The site UUID without the top level hierarchy. (Ex.”floorUuid”) Examples: siteId=floorUuid (single siteId requested) siteId=floorUuid1&siteId=floorUuid2 (multiple siteId requested) .

• ipv4_address (str) – ipv4Address query parameter. IPv4 Address of the network entity either network device or client This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: ipv4Address=1.1.1.1 (single ipv4Address requested) ipv4Address=1.1.1.1&ipv4Address=2.2.2.2 (multiple ipv4Address requested) .

• ipv6_address (str) – ipv6Address query parameter. IPv6 Address of the network entity either network device or client This field supports wildcard (*) character-based search. Ex: *2001:db8* or 2001:db8* or *2001:db8 Examples: ipv6Address=2001:db8:0:0:0:0:2:1 (single ipv6Address requested) ipv6Address=2001:db8:0:0:0:0:2:1&ipv6Address=2001:db8:85a3:8d3:1319:8a2e:370:7348 (multiple ipv6Address requested) .

• mac_address (str) – macAddress query parameter. The macAddress of the network device or client This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: macAddress=AB:AB:AB:CD:CD:CD (single macAddress requested) macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE (multiple macAddress requested) .

• wlc_name (str) – wlcName query parameter. Wireless Controller name that reports the wireless client. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *wlc-25* or wlc-25* or *wlc-25 Examples: wlcName=wlc-25 (single wlcName requested) wlcName=wlc-25&wlc-34 (multiple wlcName requested) .

• connected_network_device_name (str) – connectedNetworkDeviceName query parameter. Name of the neighbor network device that client is connected to. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *ap-25* or ap-25* or *ap-25 Examples: connectedNetworkDeviceName=ap-25 (single connectedNetworkDeviceName requested) connectedNetworkDeviceName=ap-25&ap-34 (multiple connectedNetworkDeviceName requested) .

• ssid (str) – ssid query parameter. SSID is the name of wireless network to which client connects to. It is also referred to as WLAN ID Wireless Local Area Network Identifier. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *Alpha* or Alpha* or *Alpha Examples: ssid=Alpha (single ssid requested) ssid=Alpha&ssid=Guest (multiple ssid requested) .

• band (str) – band query parameter. WiFi frequency band that client or Access Point operates. Band value is represented in Giga Hertz GHz Examples: band=5GHZ (single band requested) band=2.4GHZ&band=6GHZ (multiple band requested) .

• view (str) – view query parameter. Client related Views Refer to ClientView schema for list of views supported Examples: view=Wireless (single view requested) view=WirelessHealth&view=WirelessTraffic (multiple view requested) .

• attribute (str) – attribute query parameter. List of attributes related to resource that can be requested to only be part of the response along with the required attributes. Refer to ClientAttribute schema for list of attributes supported Examples: attribute=band (single attribute requested) attribute=band&attribute=ssid&attribute=overallScore (multiple attribute requested) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of retrieves_the_list_of_clients_while_also_offering_basic_filtering_and_sorting_capabilities_v1.

client_proximity(username, number_days=None, time_resolution=None, headers=None, **request_parameters)

This function is an alias of client_proximity_v1. .

Parameters:

• username (str) – username query parameter. Wireless client username for which proximity information is required .

• number_days (int) – number_days query parameter. Number of days to track proximity until current date. Defaults and maximum up to 14 days. .

• time_resolution (int) – time_resolution query parameter. Time interval (in minutes) to measure proximity. Defaults to 15 minutes with a minimum 5 minutes. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of client_proximity_v1.

retrieves_the_number_of_clients_by_applying_complex_filters(endTime=None, filters=None, startTime=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of retrieves_the_number_of_clients_by_applying_complex_filters_v1.

Parameters:

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• startTime (integer) – Clients’s Start Time.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of retrieves_the_number_of_clients_by_applying_complex_filters_v1.

retrieves_summary_analytics_data_related_to_clients(aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of retrieves_summary_analytics_data_related_to_clients_v1 .

Parameters:

• aggregateAttributes (list) – Clients’s aggregateAttributes (list of objects).

• attributes (list) – Clients’s Attributes (list of strings).

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• groupBy (list) – Clients’s Group By (list of strings).

• page (object) – Clients’s page.

• startTime (integer) – Clients’s Start Time.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of retrieves_summary_analytics_data_related_to_clients_v1.

retrieves_the_top_n_analytics_data_related_to_clients(aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, topN=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of retrieves_the_top_n_analytics_data_related_to_clients_v1 .

Parameters:

• aggregateAttributes (list) – Clients’s aggregateAttributes (list of objects).

• attributes (list) – Clients’s Attributes (list of strings).

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• groupBy (list) – Clients’s Group By (list of strings).

• page (object) – Clients’s page.

• startTime (integer) – Clients’s Start Time.

• topN (integer) – Clients’s Top N.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of retrieves_the_top_n_analytics_data_related_to_clients_v1.

retrieves_specific_client_information_matching_the_macaddress(id, attribute=None, end_time=None, start_time=None, view=None, headers=None, **request_parameters)

This function is an alias of retrieves_specific_client_information_matching_the_macaddress_v1.

Parameters:

• id (str) – id path parameter. id is the client mac address. It can be specified is any notational conventions 01:23:45:67:89:AB or 01-23-45-67-89-AB or 0123.4567.89AB and is case insensitive .

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• view (str) – view query parameter. Client related Views Refer to ClientView schema for list of views supported Examples: view=Wireless (single view requested) view=WirelessHealth&view=WirelessTraffic (multiple view requested) .

• attribute (str) – attribute query parameter. List of attributes related to resource that can be requested to only be part of the response along with the required attributes. Refer to ClientAttribute schema for list of attributes supported Examples: attribute=band (single attribute requested) attribute=band&attribute=ssid&attribute=overallScore (multiple attribute requested) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of retrieves_specific_client_information_matching_the_macaddress_v1.

retrieves_specific_client_information_over_a_specified_period_of_time(id, aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, trendInterval=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of retrieves_specific_client_information_over_a_specified_period_of_time_v1 .

Parameters:

• aggregateAttributes (list) – Clients’s aggregateAttributes (list of objects).

• attributes (list) – Clients’s Attributes (list of strings).

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• groupBy (list) – Clients’s Group By (list of strings).

• page (object) – Clients’s page.

• startTime (integer) – Clients’s Start Time.

• trendInterval (string) – Clients’s Trend Interval.

• id (str) – id path parameter. id is the client mac address. It can be specified in one of the notational conventions 01:23:45:67:89:AB or 01-23-45-67-89-AB or 0123.4567.89AB and is case insensitive .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of retrieves_specific_client_information_over_a_specified_period_of_time_v1.

retrieves_the_trend_analytics_data_related_to_clients(aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, trendInterval=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of retrieves_the_trend_analytics_data_related_to_clients_v1 .

Parameters:

• aggregateAttributes (list) – Clients’s aggregateAttributes (list of objects).

• attributes (list) – Clients’s Attributes (list of strings).

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• groupBy (list) – Clients’s Group By (list of strings).

• page (object) – Clients’s page.

• startTime (integer) – Clients’s Start Time.

• trendInterval (string) – Clients’s Trend Interval.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of retrieves_the_trend_analytics_data_related_to_clients_v1.

retrieves_the_list_of_clients_by_applying_complex_filters_while_also_supporting_aggregate_attributes(aggregateAttributes=None, attributes=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of retrieves_the_list_of_clients_by_applying_complex_filters_while_also_supporting_aggregate_attributes_v1 .

Parameters:

• aggregateAttributes (list) – Clients’s aggregateAttributes (list of objects).

• attributes (list) – Clients’s Attributes (list of strings).

• endTime (integer) – Clients’s End Time.

• filters (list) – Clients’s filters (list of objects).

• page (object) – Clients’s page.

• startTime (integer) – Clients’s Start Time.

• views (list) – Clients’s Views (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of retrieves_the_list_of_clients_by_applying_complex_filters_while_also_supporting_aggregate_attributes_v1.

get_overall_client_health(timestamp=None, headers=None, **request_parameters)

This function is an alias of get_overall_client_health_v1 .

Parameters:

• timestamp (int) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_overall_client_health_v1.

retrieves_the_total_count_of_clients_by_applying_basic_filtering(band=None, connected_network_device_name=None, end_time=None, ipv4_address=None, ipv6_address=None, mac_address=None, os_type=None, os_version=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, ssid=None, start_time=None, type=None, wlc_name=None, headers=None, **request_parameters)

This function is an alias of retrieves_the_total_count_of_clients_by_applying_basic_filtering_v1.

Parameters:

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• type (str) – type query parameter. The client device type whether client is connected to network through Wired or Wireless medium. .

• os_type (str) – osType query parameter. Client device operating system type. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *iOS* or iOS* or *iOS Examples: osType=iOS (single osType requested) osType=iOS&osType=Android (multiple osType requested) .

• os_version (str) – osVersion query parameter. Client device operating system version This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *14.3* or 14.3* or *14.3 Examples: osVersion=14.3 (single osVersion requested) osVersion=14.3&osVersion=10.1 (multiple osVersion requested) .

• site_hierarchy (str) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. “Global/AreaName/BuildingName/FloorName”) This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *BuildingName* or BuildingName* or *BuildingName Examples: siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) siteHierarchy=Global/AreaName/BuildingName1/FloorName1&siteHierarchy=Global/AreaName/Bu ildingName1/FloorName2 (multiple siteHierarchy requested) .

• site_hierarchy_id (str) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. “globalUuid/areaUuid/buildingUuid/floorUuid”) This field supports wildcard (*) character-based search. Ex: *buildingUuid* or buildingUuid* or *buildingUuid Examples: siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid (single siteHierarchyId requested) siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid1 &siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid2 (multiple siteHierarchyId requested) .

• site_id (str) – siteId query parameter. The site UUID without the top level hierarchy. (Ex.”floorUuid”) Examples: siteId=floorUuid (single siteId requested) siteId=floorUuid1&siteId=floorUuid2 (multiple siteId requested) .

• ipv4_address (str) – ipv4Address query parameter. IPv4 Address of the network entity either network device or client This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: ipv4Address=1.1.1.1 (single ipv4Address requested) ipv4Address=1.1.1.1&ipv4Address=2.2.2.2 (multiple ipv4Address requested) .

• ipv6_address (str) – ipv6Address query parameter. IPv6 Address of the network entity either network device or client This field supports wildcard (*) character-based search. Ex: *2001:db8* or 2001:db8* or *2001:db8 Examples: ipv6Address=2001:db8:0:0:0:0:2:1 (single ipv6Address requested) ipv6Address=2001:db8:0:0:0:0:2:1&ipv6Address=2001:db8:85a3:8d3:1319:8a2e:370:7348 (multiple ipv6Address requested) .

• mac_address (str) – macAddress query parameter. The macAddress of the network device or client This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: macAddress=AB:AB:AB:CD:CD:CD (single macAddress requested) macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE (multiple macAddress requested) .

• wlc_name (str) – wlcName query parameter. Wireless Controller name that reports the wireless client. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *wlc-25* or wlc-25* or *wlc-25 Examples: wlcName=wlc-25 (single wlcName requested) wlcName=wlc-25&wlc-34 (multiple wlcName requested) .

• connected_network_device_name (str) – connectedNetworkDeviceName query parameter. Name of the neighbor network device that client is connected to. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *ap-25* or ap-25* or *ap-25 Examples: connectedNetworkDeviceName=ap-25 (single connectedNetworkDeviceName requested) connectedNetworkDeviceName=ap-25&ap-34 (multiple connectedNetworkDeviceName requested) .

• ssid (str) – ssid query parameter. SSID is the name of wireless network to which client connects to. It is also referred to as WLAN ID Wireless Local Area Network Identifier. This field supports wildcard (*) character-based search. If the value contains the (*) character, please use the /query API for regex search. Ex: *Alpha* or Alpha* or *Alpha Examples: ssid=Alpha (single ssid requested) ssid=Alpha&ssid=Guest (multiple ssid requested) .

• band (str) – band query parameter. WiFi frequency band that client or Access Point operates. Band value is represented in Giga Hertz GHz Examples: band=5GHZ (single band requested) band=2.4GHZ&band=6GHZ (multiple band requested) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of retrieves_the_total_count_of_clients_by_applying_basic_filtering_v1.

command_runner

class CommandRunner

Cisco DNA Center Command Runner API (version: 2.3.7.6).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted_v1(headers=None, **request_parameters)

Get valid keywords .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

run_read_only_commands_on_devices_v1(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)

Submit request for read-only CLIs .

Parameters:

• commands (list) – Command Runner’s Commands to be executed (list of strings).

• description (string) – Command Runner’s Describe the details about the command request .

• deviceUuids (list) – Command Runner’s Device Id of the device (list of strings).

• name (string) – Command Runner’s Name of the the request like getshowrun , deviceinterfacestatusCli. .

• timeout (integer) – Command Runner’s The timeout value in unit of second. If no timeout provided wait till 300sec .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)

This function is an alias of get_all_keywords_of_clis_accepted_v1.

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_all_keywords_of_clis_accepted_v1.

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of run_read_only_commands_on_devices_v1.

Parameters:

• commands (list) – Command Runner’s Commands to be executed (list of strings).

• description (string) – Command Runner’s Describe the details about the command request .

• deviceUuids (list) – Command Runner’s Device Id of the device (list of strings).

• name (string) – Command Runner’s Name of the the request like getshowrun , deviceinterfacestatusCli. .

• timeout (integer) – Command Runner’s The timeout value in unit of second. If no timeout provided wait till 300sec .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of run_read_only_commands_on_devices_v1.

compliance

class Compliance

Cisco DNA Center Compliance API (version: 2.3.7.6).

Wraps the DNA Center Compliance API and exposes the API as native Python methods that return native Python objects.

get_compliance_status_v1(compliance_status=None, device_uuid=None, headers=None, **request_parameters)

Return compliance status of device(s). .

Parameters:

• compliance_status (str) – complianceStatus query parameter. Specify “Compliance status(es)” separated by commas. The Compliance status can be ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’. .

• device_uuid (str) – deviceUuid query parameter. Comma separated ‘Device Ids’ .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

run_compliance_v1(categories=None, deviceUuids=None, triggerFull=None, headers=None, payload=None, active_validation=True, **request_parameters)

Run compliance check for device(s). .

Parameters:

• categories (list) – Compliance’s Category can have any value among ‘INTENT’(mapped to compliance types: NETWORK_SETTINGS,NETWORK_PROFILE,WORKFLOW,FABRIC,APPLICATION_VISIBILITY), ‘RUNNING_CONFIG’ , ‘IMAGE’ , ‘PSIRT’ , ‘EOX’ , ‘NETWORK_SETTINGS’ (list of strings).

• deviceUuids (list) – Compliance’s UUID of the device. (list of strings).

• triggerFull (boolean) – Compliance’s if it is true then compliance will be triggered for all categories. If it is false then compliance will be triggered for categories mentioned in categories section . .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_compliance_status_count_v1(compliance_status=None, headers=None, **request_parameters)

Return Compliance Status Count .

Parameters:

• compliance_status (str) – complianceStatus query parameter. Specify “Compliance status(es)” separated by commas. The Compliance status can be ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_compliance_detail_v1(compliance_status=None, compliance_type=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)

Return Compliance Detail .

Parameters:

• compliance_type (str) – complianceType query parameter. Specify “Compliance type(s)” in commas. The Compliance type can be ‘NETWORK_PROFILE’, ‘IMAGE’, ‘FABRIC’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, RUNNING_CONFIG’, ‘NETWORK_SETTINGS’, ‘WORKFLOW’ , ‘EOX’. .

• compliance_status (str) – complianceStatus query parameter. Specify “Compliance status(es)” in commas. The Compliance status can be ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’. .

• device_uuid (str) – deviceUuid query parameter. Comma separated “Device Id(s)” .

• offset (int) – offset query parameter. offset/starting row .

• limit (int) – limit query parameter. Number of records to be retrieved .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_compliance_detail_count_v1(compliance_status=None, compliance_type=None, headers=None, **request_parameters)

Return Compliance Count Detail .

Parameters:

• compliance_type (str) – complianceType query parameter. Specify “Compliance type(s)” separated by commas. The Compliance type can be ‘APPLICATION_VISIBILITY’, ‘EOX’, ‘FABRIC’, ‘IMAGE’, ‘NETWORK_PROFILE’, ‘NETWORK_SETTINGS’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’. .

• compliance_status (str) – complianceStatus query parameter. Specify “Compliance status(es)” separated by commas. The Compliance status can be ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

compliance_remediation_v1(id, headers=None, **request_parameters)

Remediates configuration compliance issues. Compliance issues related to ‘Routing’, ‘HA Remediation’, ‘Software Image’, ‘Securities Advisories’, ‘SD-Access Unsupported Configuration’, ‘Workflow’, etc. will not be addressed by this API. Warning: Fixing compliance mismatches could result in a possible network flap. .

Parameters:

• id (str) – id path parameter. Network device identifier .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!compliance-remediation

device_compliance_status_v1(device_uuid, headers=None, **request_parameters)

Return compliance status of a device. .

Parameters:

• device_uuid (str) – deviceUuid path parameter. Device Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

compliance_details_of_device_v1(device_uuid, category=None, compliance_type=None, diff_list=None, headers=None, **request_parameters)

Return compliance detailed report for a device. .

Parameters:

• device_uuid (str) – deviceUuid path parameter. Device Id .

• category (str) – category query parameter. category can have any value among ‘INTENT’, ‘RUNNING_CONFIG’ , ‘IMAGE’ , ‘PSIRT’ , ‘DESIGN_OOD’ , ‘EOX’ , ‘NETWORK_SETTINGS’ .

• compliance_type (str) – complianceType query parameter. Specify “Compliance type(s)” separated by commas. The Compliance type can be ‘APPLICATION_VISIBILITY’, ‘EOX’, ‘FABRIC’, ‘IMAGE’, ‘NETWORK_PROFILE’, ‘NETWORK_SETTINGS’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’. .

• diff_list (bool) – diffList query parameter. diff list [ pass true to fetch the diff list ] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_config_task_details_v1(parent_task_id, headers=None, **request_parameters)

Returns a config task result details by specified id .

Parameters:

• parent_task_id (str) – parentTaskId query parameter. task Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-config-task-details

commit_device_configuration_v1(deviceId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This operation would commit device running configuration to startup by issuing “write memory” to device .

Parameters:

• deviceId (list) – Compliance’s UUID of the device. (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!commit-device-configuration

get_compliance_detail_count(compliance_status=None, compliance_type=None, headers=None, **request_parameters)

This function is an alias of get_compliance_detail_count_v1 .

Parameters:

• compliance_type (str) – complianceType query parameter. Specify “Compliance type(s)” separated by commas. The Compliance type can be ‘APPLICATION_VISIBILITY’, ‘EOX’, ‘FABRIC’, ‘IMAGE’, ‘NETWORK_PROFILE’, ‘NETWORK_SETTINGS’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’. .

• compliance_status (str) – complianceStatus query parameter. Specify “Compliance status(es)” separated by commas. The Compliance status can be ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_compliance_detail_count_v1.

compliance_remediation(id, headers=None, **request_parameters)

This function is an alias of compliance_remediation_v1. .

Parameters:

• id (str) – id path parameter. Network device identifier .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of compliance_remediation_v1.

get_compliance_detail(compliance_status=None, compliance_type=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)

This function is an alias of get_compliance_detail_v1 .

Parameters:

• compliance_type (str) – complianceType query parameter. Specify “Compliance type(s)” in commas. The Compliance type can be ‘NETWORK_PROFILE’, ‘IMAGE’, ‘FABRIC’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, RUNNING_CONFIG’, ‘NETWORK_SETTINGS’, ‘WORKFLOW’ , ‘EOX’. .

• compliance_status (str) – complianceStatus query parameter. Specify “Compliance status(es)” in commas. The Compliance status can be ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’. .

• device_uuid (str) – deviceUuid query parameter. Comma separated “Device Id(s)” .

• offset (int) – offset query parameter. offset/starting row .

• limit (int) – limit query parameter. Number of records to be retrieved .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_compliance_detail_v1.

get_config_task_details(parent_task_id, headers=None, **request_parameters)

This function is an alias of get_config_task_details_v1 .

Parameters:

• parent_task_id (str) – parentTaskId query parameter. task Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_config_task_details_v1.

get_compliance_status(compliance_status=None, device_uuid=None, headers=None, **request_parameters)

This function is an alias of get_compliance_status_v1. .

Parameters:

• compliance_status (str) – complianceStatus query parameter. Specify “Compliance status(es)” separated by commas. The Compliance status can be ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’. .

• device_uuid (str) – deviceUuid query parameter. Comma separated ‘Device Ids’ .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_compliance_status_v1.

device_compliance_status(device_uuid, headers=None, **request_parameters)

This function is an alias of device_compliance_status_v1. .

Parameters:

• device_uuid (str) – deviceUuid path parameter. Device Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of device_compliance_status_v1.

commit_device_configuration(deviceId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of commit_device_configuration_v1 .

Parameters:

• deviceId (list) – Compliance’s UUID of the device. (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of commit_device_configuration_v1.

compliance_details_of_device(device_uuid, category=None, compliance_type=None, diff_list=None, headers=None, **request_parameters)

This function is an alias of compliance_details_of_device_v1. .

Parameters:

• device_uuid (str) – deviceUuid path parameter. Device Id .

• category (str) – category query parameter. category can have any value among ‘INTENT’, ‘RUNNING_CONFIG’ , ‘IMAGE’ , ‘PSIRT’ , ‘DESIGN_OOD’ , ‘EOX’ , ‘NETWORK_SETTINGS’ .

• compliance_type (str) – complianceType query parameter. Specify “Compliance type(s)” separated by commas. The Compliance type can be ‘APPLICATION_VISIBILITY’, ‘EOX’, ‘FABRIC’, ‘IMAGE’, ‘NETWORK_PROFILE’, ‘NETWORK_SETTINGS’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’. .

• diff_list (bool) – diffList query parameter. diff list [ pass true to fetch the diff list ] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of compliance_details_of_device_v1.

get_compliance_status_count(compliance_status=None, headers=None, **request_parameters)

This function is an alias of get_compliance_status_count_v1 .

Parameters:

• compliance_status (str) – complianceStatus query parameter. Specify “Compliance status(es)” separated by commas. The Compliance status can be ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_compliance_status_count_v1.

run_compliance(categories=None, deviceUuids=None, triggerFull=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of run_compliance_v1. .

Parameters:

• categories (list) – Compliance’s Category can have any value among ‘INTENT’(mapped to compliance types: NETWORK_SETTINGS,NETWORK_PROFILE,WORKFLOW,FABRIC,APPLICATION_VISIBILITY), ‘RUNNING_CONFIG’ , ‘IMAGE’ , ‘PSIRT’ , ‘EOX’ , ‘NETWORK_SETTINGS’ (list of strings).

• deviceUuids (list) – Compliance’s UUID of the device. (list of strings).

• triggerFull (boolean) – Compliance’s if it is true then compliance will be triggered for all categories. If it is false then compliance will be triggered for categories mentioned in categories section . .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of run_compliance_v1.

configuration_archive

class ConfigurationArchive

Cisco DNA Center Configuration Archive API (version: 2.3.7.6).

Wraps the DNA Center Configuration Archive API and exposes the API as native Python methods that return native Python objects.

export_device_configurations_v1(deviceId=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)

Export Device configurations to an encrypted zip file .

Parameters:

• deviceId (string) – Configuration Archive’s UUIDs of the devices for which configurations need to be exported. .

• password (string) – Configuration Archive’s Password for the zip file to protect exported configurations. Must contain, at minimum 8 characters, one lowercase letter, one uppercase letter, one number, one special character(-=[];,./~!@#$%^&*()_+{}|:?). It may not contain white space or the characters <>. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_configuration_archive_details_v1(created_by=None, created_time=None, device_id=None, file_type=None, limit=None, offset=None, headers=None, **request_parameters)

Returns the historical device configurations (running configuration , startup configuration , vlan if applicable) by specified criteria .

Parameters:

• device_id (str) – deviceId query parameter. comma separated device id for example cf35b0a1-407f-412f-b2f4-f0c3156695f9,aaa38191-0c22-4158-befd-779a09d7cec1 . if device id is not provided it will fetch for all devices .

• file_type (str) – fileType query parameter. Config File Type can be RUNNINGCONFIG or STARTUPCONFIG .

• created_time (str) – createdTime query parameter. Supported with logical filters GT,GTE,LT,LTE & BT : time in milliseconds (epoc format) .

• created_by (str) – createdBy query parameter. Comma separated values for createdBy SCHEDULED, USER, CONFIG_CHANGE_EVENT, SCHEDULED_FIRST_TIME, DR_CALL_BACK, PRE_DEPLOY .

• offset (int) – offset query parameter.

• limit (int) – limit query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-configuration-archive-details

export_device_configurations(deviceId=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of export_device_configurations_v1 .

Parameters:

• deviceId (string) – Configuration Archive’s UUIDs of the devices for which configurations need to be exported. .

• password (string) – Configuration Archive’s Password for the zip file to protect exported configurations. Must contain, at minimum 8 characters, one lowercase letter, one uppercase letter, one number, one special character(-=[];,./~!@#$%^&*()_+{}|:?). It may not contain white space or the characters <>. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of export_device_configurations_v1.

get_configuration_archive_details(created_by=None, created_time=None, device_id=None, file_type=None, limit=None, offset=None, headers=None, **request_parameters)

This function is an alias of get_configuration_archive_details_v1.

Parameters:

• device_id (str) – deviceId query parameter. comma separated device id for example cf35b0a1-407f-412f-b2f4-f0c3156695f9,aaa38191-0c22-4158-befd-779a09d7cec1 . if device id is not provided it will fetch for all devices .

• file_type (str) – fileType query parameter. Config File Type can be RUNNINGCONFIG or STARTUPCONFIG .

• created_time (str) – createdTime query parameter. Supported with logical filters GT,GTE,LT,LTE & BT : time in milliseconds (epoc format) .

• created_by (str) – createdBy query parameter. Comma separated values for createdBy SCHEDULED, USER, CONFIG_CHANGE_EVENT, SCHEDULED_FIRST_TIME, DR_CALL_BACK, PRE_DEPLOY .

• offset (int) – offset query parameter.

• limit (int) – limit query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_configuration_archive_details_v1.

configuration_templates

class ConfigurationTemplates

Cisco DNA Center Configuration Templates API (version: 2.3.7.6).

Wraps the DNA Center Configuration Templates API and exposes the API as native Python methods that return native Python objects.

clone_given_template_v1(name, project_id, template_id, headers=None, **request_parameters)

API to clone template .

Parameters:

• name (str) – name path parameter. Template name to clone template(Name should be different than existing template name within same project) .

• template_id (str) – templateId path parameter. UUID of the template to clone it .

• project_id (str) – projectId path parameter.

• project_id – projectId query parameter. UUID of the project in which the template needs to be created .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_project_v1(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)

This API is used to create a new project. .

Parameters:

• createTime (integer) – Configuration Templates’s Create time of project .

• description (string) – Configuration Templates’s Description of project .

• id (string) – Configuration Templates’s UUID of project .

• lastUpdateTime (integer) – Configuration Templates’s Update time of project .

• name (string) – Configuration Templates’s Name of project .

• tags (list) – Configuration Templates’s tags (list of objects).

• templates (list) – Configuration Templates’s List of templates within the project (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

update_project_v1(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)

This API is used to update an existing project. .

Parameters:

• createTime (integer) – Configuration Templates’s Create time of project .

• description (string) – Configuration Templates’s Description of project .

• id (string) – Configuration Templates’s UUID of project .

• lastUpdateTime (integer) – Configuration Templates’s Update time of project .

• name (string) – Configuration Templates’s Name of project .

• tags (list) – Configuration Templates’s tags (list of objects).

• templates (object) – Configuration Templates’s List of templates within the project .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-project

get_projects_v1(name=None, sort_order=None, headers=None, **request_parameters)

List the projects .

Parameters:

• name (str) – name query parameter. Name of project to be searched .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

imports_the_projects_provided_v1(do_version=None, headers=None, payload=None, active_validation=True, **request_parameters)

Imports the Projects provided in the DTO .

Parameters:

• do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload ((list, dict)) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

export_projects_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Exports the projects for given projectNames. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

imports_the_templates_provided_v1(project_name, do_version=None, headers=None, payload=None, active_validation=True, **request_parameters)

Imports the templates provided in the DTO by project Name .

Parameters:

• project_name (str) – projectName path parameter. Project name to create template under the project .

• do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_project_details_v1(project_id, headers=None, **request_parameters)

Get the details of the given project by its id. .

Parameters:

• project_id (str) – projectId path parameter. projectId(UUID) of project to get project details .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

deletes_the_project_v1(project_id, headers=None, **request_parameters)

Deletes the project by its id .

Parameters:

• project_id (str) – projectId path parameter. projectId(UUID) of project to be deleted .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

create_template_v1(project_id, author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create a template by project id. .

Parameters:

• author (string) – Configuration Templates’s Author of template .

• composite (boolean) – Configuration Templates’s Is it composite template .

• containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

• createTime (integer) – Configuration Templates’s Create time of template .

• customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

• description (string) – Configuration Templates’s Description of template .

• deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

• failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

• id (string) – Configuration Templates’s UUID of template .

• language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

• lastUpdateTime (integer) – Configuration Templates’s Update time of template .

• latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

• name (string) – Configuration Templates’s Name of template .

• parentTemplateId (string) – Configuration Templates’s Parent templateID .

• projectId (string) – Configuration Templates’s Project UUID .

• projectName (string) – Configuration Templates’s Project name .

• rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

• rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

• softwareType (string) – Configuration Templates’s Applicable device software type .

• softwareVariant (string) – Configuration Templates’s Applicable device software variant .

• softwareVersion (string) – Configuration Templates’s Applicable device software version .

• tags (list) – Configuration Templates’s tags (list of objects).

• templateContent (string) – Configuration Templates’s Template content .

• templateParams (list) – Configuration Templates’s templateParams (list of objects).

• validationErrors (object) – Configuration Templates’s validationErrors.

• version (string) – Configuration Templates’s Current version of template .

• project_id (str) – projectId path parameter. UUID of the project in which the template needs to be created .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

gets_the_templates_available_v1(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, project_names=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)

List the templates available .

Parameters:

• project_id (str) – projectId query parameter. Filter template(s) based on project UUID .

• software_type (str) – softwareType query parameter. Filter template(s) based software type .

• software_version (str) – softwareVersion query parameter. Filter template(s) based softwareVersion .

• product_family (str) – productFamily query parameter. Filter template(s) based on device family .

• product_series (str) – productSeries query parameter. Filter template(s) based on device series .

• product_type (str) – productType query parameter. Filter template(s) based on device type .

• filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

• tags (str, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

• project_names (str, list, set, tuple) – projectNames query parameter. Filter template(s) based on project names .

• un_committed (bool) – unCommitted query parameter. Filter template(s) based on template commited or not .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

update_template_v1(author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update a template. .

Parameters:

• author (string) – Configuration Templates’s Author of template .

• composite (boolean) – Configuration Templates’s Is it composite template .

• containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

• createTime (integer) – Configuration Templates’s Create time of template .

• customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

• description (string) – Configuration Templates’s Description of template .

• deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

• failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

• id (string) – Configuration Templates’s UUID of template .

• language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

• lastUpdateTime (integer) – Configuration Templates’s Update time of template .

• latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

• name (string) – Configuration Templates’s Name of template .

• parentTemplateId (string) – Configuration Templates’s Parent templateID .

• projectId (string) – Configuration Templates’s Project UUID .

• projectName (string) – Configuration Templates’s Project name .

• rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

• rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

• softwareType (string) – Configuration Templates’s Applicable device software type .

• softwareVariant (string) – Configuration Templates’s Applicable device software variant .

• softwareVersion (string) – Configuration Templates’s Applicable device software version .

• tags (list) – Configuration Templates’s tags (list of objects).

• templateContent (string) – Configuration Templates’s Template content .

• templateParams (list) – Configuration Templates’s templateParams (list of objects).

• validationErrors (object) – Configuration Templates’s validationErrors.

• version (string) – Configuration Templates’s Current version of template .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-template

deploy_template_v1(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to deploy a template. .

Parameters:

• forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

• isComposite (boolean) – Configuration Templates’s Composite template flag .

• mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

• memberTemplateDeploymentInfo (list) – Configuration Templates’s memberTemplateDeploymentInfo (list of strings).

• targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

• templateId (string) – Configuration Templates’s UUID of template to be provisioned .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_template_deployment_status_v1(deployment_id, headers=None, **request_parameters)

API to retrieve the status of template deployment. .

Parameters:

• deployment_id (str) – deploymentId path parameter. UUID of deployment to retrieve template deployment status .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

export_templates_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Exports the templates for given templateIds. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

preview_template_v1(deviceId=None, params=None, resourceParams=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to preview a template. .

Parameters:

• deviceId (string) – Configuration Templates’s UUID of device to get template preview .

• params (object) – Configuration Templates’s Params to render preview .

• resourceParams (object) – Configuration Templates’s Resource params to render preview .

• templateId (string) – Configuration Templates’s UUID of template to get template preview .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!preview-template

version_template_v1(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to version the current contents of the template. .

Parameters:

• comments (string) – Configuration Templates’s Template version comments .

• templateId (string) – Configuration Templates’s UUID of template .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!version-template

gets_all_the_versions_of_a_given_template_v1(template_id, headers=None, **request_parameters)

Get all the versions of template by its id .

Parameters:

• template_id (str) – templateId path parameter. templateId(UUID) to get list of versioned templates .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

deletes_the_template_v1(template_id, headers=None, **request_parameters)

Deletes the template by its id .

Parameters:

• template_id (str) – templateId path parameter. templateId(UUID) of template to be deleted .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_template_details_v1(template_id, latest_version=None, headers=None, **request_parameters)

Details of the template by its id .

Parameters:

• template_id (str) – templateId path parameter. TemplateId(UUID) to get details of the template .

• latest_version (bool) – latestVersion query parameter. latestVersion flag to get the latest versioned template .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_projects_details_v2(id=None, limit=None, name=None, offset=None, sort_order=None, headers=None, **request_parameters)

Get project(s) details .

Parameters:

• id (str) – id query parameter. Id of project to be searched .

• name (str) – name query parameter. Name of project to be searched .

• offset (int) – offset query parameter. Index of first result .

• limit (int) – limit query parameter. Limits number of results .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_templates_details_v2(all_template_attributes=None, filter_conflicting_templates=None, id=None, include_version_details=None, limit=None, name=None, offset=None, product_family=None, product_series=None, product_type=None, project_id=None, project_name=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)

Get template(s) details .

Parameters:

• id (str) – id query parameter. Id of template to be searched .

• name (str) – name query parameter. Name of template to be searched .

• project_id (str) – projectId query parameter. Filter template(s) based on project id .

• project_name (str) – projectName query parameter. Filter template(s) based on project name .

• software_type (str) – softwareType query parameter. Filter template(s) based software type .

• software_version (str) – softwareVersion query parameter. Filter template(s) based softwareVersion .

• product_family (str) – productFamily query parameter. Filter template(s) based on device family .

• product_series (str) – productSeries query parameter. Filter template(s) based on device series .

• product_type (str) – productType query parameter. Filter template(s) based on device type .

• filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

• tags (str, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

• un_committed (bool) – unCommitted query parameter. Return uncommitted template .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .

• all_template_attributes (bool) – allTemplateAttributes query parameter. Return all template attributes .

• include_version_details (bool) – includeVersionDetails query parameter. Include template version details .

• offset (int) – offset query parameter. Index of first result .

• limit (int) – limit query parameter. Limits number of results .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

deploy_template_v2(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)

V2 API to deploy a template. .

Parameters:

• forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

• isComposite (boolean) – Configuration Templates’s Composite template flag .

• mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

• memberTemplateDeploymentInfo (list) – Configuration Templates’s memberTemplateDeploymentInfo (list of strings).

• targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

• templateId (string) – Configuration Templates’s UUID of template to be provisioned .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

imports_the_projects_provided(do_version=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of imports_the_projects_provided_v1 .

Parameters:

• do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload ((list, dict)) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of imports_the_projects_provided_v1.

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_project_v1. .

Parameters:

• createTime (integer) – Configuration Templates’s Create time of project .

• description (string) – Configuration Templates’s Description of project .

• id (string) – Configuration Templates’s UUID of project .

• lastUpdateTime (integer) – Configuration Templates’s Update time of project .

• name (string) – Configuration Templates’s Name of project .

• tags (list) – Configuration Templates’s tags (list of objects).

• templates (list) – Configuration Templates’s List of templates within the project (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_project_v1.

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of deploy_template_v1. .

Parameters:

• forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

• isComposite (boolean) – Configuration Templates’s Composite template flag .

• mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

• memberTemplateDeploymentInfo (list) – Configuration Templates’s memberTemplateDeploymentInfo (list of strings).

• targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

• templateId (string) – Configuration Templates’s UUID of template to be provisioned .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of deploy_template_v1.

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_template_v1. .

Parameters:

• author (string) – Configuration Templates’s Author of template .

• composite (boolean) – Configuration Templates’s Is it composite template .

• containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

• createTime (integer) – Configuration Templates’s Create time of template .

• customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

• description (string) – Configuration Templates’s Description of template .

• deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

• failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

• id (string) – Configuration Templates’s UUID of template .

• language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

• lastUpdateTime (integer) – Configuration Templates’s Update time of template .

• latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

• name (string) – Configuration Templates’s Name of template .

• parentTemplateId (string) – Configuration Templates’s Parent templateID .

• projectId (string) – Configuration Templates’s Project UUID .

• projectName (string) – Configuration Templates’s Project name .

• rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

• rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

• softwareType (string) – Configuration Templates’s Applicable device software type .

• softwareVariant (string) – Configuration Templates’s Applicable device software variant .

• softwareVersion (string) – Configuration Templates’s Applicable device software version .

• tags (list) – Configuration Templates’s tags (list of objects).

• templateContent (string) – Configuration Templates’s Template content .

• templateParams (list) – Configuration Templates’s templateParams (list of objects).

• validationErrors (object) – Configuration Templates’s validationErrors.

• version (string) – Configuration Templates’s Current version of template .

• project_id (str) – projectId path parameter. UUID of the project in which the template needs to be created .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_template_v1.

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_project_v1. .

Parameters:

• createTime (integer) – Configuration Templates’s Create time of project .

• description (string) – Configuration Templates’s Description of project .

• id (string) – Configuration Templates’s UUID of project .

• lastUpdateTime (integer) – Configuration Templates’s Update time of project .

• name (string) – Configuration Templates’s Name of project .

• tags (list) – Configuration Templates’s tags (list of objects).

• templates (object) – Configuration Templates’s List of templates within the project .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_project_v1.

get_project_details(project_id, headers=None, **request_parameters)

This function is an alias of get_project_details_v1. .

Parameters:

• project_id (str) – projectId path parameter. projectId(UUID) of project to get project details .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_project_details_v1.

deletes_the_template(template_id, headers=None, **request_parameters)

This function is an alias of deletes_the_template_v1.

Parameters:

• template_id (str) – templateId path parameter. templateId(UUID) of template to be deleted .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of deletes_the_template_v1.

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, project_names=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)

This function is an alias of gets_the_templates_available_v1 .

Parameters:

• project_id (str) – projectId query parameter. Filter template(s) based on project UUID .

• software_type (str) – softwareType query parameter. Filter template(s) based software type .

• software_version (str) – softwareVersion query parameter. Filter template(s) based softwareVersion .

• product_family (str) – productFamily query parameter. Filter template(s) based on device family .

• product_series (str) – productSeries query parameter. Filter template(s) based on device series .

• product_type (str) – productType query parameter. Filter template(s) based on device type .

• filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

• tags (str, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

• project_names (str, list, set, tuple) – projectNames query parameter. Filter template(s) based on project names .

• un_committed (bool) – unCommitted query parameter. Filter template(s) based on template commited or not .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_the_templates_available_v1.

export_projects(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of export_projects_v1. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of export_projects_v1.

exports_the_projects_for_a_given_criteria(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of export_projects.

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of export_projects.

clone_given_template(name, project_id, template_id, headers=None, **request_parameters)

This function is an alias of clone_given_template_v1 .

Parameters:

• name (str) – name path parameter. Template name to clone template(Name should be different than existing template name within same project) .

• template_id (str) – templateId path parameter. UUID of the template to clone it .

• project_id (str) – projectId path parameter.

• project_id – projectId query parameter. UUID of the project in which the template needs to be created .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of clone_given_template_v1.

imports_the_templates_provided(project_name, do_version=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of imports_the_templates_provided_v1.

Parameters:

• project_name (str) – projectName path parameter. Project name to create template under the project .

• do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of imports_the_templates_provided_v1.

preview_template(deviceId=None, params=None, resourceParams=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of preview_template_v1. .

Parameters:

• deviceId (string) – Configuration Templates’s UUID of device to get template preview .

• params (object) – Configuration Templates’s Params to render preview .

• resourceParams (object) – Configuration Templates’s Resource params to render preview .

• templateId (string) – Configuration Templates’s UUID of template to get template preview .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of preview_template_v1.

deletes_the_project(project_id, headers=None, **request_parameters)

This function is an alias of deletes_the_project_v1 .

Parameters:

• project_id (str) – projectId path parameter. projectId(UUID) of project to be deleted .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of deletes_the_project_v1.

export_templates(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of export_templates_v1. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of export_templates_v1.

get_template_versions(template_id, headers=None, **request_parameters)

This function is an alias of gets_all_the_versions_of_a_given_template_v1 .

Parameters:

• template_id (str) – templateId path parameter. templateId(UUID) to get list of versioned templates .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_all_the_versions_of_a_given_template_v1.

get_template_deployment_status(deployment_id, headers=None, **request_parameters)

This function is an alias of get_template_deployment_status_v1. .

Parameters:

• deployment_id (str) – deploymentId path parameter. UUID of deployment to retrieve template deployment status .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_template_deployment_status_v1.

update_template(author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_template_v1. .

Parameters:

• author (string) – Configuration Templates’s Author of template .

• composite (boolean) – Configuration Templates’s Is it composite template .

• containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

• createTime (integer) – Configuration Templates’s Create time of template .

• customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

• description (string) – Configuration Templates’s Description of template .

• deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

• failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

• id (string) – Configuration Templates’s UUID of template .

• language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

• lastUpdateTime (integer) – Configuration Templates’s Update time of template .

• latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

• name (string) – Configuration Templates’s Name of template .

• parentTemplateId (string) – Configuration Templates’s Parent templateID .

• projectId (string) – Configuration Templates’s Project UUID .

• projectName (string) – Configuration Templates’s Project name .

• rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

• rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

• softwareType (string) – Configuration Templates’s Applicable device software type .

• softwareVariant (string) – Configuration Templates’s Applicable device software variant .

• softwareVersion (string) – Configuration Templates’s Applicable device software version .

• tags (list) – Configuration Templates’s tags (list of objects).

• templateContent (string) – Configuration Templates’s Template content .

• templateParams (list) – Configuration Templates’s templateParams (list of objects).

• validationErrors (object) – Configuration Templates’s validationErrors.

• version (string) – Configuration Templates’s Current version of template .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_template_v1.

get_projects(name=None, sort_order=None, headers=None, **request_parameters)

This function is an alias of get_projects_v1.

Parameters:

• name (str) – name query parameter. Name of project to be searched .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_projects_v1.

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)

This function is an alias of get_template_details_v1.

Parameters:

• template_id (str) – templateId path parameter. TemplateId(UUID) to get details of the template .

• latest_version (bool) – latestVersion query parameter. latestVersion flag to get the latest versioned template .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_template_details_v1.

get_templates_details(all_template_attributes=None, filter_conflicting_templates=None, id=None, include_version_details=None, limit=None, name=None, offset=None, product_family=None, product_series=None, product_type=None, project_id=None, project_name=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)

This function is an alias of get_templates_details_v2. .

Parameters:

• id (str) – id query parameter. Id of template to be searched .

• name (str) – name query parameter. Name of template to be searched .

• project_id (str) – projectId query parameter. Filter template(s) based on project id .

• project_name (str) – projectName query parameter. Filter template(s) based on project name .

• software_type (str) – softwareType query parameter. Filter template(s) based software type .

• software_version (str) – softwareVersion query parameter. Filter template(s) based softwareVersion .

• product_family (str) – productFamily query parameter. Filter template(s) based on device family .

• product_series (str) – productSeries query parameter. Filter template(s) based on device series .

• product_type (str) – productType query parameter. Filter template(s) based on device type .

• filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

• tags (str, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

• un_committed (bool) – unCommitted query parameter. Return uncommitted template .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .

• all_template_attributes (bool) – allTemplateAttributes query parameter. Return all template attributes .

• include_version_details (bool) – includeVersionDetails query parameter. Include template version details .

• offset (int) – offset query parameter. Index of first result .

• limit (int) – limit query parameter. Limits number of results .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_templates_details_v2.

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of version_template_v1. .

Parameters:

• comments (string) – Configuration Templates’s Template version comments .

• templateId (string) – Configuration Templates’s UUID of template .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of version_template_v1.

device_onboarding_pnp

class DeviceOnboardingPnp

Cisco DNA Center Device Onboarding (PnP) API (version: 2.3.7.6).

Wraps the DNA Center Device Onboarding (PnP) API and exposes the API as native Python methods that return native Python objects.

authorize_device_v1(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)

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

Parameters:

• deviceIdList (list) – Device Onboarding (PnP)’s Device Id List (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

add_device_v1(deviceInfo=None, headers=None, payload=None, active_validation=True, **request_parameters)

Adds a device to the PnP database. .

Parameters:

• deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-device

get_device_list_v1(hostname=None, last_contact=None, limit=None, mac_address=None, name=None, offset=None, onb_state=None, pid=None, serial_number=None, site_name=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)

Returns list of devices from Plug & Play based on filter criteria. Returns 50 devices by default. This endpoint supports Pagination and Sorting. .

Parameters:

• limit (int) – limit query parameter. Limits number of results .

• offset (int) – offset query parameter. Index of first result .

• sort (str, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• serial_number (str, list, set, tuple) – serialNumber query parameter. Device Serial Number .

• state (str, list, set, tuple) – state query parameter. Device State .

• onb_state (str, list, set, tuple) – onbState query parameter. Device Onboarding State .

• name (str, list, set, tuple) – name query parameter. Device Name .

• pid (str, list, set, tuple) – pid query parameter. Device ProductId .

• source (str, list, set, tuple) – source query parameter. Device Source .

• workflow_id (str, list, set, tuple) – workflowId query parameter. Device Workflow Id .

• workflow_name (str, list, set, tuple) – workflowName query parameter. Device Workflow Name .

• smart_account_id (str, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

• virtual_account_id (str, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

• last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

• mac_address (str) – macAddress query parameter. Device Mac Address .

• hostname (str) – hostname query parameter. Device Hostname .

• site_name (str) – siteName query parameter. Device Site Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-list-site-management

claim_device_v1(authorizationNeeded=None, configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Claims one of more devices with specified workflow .

Parameters:

• authorizationNeeded (boolean) – Device Onboarding (PnP)’s Flag to enable/disable PnP device authorization. (true means enable) .

• configFileUrl (string) – Device Onboarding (PnP)’s configFileUrl.

• configId (string) – Device Onboarding (PnP)’s configId.

• deviceClaimList (list) – Device Onboarding (PnP)’s deviceClaimList (list of objects).

• fileServiceId (string) – Device Onboarding (PnP)’s fileServiceId.

• imageId (string) – Device Onboarding (PnP)’s imageId.

• imageUrl (string) – Device Onboarding (PnP)’s imageUrl.

• populateInventory (boolean) – Device Onboarding (PnP)’s populateInventory.

• projectId (string) – Device Onboarding (PnP)’s projectId.

• workflowId (string) – Device Onboarding (PnP)’s workflowId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!claim-device

get_device_count_v1(last_contact=None, name=None, onb_state=None, pid=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)

Returns the device count based on filter criteria. This is useful for pagination .

Parameters:

• serial_number (str, list, set, tuple) – serialNumber query parameter. Device Serial Number .

• state (str, list, set, tuple) – state query parameter. Device State .

• onb_state (str, list, set, tuple) – onbState query parameter. Device Onboarding State .

• name (str, list, set, tuple) – name query parameter. Device Name .

• pid (str, list, set, tuple) – pid query parameter. Device ProductId .

• source (str, list, set, tuple) – source query parameter. Device Source .

• workflow_id (str, list, set, tuple) – workflowId query parameter. Device Workflow Id .

• workflow_name (str, list, set, tuple) – workflowName query parameter. Device Workflow Name .

• smart_account_id (str, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

• virtual_account_id (str, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

• last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-count

get_device_history_v1(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)

Returns history for a specific device. Serial number is a required parameter .

Parameters:

• serial_number (str) – serialNumber query parameter. Device Serial Number .

• sort (str, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-history

import_devices_in_bulk_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Add devices to PnP in bulk .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!import-devices-in-bulk

reset_device_v1(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Recovers a device from a Workflow Execution Error state .

Parameters:

• deviceResetList (list) – Device Onboarding (PnP)’s deviceResetList (list of objects).

• projectId (string) – Device Onboarding (PnP)’s projectId.

• workflowId (string) – Device Onboarding (PnP)’s workflowId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!reset-device

get_sync_result_for_virtual_account_v1(domain, name, headers=None, **request_parameters)

Returns the summary of devices synced from the given smart account & virtual account with PnP (Deprecated) .

Parameters:

• domain (str) – domain path parameter. Smart Account Domain .

• name (str) – name path parameter. Virtual Account Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-sync-result-for-virtual-account

claim_a_device_to_a_site_v1(configInfo=None, deviceId=None, gateway=None, hostname=None, imageInfo=None, ipInterfaceName=None, rfProfile=None, sensorProfile=None, siteId=None, staticIP=None, subnetMask=None, type=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Claim a device based on DNA Center Site-based design process. Some required parameters differ based on device platform: Default/StackSwitch: imageInfo, configInfo. AccessPoints: rfProfile. Sensors: sensorProfile. DNAWLC/MobilityExpress/EWC: staticIP, subnetMask, gateway. vlanId and ipInterfaceName are also allowed for DNA 9800 WLCs. .

Parameters:

• configInfo (object) – Device Onboarding (PnP)’s configInfo.

• deviceId (string) – Device Onboarding (PnP)’s Device Id.

• gateway (string) – Device Onboarding (PnP)’s for DNAWLC/MobilityExpress .

• hostname (string) – Device Onboarding (PnP)’s hostname to configure on Device. .

• imageInfo (object) – Device Onboarding (PnP)’s imageInfo.

• ipInterfaceName (string) – Device Onboarding (PnP)’s for DNA 9800 WLC .

• rfProfile (string) – Device Onboarding (PnP)’s for Access Points .

• sensorProfile (string) – Device Onboarding (PnP)’s for Sensors .

• siteId (string) – Device Onboarding (PnP)’s Site Id.

• staticIP (string) – Device Onboarding (PnP)’s for DNAWLC/MobilityExpress .

• subnetMask (string) – Device Onboarding (PnP)’s for DNAWLC/MobilityExpress .

• type (string) – Device Onboarding (PnP)’s Type. Available values are ‘Default’, ‘StackSwitch’, ‘AccessPoint’, ‘Sensor’, ‘DNAWLC’ and ‘MobilityExpress’.

• vlanId (string) – Device Onboarding (PnP)’s for DNA 9800 WLC .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!claim-a-device-to-a-site

preview_config_v1(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)

Triggers a preview for site-based Day 0 Configuration .

Parameters:

• deviceId (string) – Device Onboarding (PnP)’s deviceId.

• siteId (string) – Device Onboarding (PnP)’s siteId.

• type (string) – Device Onboarding (PnP)’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!preview-config

un_claim_device_v1(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)

Un-Claims one of more devices with specified workflow (Deprecated). .

Parameters:

• deviceIdList (list) – Device Onboarding (PnP)’s deviceIdList (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!un-claim-device

sync_virtual_account_devices_v1(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices (Deprecated). .

Parameters:

• autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

• ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

• expiry (integer) – Device Onboarding (PnP)’s expiry.

• lastSync (integer) – Device Onboarding (PnP)’s lastSync.

• profile (object) – Device Onboarding (PnP)’s profile.

• smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

• syncResult (object) – Device Onboarding (PnP)’s syncResult.

• syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

• syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

• syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• token (string) – Device Onboarding (PnP)’s token.

• virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sync-virtual-account-devices

update_device_v1(id, deviceInfo=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates device details specified by device id in PnP database .

Parameters:

• deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

• id (str) – Device Onboarding (PnP)’s Id.

• id – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-device

delete_device_by_id_from_pnp_v1(id, headers=None, **request_parameters)

Deletes specified device from PnP database .

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-device-by-id-from-pnp

get_device_by_id_v1(id, headers=None, **request_parameters)

Returns device details specified by device id .

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-by-id

update_pnp_global_settings_v1(acceptEula=None, defaultProfile=None, id=None, savaMappingList=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates the user’s list of global PnP settings .

Parameters:

• acceptEula (string) – Device Onboarding (PnP)’s Accept Eula.

• defaultProfile (object) – Device Onboarding (PnP)’s defaultProfile.

• id (string) – Device Onboarding (PnP)’s Id.

• savaMappingList (list) – Device Onboarding (PnP)’s savaMappingList (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-pnp-global-settings

get_pnp_global_settings_v1(headers=None, **request_parameters)

Returns global PnP settings of the user .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-pnp-global-settings

get_smart_account_list_v1(headers=None, **request_parameters)

Returns the list of Smart Account domains .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-smart-account-list

get_virtual_account_list_v1(domain, headers=None, **request_parameters)

Returns list of virtual accounts associated with the specified smart account .

Parameters:

• domain (str) – domain path parameter. Smart Account Domain .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-virtual-account-list

add_virtual_account_v1(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile .

Parameters:

• autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

• ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

• expiry (integer) – Device Onboarding (PnP)’s expiry.

• lastSync (integer) – Device Onboarding (PnP)’s lastSync.

• profile (object) – Device Onboarding (PnP)’s profile.

• smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

• syncResult (object) – Device Onboarding (PnP)’s syncResult.

• syncResultStr (string) – Device Onboarding (PnP)’s Represent internal state and SHOULD not be used or relied upon. (Deprecated) .

• syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

• syncStatus (string) – Device Onboarding (PnP)’s Represent internal state and SHOULD not be used or relied upon. (Deprecated) . Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

• tenantId (string) – Device Onboarding (PnP)’s Represent internal state and SHOULD not be used or relied upon. (Deprecated) .

• token (string) – Device Onboarding (PnP)’s Represent internal state and SHOULD not be used or relied upon. (Deprecated) .

• virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-virtual-account

update_pnp_server_profile_v1(ccoUser=None, profile=None, smartAccountId=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info .

Parameters:

• ccoUser (string) – Device Onboarding (PnP)’s Cco User.

• profile (object) – Device Onboarding (PnP)’s profile.

• smartAccountId (string) – Device Onboarding (PnP)’s Smart Account Id.

• virtualAccountId (string) – Device Onboarding (PnP)’s Virtual Account Id.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-pnp-server-profile

deregister_virtual_account_v1(domain, name, headers=None, **request_parameters)

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information .

Parameters:

• domain (str) – domain query parameter. Smart Account Domain .

• name (str) – name query parameter. Virtual Account Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deregister-virtual-account

get_workflows_v1(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint .

Parameters:

• limit (int) – limit query parameter. Limits number of results .

• offset (int) – offset query parameter. Index of first result .

• sort (str, list, set, tuple) – sort query parameter. Comma seperated lost of fields to sort on .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• type (str, list, set, tuple) – type query parameter. Workflow Type .

• name (str, list, set, tuple) – name query parameter. Workflow Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-workflows

add_a_workflow_v1(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database .

Parameters:

• _id (string) – Device Onboarding (PnP)’s _id.

• addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

• addedOn (integer) – Device Onboarding (PnP)’s addedOn.

• configId (string) – Device Onboarding (PnP)’s configId.

• currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

• description (string) – Device Onboarding (PnP)’s description.

• endTime (integer) – Device Onboarding (PnP)’s endTime.

• execTime (integer) – Device Onboarding (PnP)’s execTime.

• imageId (string) – Device Onboarding (PnP)’s imageId.

• instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

• lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

• name (string) – Device Onboarding (PnP)’s name.

• startTime (integer) – Device Onboarding (PnP)’s startTime.

• state (string) – Device Onboarding (PnP)’s state.

• tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• type (string) – Device Onboarding (PnP)’s type.

• useState (string) – Device Onboarding (PnP)’s useState.

• version (integer) – Device Onboarding (PnP)’s version.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-a-workflow

get_workflow_count_v1(name=None, headers=None, **request_parameters)

Returns the workflow count .

Parameters:

• name (str, list, set, tuple) – name query parameter. Workflow Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-workflow-count

get_workflow_by_id_v1(id, headers=None, **request_parameters)

Returns a workflow specified by id .

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-workflow-by-id

delete_workflow_by_id_v1(id, headers=None, **request_parameters)

Deletes a workflow specified by id .

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-workflow-by-id

update_workflow_v1(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates an existing workflow .

Parameters:

• _id (string) – Device Onboarding (PnP)’s _id.

• addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

• addedOn (integer) – Device Onboarding (PnP)’s addedOn.

• configId (string) – Device Onboarding (PnP)’s configId.

• currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

• description (string) – Device Onboarding (PnP)’s description.

• endTime (integer) – Device Onboarding (PnP)’s endTime.

• execTime (integer) – Device Onboarding (PnP)’s execTime.

• imageId (string) – Device Onboarding (PnP)’s imageId.

• instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

• lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

• name (string) – Device Onboarding (PnP)’s name.

• startTime (integer) – Device Onboarding (PnP)’s startTime.

• state (string) – Device Onboarding (PnP)’s state.

• tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• type (string) – Device Onboarding (PnP)’s type.

• useState (string) – Device Onboarding (PnP)’s useState.

• version (integer) – Device Onboarding (PnP)’s version.

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-workflow

add_device(deviceInfo=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of add_device_v1. .

Parameters:

• deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of add_device_v1.

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)

This function is an alias of get_workflows_v1 .

Parameters:

• limit (int) – limit query parameter. Limits number of results .

• offset (int) – offset query parameter. Index of first result .

• sort (str, list, set, tuple) – sort query parameter. Comma seperated lost of fields to sort on .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• type (str, list, set, tuple) – type query parameter. Workflow Type .

• name (str, list, set, tuple) – name query parameter. Workflow Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_workflows_v1.

get_workflow_by_id(id, headers=None, **request_parameters)

This function is an alias of get_workflow_by_id_v1 .

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_workflow_by_id_v1.

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of import_devices_in_bulk_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of import_devices_in_bulk_v1.

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of add_virtual_account_v1 .

Parameters:

• autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

• ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

• expiry (integer) – Device Onboarding (PnP)’s expiry.

• lastSync (integer) – Device Onboarding (PnP)’s lastSync.

• profile (object) – Device Onboarding (PnP)’s profile.

• smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

• syncResult (object) – Device Onboarding (PnP)’s syncResult.

• syncResultStr (string) – Device Onboarding (PnP)’s Represent internal state and SHOULD not be used or relied upon. (Deprecated) .

• syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

• syncStatus (string) – Device Onboarding (PnP)’s Represent internal state and SHOULD not be used or relied upon. (Deprecated) . Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

• tenantId (string) – Device Onboarding (PnP)’s Represent internal state and SHOULD not be used or relied upon. (Deprecated) .

• token (string) – Device Onboarding (PnP)’s Represent internal state and SHOULD not be used or relied upon. (Deprecated) .

• virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of add_virtual_account_v1.

update_pnp_global_settings(acceptEula=None, defaultProfile=None, id=None, savaMappingList=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_pnp_global_settings_v1 .

Parameters:

• acceptEula (string) – Device Onboarding (PnP)’s Accept Eula.

• defaultProfile (object) – Device Onboarding (PnP)’s defaultProfile.

• id (string) – Device Onboarding (PnP)’s Id.

• savaMappingList (list) – Device Onboarding (PnP)’s savaMappingList (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_pnp_global_settings_v1.

get_virtual_account_list(domain, headers=None, **request_parameters)

This function is an alias of get_virtual_account_list_v1 .

Parameters:

• domain (str) – domain path parameter. Smart Account Domain .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_virtual_account_list_v1.

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of preview_config_v1 .

Parameters:

• deviceId (string) – Device Onboarding (PnP)’s deviceId.

• siteId (string) – Device Onboarding (PnP)’s siteId.

• type (string) – Device Onboarding (PnP)’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of preview_config_v1.

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of reset_device_v1 .

Parameters:

• deviceResetList (list) – Device Onboarding (PnP)’s deviceResetList (list of objects).

• projectId (string) – Device Onboarding (PnP)’s projectId.

• workflowId (string) – Device Onboarding (PnP)’s workflowId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of reset_device_v1.

get_smart_account_list(headers=None, **request_parameters)

This function is an alias of get_smart_account_list_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_smart_account_list_v1.

update_pnp_server_profile(ccoUser=None, profile=None, smartAccountId=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_pnp_server_profile_v1.

Parameters:

• ccoUser (string) – Device Onboarding (PnP)’s Cco User.

• profile (object) – Device Onboarding (PnP)’s profile.

• smartAccountId (string) – Device Onboarding (PnP)’s Smart Account Id.

• virtualAccountId (string) – Device Onboarding (PnP)’s Virtual Account Id.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_pnp_server_profile_v1.

update_device(id, deviceInfo=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_device_v1 .

Parameters:

• deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

• id (str) – Device Onboarding (PnP)’s Id.

• id – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_device_v1.

authorize_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of authorize_device_v1. .

Parameters:

• deviceIdList (list) – Device Onboarding (PnP)’s Device Id List (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of authorize_device_v1.

delete_workflow_by_id(id, headers=None, **request_parameters)

This function is an alias of delete_workflow_by_id_v1.

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_workflow_by_id_v1.

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)

This function is an alias of get_device_history_v1 .

Parameters:

• serial_number (str) – serialNumber query parameter. Device Serial Number .

• sort (str, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_history_v1.

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of add_a_workflow_v1 .

Parameters:

• _id (string) – Device Onboarding (PnP)’s _id.

• addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

• addedOn (integer) – Device Onboarding (PnP)’s addedOn.

• configId (string) – Device Onboarding (PnP)’s configId.

• currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

• description (string) – Device Onboarding (PnP)’s description.

• endTime (integer) – Device Onboarding (PnP)’s endTime.

• execTime (integer) – Device Onboarding (PnP)’s execTime.

• imageId (string) – Device Onboarding (PnP)’s imageId.

• instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

• lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

• name (string) – Device Onboarding (PnP)’s name.

• startTime (integer) – Device Onboarding (PnP)’s startTime.

• state (string) – Device Onboarding (PnP)’s state.

• tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• type (string) – Device Onboarding (PnP)’s type.

• useState (string) – Device Onboarding (PnP)’s useState.

• version (integer) – Device Onboarding (PnP)’s version.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of add_a_workflow_v1.

get_device_count(last_contact=None, name=None, onb_state=None, pid=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)

This function is an alias of get_device_count_v1 .

Parameters:

• serial_number (str, list, set, tuple) – serialNumber query parameter. Device Serial Number .

• state (str, list, set, tuple) – state query parameter. Device State .

• onb_state (str, list, set, tuple) – onbState query parameter. Device Onboarding State .

• name (str, list, set, tuple) – name query parameter. Device Name .

• pid (str, list, set, tuple) – pid query parameter. Device ProductId .

• source (str, list, set, tuple) – source query parameter. Device Source .

• workflow_id (str, list, set, tuple) – workflowId query parameter. Device Workflow Id .

• workflow_name (str, list, set, tuple) – workflowName query parameter. Device Workflow Name .

• smart_account_id (str, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

• virtual_account_id (str, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

• last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_count_v1.

claim_device(authorizationNeeded=None, configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of claim_device_v1.

Parameters:

• authorizationNeeded (boolean) – Device Onboarding (PnP)’s Flag to enable/disable PnP device authorization. (true means enable) .

• configFileUrl (string) – Device Onboarding (PnP)’s configFileUrl.

• configId (string) – Device Onboarding (PnP)’s configId.

• deviceClaimList (list) – Device Onboarding (PnP)’s deviceClaimList (list of objects).

• fileServiceId (string) – Device Onboarding (PnP)’s fileServiceId.

• imageId (string) – Device Onboarding (PnP)’s imageId.

• imageUrl (string) – Device Onboarding (PnP)’s imageUrl.

• populateInventory (boolean) – Device Onboarding (PnP)’s populateInventory.

• projectId (string) – Device Onboarding (PnP)’s projectId.

• workflowId (string) – Device Onboarding (PnP)’s workflowId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of claim_device_v1.

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_workflow_v1 .

Parameters:

• _id (string) – Device Onboarding (PnP)’s _id.

• addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

• addedOn (integer) – Device Onboarding (PnP)’s addedOn.

• configId (string) – Device Onboarding (PnP)’s configId.

• currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

• description (string) – Device Onboarding (PnP)’s description.

• endTime (integer) – Device Onboarding (PnP)’s endTime.

• execTime (integer) – Device Onboarding (PnP)’s execTime.

• imageId (string) – Device Onboarding (PnP)’s imageId.

• instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

• lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

• name (string) – Device Onboarding (PnP)’s name.

• startTime (integer) – Device Onboarding (PnP)’s startTime.

• state (string) – Device Onboarding (PnP)’s state.

• tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• type (string) – Device Onboarding (PnP)’s type.

• useState (string) – Device Onboarding (PnP)’s useState.

• version (integer) – Device Onboarding (PnP)’s version.

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_workflow_v1.

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of sync_virtual_account_devices_v1. .

Parameters:

• autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

• ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

• expiry (integer) – Device Onboarding (PnP)’s expiry.

• lastSync (integer) – Device Onboarding (PnP)’s lastSync.

• profile (object) – Device Onboarding (PnP)’s profile.

• smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

• syncResult (object) – Device Onboarding (PnP)’s syncResult.

• syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

• syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

• syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

• tenantId (string) – Device Onboarding (PnP)’s tenantId.

• token (string) – Device Onboarding (PnP)’s token.

• virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of sync_virtual_account_devices_v1.

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of un_claim_device_v1. .

Parameters:

• deviceIdList (list) – Device Onboarding (PnP)’s deviceIdList (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of un_claim_device_v1.

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)

This function is an alias of delete_device_by_id_from_pnp_v1 .

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_device_by_id_from_pnp_v1.

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)

This function is an alias of get_sync_result_for_virtual_account_v1 .

Parameters:

• domain (str) – domain path parameter. Smart Account Domain .

• name (str) – name path parameter. Virtual Account Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_sync_result_for_virtual_account_v1.

deregister_virtual_account(domain, name, headers=None, **request_parameters)

This function is an alias of deregister_virtual_account_v1.

Parameters:

• domain (str) – domain query parameter. Smart Account Domain .

• name (str) – name query parameter. Virtual Account Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of deregister_virtual_account_v1.

get_device_list(hostname=None, last_contact=None, limit=None, mac_address=None, name=None, offset=None, onb_state=None, pid=None, serial_number=None, site_name=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)

This function is an alias of get_device_list_v1. .

Parameters:

• limit (int) – limit query parameter. Limits number of results .

• offset (int) – offset query parameter. Index of first result .

• sort (str, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

• sort_order (str) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

• serial_number (str, list, set, tuple) – serialNumber query parameter. Device Serial Number .

• state (str, list, set, tuple) – state query parameter. Device State .

• onb_state (str, list, set, tuple) – onbState query parameter. Device Onboarding State .

• name (str, list, set, tuple) – name query parameter. Device Name .

• pid (str, list, set, tuple) – pid query parameter. Device ProductId .

• source (str, list, set, tuple) – source query parameter. Device Source .

• workflow_id (str, list, set, tuple) – workflowId query parameter. Device Workflow Id .

• workflow_name (str, list, set, tuple) – workflowName query parameter. Device Workflow Name .

• smart_account_id (str, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

• virtual_account_id (str, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

• last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

• mac_address (str) – macAddress query parameter. Device Mac Address .

• hostname (str) – hostname query parameter. Device Hostname .

• site_name (str) – siteName query parameter. Device Site Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_list_v1.

get_pnp_global_settings(headers=None, **request_parameters)

This function is an alias of get_pnp_global_settings_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_pnp_global_settings_v1.

get_device_by_id(id, headers=None, **request_parameters)

This function is an alias of get_device_by_id_v1.

Parameters:

• id (str) – id path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_by_id_v1.

claim_a_device_to_a_site(configInfo=None, deviceId=None, gateway=None, hostname=None, imageInfo=None, ipInterfaceName=None, rfProfile=None, sensorProfile=None, siteId=None, staticIP=None, subnetMask=None, type=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of claim_a_device_to_a_site_v1. .

Parameters:

• configInfo (object) – Device Onboarding (PnP)’s configInfo.

• deviceId (string) – Device Onboarding (PnP)’s Device Id.

• gateway (string) – Device Onboarding (PnP)’s for DNAWLC/MobilityExpress .

• hostname (string) – Device Onboarding (PnP)’s hostname to configure on Device. .

• imageInfo (object) – Device Onboarding (PnP)’s imageInfo.

• ipInterfaceName (string) – Device Onboarding (PnP)’s for DNA 9800 WLC .

• rfProfile (string) – Device Onboarding (PnP)’s for Access Points .

• sensorProfile (string) – Device Onboarding (PnP)’s for Sensors .

• siteId (string) – Device Onboarding (PnP)’s Site Id.

• staticIP (string) – Device Onboarding (PnP)’s for DNAWLC/MobilityExpress .

• subnetMask (string) – Device Onboarding (PnP)’s for DNAWLC/MobilityExpress .

• type (string) – Device Onboarding (PnP)’s Type. Available values are ‘Default’, ‘StackSwitch’, ‘AccessPoint’, ‘Sensor’, ‘DNAWLC’ and ‘MobilityExpress’.

• vlanId (string) – Device Onboarding (PnP)’s for DNA 9800 WLC .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of claim_a_device_to_a_site_v1.

get_workflow_count(name=None, headers=None, **request_parameters)

This function is an alias of get_workflow_count_v1 .

Parameters:

• name (str, list, set, tuple) – name query parameter. Workflow Name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_workflow_count_v1.

device_replacement

class DeviceReplacement

Cisco DNA Center Device Replacement API (version: 2.3.7.6).

Wraps the DNA Center Device Replacement API and exposes the API as native Python methods that return native Python objects.

return_replacement_devices_with_details_v1(family=None, faulty_device_name=None, faulty_device_platform=None, faulty_device_serial_number=None, limit=None, offset=None, replacement_device_platform=None, replacement_device_serial_number=None, replacement_status=None, sort_by=None, sort_order=None, headers=None, **request_parameters)

Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device Serial Number, Device Replacement status, Product Family. .

Parameters:

• faulty_device_name (str) – faultyDeviceName query parameter. Faulty Device Name .

• faulty_device_platform (str) – faultyDevicePlatform query parameter. Faulty Device Platform .

• replacement_device_platform (str) – replacementDevicePlatform query parameter. Replacement Device Platform .

• faulty_device_serial_number (str) – faultyDeviceSerialNumber query parameter. Faulty Device Serial Number .

• replacement_device_serial_number (str) – replacementDeviceSerialNumber query parameter. Replacement Device Serial Number .

• replacement_status (str, list, set, tuple) – replacementStatus query parameter. Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED] .

• family (str, list, set, tuple) – family query parameter. List of families[Routers, Switches and Hubs, AP] .

• sort_by (str) – sortBy query parameter. SortBy this field. SortBy is mandatory when order is used. .

• sort_order (str) – sortOrder query parameter. Order on displayName[ASC,DESC] .

• offset (int) – offset query parameter.

• limit (int) – limit query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!return-list-of-replacement-devices-with-replacement-details

unmark_device_for_replacement_v1(headers=None, payload=None, active_validation=True, **request_parameters)

UnMarks device for replacement .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!un-mark-device-for-replacement

mark_device_for_replacement_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Marks device for replacement .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!mark-device-for-replacement

return_replacement_devices_count_v1(replacement_status=None, headers=None, **request_parameters)

Get replacement devices count .

Parameters:

• replacement_status (str, list, set, tuple) – replacementStatus query parameter. Device Replacement status list[READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!return-replacement-devices-count

deploy_device_replacement_workflow_v1(faultyDeviceSerialNumber=None, replacementDeviceSerialNumber=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images .

Parameters:

• faultyDeviceSerialNumber (string) – Device Replacement’s Faulty device serial number .

• replacementDeviceSerialNumber (string) – Device Replacement’s Replacement device serial number .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deploy-device-replacement-workflow

return_replacement_devices_with_details(family=None, faulty_device_name=None, faulty_device_platform=None, faulty_device_serial_number=None, limit=None, offset=None, replacement_device_platform=None, replacement_device_serial_number=None, replacement_status=None, sort_by=None, sort_order=None, headers=None, **request_parameters)

This function is an alias of return_replacement_devices_with_details_v1. .

Parameters:

• faulty_device_name (str) – faultyDeviceName query parameter. Faulty Device Name .

• faulty_device_platform (str) – faultyDevicePlatform query parameter. Faulty Device Platform .

• replacement_device_platform (str) – replacementDevicePlatform query parameter. Replacement Device Platform .

• faulty_device_serial_number (str) – faultyDeviceSerialNumber query parameter. Faulty Device Serial Number .

• replacement_device_serial_number (str) – replacementDeviceSerialNumber query parameter. Replacement Device Serial Number .

• replacement_status (str, list, set, tuple) – replacementStatus query parameter. Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED] .

• family (str, list, set, tuple) – family query parameter. List of families[Routers, Switches and Hubs, AP] .

• sort_by (str) – sortBy query parameter. SortBy this field. SortBy is mandatory when order is used. .

• sort_order (str) – sortOrder query parameter. Order on displayName[ASC,DESC] .

• offset (int) – offset query parameter.

• limit (int) – limit query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of return_replacement_devices_with_details_v1.

unmark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of unmark_device_for_replacement_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of unmark_device_for_replacement_v1.

return_replacement_devices_count(replacement_status=None, headers=None, **request_parameters)

This function is an alias of return_replacement_devices_count_v1 .

Parameters:

• replacement_status (str, list, set, tuple) – replacementStatus query parameter. Device Replacement status list[READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of return_replacement_devices_count_v1.

mark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of mark_device_for_replacement_v1 .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of mark_device_for_replacement_v1.

deploy_device_replacement_workflow(faultyDeviceSerialNumber=None, replacementDeviceSerialNumber=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of deploy_device_replacement_workflow_v1 .

Parameters:

• faultyDeviceSerialNumber (string) – Device Replacement’s Faulty device serial number .

• replacementDeviceSerialNumber (string) – Device Replacement’s Replacement device serial number .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of deploy_device_replacement_workflow_v1.

devices

class Devices

Cisco DNA Center Devices API (version: 2.3.7.6).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

gets_the_total_number_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1(aggregateAttributes=None, attributes=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

Gets the total number Network Devices based on the provided complex filters and aggregation functions. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-1.0.2-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Devices’s aggregateAttributes (list of objects).

• attributes (list) – Devices’s Attributes (list of strings).

• endTime (integer) – Devices’s End Time.

• filters (list) – Devices’s filters (list of objects).

• page (object) – Devices’s page.

• startTime (integer) – Devices’s Start Time.

• views (list) – Devices’s Views (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-the-total-number-network-devices-based-on-the-provided-complex-filters-and-aggregation-functions

query_assurance_events_v1(device_family, ap_mac=None, attribute=None, client_mac=None, end_time=None, limit=None, message_type=None, network_device_id=None, network_device_name=None, offset=None, order=None, severity=None, site_hierarchy_id=None, site_id=None, sort_by=None, start_time=None, view=None, headers=None, **request_parameters)

Returns the list of events discovered by DNA Center, determined by the complex filters. Please refer to the ‘API Support Documentation’ section to understand which fields are supported. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceEvents-1.0.0-resolved.yaml .

Parameters:

• device_family (str) – deviceFamily query parameter. Device family. Please note that multiple families across network device type and client type is not allowed. For example, choosing Routers along with Wireless Client or Unified AP is not supported. Examples: deviceFamily=Switches and Hubs (single deviceFamily requested) deviceFamily=Switches and Hubs&deviceFamily=Routers (multiple deviceFamily requested) .

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time minus 24 hours. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If endTime is not provided, API will default to current time. .

• message_type (str) – messageType query parameter. Message type for the event. Examples: messageType=Syslog (single messageType requested) messageType=Trap&messageType=Syslog (multiple messageType requested) .

• severity (int) – severity query parameter. Severity of the event between 0 and 6. This is applicable only for events related to network devices (other than AP) and Wired Client events. (Value: Severity: 0: Emergency: 1: Alert: 2: Critical: 3: Error: 4: Warning: 5: Notice: 6: Info), Examples: severity=0 (single severity requested) severity=0&severity=1 (multiple severity requested) .

• site_id (str) – siteId query parameter. The UUID of the site. (Ex. flooruuid) Examples: ?siteId=id1 (single siteId requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple siteId requested) .

• site_hierarchy_id (str) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: ?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyId requested) .

• network_device_name (str) – networkDeviceName query parameter. Network device name. This parameter is applicable for network device related families. This field supports wildcard (*) character-based search. Ex: *Branch* or Branch* or *Branch Examples: networkDeviceName=Branch-3-Gateway (single networkDeviceName requested) networkDeviceName=Branch-3-Gateway&networkDeviceName=Branch-3-Switch (multiple networkDeviceName requested) .

• network_device_id (str) – networkDeviceId query parameter. The list of Network Device Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c (single networkDeviceId requested) networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b- cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple networkDeviceId with & separator) .

• ap_mac (str) – apMac query parameter. MAC address of the access point. This parameter is applicable for Unified AP and Wireless Client events. This field supports wildcard (*) character-based search. Ex: *50:0F* or 50:0F* or *50:0F Examples: apMac=50:0F:80:0F:F7:E0 (single apMac requested) apMac=50:0F:80:0F:F7:E0&apMac=18:80:90:AB:7E:A0 (multiple apMac requested) .

• client_mac (str) – clientMac query parameter. MAC address of the client. This parameter is applicable for Wired Client and Wireless Client events. This field supports wildcard (*) character-based search. Ex: *66:2B* or 66:2B* or *66:2B Examples: clientMac=66:2B:B8:D2:01:56 (single clientMac requested) clientMac=66:2B:B8:D2:01:56&clientMac=DC:A6:32:F5:5A:89 (multiple clientMac requested) .

• attribute (str) – attribute query parameter. The list of attributes that needs to be included in the response. If this parameter is not provided, then basic attributes (id, name, timestamp, details, messageType, siteHierarchyId, siteHierarchy, deviceFamily, networkDeviceId, networkDeviceName, managementIpAddress) would be part of the response. Examples: attribute=name (single attribute requested) attribute=name&attribute=networkDeviceName (multiple attribute requested) .

• view (str) – view query parameter. The list of events views. Please refer to EventViews for the supported list Examples: view=network (single view requested) view=network&view=ap (multiple view requested) .

• offset (int) – offset query parameter. Specifies the starting point within all records returned by the API. It’s one based offset. The starting value is 1. .

• limit (int) – limit query parameter. Maximum number of records to return .

• sort_by (str) – sortBy query parameter. A field within the response to sort by. .

• order (str) – order query parameter. The sort order of the field ascending or descending. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!query-assurance-events

count_the_number_of_events_v1(device_family, ap_mac=None, client_mac=None, end_time=None, message_type=None, network_device_id=None, network_device_name=None, severity=None, site_hierarchy_id=None, site_id=None, start_time=None, headers=None, **request_parameters)

API to fetch the count of assurance events that match the filter criteria. Please refer to the ‘API Support Documentation’ section to understand which fields are supported. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- AssuranceEvents-1.0.0-resolved.yaml .

Parameters:

• device_family (str) – deviceFamily query parameter. Device family. Please note that multiple families across network device type and client type is not allowed. For example, choosing Routers along with Wireless Client or Unified AP is not supported. Examples: deviceFamily=Switches and Hubs (single deviceFamily requested) deviceFamily=Switches and Hubs&deviceFamily=Routers (multiple deviceFamily requested) .

• start_time (str) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time minus 24 hours. .

• end_time (str) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If endTime is not provided, API will default to current time. .

• message_type (str) – messageType query parameter. Message type for the event. Examples: messageType=Syslog (single messageType requested) messageType=Trap&messageType=Syslog (multiple messageType requested) .

• severity (str) – severity query parameter. Severity of the event between 0 and 6. This is applicable only for events related to network devices (other than AP) and Wired Client events. (Value: Severity: 0: Emergency: 1: Alert: 2: Critical: 3: Error: 4: Warning: 5: Notice: 6: Info), Examples: severity=0 (single severity requested) severity=0&severity=1 (multiple severity requested) .

• site_id (str) – siteId query parameter. The UUID of the site. (Ex. flooruuid) Examples: ?siteId=id1 (single siteId requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple siteId requested) .

• site_hierarchy_id (str) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: ?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyId requested) .

• network_device_name (str) – networkDeviceName query parameter. Network device name. This parameter is applicable for network device related families. This field supports wildcard (*) character-based search. Ex: *Branch* or Branch* or *Branch Examples: networkDeviceName=Branch-3-Gateway (single networkDeviceName requested) networkDeviceName=Branch-3-Gateway&networkDeviceName=Branch-3-Switch (multiple networkDeviceName requested) .

• network_device_id (str) – networkDeviceId query parameter. The list of Network Device Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c (single networkDeviceId requested) networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b- cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple networkDeviceId requested) .

• ap_mac (str) – apMac query parameter. MAC address of the access point. This parameter is applicable for Unified AP and Wireless Client events. This field supports wildcard (*) character-based search. Ex: *50:0F* or 50:0F* or *50:0F Examples: apMac=50:0F:80:0F:F7:E0 (single apMac requested) apMac=50:0F:80:0F:F7:E0&apMac=18:80:90:AB:7E:A0 (multiple apMac requested) .

• client_mac (str) – clientMac query parameter. MAC address of the client. This parameter is applicable for Wired Client and Wireless Client events. This field supports wildcard (*) character-based search. Ex: *66:2B* or 66:2B* or *66:2B Examples: clientMac=66:2B:B8:D2:01:56 (single clientMac requested) clientMac=66:2B:B8:D2:01:56&clientMac=DC:A6:32:F5:5A:89 (multiple clientMac requested) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!count-the-number-of-events

query_assurance_events_with_filters_v1(attributes=None, deviceFamily=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

Returns the list of events discovered by DNA Center, determined by the complex filters. Please refer to the ‘API Support Documentation’ section to understand which fields are supported. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceEvents-1.0.0-resolved.yaml .

Parameters:

• attributes (list) – Devices’s Attributes (list of strings).

• deviceFamily (list) – Devices’s Device Family (list of strings).

• endTime (integer) – Devices’s End Time.

• filters (list) – Devices’s filters (list of objects).

• page (object) – Devices’s page.

• startTime (integer) – Devices’s Start Time.

• views (list) – Devices’s Views (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!query-assurance-events-with-filters

count_the_number_of_events_with_filters_v1(deviceFamily=None, endTime=None, filters=None, startTime=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to fetch the count of assurance events for the given complex query. Please refer to the ‘API Support Documentation’ section to understand which fields are supported. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- AssuranceEvents-1.0.0-resolved.yaml .

Parameters:

• deviceFamily (list) – Devices’s Device Family (list of strings).

• endTime (integer) – Devices’s End Time.

• filters (list) – Devices’s filters (list of objects).

• startTime (integer) – Devices’s Start Time.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!count-the-number-of-events-with-filters

get_details_of_a_single_assurance_event_v1(id, attribute=None, view=None, headers=None, **request_parameters)

API to fetch the details of an assurance event using event id. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- AssuranceEvents-1.0.0-resolved.yaml .

Parameters:

• id (str) – id path parameter. Unique identifier for the event .

• attribute (str) – attribute query parameter. The list of attributes that needs to be included in the response. If this parameter is not provided, then basic attributes (id, name, timestamp, details, messageType, siteHierarchyId, siteHierarchy, deviceFamily, networkDeviceId, networkDeviceName, managementIpAddress) would be part of the response. Examples: attribute=name (single attribute requested) attribute=name&attribute=networkDeviceName (multiple attribute requested) .

• view (str) – view query parameter. The list of events views. Please refer to EventViews for the supported list Examples: view=network (single view requested) view=network&view=ap (multiple view requested) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-details-of-a-single-assurance-event

get_list_of_child_events_for_the_given_wireless_client_event_v1(id, headers=None, **request_parameters)

Wireless client event could have child events and this API can be used to fetch the same using parent event id as the input. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceEvents-1.0.0-resolved.yaml .

Parameters:

• id (str) – id path parameter. Unique identifier for the event .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-list-of-child-events-for-the-given-wireless-client-event

gets_interfaces_along_with_statistics_data_from_all_network_devices_v1(attribute=None, end_time=None, interface_id=None, interface_name=None, limit=None, network_device_id=None, network_device_ip_address=None, network_device_mac_address=None, offset=None, order=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, sort_by=None, start_time=None, view=None, headers=None, **request_parameters)

Retrieves the list of the interfaces from all network devices based on the provided query parameters. The latest interfaces data in the specified start and end time range will be returned. When there is no start and end time specified returns the latest available data. The elements are grouped and sorted by deviceUuid first, and are then sorted by the given sort field, or by the default value: name. The supported sorting options are: name, adminStatus, description, duplexConfig, duplexOper,interfaceIfIndex,interfaceType, macAddress,mediaType, operStatus,portChannelId, portMode, portType,speed, vlanId. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-interfaces-1.0.2-resolved.yaml .

Parameters:

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• limit (int) – limit query parameter. Maximum number of records to return .

• offset (int) – offset query parameter. Specifies the starting point within all records returned by the API. It’s one based offset. The starting value is 1. .

• sort_by (str) – sortBy query parameter. A field within the response to sort by. .

• order (str) – order query parameter. The sort order of the field ascending or descending. .

• site_hierarchy (str) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. Global/AreaName/BuildingName/FloorName) This field supports wildcard asterisk (*) character search support. E.g. */San*, */San, /San* Examples: ?siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) ?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/A reaName2/BuildingName2/FloorName2 (multiple siteHierarchies requested) .

• site_hierarchy_id (str) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: ?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyIds requested) .

• site_id (str) – siteId query parameter. The UUID of the site. (Ex. flooruuid) Examples: ?siteId=id1 (single id requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple ids requested) .

• view (str) – view query parameter. The specific summary view being requested. This is an optional parameter which can be passed to get one or more of the specific view associated fields. The default view is configuration. ### Response data proviced by each view: 1. configuration [id,adminStatus,description,duplexConfig,duplexOper,interfaceIfIndex,i nterfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,name,o perStatus, portChannelId,portMode, portType,speed,timestamp,vlanId,networkDeviceId,netwo rkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] 2. statistics [id,name,rxDiscards,rxError,rxRate,rxUtilization,txDiscards,txError,txRat e,txUtilization,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName, siteHierarchy,siteHierarchyId] 3. stackPort [id,name,peerStackMember,peerStackPort ,stackPortType,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,s iteHierarchy,siteHierarchyId] The default view is configuration, If need to access an additional view, simply include the view name in the query parameter. Examples: view=configuration (single view requested) view=configuration&view=statistic&stackPort (multiple views requested) .

• attribute (str) – attribute query parameter. The following list of attributes can be provided in the attribute field [id,adminStatus, description,duplexConfig,duplexOper,interfaceIfInde x,interfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,nam e,operStatus,peerStackMember,peerStackPort, portChannelId,portMode, portType,rxDiscards, rxError,rxRate,rxUtilization,speed,stackPortType,timestamp,txDiscards,txError,txRate,txU tilization,vlanId,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteNam e,siteHierarchy,siteHierarchyId] If length of attribute list is too long, please use ‘views’ param instead. Examples: attributes=name (single attribute requested) attributes=name,description,duplexOper (multiple attributes with comma separator) .

• network_device_id (str) – networkDeviceId query parameter. The list of Network Device Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c (single networkDeviceId requested) networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b- cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple networkDeviceIds with & separator) .

• network_device_ip_address (str) – networkDeviceIpAddress query parameter. The list of Network Device management IP Address. (Ex. 121.1.1.10) This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: networkDeviceIpAddress=121.1.1.10 networkDeviceIpAddress=121.1.1.10&networkDeviceIpAd dress=172.20.1.10&networkDeviceIpAddress=10.10.20.10 (multiple networkDevice IP Address with & separator) .

• network_device_mac_address (str) – networkDeviceMacAddress query parameter. The list of Network Device MAC Address. (Ex. 64:f6:9d:07:9a:00) This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: networkDeviceMacAddress=64:f6:9d:07:9a:00 networkDeviceMacAddress=64:f6:9d:07:9a:00&networkDeviceMacAddress=70:56:9d:07:ac:77 (multiple networkDevice MAC addresses with & separator) .

• interface_id (str) – interfaceId query parameter. The list of Interface Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: interfaceId=6bef213c-19ca-4170-8375-b694e251101c (single interface uuid ) interfaceId =6bef213c-19ca-4170-8375-b694e251101c&32219612-819e-4b5e-a96b-cf22aca13dd9&2541e9a7- b80d-4955-8aa2-79b233318ba0 (multiple Interface uuid with & separator) .

• interface_name (str) – interfaceName query parameter. The list of Interface name (Ex. GigabitEthernet1/0/1) This field supports wildcard (*) character-based search. Ex: *1/0/1* or 1/0/1* or *1/0/1 Examples: interfaceNames=GigabitEthernet1/0/1 (single interface name) interfaceNames=GigabitEthernet1/0/1&GigabitEthernet2/0/1&GigabitEthernet3/0/1 (multiple interface names with & separator) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-interfaces-along-with-statistics-data-from-all-network-devices

gets_the_total_network_device_interface_counts_v1(end_time=None, interface_id=None, interface_name=None, network_device_id=None, network_device_ip_address=None, network_device_mac_address=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, start_time=None, headers=None, **request_parameters)

Gets the total Network device interface counts. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst- center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-interfaces-1.0.2-resolved.yaml .

Parameters:

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• site_hierarchy (str) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. Global/AreaName/BuildingName/FloorName) This field supports wildcard asterisk (*) character search support. E.g. */San*, */San, /San* Examples: ?siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) ?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/A reaName2/BuildingName2/FloorName2 (multiple siteHierarchies requested) .

• site_hierarchy_id (str) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: ?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyIds requested) .

• site_id (str) – siteId query parameter. The UUID of the site. (Ex. flooruuid) Examples: ?siteId=id1 (single id requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple ids requested) .

• network_device_id (str) – networkDeviceId query parameter. The list of Network Device Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c (single networkDeviceId requested) networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b- cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple networkDeviceIds with & separator) .

• network_device_ip_address (str) – networkDeviceIpAddress query parameter. The list of Network Device management IP Address. (Ex. 121.1.1.10) This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: networkDeviceIpAddress=121.1.1.10 networkDeviceIpAddress=121.1.1.10&networkDeviceIpAd dress=172.20.1.10&networkDeviceIpAddress=10.10.20.10 (multiple networkDevice IP Address with & separator) .

• network_device_mac_address (str) – networkDeviceMacAddress query parameter. The list of Network Device MAC Address. (Ex. 64:f6:9d:07:9a:00) This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: networkDeviceMacAddress=64:f6:9d:07:9a:00 networkDeviceMacAddress=64:f6:9d:07:9a:00&networkDeviceMacAddress=70:56:9d:07:ac:77 (multiple networkDevice MAC addresses with & separator) .

• interface_id (str) – interfaceId query parameter. The list of Interface Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: interfaceId=6bef213c-19ca-4170-8375-b694e251101c (single interface uuid ) interfaceId =6bef213c-19ca-4170-8375-b694e251101c&32219612-819e-4b5e-a96b-cf22aca13dd9&2541e9a7- b80d-4955-8aa2-79b233318ba0 (multiple Interface uuid with & separator) .

• interface_name (str) – interfaceName query parameter. The list of Interface name (Ex. GigabitEthernet1/0/1) This field supports wildcard (*) character-based search. Ex: *1/0/1* or 1/0/1* or *1/0/1 Examples: interfaceNames=GigabitEthernet1/0/1 (single interface name) interfaceNames=GigabitEthernet1/0/1&GigabitEthernet2/0/1&GigabitEthernet3/0/1 (multiple interface names with & separator) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-the-total-network-device-interface-counts-in-the-specified-time-range-when-there-is-no-start-and-end-time-specified-returns-the-latest-interfaces-total-count

gets_the_list_of_interfaces_across_the_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1(aggregateAttributes=None, attributes=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

Gets the list of interfaces across the Network Devices based on the provided complex filters and aggregation functions The elements are grouped and sorted by deviceUuid first, and are then sorted by the given sort field, or by the default value: name. The supported sorting options are: name, adminStatus, description, duplexConfig, duplexOper, interfaceIfIndex,interfaceType, macAddress,mediaType, operStatus, portChannelId, portMode, portType,speed, vlanId. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- interfaces-1.0.2-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Devices’s aggregateAttributes (list of objects).

• attributes (list) – Devices’s Attributes (list of strings).

• endTime (integer) – Devices’s End Time.

• filters (list) – Devices’s filters (list of objects).

• page (object) – Devices’s page.

• startTime (integer) – Devices’s Start Time.

• views (list) – Devices’s Views (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-the-list-of-interfaces-across-the-network-devices-based-on-the-provided-complex-filters-and-aggregation-functions

the_total_interfaces_count_across_the_network_devices_v1(aggregateAttributes=None, attributes=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

Gets the total number of interfaces across the Network devices based on the provided complex filters and aggregation functions. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-interfaces-1.0.2-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Devices’s aggregateAttributes (list of objects).

• attributes (list) – Devices’s Attributes (list of strings).

• endTime (integer) – Devices’s End Time.

• filters (list) – Devices’s filters (list of objects).

• page (object) – Devices’s page.

• startTime (integer) – Devices’s Start Time.

• views (list) – Devices’s Views (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!the-total-interfaces-count-across-the-network-devices

get_the_interface_data_for_the_given_interface_idinstance_uuid_along_with_the_statistics_data_v1(id, attribute=None, end_time=None, start_time=None, view=None, headers=None, **request_parameters)

Returns the interface data for the given interface instance Uuid along with the statistics data. The latest interface data in the specified start and end time range will be returned. When there is no start and end time specified returns the latest available data for the given interface Id. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-interfaces-1.0.2-resolved.yaml .

Parameters:

• id (str) – id path parameter. The interface Uuid .

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• view (str) – view query parameter. Interface data model views .

• attribute (str) – attribute query parameter. The following list of attributes can be provided in the attribute field [id,adminStatus, description,duplexConfig,duplexOper,interfaceIfInde x,interfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,nam e,operStatus,peerStackMember,peerStackPort, portChannelId,portMode, portType,rxDiscards, rxError,rxRate,rxUtilization,speed,stackPortType,timestamp,txDiscards,txError,txRate,txU tilization,vlanId,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteNam e,siteHierarchy,siteHierarchyId] If length of attribute list is too long, please use ‘views’ param instead. Examples: attributes=name (single attribute requested) attributes=name,description,duplexOper (multiple attributes with comma separator) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-the-interface-data-for-the-given-interface-idinstance-uuid-along-with-the-statistics-data

gets_the_network_device_details_based_on_the_provided_query_parameters_v1(attribute=None, end_time=None, family=None, health_score=None, id=None, limit=None, mac_address=None, maintenance_mode=None, management_ip_address=None, offset=None, order=None, role=None, serial_number=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, software_version=None, sort_by=None, start_time=None, type=None, view=None, headers=None, **request_parameters)

Gets the Network Device details based on the provided query parameters. When there is no start and end time specified returns the latest device details. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst- center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-1.0.2-resolved.yaml .

Parameters:

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• limit (int) – limit query parameter. Maximum number of records to return .

• offset (int) – offset query parameter. Specifies the starting point within all records returned by the API. It’s one based offset. The starting value is 1. .

• sort_by (str) – sortBy query parameter. A field within the response to sort by. .

• order (str) – order query parameter. The sort order of the field ascending or descending. .

• site_hierarchy (str) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. Global/AreaName/BuildingName/FloorName) This field supports wildcard asterisk (*) character search support. E.g. /San, /San, /San Examples: ?siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) ?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/A reaName2/BuildingName2/FloorName2 (multiple siteHierarchies requested) .

• site_hierarchy_id (str) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyIds requested) .

• site_id (str) – siteId query parameter. The UUID of the site. (Ex. flooruuid) This field supports wildcard asterisk (*) character search support. E.g.*flooruuid*, flooruuid, flooruuid Examples: ?siteId=id1 (single id requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple ids requested) .

• id (str) – id query parameter. The list of entity Uuids. (Ex.”6bef213c-19ca-4170-8375-b694e251101c”) Examples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested) id=6bef213c-19ca- 4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955- 8aa2-79b233318ba0 (multiple entity uuid with ‘&’ separator) .

• management_ip_address (str) – managementIpAddress query parameter. The list of entity management IP Address. It can be either Ipv4 or Ipv6 address or combination of both(Ex. “121.1.1.10”) This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: managementIpAddresses=121.1.1.10 managementIpAddresses=121.1.1.10&manag ementIpAddresses=172.20.1.10&managementIpAddresses=200:10&=managementIpAddresses172.20.3 .4 (multiple entity IP Address with & separator) .

• mac_address (str) – macAddress query parameter. The macAddress of the network device or client This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: macAddress=AB:AB:AB:CD:CD:CD (single macAddress requested) macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE (multiple macAddress requested) .

• family (str) – family query parameter. The list of network device family names Examples:family=Switches and Hubs (single network device family name )family=Switches and Hubs&family=Router&family=Wireless Controller (multiple Network device family names with & separator). This field is not case sensitive. .

• type (str) – type query parameter. The list of network device type This field supports wildcard (*) character-based search. Ex: *9407R* or *9407R or 9407R* Examples: type=SwitchesCisco DNA 9407R Switch (single network device types ) type=Cisco DNA 38xx stack-able ethernet switch&type=Cisco 3945 Integrated Services Router G2 (multiple Network device types with & separator) .

• role (str) – role query parameter. The list of network device role. Examples:role=CORE, role=CORE&role=ACCESS&role=ROUTER (multiple Network device roles with & separator). This field is not case sensitive. .

• serial_number (str) – serialNumber query parameter. The list of network device serial numbers. This field supports wildcard (*) character-based search. Ex: *MS1SV* or MS1SV* or *MS1SV Examples: serialNumber=9FUFMS1SVAX serialNumber=9FUFMS1SVAX&FCW2333Q0BY&FJC240617JX(multiple Network device serial number with & separator) .

• maintenance_mode (bool) – maintenanceMode query parameter. The device maintenanceMode status true or false .

• software_version (str) – softwareVersion query parameter. The list of network device software version This field supports wildcard (*) character-based search. Ex: *17.8* or *17.8 or 17.8* Examples: softwareVersion=2.3.4.0 (single network device software version ) softwareVersion=17.9.3.23&softwareVersion=17.7.1.2&softwareVersion=*.17.7 (multiple Network device software versions with & separator) .

• health_score (str) – healthScore query parameter. The list of entity health score categories Examples: healthScore=good, healthScore=good&healthScore=fair (multiple entity healthscore values with & separator). This field is not case sensitive. .

• view (str) – view query parameter. The List of Network Device model views. Please refer to `NetworkDeviceView` for the supported list .

• attribute (str) – attribute query parameter. The List of Network Device model attributes. This is helps to specify the interested fields in the request. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-the-network-device-details-based-on-the-provided-query-parameters

gets_the_total_network_device_counts_based_on_the_provided_query_parameters_v1(attribute=None, end_time=None, family=None, health_score=None, id=None, mac_address=None, maintenance_mode=None, management_ip_address=None, role=None, serial_number=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, software_version=None, start_time=None, type=None, view=None, headers=None, **request_parameters)

Gets the total Network device counts. When there is no start and end time specified returns the latest interfaces total count. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-1.0.2-resolved.yaml .

Parameters:

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• id (str) – id query parameter. The list of entity Uuids. (Ex.”6bef213c-19ca-4170-8375-b694e251101c”) Examples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested) id=6bef213c-19ca- 4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955- 8aa2-79b233318ba0 (multiple entity uuid with ‘&’ separator) .

• site_hierarchy (str) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. Global/AreaName/BuildingName/FloorName) This field supports wildcard asterisk (*) character search support. E.g. /San, /San, /San Examples: ?siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) ?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/A reaName2/BuildingName2/FloorName2 (multiple siteHierarchies requested) .

• site_hierarchy_id (str) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyIds requested) .

• site_id (str) – siteId query parameter. The UUID of the site. (Ex. flooruuid) This field supports wildcard asterisk (*) character search support. E.g.*flooruuid*, flooruuid, flooruuid Examples: ?siteId=id1 (single id requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple ids requested) .

• management_ip_address (str) – managementIpAddress query parameter. The list of entity management IP Address. It can be either Ipv4 or Ipv6 address or combination of both(Ex. “121.1.1.10”) This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: managementIpAddresses=121.1.1.10 managementIpAddresses=121.1.1.10&manag ementIpAddresses=172.20.1.10&managementIpAddresses=200:10&=managementIpAddresses172.20.3 .4 (multiple entity IP Address with & separator) .

• mac_address (str) – macAddress query parameter. The macAddress of the network device or client This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: macAddress=AB:AB:AB:CD:CD:CD (single macAddress requested) macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE (multiple macAddress requested) .

• family (str) – family query parameter. The list of network device family names Examples:family=Switches and Hubs (single network device family name )family=Switches and Hubs&family=Router&family=Wireless Controller (multiple Network device family names with & separator). This field is not case sensitive. .

• type (str) – type query parameter. The list of network device type This field supports wildcard (*) character-based search. Ex: *9407R* or *9407R or `9407R*`Examples:type=SwitchesCisco DNA 9407R Switch (single network device types )type=Cisco DNA 38xx stack-able ethernet switch&type=Cisco 3945 Integrated Services Router G2 (multiple Network device types with & separator) .

• role (str) – role query parameter. The list of network device role. Examples:role=CORE, role=CORE&role=ACCESS&role=ROUTER (multiple Network device roles with & separator). This field is not case sensitive. .

• serial_number (str) – serialNumber query parameter. The list of network device serial numbers. This field supports wildcard (*) character-based search. Ex: *MS1SV* or MS1SV* or *MS1SV Examples: serialNumber=9FUFMS1SVAX serialNumber=9FUFMS1SVAX&FCW2333Q0BY&FJC240617JX(multiple Network device serial number with & separator) .

• maintenance_mode (bool) – maintenanceMode query parameter. The device maintenanceMode status true or false .

• software_version (str) – softwareVersion query parameter. The list of network device software version This field supports wildcard (*) character-based search. Ex: *17.8* or *17.8 or 17.8* Examples: softwareVersion=2.3.4.0 (single network device software version ) softwareVersion=17.9.3.23&softwareVersion=17.7.1.2&softwareVersion=*.17.7 (multiple Network device software versions with & separator) .

• health_score (str) – healthScore query parameter. The list of entity health score categories Examples:healthScore=good,healthScore=good&healthScore=fair (multiple entity healthscore values with & separator). This field is not case sensitive. .

• view (str) – view query parameter. The List of Network Device model views. Please refer to `NetworkDeviceView` for the supported list .

• attribute (str) – attribute query parameter. The List of Network Device model attributes. This is helps to specify the interested fields in the request. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-the-total-network-device-counts-based-on-the-provided-query-parameters

gets_the_list_of_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1(aggregateAttributes=None, attributes=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

Gets the list of Network Devices based on the provided complex filters and aggregation functions. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-1.0.2-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Devices’s aggregateAttributes (list of objects).

• attributes (list) – Devices’s Attributes (list of strings).

• endTime (integer) – Devices’s End Time.

• filters (list) – Devices’s filters (list of objects).

• page (object) – Devices’s page.

• startTime (integer) – Devices’s Start Time.

• views (list) – Devices’s Views (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-the-list-of-network-devices-based-on-the-provided-complex-filters-and-aggregation-functions

gets_the_summary_analytics_data_related_to_network_devices_v1(aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, headers=None, payload=None, active_validation=True, **request_parameters)

Gets the summary analytics data related to network devices based on the provided input data. This endpoint helps to obtain the consolidated insights into the performance and status of the monitored network devices. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-1.0.2-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Devices’s aggregateAttributes (list of objects).

• attributes (list) – Devices’s Attributes (list of strings).

• endTime (integer) – Devices’s End Time.

• filters (list) – Devices’s filters (list of objects).

• groupBy (list) – Devices’s Group By (list of strings).

• page (object) – Devices’s page.

• startTime (integer) – Devices’s Start Time.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-the-summary-analytics-data-related-to-network-devices

gets_the_trend_analytics_data_v1(aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, trendInterval=None, headers=None, payload=None, active_validation=True, **request_parameters)

Gets the Trend analytics Network device data for the given time range. The data will be grouped based on the given trend time Interval. The required property for this API is trendInterval. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-1.0.2-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Devices’s Aggregate Attributes (list of objects).

• attributes (list) – Devices’s Attributes (list of strings).

• endTime (integer) – Devices’s End Time.

• filters (list) – Devices’s filters (list of objects).

• groupBy (list) – Devices’s Group By (list of objects).

• page (object) – Devices’s page.

• startTime (integer) – Devices’s Start Time.

• trendInterval (string) – Devices’s Trend Interval.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-the-trend-analytics-data

get_the_device_data_for_the_given_device_id_uuid_v1(id, attribute=None, end_time=None, start_time=None, view=None, headers=None, **request_parameters)

Returns the device data for the given device Uuid in the specified start and end time range. When there is no start and end time specified returns the latest available data for the given Id. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-1.0.2-resolved.yaml .

Parameters:

• id (str) – id path parameter. The device Uuid .

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• view (str) – view query parameter. The List of Network Device model views. Please refer to `NetworkDeviceView` for the supported list .

• attribute (str) – attribute query parameter. The List of Network Device model attributes. This is helps to specify the interested fields in the request. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-the-device-data-for-the-given-device-id-uuid

the_trend_analytics_data_for_the_network_device_in_the_specified_time_range_v1(id, aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, trendIntervalInMinutes=None, headers=None, payload=None, active_validation=True, **request_parameters)

The Trend analytics data for the network Device in the specified time range. The data is grouped based on the trend time Interval, other input parameters like attribute and aggregate attributes. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-1.0.2-resolved.yaml .

Parameters:

• aggregateAttributes (list) – Devices’s aggregateAttributes (list of objects).

• attributes (list) – Devices’s Attributes (list of strings).

• endTime (integer) – Devices’s End Time.

• filters (list) – Devices’s filters (list of objects).

• groupBy (list) – Devices’s Group By (list of strings).

• page (object) – Devices’s page.

• startTime (integer) – Devices’s Start Time.

• trendIntervalInMinutes (integer) – Devices’s Trend Interval In Minutes.

• id (str) – id path parameter. The device Uuid .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!the-trend-analytics-data-for-the-network-device-in-the-specified-time-range

get_planned_access_points_for_building_v1(building_id, limit=None, offset=None, radios=None, headers=None, **request_parameters)

Provides a list of Planned Access Points for the Building it is requested for .

Parameters:

• building_id (str) – buildingId path parameter. The instance UUID of the building hierarchy element .

• limit (int) – limit query parameter. The page size limit for the response, e.g. limit=100 will return a maximum of 100 records .

• offset (int) – offset query parameter. The page offset for the response. E.g. if limit=100, offset=0 will return first 100 records, offset=1 will return next 100 records, etc. .

• radios (bool) – radios query parameter. Whether to include the planned radio details of the planned access points .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-planned-access-points-for-building

get_device_detail_v1(identifier, search_by, timestamp=None, headers=None, **request_parameters)

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:

• timestamp (int) – timestamp query parameter. UTC timestamp of device data in milliseconds .

• identifier (str) – identifier query parameter. One of “macAddress”, “nwDeviceName”, “uuid” (case insensitive) .

• search_by (str) – searchBy query parameter. MAC Address, device name, or UUID of the network device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-detail

get_device_enrichment_details_v1(headers=None, **request_parameters)

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

devices_v1(device_role=None, end_time=None, health=None, limit=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)

Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services. .

Parameters:

• device_role (str) – deviceRole query parameter. CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, or AP (case insensitive) .

• site_id (str) – siteId query parameter. DNACenter site UUID .

• health (str) – health query parameter. DNACenter health catagory: POOR, FAIR, or GOOD (case insensitive) .

• start_time (int) – startTime query parameter. UTC epoch time in milliseconds .

• end_time (int) – endTime query parameter. UTC epoch time in milliseconds .

• limit (int) – limit query parameter. Max number of device entries in the response (default to 50. Max at 500) .

• offset (int) – offset query parameter. The offset of the first device in the returned data (Mutiple of ‘limit’ + 1) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!devices

update_planned_access_point_for_floor_v1(floor_id, attributes=None, isSensor=None, location=None, position=None, radioCount=None, radios=None, headers=None, payload=None, active_validation=True, **request_parameters)

Allows updating a planned access point on an existing floor map including its planned radio and antenna details. Use the Get variant of this API to fetch the existing planned access points for the floor. The payload to update a planned access point is in the same format, albeit a single object instead of a list, of that API. .

Parameters:

• attributes (object) – Devices’s attributes.

• isSensor (boolean) – Devices’s Indicates that PAP is a sensor .

• location (object) – Devices’s location.

• position (object) – Devices’s position.

• radioCount (integer) – Devices’s Number of radios of the planned access point .

• radios (list) – Devices’s radios (list of objects).

• floor_id (str) – floorId path parameter. The instance UUID of the floor hierarchy element .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-planned-access-point-for-floor

create_planned_access_point_for_floor_v1(floor_id, attributes=None, isSensor=None, location=None, position=None, radioCount=None, radios=None, headers=None, payload=None, active_validation=True, **request_parameters)

Allows creation of a new planned access point on an existing floor map including its planned radio and antenna details. Use the Get variant of this API to fetch any existing planned access points for the floor. The payload to create a planned access point is in the same format, albeit a single object instead of a list, of that API. .

Parameters:

• attributes (object) – Devices’s attributes.

• isSensor (boolean) – Devices’s Indicates that PAP is a sensor .

• location (object) – Devices’s location.

• position (object) – Devices’s position.

• radioCount (integer) – Devices’s Number of radios of the planned access point .

• radios (list) – Devices’s radios (list of objects).

• floor_id (str) – floorId path parameter. The instance UUID of the floor hierarchy element .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-planned-access-point-for-floor

get_planned_access_points_for_floor_v1(floor_id, limit=None, offset=None, radios=None, headers=None, **request_parameters)

Provides a list of Planned Access Points for the Floor it is requested for .

Parameters:

• floor_id (str) – floorId path parameter. The instance UUID of the floor hierarchy element .

• limit (int) – limit query parameter. The page size limit for the response, e.g. limit=100 will return a maximum of 100 records .

• offset (int) – offset query parameter. The page offset for the response. E.g. if limit=100, offset=0 will return first 100 records, offset=1 will return next 100 records, etc. .

• radios (bool) – radios query parameter. Whether to include the planned radio details of the planned access points .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-planned-access-points-for-floor

delete_planned_access_point_for_floor_v1(floor_id, planned_access_point_uuid, headers=None, **request_parameters)

Allow to delete a planned access point from an existing floor map including its planned radio and antenna details. Use the Get variant of this API to fetch the existing planned access points for the floor. The instanceUUID listed in each of the planned access point attributes acts as the path param input to this API to delete that specific instance. .

Parameters:

• floor_id (str) – floorId path parameter. The instance UUID of the floor hierarchy element .

• planned_access_point_uuid (str) – plannedAccessPointUuid path parameter. The instance UUID of the planned access point to delete .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-planned-access-point-for-floor

get_all_health_score_definitions_for_given_filters_v1(attribute=None, device_type=None, id=None, include_for_overall_health=None, limit=None, offset=None, headers=None, **request_parameters)

Get all health score defintions. Supported filters are id, name and overall health include status. A health score definition can be different across device type. So, deviceType in the query param is important and default is all device types. By default all supported attributes are listed in response. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-issueAndHealthDefinitions-1.0.0-resolved.yaml .

Parameters:

• device_type (str) – deviceType query parameter. These are the device families supported for health score definitions. If no input is made on device family, all device families are considered. .

• id (str) – id query parameter. The definition identifier. Examples: id=015d9cba-4f53-4087-8317-7e49e5ffef46 (single entity id request) id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (multiple ids in the query param) .

• include_for_overall_health (bool) – includeForOverallHealth query parameter. The inclusion status of the issue definition, either true or false. true indicates that particular health metric is included in overall health computation, otherwise false. By default it’s set to true. .

• attribute (str) – attribute query parameter. These are the attributes supported in health score definitions response. By default, all properties are sent in response. .

• offset (int) – offset query parameter. Specifies the starting point within all records returned by the API. It’s one based offset. The starting value is 1. .

• limit (int) – limit query parameter. Maximum number of records to return .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-health-score-definitions-for-given-filters

update_health_score_definitions_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Update health thresholds, include status of overall health status for each metric. And also to synchronize with global profile issue thresholds of the definition for given metric. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- issueAndHealthDefinitions-1.0.0-resolved.yaml .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-health-score-definitions

get_health_score_definition_for_the_given_id_v1(id, headers=None, **request_parameters)

Get health score defintion for the given id. Definition includes all properties from HealthScoreDefinition schema by default. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-issueAndHealthDefinitions-1.0.0-resolved.yaml .

Parameters:

• id (str) – id path parameter. Health score definition id. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-health-score-definition-for-the-given-id

update_health_score_definition_for_the_given_id_v1(id, includeForOverallHealth=None, synchronizeToIssueThreshold=None, thresholdValue=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update health threshold, include status of overall health status. And also to synchronize with global profile issue thresholds of the definition for given id. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- issueAndHealthDefinitions-1.0.0-resolved.yaml .

Parameters:

• includeForOverallHealth (boolean) – Devices’s Include For Overall Health.

• synchronizeToIssueThreshold (boolean) – Devices’s Synchronize To Issue Threshold.

• thresholdValue (number) – Devices’s Thresehold Value.

• id (str) – id path parameter. Health score definition id. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-health-score-definition-for-the-given-id

get_all_interfaces_v1(last_input_time=None, last_output_time=None, limit=None, offset=None, headers=None, **request_parameters)

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces .

Parameters:

• offset (int) – offset query parameter.

• limit (int) – limit query parameter.

• last_input_time (str) – lastInputTime query parameter. Last Input Time .

• last_output_time (str) – lastOutputTime query parameter. Last Output Time .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-interfaces

get_device_interface_count_v1(headers=None, **request_parameters)

Returns the count of interfaces for all devices .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-interface-count-for-multiple-devices

get_interface_by_ip_v1(ip_address, headers=None, **request_parameters)

Returns list of interfaces for specified device management IP address .

Parameters:

• ip_address (str) – ipAddress path parameter. IP address of the interface .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-by-i-p

get_isis_interfaces_v1(headers=None, **request_parameters)

Returns the interfaces that has ISIS enabled .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-isis-interfaces

get_interface_info_by_id_v1(device_id, headers=None, **request_parameters)

Returns list of interfaces by specified device .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-info-by-id

get_device_interface_count_by_id_v1(device_id, headers=None, **request_parameters)

Returns the interface count for the given device .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_interface_details_v1(device_id, name, headers=None, **request_parameters)

Returns interface by specified device Id and interface name .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• name (str) – name query parameter. Interface name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-details-by-device-id-and-interface-name

get_device_interfaces_by_specified_range_v1(device_id, records_to_return, start_index, headers=None, **request_parameters)

Returns the list of interfaces for the device for the specified range .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• start_index (int) – startIndex path parameter. Start index .

• records_to_return (int) – recordsToReturn path parameter. Number of records to return .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-interfaces-by-specified-range

get_ospf_interfaces_v1(headers=None, **request_parameters)

Returns the interfaces that has OSPF enabled .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-ospf-interfaces

get_interface_by_id_v1(id, headers=None, **request_parameters)

Returns the interface for the given interface ID .

Parameters:

• id (str) – id path parameter. Interface ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-by-id

update_interface_details_v1(interface_uuid, adminStatus=None, deployment_mode=None, description=None, vlanId=None, voiceVlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)

Add/Update Interface description, VLAN membership, Voice VLAN and change Interface admin status (‘UP’/’DOWN’) from Request body. .

Parameters:

• adminStatus (string) – Devices’s Admin status as (‘UP’/’DOWN’) .

• description (string) – Devices’s Description for the Interface .

• vlanId (integer) – Devices’s VLAN Id to be Updated .

• voiceVlanId (integer) – Devices’s Voice Vlan Id to be Updated .

• interface_uuid (str) – interfaceUuid path parameter. Interface ID .

• deployment_mode (str) – deploymentMode query parameter. Preview/Deploy [‘Preview’ means the configuration is not pushed to the device. ‘Deploy’ makes the configuration pushed to the device] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-interface-details

legit_operations_for_interface_v1(interface_uuid, headers=None, **request_parameters)

Get list of all properties & operations valid for an interface. .

Parameters:

• interface_uuid (str) – interfaceUuid path parameter. Interface ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!legit-operations-for-interface

clear_mac_address_table_v1(interface_uuid, deployment_mode=None, operation=None, payload=None, headers=None, active_validation=True, **request_parameters)

Clear mac-address on an individual port. In request body, operation needs to be specified as ‘ClearMacAddress’. In the future more possible operations will be added to this API .

Parameters:

• operation (string) – Devices’s Operation needs to be specified as ‘ClearMacAddress’. .

• payload (dict) – Devices’s Payload is not applicable .

• interface_uuid (str) – interfaceUuid path parameter. Interface Id .

• deployment_mode (str) – deploymentMode query parameter. Preview/Deploy [‘Preview’ means the configuration is not pushed to the device. ‘Deploy’ makes the configuration pushed to the device] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!clear-mac-address-table

get_device_list_v1(associated_wlc_ip=None, collection_interval=None, collection_status=None, device_support_level=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, limit=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, offset=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc. You can use the .* in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET /dna/intent/api/v1/network-device?hostname=myhost.*&managementIpAddress=192.25.18..* If id parameter is provided with comma separated ids, it will return the list of network-devices for the given ids and ignores the other request parameters. You can also specify offset & limit to get the required list. .

Parameters:

• hostname (str, list, set, tuple) – hostname query parameter.

• management_ip_address (str, list, set, tuple) – managementIpAddress query parameter.

• mac_address (str, list, set, tuple) – macAddress query parameter.

• location_name (str, list, set, tuple) – locationName query parameter.

• serial_number (str, list, set, tuple) – serialNumber query parameter.

• location (str, list, set, tuple) – location query parameter.

• family (str, list, set, tuple) – family query parameter.

• type (str, list, set, tuple) – type query parameter.

• series (str, list, set, tuple) – series query parameter.

• collection_status (str, list, set, tuple) – collectionStatus query parameter.

• collection_interval (str, list, set, tuple) – collectionInterval query parameter.

• not_synced_for_minutes (str, list, set, tuple) – notSyncedForMinutes query parameter.

• error_code (str, list, set, tuple) – errorCode query parameter.

• error_description (str, list, set, tuple) – errorDescription query parameter.

• software_version (str, list, set, tuple) – softwareVersion query parameter.

• software_type (str, list, set, tuple) – softwareType query parameter.

• platform_id (str, list, set, tuple) – platformId query parameter.

• role (str, list, set, tuple) – role query parameter.

• reachability_status (str, list, set, tuple) – reachabilityStatus query parameter.

• up_time (str, list, set, tuple) – upTime query parameter.

• associated_wlc_ip (str, list, set, tuple) – associatedWlcIp query parameter.

• license_name (str, list, set, tuple) – license.name query parameter.

• license_type (str, list, set, tuple) – license.type query parameter.

• license_status (str, list, set, tuple) – license.status query parameter.

• module_name (str, list, set, tuple) – module+name query parameter.

• module_equpimenttype (str, list, set, tuple) – module+equpimenttype query parameter.

• module_servicestate (str, list, set, tuple) – module+servicestate query parameter.

• module_vendorequipmenttype (str, list, set, tuple) – module+vendorequipmenttype query parameter.

• module_partnumber (str, list, set, tuple) – module+partnumber query parameter.

• module_operationstatecode (str, list, set, tuple) – module+operationstatecode query parameter.

• id (str) – id query parameter. Accepts comma separated ids and return list of network-devices for the given ids. If invalid or not-found ids are provided, null entry will be returned in the list. .

• device_support_level (str) – deviceSupportLevel query parameter.

• offset (int) – offset query parameter. offset >= 1 [X gives results from Xth device onwards] .

• limit (int) – limit query parameter. 1 <= limit <= 500 [max. no. of devices to be returned in the result] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-list

add_device_v1(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Adds the device with given credential .

Parameters:

• cliTransport (string) – Devices’s CLI transport. Supported values: telnet, ssh. Required if type is NETWORK_DEVICE. .

• computeDevice (boolean) – Devices’s Compute Device or not. Options are true / false. .

• enablePassword (string) – Devices’s CLI enable password of the device. Required if device is configured to use enable password. .

• extendedDiscoveryInfo (string) – Devices’s This field holds that info as whether to add device with canned data or not. Supported values: DISCOVER_WITH_CANNED_DATA. .

• httpPassword (string) – Devices’s HTTP password of the device / API key for Meraki Dashboard. Required if type is MERAKI_DASHBOARD or COMPUTE_DEVICE. .

• httpPort (string) – Devices’s HTTP port of the device. Required if type is COMPUTE_DEVICE. .

• httpSecure (boolean) – Devices’s Flag to select HTTP / HTTPS protocol. Options are true / false. true for HTTPS and false for HTTP. Default is true. .

• httpUserName (string) – Devices’s HTTP Username of the device. Required if type is COMPUTE_DEVICE. .

• ipAddress (list) – Devices’s IP Address of the device. Required if type is NETWORK_DEVICE, COMPUTE_DEVICE or THIRD_PARTY_DEVICE. (list of strings).

• merakiOrgId (list) – Devices’s Selected Meraki organization for which the devices needs to be imported. Required if type is MERAKI_DASHBOARD. (list of strings).

• netconfPort (string) – Devices’s Netconf Port of the device. cliTransport must be ‘ssh’ if netconf is provided. .

• password (string) – Devices’s CLI Password of the device. Required if type is NETWORK_DEVICE. .

• serialNumber (string) – Devices’s Serial Number of the Device. Required if extendedDiscoveryInfo is ‘DISCOVER_WITH_CANNED_DATA’. .

• snmpAuthPassphrase (string) – Devices’s SNMPv3 auth passphrase of the device. Required if snmpMode is authNoPriv or authPriv. .

• snmpAuthProtocol (string) – Devices’s SNMPv3 auth protocol. Supported values: sha, md5. Required if snmpMode is authNoPriv or authPriv. .

• snmpMode (string) – Devices’s SNMPv3 mode. Supported values: noAuthnoPriv, authNoPriv, authPriv. Required if snmpVersion is v3. .

• snmpPrivPassphrase (string) – Devices’s SNMPv3 priv passphrase. Required if snmpMode is authPriv. .

• snmpPrivProtocol (string) – Devices’s SNMPv3 priv protocol. Supported values: AES128. Required if snmpMode is authPriv. .

• snmpROCommunity (string) – Devices’s SNMP Read Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. .

• snmpRWCommunity (string) – Devices’s SNMP Write Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. .

• snmpRetry (integer) – Devices’s SNMP retry count. Max value supported is 3. Default is Global SNMP retry (if exists) or 3. .

• snmpTimeout (integer) – Devices’s SNMP timeout in seconds. Max value supported is 300. Default is Global SNMP timeout (if exists) or 5. .

• snmpUserName (string) – Devices’s SNMPV3 user name of the device. Required if snmpVersion is v3. .

• snmpVersion (string) – Devices’s SNMP version. Values supported: v2, v3. Required if type is NETWORK_DEVICE, COMPUTE_DEVICE or THIRD_PARTY_DEVICE. .

• type (string) – Devices’s Type of device being added. Default is NETWORK_DEVICE. . Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘THIRD_PARTY_DEVICE’ and ‘NETWORK_DEVICE’.

• userName (string) – Devices’s CLI user name of the device. Required if type is NETWORK_DEVICE. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-device-know-your-network

sync_devices_v1(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update the credentials, management IP address of a given device (or a set of devices) in DNA Center and trigger an inventory sync. .

Parameters:

• cliTransport (string) – Devices’s CLI transport. Supported values: telnet, ssh. Use NO!$DATA!$ if no change is required. Required if type is NETWORK_DEVICE. .

• computeDevice (boolean) – Devices’s Compute Device or not. Options are true / false. .

• enablePassword (string) – Devices’s CLI enable password of the device. Required if device is configured to use enable password. Use NO!$DATA!$ if no change is required. .

• extendedDiscoveryInfo (string) – Devices’s This field holds that info as whether to add device with canned data or not. Supported values: DISCOVER_WITH_CANNED_DATA. .

• httpPassword (string) – Devices’s HTTP password of the device / API key for Meraki Dashboard. Required if type is MERAKI_DASHBOARD or COMPUTE_DEVICE. Use NO!$DATA!$ if no change is required. .

• httpPort (string) – Devices’s HTTP port of the device. Required if type is COMPUTE_DEVICE. .

• httpSecure (boolean) – Devices’s Flag to select HTTP / HTTPS protocol. Options are true / false. true for HTTPS and false for HTTP. .

• httpUserName (string) – Devices’s HTTP Username of the device. Required if type is COMPUTE_DEVICE. Use NO!$DATA!$ if no change is required. .

• ipAddress (list) – Devices’s IP Address of the device. Required. Use ‘api.meraki.com’ for Meraki Dashboard. (list of strings).

• merakiOrgId (list) – Devices’s Selected Meraki organization for which the devices needs to be imported. Required if type is MERAKI_DASHBOARD. (list of strings).

• netconfPort (string) – Devices’s Netconf Port of the device. cliTransport must be ‘ssh’ if netconf is provided. .

• password (string) – Devices’s CLI Password of the device. Required if type is NETWORK_DEVICE. Use NO!$DATA!$ if no change is required. .

• serialNumber (string) – Devices’s Serial Number of the Device. Required if extendedDiscoveryInfo is ‘DISCOVER_WITH_CANNED_DATA’. .

• snmpAuthPassphrase (string) – Devices’s SNMPv3 auth passphrase of the device. Required if snmpMode is authNoPriv or authPriv. Use NO!$DATA!$ if no change is required. .

• snmpAuthProtocol (string) – Devices’s SNMPv3 auth protocol. Supported values: sha, md5. Required if snmpMode is authNoPriv or authPriv. Use NODATACHANGE if no change is required. .

• snmpMode (string) – Devices’s SNMPv3 mode. Supported values: noAuthnoPriv, authNoPriv, authPriv. Required if snmpVersion is v3. Use NODATACHANGE if no change is required. .

• snmpPrivPassphrase (string) – Devices’s SNMPv3 priv passphrase. Required if snmpMode is authPriv. Use NO!$DATA!$ if no change is required. .

• snmpPrivProtocol (string) – Devices’s SNMPv3 priv protocol. Supported values: AES128. Required if snmpMode is authPriv. Use NODATACHANGE if no change is required. .

• snmpROCommunity (string) – Devices’s SNMP Read Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. Use NO!$DATA!$ if no change is required. .

• snmpRWCommunity (string) – Devices’s SNMP Write Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. Use NO!$DATA!$ if no change is required. .

• snmpRetry (integer) – Devices’s SNMP retry count. Max value supported is 3. Default is Global SNMP retry (if exists) or 3. .

• snmpTimeout (integer) – Devices’s SNMP timeout in seconds. Max value supported is 300. Default is Global SNMP timeout (if exists) or 5. .

• snmpUserName (string) – Devices’s SNMPV3 user name of the device. Required if snmpVersion is v3. Use NO!$DATA!$ if no change is required. .

• snmpVersion (string) – Devices’s SNMP version. Values supported: v2, v3. Required if type is NETWORK_DEVICE, COMPUTE_DEVICE or THIRD_PARTY_DEVICE. Use NODATACHANGE if no change is required. .

• type (string) – Devices’s Type of device being edited. Default is NETWORK_DEVICE. . Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’, ‘THIRD_PARTY_DEVICE’ and ‘NODATACHANGE’.

• updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

• userName (string) – Devices’s CLI user name of the device. Required if type is NETWORK_DEVICE. Use NO!$DATA!$ if no change is required. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-device-details

get_device_values_that_match_fully_or_partially_an_attribute_v1(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)

Returns the list of values of the first given required parameter. You can use the .* in any value to conduct a wildcard search. For example, to get all the devices with the management IP address starting with 10.10. , issue the following request: GET /dna/inten/api/v1/network- device/autocomplete?managementIpAddress=10.10..* It will return the device management IP addresses that match fully or partially the provided attribute. {[10.10.1.1, 10.10.20.2, …]}. .

Parameters:

• vrf_name (str) – vrfName query parameter.

• management_ip_address (str) – managementIpAddress query parameter.

• hostname (str) – hostname query parameter.

• mac_address (str) – macAddress query parameter.

• family (str) – family query parameter.

• collection_status (str) – collectionStatus query parameter.

• collection_interval (str) – collectionInterval query parameter.

• software_version (str) – softwareVersion query parameter.

• software_type (str) – softwareType query parameter.

• reachability_status (str) – reachabilityStatus query parameter.

• reachability_failure_reason (str) – reachabilityFailureReason query parameter.

• error_code (str) – errorCode query parameter.

• platform_id (str) – platformId query parameter.

• series (str) – series query parameter.

• type (str) – type query parameter.

• serial_number (str) – serialNumber query parameter.

• up_time (str) – upTime query parameter.

• role (str) – role query parameter.

• role_source (str) – roleSource query parameter.

• associated_wlc_ip (str) – associatedWlcIp query parameter.

• offset (int) – offset query parameter.

• limit (int) – limit query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-values-that-match-fully-or-partially-an-attribute

update_device_role_v1(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)

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

Parameters:

• id (string) – Devices’s DeviceId of the Device .

• role (string) – Devices’s Role of device as ACCESS, CORE, DISTRIBUTION, BORDER ROUTER .

• roleSource (string) – Devices’s Role source as MANUAL / AUTO .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-device-role

get_polling_interval_for_all_devices_v1(headers=None, **request_parameters)

Returns polling interval of all devices .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-polling-interval-for-all-devices

get_device_config_for_all_devices_v1(headers=None, **request_parameters)

Returns the config for all devices. This API has been deprecated and will not be available in a Cisco DNA Center release after Nov 1st 2024 23:59:59 GMT. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-config-for-all-devices

get_device_config_count_v1(headers=None, **request_parameters)

Returns the count of device configs .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-config-count

get_device_count_v1(hostname=None, location_name=None, mac_address=None, management_ip_address=None, headers=None, **request_parameters)

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name .

Parameters:

• hostname (str, list, set, tuple) – hostname query parameter.

• management_ip_address (str, list, set, tuple) – managementIpAddress query parameter.

• mac_address (str, list, set, tuple) – macAddress query parameter.

• location_name (str, list, set, tuple) – locationName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-count

export_device_list_v1(deviceUuids=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)

Exports the selected network device to a file .

Parameters:

• deviceUuids (list) – Devices’s List of device uuids (list of strings).

• operationEnum (string) – Devices’s 0 to export Device Credential Details Or 1 to export Device Details . Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

• parameters (list) – Devices’s List of device parameters that needs to be exported to file (list of strings).

• password (string) – Devices’s Password is required when the operationEnum value is 0 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!export-device-list

get_functional_capability_for_devices_v1(device_id, function_name=None, headers=None, **request_parameters)

Returns the functional-capability for given devices .

Parameters:

• device_id (str) – deviceId query parameter. Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list. .

• function_name (str, list, set, tuple) – functionName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-functional-capability-for-devices

get_functional_capability_by_id_v1(id, headers=None, **request_parameters)

Returns functional capability with given Id .

Parameters:

• id (str) – id path parameter. Functional Capability UUID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-functional-capability-by-id

inventory_insight_device_link_mismatch_v1(category, site_id, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Find all devices with link mismatch (speed / vlan) .

Parameters:

• site_id (str) – siteId path parameter.

• offset (int) – offset query parameter. Row Number. Default value is 1 .

• limit (int) – limit query parameter. Default value is 500 .

• category (str) – category query parameter. Links mismatch category. Value can be speed-duplex or vlan. .

• sort_by (str) – sortBy query parameter. Sort By .

• order (str) – order query parameter. Order. Value can be asc or desc. Default value is asc .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!inventory-insight-device-link-mismatch-api

get_network_device_by_ip_v1(ip_address, headers=None, **request_parameters)

Returns the network device by specified IP address .

Parameters:

• ip_address (str) – ipAddress path parameter. Device IP address .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network-device-by-ip

get_modules_v1(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)

Returns modules by specified device id .

Parameters:

• device_id (str) – deviceId query parameter.

• limit (int) – limit query parameter.

• offset (int) – offset query parameter.

• name_list (str, list, set, tuple) – nameList query parameter.

• vendor_equipment_type_list (str, list, set, tuple) – vendorEquipmentTypeList query parameter.

• part_number_list (str, list, set, tuple) – partNumberList query parameter.

• operational_state_code_list (str, list, set, tuple) – operationalStateCodeList query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-modules

get_module_count_v1(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)

Returns Module Count .

Parameters:

• device_id (str) – deviceId query parameter.

• name_list (str, list, set, tuple) – nameList query parameter.

• vendor_equipment_type_list (str, list, set, tuple) – vendorEquipmentTypeList query parameter.

• part_number_list (str, list, set, tuple) – partNumberList query parameter.

• operational_state_code_list (str, list, set, tuple) – operationalStateCodeList query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-module-count

get_module_info_by_id_v1(id, headers=None, **request_parameters)

Returns Module info by ‘module id’ .

Parameters:

• id (str) – id path parameter. Module id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-module-info-by-id

get_device_by_serial_number_v1(serial_number, headers=None, **request_parameters)

Returns the network device with given serial number .

Parameters:

• serial_number (str) – serialNumber path parameter. Device serial number .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-by-serial-number

sync_devices_using_forcesync_v1(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device .

Parameters:

• force_sync (bool) – forceSync query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sync-devices

get_devices_registered_for_wsa_notification_v1(macaddress=None, serial_number=None, headers=None, **request_parameters)

It fetches devices which are registered to receive WSA notifications. The device serial number and/or MAC address are required to be provided as query parameters. .

Parameters:

• serial_number (str) – serialNumber query parameter. Serial number of the device .

• macaddress (str) – macaddress query parameter. Mac addres of the device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-devices-registered-for-wsa-notification

get_all_user_defined_fields_v1(id=None, name=None, headers=None, **request_parameters)

Gets existing global User Defined Fields. If no input is given, it fetches ALL the Global UDFs. Filter/search is supported by UDF Id(s) or UDF name(s) or both. .

Parameters:

• id (str) – id query parameter. Comma-seperated id(s) used for search/filtering .

• name (str) – name query parameter. Comma-seperated name(s) used for search/filtering .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-user-defined-fields

create_user_defined_field_v1(description=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)

Creates a new global User Defined Field, which can be assigned to devices .

Parameters:

• description (string) – Devices’s Description of UDF .

• name (string) – Devices’s Name of UDF .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-user-defined-field

update_user_defined_field_v1(id, description=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates an existing global User Defined Field, using it’s id. .

Parameters:

• description (string) – Devices’s Description of UDF .

• name (string) – Devices’s Name of UDF .

• id (str) – id path parameter. UDF id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-user-defined-field

delete_user_defined_field_v1(id, headers=None, **request_parameters)

Deletes an existing Global User-Defined-Field using it’s id. .

Parameters:

• id (str) – id path parameter. UDF id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-user-defined-field

get_chassis_details_for_device_v1(device_id, headers=None, **request_parameters)

Returns chassis details for given device ID .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-chassis-details-for-device

get_stack_details_for_device_v1(device_id, headers=None, **request_parameters)

Retrieves complete stack details for given device ID .

Parameters:

• device_id (str) – deviceId path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-stack-details-for-device

remove_user_defined_field_from_device_v1(device_id, name, headers=None, **request_parameters)

Remove a User-Defined-Field from device. Name of UDF has to be passed as the query parameter. Please note that Global UDF will not be deleted by this operation. .

Parameters:

• device_id (str) – deviceId path parameter. UUID of device from which UDF has to be removed .

• name (str) – name query parameter. Name of UDF to be removed .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!remove-user-defined-field-from-device

add_user_defined_field_to_device_v1(device_id, headers=None, payload=None, active_validation=True, **request_parameters)

Assigns an existing Global User-Defined-Field to a device. If the UDF is already assigned to the specific device, then it updates the device UDF value accordingly. Please note that the assigning UDF ‘name’ must be an existing global UDF. Otherwise error shall be shown. .

Parameters:

• device_id (str) – deviceId path parameter. UUID of device to which UDF has to be added .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-user-defined-field-to-device

get_the_details_of_physical_components_of_the_given_device_v1(device_uuid, type=None, headers=None, **request_parameters)

Return all types of equipment details like PowerSupply, Fan, Chassis, Backplane, Module, PROCESSOR, Other and SFP for the Given device. .

Parameters:

• device_uuid (str) – deviceUuid path parameter.

• type (str) – type query parameter. Type value can be PowerSupply, Fan, Chassis, Backplane, Module, PROCESSOR, Other, SFP. If no type is mentioned, All equipments are fetched for the device. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-the-details-of-physical-components-of-the-given-device

poe_interface_details_v1(device_uuid, interface_name_list=None, headers=None, **request_parameters)

Returns POE interface details for the device, where deviceuuid is mandatory & accepts comma seperated interface names which is optional and returns information for that particular interfaces where(operStatus = operationalStatus) .

Parameters:

• device_uuid (str) – deviceUuid path parameter. uuid of the device .

• interface_name_list (str) – interfaceNameList query parameter. comma seperated interface names .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!returns-poe-interface-details-for-the-device

get_connected_device_detail_v1(device_uuid, interface_uuid, headers=None, **request_parameters)

Get connected device detail for given deviceUuid and interfaceUuid .

Parameters:

• device_uuid (str) – deviceUuid path parameter. instanceuuid of Device .

• interface_uuid (str) – interfaceUuid path parameter. instanceuuid of interface .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-connected-device-detail

get_linecard_details_v1(device_uuid, headers=None, **request_parameters)

Get line card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:

• device_uuid (str) – deviceUuid path parameter. instanceuuid of device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-linecard-details

poe_details_v1(device_uuid, headers=None, **request_parameters)

Returns POE details for device. .

Parameters:

• device_uuid (str) – deviceUuid path parameter. UUID of the device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!poe-details

get_supervisor_card_detail_v1(device_uuid, headers=None, **request_parameters)

Get supervisor card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:

• device_uuid (str) – deviceUuid path parameter. instanceuuid of device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-supervisor-card-detail

update_device_management_address_v1(deviceid, newIP=None, headers=None, payload=None, active_validation=True, **request_parameters)

This is a simple PUT API to edit the management IP Address of the device. .

Parameters:

• newIP (string) – Devices’s New IP Address of the device to be Updated .

• deviceid (str) – deviceid path parameter. The UUID of the device whose management IP address is to be updated. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-device-management-address

get_device_by_id_v1(id, headers=None, **request_parameters)

Returns the network device details for the given device ID .

Parameters:

• id (str) – id path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-by-id

delete_device_by_id_v1(id, clean_config=None, headers=None, **request_parameters)

This API allows any network device that is not currently provisioned to be removed from the inventory. Important: Devices currently provisioned cannot be deleted. To delete a provisioned device, the device must be first deprovisioned. .

Parameters:

• id (str) – id path parameter. Device ID .

• clean_config (bool) – cleanConfig query parameter. Selecting the clean up configuration option will attempt to remove device settings that were configured during the addition of the device to the inventory and site assignment. Please note that this operation is different from deprovisioning. It does not remove configurations that were pushed during device provisioning. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-device-by-id

get_device_summary_v1(id, headers=None, **request_parameters)

Returns brief summary of device info such as hostname, management IP address for the given device Id .

Parameters:

• id (str) – id path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-summary

get_polling_interval_by_id_v1(id, headers=None, **request_parameters)

Returns polling interval by device id .

Parameters:

• id (str) – id path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-polling-interval-by-id

get_organization_list_for_meraki_v1(id, headers=None, **request_parameters)

Returns list of organizations for meraki dashboard .

Parameters:

• id (str) – id path parameter. Device Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-organization-list-for-meraki

get_device_interface_vlans_v1(id, interface_type=None, headers=None, **request_parameters)

Returns Device Interface VLANs. If parameter value is null or empty, it won’t return any value in response. .

Parameters:

• id (str) – id path parameter.

• interface_type (str) – interfaceType query parameter. Vlan associated with sub-interface. If no interfaceType mentioned it will return all types of Vlan interfaces. If interfaceType is selected but not specified then it will take default value. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-interface-vlans

get_wireless_lan_controller_details_by_id_v1(id, headers=None, **request_parameters)

Returns the wireless lan controller info with given device ID .

Parameters:

• id (str) – id path parameter. Device ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-wireless-lan-controller-details-by-id

get_device_config_by_id_v1(network_device_id, headers=None, **request_parameters)

Returns the device config by specified device ID .

Parameters:

• network_device_id (str) – networkDeviceId path parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-config-by-id

get_network_device_by_pagination_range_v1(records_to_return, start_index, headers=None, **request_parameters)

Returns the list of network devices for the given pagination range. The maximum number of records that can be retrieved is 500 .

Parameters:

• start_index (int) – startIndex path parameter. Start index [>=1] .

• records_to_return (int) – recordsToReturn path parameter. Number of records to return [1<= recordsToReturn <= 500] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network-device-by-pagination-range

update_global_resync_interval_v1(interval=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates the resync interval (in minutes) globally for devices which do not have custom resync interval. To override this setting for all network devices refer to [/networkDevices/resyncIntervalSettings/override] .

Parameters:

• interval (integer) – Devices’s Resync Interval should be between 25 to 1440 minutes .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-global-resync-interval

override_resync_interval_v1(headers=None, **request_parameters)

Overrides the global resync interval on all network devices. This essentially removes device specific intervals if set. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!override-resync-interval

update_resync_interval_for_the_network_device_v1(id, interval=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update the resync interval (in minutes) for the given network device id. To disable periodic resync, set interval as 0. To use global settings, set interval as null. .

Parameters:

• interval (integer) – Devices’s Resync interval in minutes. To disable periodic resync, set interval as 0. To use global settings, set interval as null. .

• id (str) – id path parameter. The id of the network device. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-resync-interval-for-the-network-device

get_resync_interval_for_the_network_device_v1(id, headers=None, **request_parameters)

Fetch the reysnc interval for the given network device id. .

Parameters:

• id (str) – id path parameter. The id of the network device. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-resync-interval-for-the-network-device

rogue_additional_details_v1(endTime=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)

This API provides additional information of the rogue threats with details at BSSID level. The additional information includes Switch Port details in case of Rogue on Wire, first time when the rogue is seen in the network etc. .

Parameters:

• endTime (number) – Devices’s This is the epoch end time in milliseconds upto which data need to be fetched. Default value is current time .

• limit (number) – Devices’s The maximum number of entries to return. Default value is 1000 .

• offset (number) – Devices’s The offset of the first item in the collection to return. Default value is 1 .

• siteId (list) – Devices’s Filter Rogues by location. Site IDs information can be fetched from “Get Site” API (list of strings).

• startTime (number) – Devices’s This is the epoch start time in milliseconds from which data need to be fetched. Default value is 24 hours earlier to endTime .

• threatLevel (list) – Devices’s Filter Rogues by Threat Level. Threat Level information can be fetched from “Get Threat Levels” API (list of strings).

• threatType (list) – Devices’s Filter Rogues by Threat Type. Threat Type information can be fetched from “Get Threat Types” API (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!rogue-additional-details

rogue_additional_detail_count_v1(endTime=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)

This API returns the count for the Rogue Additional Details. .

Parameters:

• endTime (number) – Devices’s This is the epoch end time in milliseconds upto which data need to be fetched. Default value is current time .

• siteId (list) – Devices’s Filter Rogues by location. Site IDs information can be fetched from “Get Site” API (list of strings).

• startTime (number) – Devices’s This is the epoch start time in milliseconds from which data need to be fetched. Default value is 24 hours earlier to endTime .

• threatLevel (list) – Devices’s This information can be fetched from “Get Threat Levels” API (list of strings).

• threatType (list) – Devices’s This information can be fetched from “Get Threat Types” API (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!rogue-additional-detail-count

start_wireless_rogue_ap_containment_v1(macAddress=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)

Intent API to start the wireless rogue access point containment. This API will initiate the containment operation on the strongest detecting WLC for the given Rogue AP. This is a resource intensive operation which has legal implications since the rogue access point on whom it is triggered, might be a valid neighbor access point. .

Parameters:

• macAddress (string) – Devices’s Mac Address.

• type (integer) – Devices’s Type.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!start-wireless-rogue-ap-containment

wireless_rogue_ap_containment_status_v1(mac_address, headers=None, **request_parameters)

Intent API to check the wireless rogue access point containment status. The response includes all the details like containment status, contained by WLC, containment status of each BSSID etc. This API also includes the information of strongest detecting WLC for this rogue access point. .

Parameters:

• mac_address (str) – macAddress path parameter. MAC Address of the Wireless Rogue AP .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!wireless-rogue-ap-containment-status

stop_wireless_rogue_ap_containment_v1(macAddress=None, type=None, wlcIp=None, headers=None, payload=None, active_validation=True, **request_parameters)

Intent API to stop the wireless rogue access point containment. This API will stop the containment through single WLC. The response includes the details like WLC and BSSID on which the stop containment has been initiated. .

Parameters:

• macAddress (string) – Devices’s Mac Address.

• type (integer) – Devices’s Type.

• wlcIp (string) – Devices’s Wlc Ip.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!stop-wireless-rogue-ap-containment

threat_details_v1(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)

The details for the Rogue and aWIPS threats .

Parameters:

• endTime (integer) – Devices’s End Time.

• isNewThreat (boolean) – Devices’s Is New Threat.

• limit (integer) – Devices’s Limit.

• offset (integer) – Devices’s Offset.

• siteId (list) – Devices’s Site Id (list of strings).

• startTime (integer) – Devices’s Start Time.

• threatLevel (list) – Devices’s Threat Level (list of strings).

• threatType (list) – Devices’s Threat Type (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!threat-details

threat_detail_count_v1(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)

The details count for the Rogue and aWIPS threats .

Parameters:

• endTime (integer) – Devices’s End Time.

• isNewThreat (boolean) – Devices’s Is New Threat.

• limit (integer) – Devices’s Limit.

• offset (integer) – Devices’s Offset.

• siteId (list) – Devices’s Site Id (list of strings).

• startTime (integer) – Devices’s Start Time.

• threatLevel (list) – Devices’s Threat Level (list of strings).

• threatType (list) – Devices’s Threat Type (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!threat-detail-count

get_threat_levels_v1(headers=None, **request_parameters)

Intent API to fetch all threat levels defined. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-threat-levels

add_allowed_mac_address_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Intent API to add the threat mac address to allowed list. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-allowed-mac-address

get_allowed_mac_address_v1(limit=None, offset=None, headers=None, **request_parameters)

Intent API to fetch all the allowed mac addresses in the system. .

Parameters:

• offset (int) – offset query parameter. The offset of the first item in the collection to return. .

• limit (int) – limit query parameter. The maximum number of entries to return. If the value exceeds the total count, then the maximum entries will be returned. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-allowed-mac-address

get_allowed_mac_address_count_v1(headers=None, **request_parameters)

Intent API to fetch the count of allowed mac addresses in the system. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-allowed-mac-address-count

remove_allowed_mac_address_v1(mac_address, headers=None, **request_parameters)

Intent API to remove the threat mac address from allowed list. .

Parameters:

• mac_address (str) – macAddress path parameter. Threat mac address which needs to be removed from the allowed list. Multiple mac addresses will be removed if provided as comma separated values (example: 00:2A:10:51:22:43,00:2A:10:51:22:44). Note: In one request, maximum 100 mac addresses can be removed. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!remove-allowed-mac-address

threat_summary_v1(endTime=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)

The Threat Summary for the Rogues and aWIPS .

Parameters:

• endTime (integer) – Devices’s End Time.

• siteId (list) – Devices’s Site Id (list of strings).

• startTime (integer) – Devices’s Start Time.

• threatLevel (list) – Devices’s Threat Level (list of strings).

• threatType (list) – Devices’s Threat Type (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!threat-summary

get_threat_types_v1(headers=None, **request_parameters)

Intent API to fetch all threat types defined. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-threat-types

get_device_interface_stats_info_v2(device_id, endTime=None, query=None, startTime=None, headers=None, payload=None, active_validation=True, **request_parameters)

This API returns the Interface Stats for the given Device Id. Please refer to the Feature tab for the Request Body usage and the API filtering support. .

Parameters:

• endTime (integer) – Devices’s UTC epoch timestamp in milliseconds .

• query (object) – Devices’s query.

• startTime (integer) – Devices’s UTC epoch timestamp in milliseconds .

• device_id (str) – deviceId path parameter. Network Device Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

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

get_the_count_of_health_score_definitions_based_on_provided_filters_v1(device_type=None, id=None, include_for_overall_health=None, headers=None, **request_parameters)

Get the count of health score definitions based on provided filters. Supported filters are id, name and overall health include status. For detailed information about the usage of the API, please refer to the Open API specification document https://github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-issueAndHealthDefinitions-1.0.0-resolved.yaml .

Parameters:

• device_type (str) – deviceType query parameter. These are the device families supported for health score definitions. If no input is made on device family, all device families are considered. .

• id (str) – id query parameter. The definition identifier. Examples: id=015d9cba-4f53-4087-8317-7e49e5ffef46 (single entity id request) id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (multiple ids in the query param) .

• include_for_overall_health (bool) – includeForOverallHealth query parameter. The inclusion status of the issue definition, either true or false. true indicates that particular health metric is included in overall health computation, otherwise false. By default it’s set to true. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-the-count-of-health-score-definitions-based-on-provided-filters

get_interface_by_ip(ip_address, headers=None, **request_parameters)

This function is an alias of get_interface_by_ip_v1 . :param ip_address: ipAddress path parameter. IP address of the interface . :type ip_address: basestring :param headers: Dictionary of HTTP Headers to send with the Request. :type headers: dict :param **request_parameters: Additional request parameters (provides

support for parameters that may be added in the future).

Returns:

This function returns the output of get_interface_by_ip_v1 .

get_supervisor_card_detail(device_uuid, headers=None, **request_parameters)

This function is an alias of get_supervisor_card_detail_v1 . :param device_uuid: deviceUuid path parameter. instanceuuid of device . :type device_uuid: basestring :param headers: Dictionary of HTTP Headers to send with the Request. :type headers: dict :param **request_parameters: Additional request parameters (provides

support for parameters that may be added in the future).

Returns:

This function returns the output of get_supervisor_card_detail_v1 .

the_total_interfaces_count_across_the_network_devices(aggregateAttributes=None, attributes=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of the_total_interfaces_count_across_the_network_devices_v1 . :param aggregateAttributes: Devices’s aggregateAttributes (list of objects). :type aggregateAttributes: list :param attributes: Devices’s Attributes (list of strings). :type attributes: list :param endTime: Devices’s End Time. :type endTime: integer :param filters: Devices’s filters (list of objects). :type filters: list :param page: Devices’s page. :type page: object :param startTime: Devices’s Start Time. :type startTime: integer :param views: Devices’s Views (list of strings). :type views: list :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of the_total_interfaces_count_across_the_network_devices_v1 .

threat_details(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of threat_details_v1 . :param endTime: Devices’s End Time. :type endTime: integer :param isNewThreat: Devices’s Is New Threat. :type isNewThreat: boolean :param limit: Devices’s Limit. :type limit: integer :param offset: Devices’s Offset. :type offset: integer :param siteId: Devices’s Site Id (list of strings). :type siteId: list :param startTime: Devices’s Start Time. :type startTime: integer :param threatLevel: Devices’s Threat Level (list of strings). :type threatLevel: list :param threatType: Devices’s Threat Type (list of strings). :type threatType: list :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of threat_details_v1 .

gets_the_total_network_device_counts_based_on_the_provided_query_parameters(attribute=None, end_time=None, family=None, health_score=None, id=None, mac_address=None, maintenance_mode=None, management_ip_address=None, role=None, serial_number=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, software_version=None, start_time=None, type=None, view=None, headers=None, **request_parameters)

This function is an alias of gets_the_total_network_device_counts_based_on_the_provided_query_parameters_v1 . :param start_time: startTime query parameter. Start time from which API queries the data set related to

the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

Parameters:

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• id (basestring) – id query parameter. The list of entity Uuids. (Ex.”6bef213c-19ca-4170-8375-b694e251101c”) Examples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested) id=6bef213c-19ca- 4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955- 8aa2-79b233318ba0 (multiple entity uuid with ‘&’ separator) .

• site_hierarchy (basestring) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. Global/AreaName/BuildingName/FloorName) This field supports wildcard asterisk (*) character search support. E.g. /San, /San, /San Examples: ?siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) ?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/A reaName2/BuildingName2/FloorName2 (multiple siteHierarchies requested) .

• site_hierarchy_id (basestring) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyIds requested) .

• site_id (basestring) – siteId query parameter. The UUID of the site. (Ex. flooruuid) This field supports wildcard asterisk (*) character search support. E.g.*flooruuid*, flooruuid, flooruuid Examples: ?siteId=id1 (single id requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple ids requested) .

• management_ip_address (basestring) – managementIpAddress query parameter. The list of entity management IP Address. It can be either Ipv4 or Ipv6 address or combination of both(Ex. “121.1.1.10”) This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: managementIpAddresses=121.1.1.10 managementIpAddresses=121.1.1.10&manag ementIpAddresses=172.20.1.10&managementIpAddresses=200:10&=managementIpAddresses172.20.3 .4 (multiple entity IP Address with & separator) .

• mac_address (basestring) – macAddress query parameter. The macAddress of the network device or client This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: macAddress=AB:AB:AB:CD:CD:CD (single macAddress requested) macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE (multiple macAddress requested) .

• family (basestring) – family query parameter. The list of network device family names Examples:family=Switches and Hubs (single network device family name )family=Switches and Hubs&family=Router&family=Wireless Controller (multiple Network device family names with & separator). This field is not case sensitive. .

• type (basestring) – type query parameter. The list of network device type This field supports wildcard (*) character-based search. Ex: *9407R* or *9407R or `9407R*`Examples:type=SwitchesCisco DNA 9407R Switch (single network device types )type=Cisco DNA 38xx stack-able ethernet switch&type=Cisco 3945 Integrated Services Router G2 (multiple Network device types with & separator) .

• role (basestring) – role query parameter. The list of network device role. Examples:role=CORE, role=CORE&role=ACCESS&role=ROUTER (multiple Network device roles with & separator). This field is not case sensitive. .

• serial_number (basestring) – serialNumber query parameter. The list of network device serial numbers. This field supports wildcard (*) character-based search. Ex: *MS1SV* or MS1SV* or *MS1SV Examples: serialNumber=9FUFMS1SVAX serialNumber=9FUFMS1SVAX&FCW2333Q0BY&FJC240617JX(multiple Network device serial number with & separator) .

• maintenance_mode (bool) – maintenanceMode query parameter. The device maintenanceMode status true or false .

• software_version (basestring) – softwareVersion query parameter. The list of network device software version This field supports wildcard (*) character-based search. Ex: *17.8* or *17.8 or 17.8* Examples: softwareVersion=2.3.4.0 (single network device software version ) softwareVersion=17.9.3.23&softwareVersion=17.7.1.2&softwareVersion=*.17.7 (multiple Network device software versions with & separator) .

• health_score (basestring) – healthScore query parameter. The list of entity health score categories Examples:healthScore=good,healthScore=good&healthScore=fair (multiple entity healthscore values with & separator). This field is not case sensitive. .

• view (basestring) – view query parameter. The List of Network Device model views. Please refer to `NetworkDeviceView` for the supported list .

• attribute (basestring) – attribute query parameter. The List of Network Device model attributes. This is helps to specify the interested fields in the request. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_the_total_network_device_counts_based_on_the_provided_query_parameters_v1 .

poe_details(device_uuid, headers=None, **request_parameters)

This function is an alias of poe_details_v1 . :param device_uuid: deviceUuid path parameter. UUID of the device . :type device_uuid: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of poe_details_v1 .

get_threat_levels(headers=None, **request_parameters)

This function is an alias of get_threat_levels_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_threat_levels_v1 .

get_connected_device_detail(device_uuid, interface_uuid, headers=None, **request_parameters)

This function is an alias of get_connected_device_detail_v1 . :param device_uuid: deviceUuid path parameter. instanceuuid of Device . :type device_uuid: basestring :param interface_uuid: interfaceUuid path parameter. instanceuuid of interface . :type interface_uuid: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_connected_device_detail_v1 .

export_device_list(deviceUuids=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of export_device_list_v1 . :param deviceUuids: Devices’s List of device uuids (list of strings). :type deviceUuids: list :param operationEnum: Devices’s 0 to export Device Credential Details Or 1 to export Device Details .

Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

Parameters:

• parameters (list) – Devices’s List of device parameters that needs to be exported to file (list of strings).

• password (string) – Devices’s Password is required when the operationEnum value is 0 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of export_device_list_v1 .

gets_the_total_number_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions(aggregateAttributes=None, attributes=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of gets_the_total_number_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1 . :param aggregateAttributes: Devices’s aggregateAttributes (list of objects). :type aggregateAttributes: list :param attributes: Devices’s Attributes (list of strings). :type attributes: list :param endTime: Devices’s End Time. :type endTime: integer :param filters: Devices’s filters (list of objects). :type filters: list :param page: Devices’s page. :type page: object :param startTime: Devices’s Start Time. :type startTime: integer :param views: Devices’s Views (list of strings). :type views: list :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_the_total_number_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1 .

get_organization_list_for_meraki(id, headers=None, **request_parameters)

This function is an alias of get_organization_list_for_meraki_v1 . :param id: id path parameter. Device Id . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_organization_list_for_meraki_v1 .

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)

This function is an alias of get_wireless_lan_controller_details_by_id_v1 . :param id: id path parameter. Device ID . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_wireless_lan_controller_details_by_id_v1 .

get_all_interfaces(last_input_time=None, last_output_time=None, limit=None, offset=None, headers=None, **request_parameters)

This function is an alias of get_all_interfaces_v1 . :param offset: offset query parameter. :type offset: int :param limit: limit query parameter. :type limit: int :param last_input_time: lastInputTime query parameter. Last Input Time . :type last_input_time: basestring :param last_output_time: lastOutputTime query parameter. Last Output Time . :type last_output_time: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_all_interfaces_v1 .

update_user_defined_field(id, description=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_user_defined_field_v1 . :param description: Devices’s Description of UDF . :type description: string :param name: Devices’s Name of UDF . :type name: string :param id: id path parameter. UDF id . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_user_defined_field_v1 .

get_device_interface_stats_info(device_id, endTime=None, query=None, startTime=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of get_device_interface_stats_info_v2 . :param endTime: Devices’s UTC epoch timestamp in milliseconds . :type endTime: integer :param query: Devices’s query. :type query: object :param startTime: Devices’s UTC epoch timestamp in milliseconds . :type startTime: integer :param device_id: deviceId path parameter. Network Device Id . :type device_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_interface_stats_info_v2 .

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)

This function is an alias of get_network_device_by_pagination_range_v1 . :param start_index: startIndex path parameter. Start index [>=1] . :type start_index: int :param records_to_return: recordsToReturn path parameter. Number of records to return [1<= recordsToReturn

<= 500] .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_network_device_by_pagination_range_v1 .

stop_wireless_rogue_ap_containment(macAddress=None, type=None, wlcIp=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of stop_wireless_rogue_ap_containment_v1 . :param macAddress: Devices’s Mac Address. :type macAddress: string :param type: Devices’s Type. :type type: integer :param wlcIp: Devices’s Wlc Ip. :type wlcIp: string :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of stop_wireless_rogue_ap_containment_v1 .

inventory_insight_device_link_mismatch(category, site_id, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

This function is an alias of inventory_insight_device_link_mismatch_v1 . :param site_id: siteId path parameter. :type site_id: basestring :param offset: offset query parameter. Row Number. Default value is 1 . :type offset: int :param limit: limit query parameter. Default value is 500 . :type limit: int :param category: category query parameter. Links mismatch category. Value can be speed-duplex or

vlan. .

Parameters:

• sort_by (basestring) – sortBy query parameter. Sort By .

• order (basestring) – order query parameter. Order. Value can be asc or desc. Default value is asc .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of inventory_insight_device_link_mismatch_v1 .

get_devices_registered_for_wsa_notification(macaddress=None, serial_number=None, headers=None, **request_parameters)

This function is an alias of get_devices_registered_for_wsa_notification_v1 . :param serial_number: serialNumber query parameter. Serial number of the device . :type serial_number: basestring :param macaddress: macaddress query parameter. Mac addres of the device . :type macaddress: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_devices_registered_for_wsa_notification_v1 .

threat_detail_count(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of threat_detail_count_v1 . :param endTime: Devices’s End Time. :type endTime: integer :param isNewThreat: Devices’s Is New Threat. :type isNewThreat: boolean :param limit: Devices’s Limit. :type limit: integer :param offset: Devices’s Offset. :type offset: integer :param siteId: Devices’s Site Id (list of strings). :type siteId: list :param startTime: Devices’s Start Time. :type startTime: integer :param threatLevel: Devices’s Threat Level (list of strings). :type threatLevel: list :param threatType: Devices’s Threat Type (list of strings). :type threatType: list :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of threat_detail_count_v1 .

get_device_enrichment_details(headers=None, **request_parameters)

This function is an alias of get_device_enrichment_details_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_enrichment_details_v1 .

get_device_by_id(id, headers=None, **request_parameters)

This function is an alias of get_device_by_id_v1 . :param id: id path parameter. Device ID . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_by_id_v1 .

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)

This function is an alias of get_device_interface_vlans_v1 . :param id: id path parameter. :type id: basestring :param interface_type: interfaceType query parameter. Vlan associated with sub-interface. If no

interfaceType mentioned it will return all types of Vlan interfaces. If interfaceType is selected but not specified then it will take default value. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_interface_vlans_v1 .

gets_the_summary_analytics_data_related_to_network_devices(aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of gets_the_summary_analytics_data_related_to_network_devices_v1 . :param aggregateAttributes: Devices’s aggregateAttributes (list of objects). :type aggregateAttributes: list :param attributes: Devices’s Attributes (list of strings). :type attributes: list :param endTime: Devices’s End Time. :type endTime: integer :param filters: Devices’s filters (list of objects). :type filters: list :param groupBy: Devices’s Group By (list of strings). :type groupBy: list :param page: Devices’s page. :type page: object :param startTime: Devices’s Start Time. :type startTime: integer :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_the_summary_analytics_data_related_to_network_devices_v1 .

get_linecard_details(device_uuid, headers=None, **request_parameters)

This function is an alias of get_linecard_details_v1 . :param device_uuid: deviceUuid path parameter. instanceuuid of device . :type device_uuid: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_linecard_details_v1 .

delete_planned_access_point_for_floor(floor_id, planned_access_point_uuid, headers=None, **request_parameters)

This function is an alias of delete_planned_access_point_for_floor_v1 . :param floor_id: floorId path parameter. The instance UUID of the floor hierarchy element . :type floor_id: basestring :param planned_access_point_uuid: plannedAccessPointUuid path parameter. The instance UUID of the

planned access point to delete .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_planned_access_point_for_floor_v1 .

legit_operations_for_interface(interface_uuid, headers=None, **request_parameters)

This function is an alias of legit_operations_for_interface_v1 . :param interface_uuid: interfaceUuid path parameter. Interface ID . :type interface_uuid: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of legit_operations_for_interface_v1 .

override_resync_interval(headers=None, **request_parameters)

This function is an alias of override_resync_interval_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of override_resync_interval_v1 .

get_threat_types(headers=None, **request_parameters)

This function is an alias of get_threat_types_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_threat_types_v1 .

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)

This function is an alias of get_modules_v1 . :param device_id: deviceId query parameter. :type device_id: basestring :param limit: limit query parameter. :type limit: int :param offset: offset query parameter. :type offset: int :param name_list: nameList query parameter. :type name_list: basestring, list, set, tuple :param vendor_equipment_type_list: vendorEquipmentTypeList query parameter. :type vendor_equipment_type_list: basestring, list, set, tuple :param part_number_list: partNumberList query parameter. :type part_number_list: basestring, list, set, tuple :param operational_state_code_list: operationalStateCodeList query parameter. :type operational_state_code_list: basestring, list, set, tuple :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_modules_v1 .

update_planned_access_point_for_floor(floor_id, attributes=None, isSensor=None, location=None, position=None, radioCount=None, radios=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_planned_access_point_for_floor_v1 . :param attributes: Devices’s attributes. :type attributes: object :param isSensor: Devices’s Indicates that PAP is a sensor . :type isSensor: boolean :param location: Devices’s location. :type location: object :param position: Devices’s position. :type position: object :param radioCount: Devices’s Number of radios of the planned access point . :type radioCount: integer :param radios: Devices’s radios (list of objects). :type radios: list :param floor_id: floorId path parameter. The instance UUID of the floor hierarchy element . :type floor_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_planned_access_point_for_floor_v1 .

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of sync_devices_using_forcesync_v1 . :param force_sync: forceSync query parameter. :type force_sync: bool :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of sync_devices_using_forcesync_v1 .

create_planned_access_point_for_floor(floor_id, attributes=None, isSensor=None, location=None, position=None, radioCount=None, radios=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_planned_access_point_for_floor_v1 . :param attributes: Devices’s attributes. :type attributes: object :param isSensor: Devices’s Indicates that PAP is a sensor . :type isSensor: boolean :param location: Devices’s location. :type location: object :param position: Devices’s position. :type position: object :param radioCount: Devices’s Number of radios of the planned access point . :type radioCount: integer :param radios: Devices’s radios (list of objects). :type radios: list :param floor_id: floorId path parameter. The instance UUID of the floor hierarchy element . :type floor_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_planned_access_point_for_floor_v1 .

gets_the_list_of_interfaces_across_the_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions(aggregateAttributes=None, attributes=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of gets_the_list_of_interfaces_across_the_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1 . :param aggregateAttributes: Devices’s aggregateAttributes (list of objects). :type aggregateAttributes: list :param attributes: Devices’s Attributes (list of strings). :type attributes: list :param endTime: Devices’s End Time. :type endTime: integer :param filters: Devices’s filters (list of objects). :type filters: list :param page: Devices’s page. :type page: object :param startTime: Devices’s Start Time. :type startTime: integer :param views: Devices’s Views (list of strings). :type views: list :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_the_list_of_interfaces_across_the_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1 .

get_polling_interval_by_id(id, headers=None, **request_parameters)

This function is an alias of get_polling_interval_by_id_v1 . :param id: id path parameter. Device ID . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_polling_interval_by_id_v1 .

get_the_count_of_health_score_definitions_based_on_provided_filters(device_type=None, id=None, include_for_overall_health=None, headers=None, **request_parameters)

This function is an alias of get_the_count_of_health_score_definitions_based_on_provided_filters_v1 . :param device_type: deviceType query parameter. These are the device families supported for health

score definitions. If no input is made on device family, all device families are considered. .

Parameters:

• id (basestring) – id query parameter. The definition identifier. Examples: id=015d9cba-4f53-4087-8317-7e49e5ffef46 (single entity id request) id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (multiple ids in the query param) .

• include_for_overall_health (bool) – includeForOverallHealth query parameter. The inclusion status of the issue definition, either true or false. true indicates that particular health metric is included in overall health computation, otherwise false. By default it’s set to true. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_the_count_of_health_score_definitions_based_on_provided_filters_v1 .

threat_summary(endTime=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of threat_summary_v1 . :param endTime: Devices’s End Time. :type endTime: integer :param siteId: Devices’s Site Id (list of strings). :type siteId: list :param startTime: Devices’s Start Time. :type startTime: integer :param threatLevel: Devices’s Threat Level (list of strings). :type threatLevel: list :param threatType: Devices’s Threat Type (list of strings). :type threatType: list :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of threat_summary_v1 .

get_interface_info_by_id(device_id, headers=None, **request_parameters)

This function is an alias of get_interface_info_by_id_v1 . :param device_id: deviceId path parameter. Device ID . :type device_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_interface_info_by_id_v1 .

get_health_score_definition_for_the_given_id(id, headers=None, **request_parameters)

This function is an alias of get_health_score_definition_for_the_given_id_v1 . :param id: id path parameter. Health score definition id. . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_health_score_definition_for_the_given_id_v1 .

count_the_number_of_events_with_filters(deviceFamily=None, endTime=None, filters=None, startTime=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of count_the_number_of_events_with_filters_v1 . :param deviceFamily: Devices’s Device Family (list of strings). :type deviceFamily: list :param endTime: Devices’s End Time. :type endTime: integer :param filters: Devices’s filters (list of objects). :type filters: list :param startTime: Devices’s Start Time. :type startTime: integer :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of count_the_number_of_events_with_filters_v1 .

remove_user_defined_field_from_device(device_id, name, headers=None, **request_parameters)

This function is an alias of remove_user_defined_field_from_device_v1 . :param device_id: deviceId path parameter. UUID of device from which UDF has to be removed . :type device_id: basestring :param name: name query parameter. Name of UDF to be removed . :type name: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of remove_user_defined_field_from_device_v1 .

delete_user_defined_field(id, headers=None, **request_parameters)

This function is an alias of delete_user_defined_field_v1 . :param id: id path parameter. UDF id . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_user_defined_field_v1 .

delete_device_by_id(id, clean_config=None, headers=None, **request_parameters)

This function is an alias of delete_device_by_id_v1 . :param id: id path parameter. Device ID . :type id: basestring :param clean_config: cleanConfig query parameter. Selecting the clean up configuration option will

attempt to remove device settings that were configured during the addition of the device to the inventory and site assignment. Please note that this operation is different from deprovisioning. It does not remove configurations that were pushed during device provisioning. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_device_by_id_v1 .

update_global_resync_interval(interval=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_global_resync_interval_v1 . :param interval: Devices’s Resync Interval should be between 25 to 1440 minutes . :type interval: integer :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_global_resync_interval_v1 .

get_module_info_by_id(id, headers=None, **request_parameters)

This function is an alias of get_module_info_by_id_v1 . :param id: id path parameter. Module id . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_module_info_by_id_v1 .

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, device_support_level=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, limit=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, offset=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)

This function is an alias of get_device_list_v1 . :param hostname: hostname query parameter. :type hostname: basestring, list, set, tuple :param management_ip_address: managementIpAddress query parameter. :type management_ip_address: basestring, list, set, tuple :param mac_address: macAddress query parameter. :type mac_address: basestring, list, set, tuple :param location_name: locationName query parameter. :type location_name: basestring, list, set, tuple :param serial_number: serialNumber query parameter. :type serial_number: basestring, list, set, tuple :param location: location query parameter. :type location: basestring, list, set, tuple :param family: family query parameter. :type family: basestring, list, set, tuple :param type: type query parameter. :type type: basestring, list, set, tuple :param series: series query parameter. :type series: basestring, list, set, tuple :param collection_status: collectionStatus query parameter. :type collection_status: basestring, list, set, tuple :param collection_interval: collectionInterval query parameter. :type collection_interval: basestring, list, set, tuple :param not_synced_for_minutes: notSyncedForMinutes query parameter. :type not_synced_for_minutes: basestring, list, set, tuple :param error_code: errorCode query parameter. :type error_code: basestring, list, set, tuple :param error_description: errorDescription query parameter. :type error_description: basestring, list, set, tuple :param software_version: softwareVersion query parameter. :type software_version: basestring, list, set, tuple :param software_type: softwareType query parameter. :type software_type: basestring, list, set, tuple :param platform_id: platformId query parameter. :type platform_id: basestring, list, set, tuple :param role: role query parameter. :type role: basestring, list, set, tuple :param reachability_status: reachabilityStatus query parameter. :type reachability_status: basestring, list, set, tuple :param up_time: upTime query parameter. :type up_time: basestring, list, set, tuple :param associated_wlc_ip: associatedWlcIp query parameter. :type associated_wlc_ip: basestring, list, set, tuple :param license_name: license.name query parameter. :type license_name: basestring, list, set, tuple :param license_type: license.type query parameter. :type license_type: basestring, list, set, tuple :param license_status: license.status query parameter. :type license_status: basestring, list, set, tuple :param module_name: module+name query parameter. :type module_name: basestring, list, set, tuple :param module_equpimenttype: module+equpimenttype query parameter. :type module_equpimenttype: basestring, list, set, tuple :param module_servicestate: module+servicestate query parameter. :type module_servicestate: basestring, list, set, tuple :param module_vendorequipmenttype: module+vendorequipmenttype query parameter. :type module_vendorequipmenttype: basestring, list, set, tuple :param module_partnumber: module+partnumber query parameter. :type module_partnumber: basestring, list, set, tuple :param module_operationstatecode: module+operationstatecode query parameter. :type module_operationstatecode: basestring, list, set, tuple :param id: id query parameter. Accepts comma separated ids and return list of network-devices for

the given ids. If invalid or not-found ids are provided, null entry will be returned in the list. .

Parameters:

• device_support_level (basestring) – deviceSupportLevel query parameter.

• offset (int) – offset query parameter. offset >= 1 [X gives results from Xth device onwards] .

• limit (int) – limit query parameter. 1 <= limit <= 500 [max. no. of devices to be returned in the result] .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_list_v1 .

gets_the_total_network_device_interface_counts(end_time=None, interface_id=None, interface_name=None, network_device_id=None, network_device_ip_address=None, network_device_mac_address=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, start_time=None, headers=None, **request_parameters)

This function is an alias of gets_the_total_network_device_interface_counts_v1 . :param start_time: startTime query parameter. Start time from which API queries the data set related to

the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

Parameters:

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• site_hierarchy (basestring) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. Global/AreaName/BuildingName/FloorName) This field supports wildcard asterisk (*) character search support. E.g. */San*, */San, /San* Examples: ?siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) ?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/A reaName2/BuildingName2/FloorName2 (multiple siteHierarchies requested) .

• site_hierarchy_id (basestring) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: ?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyIds requested) .

• site_id (basestring) – siteId query parameter. The UUID of the site. (Ex. flooruuid) Examples: ?siteId=id1 (single id requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple ids requested) .

• network_device_id (basestring) – networkDeviceId query parameter. The list of Network Device Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c (single networkDeviceId requested) networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b- cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple networkDeviceIds with & separator) .

• network_device_ip_address (basestring) – networkDeviceIpAddress query parameter. The list of Network Device management IP Address. (Ex. 121.1.1.10) This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: networkDeviceIpAddress=121.1.1.10 networkDeviceIpAddress=121.1.1.10&networkDeviceIpAd dress=172.20.1.10&networkDeviceIpAddress=10.10.20.10 (multiple networkDevice IP Address with & separator) .

• network_device_mac_address (basestring) – networkDeviceMacAddress query parameter. The list of Network Device MAC Address. (Ex. 64:f6:9d:07:9a:00) This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: networkDeviceMacAddress=64:f6:9d:07:9a:00 networkDeviceMacAddress=64:f6:9d:07:9a:00&networkDeviceMacAddress=70:56:9d:07:ac:77 (multiple networkDevice MAC addresses with & separator) .

• interface_id (basestring) – interfaceId query parameter. The list of Interface Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: interfaceId=6bef213c-19ca-4170-8375-b694e251101c (single interface uuid ) interfaceId =6bef213c-19ca-4170-8375-b694e251101c&32219612-819e-4b5e-a96b-cf22aca13dd9&2541e9a7- b80d-4955-8aa2-79b233318ba0 (multiple Interface uuid with & separator) .

• interface_name (basestring) – interfaceName query parameter. The list of Interface name (Ex. GigabitEthernet1/0/1) This field supports wildcard (*) character-based search. Ex: *1/0/1* or 1/0/1* or *1/0/1 Examples: interfaceNames=GigabitEthernet1/0/1 (single interface name) interfaceNames=GigabitEthernet1/0/1&GigabitEthernet2/0/1&GigabitEthernet3/0/1 (multiple interface names with & separator) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_the_total_network_device_interface_counts_v1 .

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of add_device_v1 . :param cliTransport: Devices’s CLI transport. Supported values: telnet, ssh. Required if type is

NETWORK_DEVICE. .

Parameters:

• computeDevice (boolean) – Devices’s Compute Device or not. Options are true / false. .

• enablePassword (string) – Devices’s CLI enable password of the device. Required if device is configured to use enable password. .

• extendedDiscoveryInfo (string) – Devices’s This field holds that info as whether to add device with canned data or not. Supported values: DISCOVER_WITH_CANNED_DATA. .

• httpPassword (string) – Devices’s HTTP password of the device / API key for Meraki Dashboard. Required if type is MERAKI_DASHBOARD or COMPUTE_DEVICE. .

• httpPort (string) – Devices’s HTTP port of the device. Required if type is COMPUTE_DEVICE. .

• httpSecure (boolean) – Devices’s Flag to select HTTP / HTTPS protocol. Options are true / false. true for HTTPS and false for HTTP. Default is true. .

• httpUserName (string) – Devices’s HTTP Username of the device. Required if type is COMPUTE_DEVICE. .

• ipAddress (list) – Devices’s IP Address of the device. Required if type is NETWORK_DEVICE, COMPUTE_DEVICE or THIRD_PARTY_DEVICE. (list of strings).

• merakiOrgId (list) – Devices’s Selected Meraki organization for which the devices needs to be imported. Required if type is MERAKI_DASHBOARD. (list of strings).

• netconfPort (string) – Devices’s Netconf Port of the device. cliTransport must be ‘ssh’ if netconf is provided. .

• password (string) – Devices’s CLI Password of the device. Required if type is NETWORK_DEVICE. .

• serialNumber (string) – Devices’s Serial Number of the Device. Required if extendedDiscoveryInfo is ‘DISCOVER_WITH_CANNED_DATA’. .

• snmpAuthPassphrase (string) – Devices’s SNMPv3 auth passphrase of the device. Required if snmpMode is authNoPriv or authPriv. .

• snmpAuthProtocol (string) – Devices’s SNMPv3 auth protocol. Supported values: sha, md5. Required if snmpMode is authNoPriv or authPriv. .

• snmpMode (string) – Devices’s SNMPv3 mode. Supported values: noAuthnoPriv, authNoPriv, authPriv. Required if snmpVersion is v3. .

• snmpPrivPassphrase (string) – Devices’s SNMPv3 priv passphrase. Required if snmpMode is authPriv. .

• snmpPrivProtocol (string) – Devices’s SNMPv3 priv protocol. Supported values: AES128. Required if snmpMode is authPriv. .

• snmpROCommunity (string) – Devices’s SNMP Read Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. .

• snmpRWCommunity (string) – Devices’s SNMP Write Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. .

• snmpRetry (integer) – Devices’s SNMP retry count. Max value supported is 3. Default is Global SNMP retry (if exists) or 3. .

• snmpTimeout (integer) – Devices’s SNMP timeout in seconds. Max value supported is 300. Default is Global SNMP timeout (if exists) or 5. .

• snmpUserName (string) – Devices’s SNMPV3 user name of the device. Required if snmpVersion is v3. .

• snmpVersion (string) – Devices’s SNMP version. Values supported: v2, v3. Required if type is NETWORK_DEVICE, COMPUTE_DEVICE or THIRD_PARTY_DEVICE. .

• type (string) – Devices’s Type of device being added. Default is NETWORK_DEVICE. . Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘THIRD_PARTY_DEVICE’ and ‘NETWORK_DEVICE’.

• userName (string) – Devices’s CLI user name of the device. Required if type is NETWORK_DEVICE. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of add_device_v1 .

update_resync_interval_for_the_network_device(id, interval=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_resync_interval_for_the_network_device_v1 . :param interval: Devices’s Resync interval in minutes. To disable periodic resync, set interval as

0. To use global settings, set interval as null. .

Parameters:

• id (basestring) – id path parameter. The id of the network device. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_resync_interval_for_the_network_device_v1 .

the_trend_analytics_data_for_the_network_device_in_the_specified_time_range(id, aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, trendIntervalInMinutes=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of the_trend_analytics_data_for_the_network_device_in_the_specified_time_range_v1 . :param aggregateAttributes: Devices’s aggregateAttributes (list of objects). :type aggregateAttributes: list :param attributes: Devices’s Attributes (list of strings). :type attributes: list :param endTime: Devices’s End Time. :type endTime: integer :param filters: Devices’s filters (list of objects). :type filters: list :param groupBy: Devices’s Group By (list of strings). :type groupBy: list :param page: Devices’s page. :type page: object :param startTime: Devices’s Start Time. :type startTime: integer :param trendIntervalInMinutes: Devices’s Trend Interval In Minutes. :type trendIntervalInMinutes: integer :param id: id path parameter. The device Uuid . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of the_trend_analytics_data_for_the_network_device_in_the_specified_time_range_v1 .

get_isis_interfaces(headers=None, **request_parameters)

This function is an alias of get_isis_interfaces_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_isis_interfaces_v1 .

get_device_by_serial_number(serial_number, headers=None, **request_parameters)

This function is an alias of get_device_by_serial_number_v1 . :param serial_number: serialNumber path parameter. Device serial number . :type serial_number: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_by_serial_number_v1 .

get_device_config_count(headers=None, **request_parameters)

This function is an alias of get_device_config_count_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_config_count_v1 .

get_chassis_details_for_device(device_id, headers=None, **request_parameters)

This function is an alias of get_chassis_details_for_device_v1 . :param device_id: deviceId path parameter. Device ID . :type device_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_chassis_details_for_device_v1 .

get_device_config_by_id(network_device_id, headers=None, **request_parameters)

This function is an alias of get_device_config_by_id_v1 . :param network_device_id: networkDeviceId path parameter. :type network_device_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_config_by_id_v1 .

rogue_additional_details(endTime=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of rogue_additional_details_v1 . :param endTime: Devices’s This is the epoch end time in milliseconds upto which data need to be

fetched. Default value is current time .

Parameters:

• limit (number) – Devices’s The maximum number of entries to return. Default value is 1000 .

• offset (number) – Devices’s The offset of the first item in the collection to return. Default value is 1 .

• siteId (list) – Devices’s Filter Rogues by location. Site IDs information can be fetched from “Get Site” API (list of strings).

• startTime (number) – Devices’s This is the epoch start time in milliseconds from which data need to be fetched. Default value is 24 hours earlier to endTime .

• threatLevel (list) – Devices’s Filter Rogues by Threat Level. Threat Level information can be fetched from “Get Threat Levels” API (list of strings).

• threatType (list) – Devices’s Filter Rogues by Threat Type. Threat Type information can be fetched from “Get Threat Types” API (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of rogue_additional_details_v1 .

get_all_health_score_definitions_for_given_filters(attribute=None, device_type=None, id=None, include_for_overall_health=None, limit=None, offset=None, headers=None, **request_parameters)

This function is an alias of get_all_health_score_definitions_for_given_filters_v1 . :param device_type: deviceType query parameter. These are the device families supported for health

score definitions. If no input is made on device family, all device families are considered. .

Parameters:

• id (basestring) – id query parameter. The definition identifier. Examples: id=015d9cba-4f53-4087-8317-7e49e5ffef46 (single entity id request) id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (multiple ids in the query param) .

• include_for_overall_health (bool) – includeForOverallHealth query parameter. The inclusion status of the issue definition, either true or false. true indicates that particular health metric is included in overall health computation, otherwise false. By default it’s set to true. .

• attribute (basestring) – attribute query parameter. These are the attributes supported in health score definitions response. By default, all properties are sent in response. .

• offset (int) – offset query parameter. Specifies the starting point within all records returned by the API. It’s one based offset. The starting value is 1. .

• limit (int) – limit query parameter. Maximum number of records to return .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_all_health_score_definitions_for_given_filters_v1 .

get_planned_access_points_for_building(building_id, limit=None, offset=None, radios=None, headers=None, **request_parameters)

This function is an alias of get_planned_access_points_for_building_v1 . :param building_id: buildingId path parameter. The instance UUID of the building hierarchy element

.

Parameters:

• limit (int) – limit query parameter. The page size limit for the response, e.g. limit=100 will return a maximum of 100 records .

• offset (int) – offset query parameter. The page offset for the response. E.g. if limit=100, offset=0 will return first 100 records, offset=1 will return next 100 records, etc. .

• radios (bool) – radios query parameter. Whether to include the planned radio details of the planned access points .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_planned_access_points_for_building_v1 .

remove_allowed_mac_address(mac_address, headers=None, **request_parameters)

This function is an alias of remove_allowed_mac_address_v1 . :param mac_address: macAddress path parameter. Threat mac address which needs to be removed from

the allowed list. Multiple mac addresses will be removed if provided as comma separated values (example: 00:2A:10:51:22:43,00:2A:10:51:22:44). Note: In one request, maximum 100 mac addresses can be removed. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of remove_allowed_mac_address_v1 .

devices(device_role=None, end_time=None, health=None, limit=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)

This function is an alias of devices_v1 . :param device_role: deviceRole query parameter. CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, or AP

(case insensitive) .

Parameters:

• site_id (basestring) – siteId query parameter. DNAC site UUID .

• health (basestring) – health query parameter. DNAC health catagory: POOR, FAIR, or GOOD (case insensitive) .

• start_time (int) – startTime query parameter. UTC epoch time in milliseconds .

• end_time (int) – endTime query parameter. UTC epoch time in milliseconds .

• limit (int) – limit query parameter. Max number of device entries in the response (default to 50. Max at 500) .

• offset (int) – offset query parameter. The offset of the first device in the returned data (Mutiple of ‘limit’ + 1) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of devices_v1 .

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_device_role_v1 . :param id: Devices’s DeviceId of the Device . :type id: string :param role: Devices’s Role of device as ACCESS, CORE, DISTRIBUTION, BORDER ROUTER . :type role: string :param roleSource: Devices’s Role source as MANUAL / AUTO . :type roleSource: string :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_device_role_v1 .

gets_the_network_device_details_based_on_the_provided_query_parameters(attribute=None, end_time=None, family=None, health_score=None, id=None, limit=None, mac_address=None, maintenance_mode=None, management_ip_address=None, offset=None, order=None, role=None, serial_number=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, software_version=None, sort_by=None, start_time=None, type=None, view=None, headers=None, **request_parameters)

This function is an alias of gets_the_network_device_details_based_on_the_provided_query_parameters_v1 . :param start_time: startTime query parameter. Start time from which API queries the data set related to

the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

Parameters:

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• limit (int) – limit query parameter. Maximum number of records to return .

• offset (int) – offset query parameter. Specifies the starting point within all records returned by the API. It’s one based offset. The starting value is 1. .

• sort_by (basestring) – sortBy query parameter. A field within the response to sort by. .

• order (basestring) – order query parameter. The sort order of the field ascending or descending. .

• site_hierarchy (basestring) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. Global/AreaName/BuildingName/FloorName) This field supports wildcard asterisk (*) character search support. E.g. /San, /San, /San Examples: ?siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) ?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/A reaName2/BuildingName2/FloorName2 (multiple siteHierarchies requested) .

• site_hierarchy_id (basestring) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyIds requested) .

• site_id (basestring) – siteId query parameter. The UUID of the site. (Ex. flooruuid) This field supports wildcard asterisk (*) character search support. E.g.*flooruuid*, flooruuid, flooruuid Examples: ?siteId=id1 (single id requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple ids requested) .

• id (basestring) – id query parameter. The list of entity Uuids. (Ex.”6bef213c-19ca-4170-8375-b694e251101c”) Examples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested) id=6bef213c-19ca- 4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955- 8aa2-79b233318ba0 (multiple entity uuid with ‘&’ separator) .

• management_ip_address (basestring) – managementIpAddress query parameter. The list of entity management IP Address. It can be either Ipv4 or Ipv6 address or combination of both(Ex. “121.1.1.10”) This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: managementIpAddresses=121.1.1.10 managementIpAddresses=121.1.1.10&manag ementIpAddresses=172.20.1.10&managementIpAddresses=200:10&=managementIpAddresses172.20.3 .4 (multiple entity IP Address with & separator) .

• mac_address (basestring) – macAddress query parameter. The macAddress of the network device or client This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: macAddress=AB:AB:AB:CD:CD:CD (single macAddress requested) macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE (multiple macAddress requested) .

• family (basestring) – family query parameter. The list of network device family names Examples:family=Switches and Hubs (single network device family name )family=Switches and Hubs&family=Router&family=Wireless Controller (multiple Network device family names with & separator). This field is not case sensitive. .

• type (basestring) – type query parameter. The list of network device type This field supports wildcard (*) character-based search. Ex: *9407R* or *9407R or 9407R* Examples: type=SwitchesCisco DNA 9407R Switch (single network device types ) type=Cisco DNA 38xx stack-able ethernet switch&type=Cisco 3945 Integrated Services Router G2 (multiple Network device types with & separator) .

• role (basestring) – role query parameter. The list of network device role. Examples:role=CORE, role=CORE&role=ACCESS&role=ROUTER (multiple Network device roles with & separator). This field is not case sensitive. .

• serial_number (basestring) – serialNumber query parameter. The list of network device serial numbers. This field supports wildcard (*) character-based search. Ex: *MS1SV* or MS1SV* or *MS1SV Examples: serialNumber=9FUFMS1SVAX serialNumber=9FUFMS1SVAX&FCW2333Q0BY&FJC240617JX(multiple Network device serial number with & separator) .

• maintenance_mode (bool) – maintenanceMode query parameter. The device maintenanceMode status true or false .

• software_version (basestring) – softwareVersion query parameter. The list of network device software version This field supports wildcard (*) character-based search. Ex: *17.8* or *17.8 or 17.8* Examples: softwareVersion=2.3.4.0 (single network device software version ) softwareVersion=17.9.3.23&softwareVersion=17.7.1.2&softwareVersion=*.17.7 (multiple Network device software versions with & separator) .

• health_score (basestring) – healthScore query parameter. The list of entity health score categories Examples: healthScore=good, healthScore=good&healthScore=fair (multiple entity healthscore values with & separator). This field is not case sensitive. .

• view (basestring) – view query parameter. The List of Network Device model views. Please refer to `NetworkDeviceView` for the supported list .

• attribute (basestring) – attribute query parameter. The List of Network Device model attributes. This is helps to specify the interested fields in the request. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_the_network_device_details_based_on_the_provided_query_parameters_v1 .

get_device_interface_count(headers=None, **request_parameters)

This function is an alias of get_device_interface_count_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_interface_count_v1 .

get_resync_interval_for_the_network_device(id, headers=None, **request_parameters)

This function is an alias of get_resync_interval_for_the_network_device_v1 . :param id: id path parameter. The id of the network device. . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_resync_interval_for_the_network_device_v1 .

get_all_user_defined_fields(id=None, name=None, headers=None, **request_parameters)

This function is an alias of get_all_user_defined_fields_v1 . :param id: id query parameter. Comma-seperated id(s) used for search/filtering . :type id: basestring :param name: name query parameter. Comma-seperated name(s) used for search/filtering . :type name: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_all_user_defined_fields_v1 .

gets_the_list_of_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions(aggregateAttributes=None, attributes=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of gets_the_list_of_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1 . :param aggregateAttributes: Devices’s aggregateAttributes (list of objects). :type aggregateAttributes: list :param attributes: Devices’s Attributes (list of strings). :type attributes: list :param endTime: Devices’s End Time. :type endTime: integer :param filters: Devices’s filters (list of objects). :type filters: list :param page: Devices’s page. :type page: object :param startTime: Devices’s Start Time. :type startTime: integer :param views: Devices’s Views (list of strings). :type views: list :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_the_list_of_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1 .

get_device_values_that_match_fully_or_partially_an_attribute(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)

This function is an alias of get_device_values_that_match_fully_or_partially_an_attribute_v1 . :param vrf_name: vrfName query parameter. :type vrf_name: basestring :param management_ip_address: managementIpAddress query parameter. :type management_ip_address: basestring :param hostname: hostname query parameter. :type hostname: basestring :param mac_address: macAddress query parameter. :type mac_address: basestring :param family: family query parameter. :type family: basestring :param collection_status: collectionStatus query parameter. :type collection_status: basestring :param collection_interval: collectionInterval query parameter. :type collection_interval: basestring :param software_version: softwareVersion query parameter. :type software_version: basestring :param software_type: softwareType query parameter. :type software_type: basestring :param reachability_status: reachabilityStatus query parameter. :type reachability_status: basestring :param reachability_failure_reason: reachabilityFailureReason query parameter. :type reachability_failure_reason: basestring :param error_code: errorCode query parameter. :type error_code: basestring :param platform_id: platformId query parameter. :type platform_id: basestring :param series: series query parameter. :type series: basestring :param type: type query parameter. :type type: basestring :param serial_number: serialNumber query parameter. :type serial_number: basestring :param up_time: upTime query parameter. :type up_time: basestring :param role: role query parameter. :type role: basestring :param role_source: roleSource query parameter. :type role_source: basestring :param associated_wlc_ip: associatedWlcIp query parameter. :type associated_wlc_ip: basestring :param offset: offset query parameter. :type offset: int :param limit: limit query parameter. :type limit: int :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_values_that_match_fully_or_partially_an_attribute_v1 .

poe_interface_details(device_uuid, interface_name_list=None, headers=None, **request_parameters)

This function is an alias of poe_interface_details_v1 . :param device_uuid: deviceUuid path parameter. uuid of the device . :type device_uuid: basestring :param interface_name_list: interfaceNameList query parameter. comma seperated interface names . :type interface_name_list: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of poe_interface_details_v1 .

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)

This function is an alias of get_module_count_v1 . :param device_id: deviceId query parameter. :type device_id: basestring :param name_list: nameList query parameter. :type name_list: basestring, list, set, tuple :param vendor_equipment_type_list: vendorEquipmentTypeList query parameter. :type vendor_equipment_type_list: basestring, list, set, tuple :param part_number_list: partNumberList query parameter. :type part_number_list: basestring, list, set, tuple :param operational_state_code_list: operationalStateCodeList query parameter. :type operational_state_code_list: basestring, list, set, tuple :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_module_count_v1 .

get_polling_interval_for_all_devices(headers=None, **request_parameters)

This function is an alias of get_polling_interval_for_all_devices_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_polling_interval_for_all_devices_v1 .

get_planned_access_points_for_floor(floor_id, limit=None, offset=None, radios=None, headers=None, **request_parameters)

This function is an alias of get_planned_access_points_for_floor_v1 . :param floor_id: floorId path parameter. The instance UUID of the floor hierarchy element . :type floor_id: basestring :param limit: limit query parameter. The page size limit for the response, e.g. limit=100 will return a

maximum of 100 records .

Parameters:

• offset (int) – offset query parameter. The page offset for the response. E.g. if limit=100, offset=0 will return first 100 records, offset=1 will return next 100 records, etc. .

• radios (bool) – radios query parameter. Whether to include the planned radio details of the planned access points .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_planned_access_points_for_floor_v1 .

clear_mac_address_table(interface_uuid, deployment_mode=None, operation=None, payload=None, headers=None, active_validation=True, **request_parameters)

This function is an alias of clear_mac_address_table_v1 . :param operation: Devices’s Operation needs to be specified as ‘ClearMacAddress’. . :type operation: string :param payload: Devices’s Payload is not applicable . :type payload: object :param interface_uuid: interfaceUuid path parameter. Interface Id . :type interface_uuid: basestring :param deployment_mode: deploymentMode query parameter. Preview/Deploy [‘Preview’ means the

configuration is not pushed to the device. ‘Deploy’ makes the configuration pushed to the device] .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of clear_mac_address_table_v1 .

wireless_rogue_ap_containment_status(mac_address, headers=None, **request_parameters)

This function is an alias of wireless_rogue_ap_containment_status_v1 . :param mac_address: macAddress path parameter. MAC Address of the Wireless Rogue AP . :type mac_address: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of wireless_rogue_ap_containment_status_v1 .

gets_the_trend_analytics_data(aggregateAttributes=None, attributes=None, endTime=None, filters=None, groupBy=None, page=None, startTime=None, trendInterval=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of gets_the_trend_analytics_data_v1 . :param aggregateAttributes: Devices’s Aggregate Attributes (list of objects). :type aggregateAttributes: list :param attributes: Devices’s Attributes (list of strings). :type attributes: list :param endTime: Devices’s End Time. :type endTime: integer :param filters: Devices’s filters (list of objects). :type filters: list :param groupBy: Devices’s Group By (list of objects). :type groupBy: list :param page: Devices’s page. :type page: object :param startTime: Devices’s Start Time. :type startTime: integer :param trendInterval: Devices’s Trend Interval. :type trendInterval: string :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_the_trend_analytics_data_v1 .

get_device_config_for_all_devices(headers=None, **request_parameters)

This function is an alias of get_device_config_for_all_devices_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_config_for_all_devices_v1 .

add_user_defined_field_to_device(device_id, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of add_user_defined_field_to_device_v1 . :param device_id: deviceId path parameter. UUID of device to which UDF has to be added . :type device_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of add_user_defined_field_to_device_v1 .

get_stack_details_for_device(device_id, headers=None, **request_parameters)

This function is an alias of get_stack_details_for_device_v1 . :param device_id: deviceId path parameter. Device ID . :type device_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_stack_details_for_device_v1 .

rogue_additional_detail_count(endTime=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of rogue_additional_detail_count_v1 . :param endTime: Devices’s This is the epoch end time in milliseconds upto which data need to be

fetched. Default value is current time .

Parameters:

• siteId (list) – Devices’s Filter Rogues by location. Site IDs information can be fetched from “Get Site” API (list of strings).

• startTime (number) – Devices’s This is the epoch start time in milliseconds from which data need to be fetched. Default value is 24 hours earlier to endTime .

• threatLevel (list) – Devices’s This information can be fetched from “Get Threat Levels” API (list of strings).

• threatType (list) – Devices’s This information can be fetched from “Get Threat Types” API (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of rogue_additional_detail_count_v1 .

get_list_of_child_events_for_the_given_wireless_client_event(id, headers=None, **request_parameters)

This function is an alias of get_list_of_child_events_for_the_given_wireless_client_event_v1 . :param id: id path parameter. Unique identifier for the event . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_list_of_child_events_for_the_given_wireless_client_event_v1 .

get_network_device_by_ip(ip_address, headers=None, **request_parameters)

This function is an alias of get_network_device_by_ip_v1 . :param ip_address: ipAddress path parameter. Device IP address . :type ip_address: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_network_device_by_ip_v1 .

get_device_summary(id, headers=None, **request_parameters)

This function is an alias of get_device_summary_v1 . :param id: id path parameter. Device ID . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_summary_v1 .

gets_interfaces_along_with_statistics_data_from_all_network_devices(attribute=None, end_time=None, interface_id=None, interface_name=None, limit=None, network_device_id=None, network_device_ip_address=None, network_device_mac_address=None, offset=None, order=None, site_hierarchy=None, site_hierarchy_id=None, site_id=None, sort_by=None, start_time=None, view=None, headers=None, **request_parameters)

This function is an alias of gets_interfaces_along_with_statistics_data_from_all_network_devices_v1 . :param start_time: startTime query parameter. Start time from which API queries the data set related to

the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time. .

Parameters:

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. .

• limit (int) – limit query parameter. Maximum number of records to return .

• offset (int) – offset query parameter. Specifies the starting point within all records returned by the API. It’s one based offset. The starting value is 1. .

• sort_by (basestring) – sortBy query parameter. A field within the response to sort by. .

• order (basestring) – order query parameter. The sort order of the field ascending or descending. .

• site_hierarchy (basestring) – siteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. Global/AreaName/BuildingName/FloorName) This field supports wildcard asterisk (*) character search support. E.g. */San*, */San, /San* Examples: ?siteHierarchy=Global/AreaName/BuildingName/FloorName (single siteHierarchy requested) ?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/A reaName2/BuildingName2/FloorName2 (multiple siteHierarchies requested) .

• site_hierarchy_id (basestring) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: ?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyIds requested) .

• site_id (basestring) – siteId query parameter. The UUID of the site. (Ex. flooruuid) Examples: ?siteId=id1 (single id requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple ids requested) .

• view (basestring) – view query parameter. The specific summary view being requested. This is an optional parameter which can be passed to get one or more of the specific view associated fields. The default view is configuration. ### Response data proviced by each view: 1. configuration [id,adminStatus,description,duplexConfig,duplexOper,interfaceIfIndex,i nterfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,name,o perStatus, portChannelId,portMode, portType,speed,timestamp,vlanId,networkDeviceId,netwo rkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] 2. statistics [id,name,rxDiscards,rxError,rxRate,rxUtilization,txDiscards,txError,txRat e,txUtilization,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName, siteHierarchy,siteHierarchyId] 3. stackPort [id,name,peerStackMember,peerStackPort ,stackPortType,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,s iteHierarchy,siteHierarchyId] The default view is configuration, If need to access an additional view, simply include the view name in the query parameter. Examples: view=configuration (single view requested) view=configuration&view=statistic&stackPort (multiple views requested) .

• attribute (basestring) – attribute query parameter. The following list of attributes can be provided in the attribute field [id,adminStatus, description,duplexConfig,duplexOper,interfaceIfInde x,interfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,nam e,operStatus,peerStackMember,peerStackPort, portChannelId,portMode, portType,rxDiscards, rxError,rxRate,rxUtilization,speed,stackPortType,timestamp,txDiscards,txError,txRate,txU tilization,vlanId,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteNam e,siteHierarchy,siteHierarchyId] If length of attribute list is too long, please use ‘views’ param instead. Examples: attributes=name (single attribute requested) attributes=name,description,duplexOper (multiple attributes with comma separator) .

• network_device_id (basestring) – networkDeviceId query parameter. The list of Network Device Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c (single networkDeviceId requested) networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b- cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple networkDeviceIds with & separator) .

• network_device_ip_address (basestring) – networkDeviceIpAddress query parameter. The list of Network Device management IP Address. (Ex. 121.1.1.10) This field supports wildcard (*) character-based search. Ex: *1.1* or 1.1* or *1.1 Examples: networkDeviceIpAddress=121.1.1.10 networkDeviceIpAddress=121.1.1.10&networkDeviceIpAd dress=172.20.1.10&networkDeviceIpAddress=10.10.20.10 (multiple networkDevice IP Address with & separator) .

• network_device_mac_address (basestring) – networkDeviceMacAddress query parameter. The list of Network Device MAC Address. (Ex. 64:f6:9d:07:9a:00) This field supports wildcard (*) character-based search. Ex: *AB:AB:AB* or AB:AB:AB* or *AB:AB:AB Examples: networkDeviceMacAddress=64:f6:9d:07:9a:00 networkDeviceMacAddress=64:f6:9d:07:9a:00&networkDeviceMacAddress=70:56:9d:07:ac:77 (multiple networkDevice MAC addresses with & separator) .

• interface_id (basestring) – interfaceId query parameter. The list of Interface Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: interfaceId=6bef213c-19ca-4170-8375-b694e251101c (single interface uuid ) interfaceId =6bef213c-19ca-4170-8375-b694e251101c&32219612-819e-4b5e-a96b-cf22aca13dd9&2541e9a7- b80d-4955-8aa2-79b233318ba0 (multiple Interface uuid with & separator) .

• interface_name (basestring) – interfaceName query parameter. The list of Interface name (Ex. GigabitEthernet1/0/1) This field supports wildcard (*) character-based search. Ex: *1/0/1* or 1/0/1* or *1/0/1 Examples: interfaceNames=GigabitEthernet1/0/1 (single interface name) interfaceNames=GigabitEthernet1/0/1&GigabitEthernet2/0/1&GigabitEthernet3/0/1 (multiple interface names with & separator) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of gets_interfaces_along_with_statistics_data_from_all_network_devices_v1 .

add_allowed_mac_address(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of add_allowed_mac_address_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of add_allowed_mac_address_v1 .

get_functional_capability_by_id(id, headers=None, **request_parameters)

This function is an alias of get_functional_capability_by_id_v1 . :param id: id path parameter. Functional Capability UUID . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_functional_capability_by_id_v1 .

query_assurance_events(device_family, ap_mac=None, attribute=None, client_mac=None, end_time=None, limit=None, message_type=None, network_device_id=None, network_device_name=None, offset=None, order=None, severity=None, site_hierarchy_id=None, site_id=None, sort_by=None, start_time=None, view=None, headers=None, **request_parameters)

This function is an alias of query_assurance_events_v1 . :param device_family: deviceFamily query parameter. Device family. Please note that multiple

families across network device type and client type is not allowed. For example, choosing Routers along with Wireless Client or Unified AP is not supported. Examples: deviceFamily=Switches and Hubs (single deviceFamily requested) deviceFamily=Switches and Hubs&deviceFamily=Routers (multiple deviceFamily requested) .

Parameters:

• start_time (int) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time minus 24 hours. .

• end_time (int) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If endTime is not provided, API will default to current time. .

• message_type (basestring) – messageType query parameter. Message type for the event. Examples: messageType=Syslog (single messageType requested) messageType=Trap&messageType=Syslog (multiple messageType requested) .

• severity (int) – severity query parameter. Severity of the event between 0 and 6. This is applicable only for events related to network devices (other than AP) and Wired Client events. (Value: Severity: 0: Emergency: 1: Alert: 2: Critical: 3: Error: 4: Warning: 5: Notice: 6: Info), Examples: severity=0 (single severity requested) severity=0&severity=1 (multiple severity requested) .

• site_id (basestring) – siteId query parameter. The UUID of the site. (Ex. flooruuid) Examples: ?siteId=id1 (single siteId requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple siteId requested) .

• site_hierarchy_id (basestring) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: ?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyId requested) .

• network_device_name (basestring) – networkDeviceName query parameter. Network device name. This parameter is applicable for network device related families. This field supports wildcard (*) character-based search. Ex: *Branch* or Branch* or *Branch Examples: networkDeviceName=Branch-3-Gateway (single networkDeviceName requested) networkDeviceName=Branch-3-Gateway&networkDeviceName=Branch-3-Switch (multiple networkDeviceName requested) .

• network_device_id (basestring) – networkDeviceId query parameter. The list of Network Device Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c (single networkDeviceId requested) networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b- cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple networkDeviceId with & separator) .

• ap_mac (basestring) – apMac query parameter. MAC address of the access point. This parameter is applicable for Unified AP and Wireless Client events. This field supports wildcard (*) character-based search. Ex: *50:0F* or 50:0F* or *50:0F Examples: apMac=50:0F:80:0F:F7:E0 (single apMac requested) apMac=50:0F:80:0F:F7:E0&apMac=18:80:90:AB:7E:A0 (multiple apMac requested) .

• client_mac (basestring) – clientMac query parameter. MAC address of the client. This parameter is applicable for Wired Client and Wireless Client events. This field supports wildcard (*) character-based search. Ex: *66:2B* or 66:2B* or *66:2B Examples: clientMac=66:2B:B8:D2:01:56 (single clientMac requested) clientMac=66:2B:B8:D2:01:56&clientMac=DC:A6:32:F5:5A:89 (multiple clientMac requested) .

• attribute (basestring) – attribute query parameter. The list of attributes that needs to be included in the response. If this parameter is not provided, then basic attributes (id, name, timestamp, details, messageType, siteHierarchyId, siteHierarchy, deviceFamily, networkDeviceId, networkDeviceName, managementIpAddress) would be part of the response. Examples: attribute=name (single attribute requested) attribute=name&attribute=networkDeviceName (multiple attribute requested) .

• view (basestring) – view query parameter. The list of events views. Please refer to EventViews for the supported list Examples: view=network (single view requested) view=network&view=ap (multiple view requested) .

• offset (int) – offset query parameter. Specifies the starting point within all records returned by the API. It’s one based offset. The starting value is 1. .

• limit (int) – limit query parameter. Maximum number of records to return .

• sort_by (basestring) – sortBy query parameter. A field within the response to sort by. .

• order (basestring) – order query parameter. The sort order of the field ascending or descending. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of query_assurance_events_v1 .

get_allowed_mac_address_count(headers=None, **request_parameters)

This function is an alias of get_allowed_mac_address_count_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_allowed_mac_address_count_v1 .

update_health_score_definitions(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_health_score_definitions_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_health_score_definitions_v1 .

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)

This function is an alias of get_device_interface_count_by_id_v1 . :param device_id: deviceId path parameter. Device ID . :type device_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_interface_count_by_id_v1 .

get_interface_by_id(id, headers=None, **request_parameters)

This function is an alias of get_interface_by_id_v1 . :param id: id path parameter. Interface ID . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_interface_by_id_v1 .

get_allowed_mac_address(limit=None, offset=None, headers=None, **request_parameters)

This function is an alias of get_allowed_mac_address_v1 . :param offset: offset query parameter. The offset of the first item in the collection to return. . :type offset: int :param limit: limit query parameter. The maximum number of entries to return. If the value exceeds the

total count, then the maximum entries will be returned. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_allowed_mac_address_v1 .

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)

This function is an alias of get_device_detail_v1 . :param timestamp: timestamp query parameter. UTC timestamp of device data in milliseconds . :type timestamp: int :param identifier: identifier query parameter. One of “macAddress”, “nwDeviceName”, “uuid” (case

insensitive) .

Parameters:

• search_by (basestring) – searchBy query parameter. MAC Address, device name, or UUID of the network device .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_detail_v1 .

update_health_score_definition_for_the_given_id(id, includeForOverallHealth=None, synchronizeToIssueThreshold=None, thresholdValue=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_health_score_definition_for_the_given_id_v1 . :param includeForOverallHealth: Devices’s Include For Overall Health. :type includeForOverallHealth: boolean :param synchronizeToIssueThreshold: Devices’s Synchronize To Issue Threshold. :type synchronizeToIssueThreshold: boolean :param thresholdValue: Devices’s Thresehold Value. :type thresholdValue: number :param id: id path parameter. Health score definition id. . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_health_score_definition_for_the_given_id_v1 .

get_details_of_a_single_assurance_event(id, attribute=None, view=None, headers=None, **request_parameters)

This function is an alias of get_details_of_a_single_assurance_event_v1 . :param id: id path parameter. Unique identifier for the event . :type id: basestring :param attribute: attribute query parameter. The list of attributes that needs to be included in

the response. If this parameter is not provided, then basic attributes (id, name, timestamp, details, messageType, siteHierarchyId, siteHierarchy, deviceFamily, networkDeviceId, networkDeviceName, managementIpAddress) would be part of the response. Examples: attribute=name (single attribute requested) attribute=name&attribute=networkDeviceName (multiple attribute requested) .

Parameters:

• view (basestring) – view query parameter. The list of events views. Please refer to EventViews for the supported list Examples: view=network (single view requested) view=network&view=ap (multiple view requested) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_details_of_a_single_assurance_event_v1 .

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)

This function is an alias of get_device_interfaces_by_specified_range_v1 . :param device_id: deviceId path parameter. Device ID . :type device_id: basestring :param start_index: startIndex path parameter. Start index . :type start_index: int :param records_to_return: recordsToReturn path parameter. Number of records to return . :type records_to_return: int :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_interfaces_by_specified_range_v1 .

query_assurance_events_with_filters(attributes=None, deviceFamily=None, endTime=None, filters=None, page=None, startTime=None, views=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of query_assurance_events_with_filters_v1 . :param attributes: Devices’s Attributes (list of strings). :type attributes: list :param deviceFamily: Devices’s Device Family (list of strings). :type deviceFamily: list :param endTime: Devices’s End Time. :type endTime: integer :param filters: Devices’s filters (list of objects). :type filters: list :param page: Devices’s page. :type page: object :param startTime: Devices’s Start Time. :type startTime: integer :param views: Devices’s Views (list of strings). :type views: list :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of query_assurance_events_with_filters_v1 .

get_device_count(hostname=None, location_name=None, mac_address=None, management_ip_address=None, headers=None, **request_parameters)

This function is an alias of get_device_count_v1 . :param hostname: hostname query parameter. :type hostname: basestring, list, set, tuple :param management_ip_address: managementIpAddress query parameter. :type management_ip_address: basestring, list, set, tuple :param mac_address: macAddress query parameter. :type mac_address: basestring, list, set, tuple :param location_name: locationName query parameter. :type location_name: basestring, list, set, tuple :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_device_count_v1 .

start_wireless_rogue_ap_containment(macAddress=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of start_wireless_rogue_ap_containment_v1 . :param macAddress: Devices’s Mac Address. :type macAddress: string :param type: Devices’s Type. :type type: integer :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of start_wireless_rogue_ap_containment_v1 .

create_user_defined_field(description=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_user_defined_field_v1 . :param description: Devices’s Description of UDF . :type description: string :param name: Devices’s Name of UDF . :type name: string :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_user_defined_field_v1 .

update_device_management_address(deviceid, newIP=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_device_management_address_v1 . :param newIP: Devices’s New IP Address of the device to be Updated . :type newIP: string :param deviceid: deviceid path parameter. The UUID of the device whose management IP address is to

be updated. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_device_management_address_v1 .

get_interface_details(device_id, name, headers=None, **request_parameters)

This function is an alias of get_interface_details_v1 . :param device_id: deviceId path parameter. Device ID . :type device_id: basestring :param name: name query parameter. Interface name . :type name: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_interface_details_v1 .

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of sync_devices_v1 . :param cliTransport: Devices’s CLI transport. Supported values: telnet, ssh. Use NO!$DATA!$ if no

change is required. Required if type is NETWORK_DEVICE. .

Parameters:

• computeDevice (boolean) – Devices’s Compute Device or not. Options are true / false. .

• enablePassword (string) – Devices’s CLI enable password of the device. Required if device is configured to use enable password. Use NO!$DATA!$ if no change is required. .

• extendedDiscoveryInfo (string) – Devices’s This field holds that info as whether to add device with canned data or not. Supported values: DISCOVER_WITH_CANNED_DATA. .

• httpPassword (string) – Devices’s HTTP password of the device / API key for Meraki Dashboard. Required if type is MERAKI_DASHBOARD or COMPUTE_DEVICE. Use NO!$DATA!$ if no change is required. .

• httpPort (string) – Devices’s HTTP port of the device. Required if type is COMPUTE_DEVICE. .

• httpSecure (boolean) – Devices’s Flag to select HTTP / HTTPS protocol. Options are true / false. true for HTTPS and false for HTTP. .

• httpUserName (string) – Devices’s HTTP Username of the device. Required if type is COMPUTE_DEVICE. Use NO!$DATA!$ if no change is required. .

• ipAddress (list) – Devices’s IP Address of the device. Required. Use ‘api.meraki.com’ for Meraki Dashboard. (list of strings).

• merakiOrgId (list) – Devices’s Selected Meraki organization for which the devices needs to be imported. Required if type is MERAKI_DASHBOARD. (list of strings).

• netconfPort (string) – Devices’s Netconf Port of the device. cliTransport must be ‘ssh’ if netconf is provided. .

• password (string) – Devices’s CLI Password of the device. Required if type is NETWORK_DEVICE. Use NO!$DATA!$ if no change is required. .

• serialNumber (string) – Devices’s Serial Number of the Device. Required if extendedDiscoveryInfo is ‘DISCOVER_WITH_CANNED_DATA’. .

• snmpAuthPassphrase (string) – Devices’s SNMPv3 auth passphrase of the device. Required if snmpMode is authNoPriv or authPriv. Use NO!$DATA!$ if no change is required. .

• snmpAuthProtocol (string) – Devices’s SNMPv3 auth protocol. Supported values: sha, md5. Required if snmpMode is authNoPriv or authPriv. Use NODATACHANGE if no change is required. .

• snmpMode (string) – Devices’s SNMPv3 mode. Supported values: noAuthnoPriv, authNoPriv, authPriv. Required if snmpVersion is v3. Use NODATACHANGE if no change is required. .

• snmpPrivPassphrase (string) – Devices’s SNMPv3 priv passphrase. Required if snmpMode is authPriv. Use NO!$DATA!$ if no change is required. .

• snmpPrivProtocol (string) – Devices’s SNMPv3 priv protocol. Supported values: AES128. Required if snmpMode is authPriv. Use NODATACHANGE if no change is required. .

• snmpROCommunity (string) – Devices’s SNMP Read Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. Use NO!$DATA!$ if no change is required. .

• snmpRWCommunity (string) – Devices’s SNMP Write Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. Use NO!$DATA!$ if no change is required. .

• snmpRetry (integer) – Devices’s SNMP retry count. Max value supported is 3. Default is Global SNMP retry (if exists) or 3. .

• snmpTimeout (integer) – Devices’s SNMP timeout in seconds. Max value supported is 300. Default is Global SNMP timeout (if exists) or 5. .

• snmpUserName (string) – Devices’s SNMPV3 user name of the device. Required if snmpVersion is v3. Use NO!$DATA!$ if no change is required. .

• snmpVersion (string) – Devices’s SNMP version. Values supported: v2, v3. Required if type is NETWORK_DEVICE, COMPUTE_DEVICE or THIRD_PARTY_DEVICE. Use NODATACHANGE if no change is required. .

• type (string) – Devices’s Type of device being edited. Default is NETWORK_DEVICE. . Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’, ‘THIRD_PARTY_DEVICE’ and ‘NODATACHANGE’.

• updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

• userName (string) – Devices’s CLI user name of the device. Required if type is NETWORK_DEVICE. Use NO!$DATA!$ if no change is required. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of sync_devices_v1 .

get_the_details_of_physical_components_of_the_given_device(device_uuid, type=None, headers=None, **request_parameters)

This function is an alias of get_the_details_of_physical_components_of_the_given_device_v1 . :param device_uuid: deviceUuid path parameter. :type device_uuid: basestring :param type: type query parameter. Type value can be PowerSupply, Fan, Chassis, Backplane, Module,

PROCESSOR, Other, SFP. If no type is mentioned, All equipments are fetched for the device. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_the_details_of_physical_components_of_the_given_device_v1 .

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)

This function is an alias of get_functional_capability_for_devices_v1 . :param device_id: deviceId query parameter. Accepts comma separated deviceid’s and return list of

functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list. .

Parameters:

• function_name (basestring, list, set, tuple) – functionName query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_functional_capability_for_devices_v1 .

update_interface_details(interface_uuid, adminStatus=None, deployment_mode=None, description=None, vlanId=None, voiceVlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_interface_details_v1 . :param adminStatus: Devices’s Admin status as (‘UP’/’DOWN’) . :type adminStatus: string :param description: Devices’s Description for the Interface . :type description: string :param vlanId: Devices’s VLAN Id to be Updated . :type vlanId: integer :param voiceVlanId: Devices’s Voice Vlan Id to be Updated . :type voiceVlanId: integer :param interface_uuid: interfaceUuid path parameter. Interface ID . :type interface_uuid: basestring :param deployment_mode: deploymentMode query parameter. Preview/Deploy [‘Preview’ means the

configuration is not pushed to the device. ‘Deploy’ makes the configuration pushed to the device] .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_interface_details_v1 .

count_the_number_of_events(device_family, ap_mac=None, client_mac=None, end_time=None, message_type=None, network_device_id=None, network_device_name=None, severity=None, site_hierarchy_id=None, site_id=None, start_time=None, headers=None, **request_parameters)

This function is an alias of count_the_number_of_events_v1 . :param device_family: deviceFamily query parameter. Device family. Please note that multiple

families across network device type and client type is not allowed. For example, choosing Routers along with Wireless Client or Unified AP is not supported. Examples: deviceFamily=Switches and Hubs (single deviceFamily requested) deviceFamily=Switches and Hubs&deviceFamily=Routers (multiple deviceFamily requested) .

Parameters:

• start_time (basestring) – startTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If startTime is not provided, API will default to current time minus 24 hours. .

• end_time (basestring) – endTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If endTime is not provided, API will default to current time. .

• message_type (basestring) – messageType query parameter. Message type for the event. Examples: messageType=Syslog (single messageType requested) messageType=Trap&messageType=Syslog (multiple messageType requested) .

• severity (basestring) – severity query parameter. Severity of the event between 0 and 6. This is applicable only for events related to network devices (other than AP) and Wired Client events. (Value: Severity: 0: Emergency: 1: Alert: 2: Critical: 3: Error: 4: Warning: 5: Notice: 6: Info), Examples: severity=0 (single severity requested) severity=0&severity=1 (multiple severity requested) .

• site_id (basestring) – siteId query parameter. The UUID of the site. (Ex. flooruuid) Examples: ?siteId=id1 (single siteId requested) ?siteId=id1&siteId=id2&siteId=id3 (multiple siteId requested) .

• site_hierarchy_id (basestring) – siteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. globalUuid/areaUuid/buildingUuid/floorUuid) This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: ?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId= globalUuid/areaUuid2/buildingUuid2/floorUuid2 (multiple siteHierarchyId requested) .

• network_device_name (basestring) – networkDeviceName query parameter. Network device name. This parameter is applicable for network device related families. This field supports wildcard (*) character-based search. Ex: *Branch* or Branch* or *Branch Examples: networkDeviceName=Branch-3-Gateway (single networkDeviceName requested) networkDeviceName=Branch-3-Gateway&networkDeviceName=Branch-3-Switch (multiple networkDeviceName requested) .

• network_device_id (basestring) – networkDeviceId query parameter. The list of Network Device Uuids. (Ex. 6bef213c-19ca-4170-8375-b694e251101c) Examples: networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c (single networkDeviceId requested) networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b- cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple networkDeviceId requested) .

• ap_mac (basestring) – apMac query parameter. MAC address of the access point. This parameter is applicable for Unified AP and Wireless Client events. This field supports wildcard (*) character-based search. Ex: *50:0F* or 50:0F* or *50:0F Examples: apMac=50:0F:80:0F:F7:E0 (single apMac requested) apMac=50:0F:80:0F:F7:E0&apMac=18:80:90:AB:7E:A0 (multiple apMac requested) .

• client_mac (basestring) – clientMac query parameter. MAC address of the client. This parameter is applicable for Wired Client and Wireless Client events. This field supports wildcard (*) character-based search. Ex: *66:2B* or 66:2B* or *66:2B Examples: clientMac=66:2B:B8:D2:01:56 (single clientMac requested) clientMac=66:2B:B8:D2:01:56&clientMac=DC:A6:32:F5:5A:89 (multiple clientMac requested) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of count_the_number_of_events_v1 .

get_ospf_interfaces(headers=None, **request_parameters)

This function is an alias of get_ospf_interfaces_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_ospf_interfaces_v1 .

disaster_recovery

class DisasterRecovery

Cisco DNA Center Disaster Recovery API (version: 2.3.7.6).

Wraps the DNA Center Disaster Recovery API and exposes the API as native Python methods that return native Python objects.

disaster_recovery_operational_status_v1(headers=None, **request_parameters)

Returns the status of Disaster Recovery operation performed on the system. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!disaster-recovery-operational-status

disaster_recovery_status_v1(headers=None, **request_parameters)

Detailed and Summarized status of DR components (Active, Standby and Witness system’s health). .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!disaster-recovery-status

disaster_recovery_operational_status(headers=None, **request_parameters)

This function is an alias of disaster_recovery_operational_status_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of disaster_recovery_operational_status_v1 .

disaster_recovery_status(headers=None, **request_parameters)

This function is an alias of disaster_recovery_status_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of disaster_recovery_status_v1 .

discovery

class Discovery

Cisco DNA Center Discovery API (version: 2.3.7.6).

Wraps the DNA Center Discovery API and exposes the API as native Python methods that return native Python objects.

delete_all_discovery_v1(headers=None, **request_parameters)

Stops all the discoveries and removes them .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-all-discovery

updates_discovery_by_id_v1(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)

Stops or starts an existing discovery .

Parameters:

• attributeInfo (object) – Discovery’s Deprecated .

• cdpLevel (integer) – Discovery’s CDP level to which neighbor devices to be discovered .

• deviceIds (string) – Discovery’s Ids of the devices discovered in a discovery .

• discoveryCondition (string) – Discovery’s To indicate the discovery status. Available options: Complete or In Progress .

• discoveryStatus (string) – Discovery’s Status of the discovery. Available options are: Active, Inactive, Edit .

• discoveryType (string) – Discovery’s Type of the discovery. ‘Single’, ‘Range’, ‘Multi Range’, ‘CDP’, ‘LLDP’, ‘CIDR’ .

• enablePasswordList (string) – Discovery’s Enable Password of the devices to be discovered .

• globalCredentialIdList (list) – Discovery’s List of global credential ids to be used (list of strings).

• httpReadCredential (object) – Discovery’s httpReadCredential.

• httpWriteCredential (object) – Discovery’s httpWriteCredential.

• id (string) – Discovery’s Unique Discovery Id .

• ipAddressList (string) – Discovery’s List of IP address of the devices to be discovered .

• ipFilterList (string) – Discovery’s IP addresses of the devices to be filtered .

• isAutoCdp (boolean) – Discovery’s Flag to mention if CDP discovery or not .

• lldpLevel (integer) – Discovery’s LLDP level to which neighbor devices to be discovered .

• name (string) – Discovery’s Name for the discovery .

• netconfPort (string) – Discovery’s Netconf port on the device. Netconf will need valid sshv2 credentials for it to work .

• numDevices (integer) – Discovery’s Number of devices discovered in the discovery .

• parentDiscoveryId (string) – Discovery’s Parent Discovery Id from which the discovery was initiated .

• passwordList (string) – Discovery’s Password of the devices to be discovered .

• preferredMgmtIPMethod (string) – Discovery’s Preferred management IP method. Available options are ‘None’ and ‘UseLoopBack’ .

• protocolOrder (string) – Discovery’s Order of protocol (ssh/telnet) in which device connection will be tried. Ex: ‘telnet’: only telnet; ‘ssh,telnet’: ssh with higher order than telnet .

• retryCount (integer) – Discovery’s Number of times to try establishing connection to device .

• snmpAuthPassphrase (string) – Discovery’s Auth passphrase for SNMP .

• snmpAuthProtocol (string) – Discovery’s SNMP auth protocol. SHA’ or ‘MD5’ .

• snmpMode (string) – Discovery’s Mode of SNMP. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’ .

• snmpPrivPassphrase (string) – Discovery’s Passphrase for SNMP privacy .

• snmpPrivProtocol (string) – Discovery’s SNMP privacy protocol. ‘AES128’ .

• snmpRoCommunity (string) – Discovery’s SNMP RO community of the devices to be discovered .

• snmpRoCommunityDesc (string) – Discovery’s Description for SNMP RO community .

• snmpRwCommunity (string) – Discovery’s SNMP RW community of the devices to be discovered .

• snmpRwCommunityDesc (string) – Discovery’s Description for SNMP RW community .

• snmpUserName (string) – Discovery’s SNMP username of the device .

• timeOut (integer) – Discovery’s Time to wait for device response. .

• updateMgmtIp (boolean) – Discovery’s Updates Management IP if multiple IPs are available for a device. If set to true, when a device is rediscovered with a different IP, the management IP is updated. Default value is false .

• userNameList (string) – Discovery’s Username of the devices to be discovered .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!updates-an-existing-discovery-by-specified-id

start_discovery_v1(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)

Initiates discovery with the given parameters .

Parameters:

• cdpLevel (integer) – Discovery’s CDP level to which neighbor devices are to be discovered .

• discoveryType (string) – Discovery’s Type of the discovery. ‘Single’, ‘Range’, ‘Multi Range’, ‘CDP’, ‘LLDP’, ‘CIDR’ .

• enablePasswordList (list) – Discovery’s Enable Password of the devices to be discovered (list of strings).

• globalCredentialIdList (list) – Discovery’s Global Credential Ids to be used for discovery (list of strings).

• httpReadCredential (object) – Discovery’s httpReadCredential.

• httpWriteCredential (object) – Discovery’s httpWriteCredential.

• ipAddressList (string) – Discovery’s IP Address of devices to be discovered. Ex: ‘172.30.0.1’ for SINGLE, CDP and LLDP; ‘72.30.0.1-172.30.0.4’ for RANGE; ‘72.30.0.1-172.30.0.4,172.31.0.1-172.31.0.4’ for MULTI RANGE; ‘172.30.0.1/20’ for CIDR .

• ipFilterList (list) – Discovery’s IP Addresses of the devices to be filtered out during discovery (list of strings).

• lldpLevel (integer) – Discovery’s LLDP level to which neighbor devices to be discovered .

• name (string) – Discovery’s Name of the discovery .

• netconfPort (string) – Discovery’s Netconf Port. It will need valid SSH credentials to work .

• passwordList (list) – Discovery’s Password of the devices to be discovered (list of strings).

• preferredMgmtIPMethod (string) – Discovery’s Preferred Management IP Method.’None’ or ‘UseLoopBack’. Default is ‘None’ .

• protocolOrder (string) – Discovery’s Order of protocol (ssh/telnet) in which device connection will be tried. Ex: ‘telnet’: only telnet; ‘ssh,telnet’: ssh with higher order than telnet .

• retry (integer) – Discovery’s Number of times to try establishing connection to device .

• snmpAuthPassphrase (string) – Discovery’s Auth passphrase for SNMP .

• snmpAuthProtocol (string) – Discovery’s SNMP auth protocol. SHA’ or ‘MD5’ .

• snmpMode (string) – Discovery’s Mode of SNMP. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’ .

• snmpPrivPassphrase (string) – Discovery’s Pass phrase for SNMP privacy .

• snmpPrivProtocol (string) – Discovery’s SNMP privacy protocol. ‘AES128’ .

• snmpROCommunity (string) – Discovery’s SNMP RO community of the devices to be discovered .

• snmpROCommunityDesc (string) – Discovery’s Description for SNMP RO community .

• snmpRWCommunity (string) – Discovery’s SNMP RW community of the devices to be discovered .

• snmpRWCommunityDesc (string) – Discovery’s Description for SNMP RW community .

• snmpUserName (string) – Discovery’s SNMP username of the device .

• snmpVersion (string) – Discovery’s Version of SNMP. v2 or v3 .

• timeout (integer) – Discovery’s Time to wait for device response in seconds .

• userNameList (list) – Discovery’s Username of the devices to be discovered (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!start-discovery

get_count_of_all_discovery_jobs_v1(headers=None, **request_parameters)

Returns the count of all available discovery jobs .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-count-of-all-discovery-jobs

get_discovery_jobs_by_ip_v1(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)

Returns the list of discovery jobs for the given IP .

Parameters:

• offset (int) – offset query parameter.

• limit (int) – limit query parameter.

• ip_address (str) – ipAddress query parameter.

• name (str) – name query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovery-jobs-by-ip

delete_discovery_by_id_v1(id, headers=None, **request_parameters)

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-discovery-by-id

get_discovery_by_id_v1(id, headers=None, **request_parameters)

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovery-by-id

get_list_of_discoveries_by_discovery_id_v1(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• offset (int) – offset query parameter. Starting index for the records .

• limit (int) – limit query parameter. Number of records to fetch from the starting index .

• ip_address (str) – ipAddress query parameter. Filter records based on IP address .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-list-of-discoveries-by-discovery-id

get_discovered_network_devices_by_discovery_id_v1(id, task_id=None, headers=None, **request_parameters)

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• task_id (str) – taskId query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovered-network-devices-by-discovery-id

get_devices_discovered_by_id_v1(id, task_id=None, headers=None, **request_parameters)

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• task_id (str) – taskId query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-devices-discovered-by-id

get_discovered_devices_by_range_v1(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• start_index (int) – startIndex path parameter. Starting index for the records .

• records_to_return (int) – recordsToReturn path parameter. Number of records to fetch from the start index .

• task_id (str) – taskId query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovered-devices-by-range

get_network_devices_from_discovery_v1(id, clistatus=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)

Returns the devices discovered in the given discovery based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:

• id (str) – id path parameter. Discovery ID .

• task_id (str) – taskId query parameter.

• sort_by (str) – sortBy query parameter. Sort by field. Available values are pingStatus, cliStatus,snmpStatus, httpStatus and netconfStatus .

• sort_order (str) – sortOrder query parameter. Order of sorting based on sortBy. Available values are ‘asc’ and ‘des’ .

• ip_address (str, list, set, tuple) – ipAddress query parameter. IP Address of the device .

• ping_status (str, list, set, tuple) – pingStatus query parameter. Ping status for the IP during the job run. Available values are ‘SUCCESS’, ‘FAILURE’, ‘NOT-PROVIDED’ and ‘NOT-VALIDATED’ .

• snmp_status (str, list, set, tuple) – snmpStatus query parameter. SNMP status for the IP during the job run. Available values are ‘SUCCESS’, ‘FAILURE’, ‘NOT-PROVIDED’ and ‘NOT-VALIDATED’ .

• clistatus (str, list, set, tuple) – cliStatus query parameter. CLI status for the IP during the job run. Available values are ‘SUCCESS’, ‘FAILURE’, ‘NOT-PROVIDED’ and ‘NOT-VALIDATED’ .

• netconf_status (str, list, set, tuple) – netconfStatus query parameter. NETCONF status for the IP during the job run. Available values are ‘SUCCESS’, ‘FAILURE’, ‘NOT-PROVIDED’ and ‘NOT- VALIDATED’ .

• http_status (str, list, set, tuple) – httpStatus query parameter. HTTP staus for the IP during the job run. Available values are ‘SUCCESS’, ‘FAILURE’, ‘NOT-PROVIDED’ and ‘NOT-VALIDATED’ .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network-devices-from-discovery

delete_discovery_by_specified_range_v1(records_to_delete, start_index, headers=None, **request_parameters)

Stops discovery for the given range and removes them .

Parameters:

• start_index (int) – startIndex path parameter. Starting index for the records .

• records_to_delete (int) – recordsToDelete path parameter. Number of records to delete from the starting index .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-discovery-by-specified-range

get_discoveries_by_range_v1(records_to_return, start_index, headers=None, **request_parameters)

Returns the discoveries by specified range .

Parameters:

• start_index (int) – startIndex path parameter. Starting index for the records .

• records_to_return (int) – recordsToReturn path parameter. Number of records to fetch from the starting index .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discoveries-by-range

get_global_credentials_v1(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)

Returns global credential for the given credential sub type .

Parameters:

• credential_sub_type (str) – credentialSubType query parameter. Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF .

• sort_by (str) – sortBy query parameter. Field to sort the results by. Sorts by ‘instanceId’ if no value is provided .

• order (str) – order query parameter. Order of sorting. ‘asc’ or ‘des’ .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-global-credentials

update_cli_credentials_v1(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global CLI credentials .

Parameters:

• comments (string) – Discovery’s Comments to identify the CLI credential .

• credentialType (string) – Discovery’s Credential type to identify the application that uses the CLI credential . Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s Description for CLI Credentials .

• enablePassword (string) – Discovery’s CLI Enable Password .

• id (string) – Discovery’s Id of the CLI Credential in UUID format .

• instanceTenantId (string) – Discovery’s Deprecated .

• instanceUuid (string) – Discovery’s Deprecated .

• password (string) – Discovery’s CLI Password .

• username (string) – Discovery’s CLI Username .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-cli-credentials

create_cli_credentials_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global CLI credential .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-cli-credentials

create_http_read_credentials_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Adds HTTP read credentials .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-http-read-credentials

update_http_read_credential_v1(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global HTTP Read credential .

Parameters:

• comments (string) – Discovery’s Comments to identify the HTTP(S) Read credential .

• credentialType (string) – Discovery’s Credential type to identify the application that uses the HTTP(S) Read credential . Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s Description for HTTP(S) Read Credential .

• id (string) – Discovery’s Id of the HTTP(S) Read Credential in UUID format .

• instanceTenantId (string) – Discovery’s Deprecated .

• instanceUuid (string) – Discovery’s Deprecated .

• password (string) – Discovery’s HTTP(S) Read Password .

• port (integer) – Discovery’s HTTP(S) Port. Valid port should be in the range of 1 to 65535. .

• secure (boolean) – Discovery’s Flag for HTTPS Read .

• username (string) – Discovery’s HTTP(S) Read Username .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-http-read-credential

update_http_write_credentials_v1(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global HTTP write credentials .

Parameters:

• comments (string) – Discovery’s Comments to identify the HTTP(S) Write credential .

• credentialType (string) – Discovery’s Credential type to identify the application that uses the HTTP(S) Write credential . Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s Description for HTTP(S) Write Credential .

• id (string) – Discovery’s Id of the HTTP(S) Write Credential in UUID format .

• instanceTenantId (string) – Discovery’s Deprecated .

• instanceUuid (string) – Discovery’s Deprecated .

• password (string) – Discovery’s HTTP(S) Write Password .

• port (integer) – Discovery’s HTTP(S) Port. Valid port should be in the range of 1 to 65535. .

• secure (boolean) – Discovery’s Flag for HTTPS Write .

• username (string) – Discovery’s HTTP(S) Write Username .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-http-write-credentials

create_http_write_credentials_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global HTTP write credentials .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-http-write-credentials

update_netconf_credentials_v1(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global netconf credentials .

Parameters:

• comments (string) – Discovery’s Comments to identify the netconf credential .

• credentialType (string) – Discovery’s Credential type to identify the application that uses the netconf credential . Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s Description for Netconf Credentials .

• id (string) – Discovery’s Id of the Netconf Credential in UUID format .

• instanceTenantId (string) – Discovery’s Deprecated .

• instanceUuid (string) – Discovery’s Deprecated .

• netconfPort (string) – Discovery’s Netconf port on the device. Valid port should be in the range of 1 to 65535. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-netconf-credentials

create_netconf_credentials_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global netconf credentials .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-netconf-credentials

update_snmp_read_community_v1(comments=None, credentialType=None, description=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global SNMP read community .

Parameters:

• comments (string) – Discovery’s Comments to identify the credential .

• credentialType (string) – Discovery’s Credential type to identify the application that uses the credential . Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s Name/Description of the credential .

• instanceUuid (string) – Discovery’s Credential UUID .

• readCommunity (string) – Discovery’s SNMP read community. NO!$DATA!$ for no value change .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-snmp-read-community

create_snmp_read_community_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global SNMP read community .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-snmp-read-community

create_snmp_write_community_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global SNMP write community .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-snmp-write-community

update_snmp_write_community_v1(comments=None, credentialType=None, description=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global SNMP write community .

Parameters:

• comments (string) – Discovery’s Comments to identify the credential .

• credentialType (string) – Discovery’s Credential type to identify the application that uses the credential . Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s Name/Description of the credential .

• instanceUuid (string) – Discovery’s Credential UUID .

• writeCommunity (string) – Discovery’s SNMP write community. NO!$DATA!$ for no value change .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-snmp-write-community

update_snmpv3_credentials_v1(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

Updates global SNMPv3 credential .

Parameters:

• authPassword (string) – Discovery’s Auth password for SNMPv3. Required if snmpMode is ‘AUTHPRIV’ or ‘AUTHNOPRIV’. Use ‘NO!$DATA!$’ if no change required. .

• authType (string) – Discovery’s SNMPv3 auth protocol. ‘SHA’ or ‘MD5’. Required if snmpMode is ‘AUTHPRIV’ or ‘AUTHNOPRIV’. . Available values are ‘SHA’ and ‘MD5’.

• comments (string) – Discovery’s Comments to identify the SNMPv3 credential .

• credentialType (string) – Discovery’s Credential type to identify the application that uses the SNMPv3 credential . Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s Description for SNMPv3 Credential .

• id (string) – Discovery’s Id of the SNMPv3 Credential .

• instanceTenantId (string) – Discovery’s Deprecated. This attribute will be removed in a future release, should not be used, and any value supplied will be ignored. .

• instanceUuid (string) – Discovery’s Deprecated. This attribute will be removed in a future release, should not be used, and any value supplied will be ignored. .

• privacyPassword (string) – Discovery’s Privacy password for SNMPv3 privacy. Required if snmpMode is ‘AUTHPRIV’. Use ‘NO!$DATA!$’ if no change required. .

• privacyType (string) – Discovery’s SNMPv3 privacy protocol. Required is snmpMode is ‘AUTHPRIV’. . Available values are ‘AES128’.

• snmpMode (string) – Discovery’s Mode of SNMPv3. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’ . Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

• username (string) – Discovery’s SNMPv3 username .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-snmpv3-credentials

create_snmpv3_credentials_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Adds global SNMPv3 credentials .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-snmpv3-credentials

delete_global_credentials_by_id_v1(global_credential_id, headers=None, **request_parameters)

Deletes global credential for the given ID .

Parameters:

• global_credential_id (str) – globalCredentialId path parameter. ID of global-credential .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-global-credentials-by-id

update_global_credentials_v1(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update global credential for network devices in site(s) .

Parameters:

• siteUuids (list) – Discovery’s List of siteUuids where credential is to be updated (list of strings).

• global_credential_id (str) – globalCredentialId path parameter. Global credential Uuid .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-global-credentials

get_credential_sub_type_by_credential_id_v1(id, headers=None, **request_parameters)

Returns the credential sub type for the given Id .

Parameters:

• id (str) – id path parameter. Global Credential ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-credential-sub-type-by-credential-id

get_snmp_properties_v1(headers=None, **request_parameters)

Returns SNMP properties .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-snmp-properties

create_update_snmp_properties_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Adds SNMP properties .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-update-snmp-properties

update_global_credentials_v2(cliCredential=None, httpsRead=None, httpsWrite=None, snmpV2cRead=None, snmpV2cWrite=None, snmpV3=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to update device credentials. Multiple credentials can be passed at once, but only a single credential of a given type can be passed at once. Please refer sample Request Body for more information. .

Parameters:

• cliCredential (object) – Discovery’s cliCredential.

• httpsRead (object) – Discovery’s httpsRead.

• httpsWrite (object) – Discovery’s httpsWrite.

• snmpV2cRead (object) – Discovery’s snmpV2cRead.

• snmpV2cWrite (object) – Discovery’s snmpV2cWrite.

• snmpV3 (object) – Discovery’s snmpV3.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-global-credentials-v2

create_global_credentials_v2(cliCredential=None, httpsRead=None, httpsWrite=None, snmpV2cRead=None, snmpV2cWrite=None, snmpV3=None, headers=None, payload=None, active_validation=True, **request_parameters)

API to create new global credentials. Multiple credentials of various types can be passed at once. Please refer sample Request Body for more information. .

Parameters:

• cliCredential (list) – Discovery’s cliCredential (list of objects).

• httpsRead (list) – Discovery’s httpsRead (list of objects).

• httpsWrite (list) – Discovery’s httpsWrite (list of objects).

• snmpV2cRead (list) – Discovery’s snmpV2cRead (list of objects).

• snmpV2cWrite (list) – Discovery’s snmpV2cWrite (list of objects).

• snmpV3 (list) – Discovery’s snmpV3 (list of objects).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-global-credentials-v2

get_all_global_credentials_v2(headers=None, **request_parameters)

API to get device credentials’ details. It fetches all global credentials of all types at once, without the need to pass any input parameters. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-global-credentials-v2

delete_global_credential_v2(id, headers=None, **request_parameters)

Delete a global credential. Only ‘id’ of the credential has to be passed. .

Parameters:

• id (str) – id path parameter. Global Credential id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-global-credential-v2

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_snmp_write_community_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_snmp_write_community_v1 .

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)

This function is an alias of get_discoveries_by_range_v1 . :param start_index: startIndex path parameter. Starting index for the records . :type start_index: int :param records_to_return: recordsToReturn path parameter. Number of records to fetch from the starting

index .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_discoveries_by_range_v1 .

get_count_of_all_discovery_jobs(headers=None, **request_parameters)

This function is an alias of get_count_of_all_discovery_jobs_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_count_of_all_discovery_jobs_v1 .

get_snmp_properties(headers=None, **request_parameters)

This function is an alias of get_snmp_properties_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_snmp_properties_v1 .

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)

This function is an alias of get_discovered_network_devices_by_discovery_id_v1 . :param id: id path parameter. Discovery ID . :type id: basestring :param task_id: taskId query parameter. :type task_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_discovered_network_devices_by_discovery_id_v1 .

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)

This function is an alias of get_global_credentials_v1 . :param credential_sub_type: credentialSubType query parameter. Credential type as CLI /

SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF .

Parameters:

• sort_by (basestring) – sortBy query parameter. Field to sort the results by. Sorts by ‘instanceId’ if no value is provided .

• order (basestring) – order query parameter. Order of sorting. ‘asc’ or ‘des’ .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_global_credentials_v1 .

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)

This function is an alias of get_devices_discovered_by_id_v1 . :param id: id path parameter. Discovery ID . :type id: basestring :param task_id: taskId query parameter. :type task_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_devices_discovered_by_id_v1 .

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)

This function is an alias of delete_discovery_by_specified_range_v1 . :param start_index: startIndex path parameter. Starting index for the records . :type start_index: int :param records_to_delete: recordsToDelete path parameter. Number of records to delete from the starting

index .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_discovery_by_specified_range_v1 .

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_netconf_credentials_v1 . :param comments: Discovery’s Comments to identify the netconf credential . :type comments: string :param credentialType: Discovery’s Credential type to identify the application that uses the netconf

credential . Available values are ‘GLOBAL’ and ‘APP’.

Parameters:

• description (string) – Discovery’s Description for Netconf Credentials .

• id (string) – Discovery’s Id of the Netconf Credential in UUID format .

• instanceTenantId (string) – Discovery’s Deprecated .

• instanceUuid (string) – Discovery’s Deprecated .

• netconfPort (string) – Discovery’s Netconf port on the device. Valid port should be in the range of 1 to 65535. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_netconf_credentials_v1 .

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)

This function is an alias of get_discovered_devices_by_range_v1 . :param id: id path parameter. Discovery ID . :type id: basestring :param start_index: startIndex path parameter. Starting index for the records . :type start_index: int :param records_to_return: recordsToReturn path parameter. Number of records to fetch from the start index

.

Parameters:

• task_id (basestring) – taskId query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_discovered_devices_by_range_v1 .

delete_all_discovery(headers=None, **request_parameters)

This function is an alias of delete_all_discovery_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_all_discovery_v1 .

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of updates_discovery_by_id_v1 . :param attributeInfo: Discovery’s Deprecated . :type attributeInfo: object :param cdpLevel: Discovery’s CDP level to which neighbor devices to be discovered . :type cdpLevel: integer :param deviceIds: Discovery’s Ids of the devices discovered in a discovery . :type deviceIds: string :param discoveryCondition: Discovery’s To indicate the discovery status. Available options: Complete or

In Progress .

Parameters:

• discoveryStatus (string) – Discovery’s Status of the discovery. Available options are: Active, Inactive, Edit .

• discoveryType (string) – Discovery’s Type of the discovery. ‘Single’, ‘Range’, ‘Multi Range’, ‘CDP’, ‘LLDP’, ‘CIDR’ .

• enablePasswordList (string) – Discovery’s Enable Password of the devices to be discovered .

• globalCredentialIdList (list) – Discovery’s List of global credential ids to be used (list of strings).

• httpReadCredential (object) – Discovery’s httpReadCredential.

• httpWriteCredential (object) – Discovery’s httpWriteCredential.

• id (string) – Discovery’s Unique Discovery Id .

• ipAddressList (string) – Discovery’s List of IP address of the devices to be discovered .

• ipFilterList (string) – Discovery’s IP addresses of the devices to be filtered .

• isAutoCdp (boolean) – Discovery’s Flag to mention if CDP discovery or not .

• lldpLevel (integer) – Discovery’s LLDP level to which neighbor devices to be discovered .

• name (string) – Discovery’s Name for the discovery .

• netconfPort (string) – Discovery’s Netconf port on the device. Netconf will need valid sshv2 credentials for it to work .

• numDevices (integer) – Discovery’s Number of devices discovered in the discovery .

• parentDiscoveryId (string) – Discovery’s Parent Discovery Id from which the discovery was initiated .

• passwordList (string) – Discovery’s Password of the devices to be discovered .

• preferredMgmtIPMethod (string) – Discovery’s Preferred management IP method. Available options are ‘None’ and ‘UseLoopBack’ .

• protocolOrder (string) – Discovery’s Order of protocol (ssh/telnet) in which device connection will be tried. Ex: ‘telnet’: only telnet; ‘ssh,telnet’: ssh with higher order than telnet .

• retryCount (integer) – Discovery’s Number of times to try establishing connection to device .

• snmpAuthPassphrase (string) – Discovery’s Auth passphrase for SNMP .

• snmpAuthProtocol (string) – Discovery’s SNMP auth protocol. SHA’ or ‘MD5’ .

• snmpMode (string) – Discovery’s Mode of SNMP. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’ .

• snmpPrivPassphrase (string) – Discovery’s Passphrase for SNMP privacy .

• snmpPrivProtocol (string) – Discovery’s SNMP privacy protocol. ‘AES128’ .

• snmpRoCommunity (string) – Discovery’s SNMP RO community of the devices to be discovered .

• snmpRoCommunityDesc (string) – Discovery’s Description for SNMP RO community .

• snmpRwCommunity (string) – Discovery’s SNMP RW community of the devices to be discovered .

• snmpRwCommunityDesc (string) – Discovery’s Description for SNMP RW community .

• snmpUserName (string) – Discovery’s SNMP username of the device .

• timeOut (integer) – Discovery’s Time to wait for device response. .

• updateMgmtIp (boolean) – Discovery’s Updates Management IP if multiple IPs are available for a device. If set to true, when a device is rediscovered with a different IP, the management IP is updated. Default value is false .

• userNameList (string) – Discovery’s Username of the devices to be discovered .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of updates_discovery_by_id_v1 .

update_snmp_read_community(comments=None, credentialType=None, description=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_snmp_read_community_v1 . :param comments: Discovery’s Comments to identify the credential . :type comments: string :param credentialType: Discovery’s Credential type to identify the application that uses the credential

. Available values are ‘GLOBAL’ and ‘APP’.

Parameters:

• description (string) – Discovery’s Name/Description of the credential .

• instanceUuid (string) – Discovery’s Credential UUID .

• readCommunity (string) – Discovery’s SNMP read community. NO!$DATA!$ for no value change .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_snmp_read_community_v1 .

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_snmpv3_credentials_v1 . :param authPassword: Discovery’s Auth password for SNMPv3. Required if snmpMode is ‘AUTHPRIV’ or

‘AUTHNOPRIV’. Use ‘NO!$DATA!$’ if no change required. .

Parameters:

• authType (string) – Discovery’s SNMPv3 auth protocol. ‘SHA’ or ‘MD5’. Required if snmpMode is ‘AUTHPRIV’ or ‘AUTHNOPRIV’. . Available values are ‘SHA’ and ‘MD5’.

• comments (string) – Discovery’s Comments to identify the SNMPv3 credential .

• credentialType (string) – Discovery’s Credential type to identify the application that uses the SNMPv3 credential . Available values are ‘GLOBAL’ and ‘APP’.

• description (string) – Discovery’s Description for SNMPv3 Credential .

• id (string) – Discovery’s Id of the SNMPv3 Credential .

• instanceTenantId (string) – Discovery’s Deprecated. This attribute will be removed in a future release, should not be used, and any value supplied will be ignored. .

• instanceUuid (string) – Discovery’s Deprecated. This attribute will be removed in a future release, should not be used, and any value supplied will be ignored. .

• privacyPassword (string) – Discovery’s Privacy password for SNMPv3 privacy. Required if snmpMode is ‘AUTHPRIV’. Use ‘NO!$DATA!$’ if no change required. .

• privacyType (string) – Discovery’s SNMPv3 privacy protocol. Required is snmpMode is ‘AUTHPRIV’. . Available values are ‘AES128’.

• snmpMode (string) – Discovery’s Mode of SNMPv3. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’ . Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

• username (string) – Discovery’s SNMPv3 username .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_snmpv3_credentials_v1 .

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)

This function is an alias of delete_global_credentials_by_id_v1 . :param global_credential_id: globalCredentialId path parameter. ID of global-credential . :type global_credential_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_global_credentials_by_id_v1 .

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)

This function is an alias of get_list_of_discoveries_by_discovery_id_v1 . :param id: id path parameter. Discovery ID . :type id: basestring :param offset: offset query parameter. Starting index for the records . :type offset: int :param limit: limit query parameter. Number of records to fetch from the starting index . :type limit: int :param ip_address: ipAddress query parameter. Filter records based on IP address . :type ip_address: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_list_of_discoveries_by_discovery_id_v1 .

delete_discovery_by_id(id, headers=None, **request_parameters)

This function is an alias of delete_discovery_by_id_v1 . :param id: id path parameter. Discovery ID . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_discovery_by_id_v1 .

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_global_credentials_v1 . :param siteUuids: Discovery’s List of siteUuids where credential is to be updated (list of strings). :type siteUuids: list :param global_credential_id: globalCredentialId path parameter. Global credential Uuid . :type global_credential_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_global_credentials_v1 .

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)

This function is an alias of get_credential_sub_type_by_credential_id_v1 . :param id: id path parameter. Global Credential ID . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_credential_sub_type_by_credential_id_v1 .

create_global_credentials(cliCredential=None, httpsRead=None, httpsWrite=None, snmpV2cRead=None, snmpV2cWrite=None, snmpV3=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_global_credentials_v2 . :param cliCredential: Discovery’s cliCredential (list of objects). :type cliCredential: list :param httpsRead: Discovery’s httpsRead (list of objects). :type httpsRead: list :param httpsWrite: Discovery’s httpsWrite (list of objects). :type httpsWrite: list :param snmpV2cRead: Discovery’s snmpV2cRead (list of objects). :type snmpV2cRead: list :param snmpV2cWrite: Discovery’s snmpV2cWrite (list of objects). :type snmpV2cWrite: list :param snmpV3: Discovery’s snmpV3 (list of objects). :type snmpV3: list :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_global_credentials_v2 .

get_all_global_credentials(headers=None, **request_parameters)

This function is an alias of get_all_global_credentials_v2 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_all_global_credentials_v2 .

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_http_read_credentials_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_http_read_credentials_v1 .

get_network_devices_from_discovery(id, clistatus=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)

This function is an alias of get_network_devices_from_discovery_v1 . :param id: id path parameter. Discovery ID . :type id: basestring :param task_id: taskId query parameter. :type task_id: basestring :param sort_by: sortBy query parameter. Sort by field. Available values are pingStatus,

cliStatus,snmpStatus, httpStatus and netconfStatus .

Parameters:

• sort_order (basestring) – sortOrder query parameter. Order of sorting based on sortBy. Available values are ‘asc’ and ‘des’ .

• ip_address (basestring, list, set, tuple) – ipAddress query parameter. IP Address of the device .

• ping_status (basestring, list, set, tuple) – pingStatus query parameter. Ping status for the IP during the job run. Available values are ‘SUCCESS’, ‘FAILURE’, ‘NOT-PROVIDED’ and ‘NOT-VALIDATED’ .

• snmp_status (basestring, list, set, tuple) – snmpStatus query parameter. SNMP status for the IP during the job run. Available values are ‘SUCCESS’, ‘FAILURE’, ‘NOT-PROVIDED’ and ‘NOT-VALIDATED’ .

• clistatus (basestring, list, set, tuple) – cliStatus query parameter. CLI status for the IP during the job run. Available values are ‘SUCCESS’, ‘FAILURE’, ‘NOT-PROVIDED’ and ‘NOT-VALIDATED’ .

• netconf_status (basestring, list, set, tuple) – netconfStatus query parameter. NETCONF status for the IP during the job run. Available values are ‘SUCCESS’, ‘FAILURE’, ‘NOT-PROVIDED’ and ‘NOT- VALIDATED’ .

• http_status (basestring, list, set, tuple) – httpStatus query parameter. HTTP staus for the IP during the job run. Available values are ‘SUCCESS’, ‘FAILURE’, ‘NOT-PROVIDED’ and ‘NOT-VALIDATED’ .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_network_devices_from_discovery_v1 .

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_cli_credentials_v1 . :param comments: Discovery’s Comments to identify the CLI credential . :type comments: string :param credentialType: Discovery’s Credential type to identify the application that uses the CLI

credential . Available values are ‘GLOBAL’ and ‘APP’.

Parameters:

• description (string) – Discovery’s Description for CLI Credentials .

• enablePassword (string) – Discovery’s CLI Enable Password .

• id (string) – Discovery’s Id of the CLI Credential in UUID format .

• instanceTenantId (string) – Discovery’s Deprecated .

• instanceUuid (string) – Discovery’s Deprecated .

• password (string) – Discovery’s CLI Password .

• username (string) – Discovery’s CLI Username .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_cli_credentials_v1 .

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of start_discovery_v1 . :param cdpLevel: Discovery’s CDP level to which neighbor devices are to be discovered . :type cdpLevel: integer :param discoveryType: Discovery’s Type of the discovery. ‘Single’, ‘Range’, ‘Multi Range’, ‘CDP’,

‘LLDP’, ‘CIDR’ .

Parameters:

• enablePasswordList (list) – Discovery’s Enable Password of the devices to be discovered (list of strings).

• globalCredentialIdList (list) – Discovery’s Global Credential Ids to be used for discovery (list of strings).

• httpReadCredential (object) – Discovery’s httpReadCredential.

• httpWriteCredential (object) – Discovery’s httpWriteCredential.

• ipAddressList (string) – Discovery’s IP Address of devices to be discovered. Ex: ‘172.30.0.1’ for SINGLE, CDP and LLDP; ‘72.30.0.1-172.30.0.4’ for RANGE; ‘72.30.0.1-172.30.0.4,172.31.0.1-172.31.0.4’ for MULTI RANGE; ‘172.30.0.1/20’ for CIDR .

• ipFilterList (list) – Discovery’s IP Addresses of the devices to be filtered out during discovery (list of strings).

• lldpLevel (integer) – Discovery’s LLDP level to which neighbor devices to be discovered .

• name (string) – Discovery’s Name of the discovery .

• netconfPort (string) – Discovery’s Netconf Port. It will need valid SSH credentials to work .

• passwordList (list) – Discovery’s Password of the devices to be discovered (list of strings).

• preferredMgmtIPMethod (string) – Discovery’s Preferred Management IP Method.’None’ or ‘UseLoopBack’. Default is ‘None’ .

• protocolOrder (string) – Discovery’s Order of protocol (ssh/telnet) in which device connection will be tried. Ex: ‘telnet’: only telnet; ‘ssh,telnet’: ssh with higher order than telnet .

• retry (integer) – Discovery’s Number of times to try establishing connection to device .

• snmpAuthPassphrase (string) – Discovery’s Auth passphrase for SNMP .

• snmpAuthProtocol (string) – Discovery’s SNMP auth protocol. SHA’ or ‘MD5’ .

• snmpMode (string) – Discovery’s Mode of SNMP. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’ .

• snmpPrivPassphrase (string) – Discovery’s Pass phrase for SNMP privacy .

• snmpPrivProtocol (string) – Discovery’s SNMP privacy protocol. ‘AES128’ .

• snmpROCommunity (string) – Discovery’s SNMP RO community of the devices to be discovered .

• snmpROCommunityDesc (string) – Discovery’s Description for SNMP RO community .

• snmpRWCommunity (string) – Discovery’s SNMP RW community of the devices to be discovered .

• snmpRWCommunityDesc (string) – Discovery’s Description for SNMP RW community .

• snmpUserName (string) – Discovery’s SNMP username of the device .

• snmpVersion (string) – Discovery’s Version of SNMP. v2 or v3 .

• timeout (integer) – Discovery’s Time to wait for device response in seconds .

• userNameList (list) – Discovery’s Username of the devices to be discovered (list of strings).

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of start_discovery_v1 .

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_snmp_read_community_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_snmp_read_community_v1 .

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_cli_credentials_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_cli_credentials_v1 .

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_http_read_credential_v1 . :param comments: Discovery’s Comments to identify the HTTP(S) Read credential . :type comments: string :param credentialType: Discovery’s Credential type to identify the application that uses the HTTP(S)

Read credential . Available values are ‘GLOBAL’ and ‘APP’.

Parameters:

• description (string) – Discovery’s Description for HTTP(S) Read Credential .

• id (string) – Discovery’s Id of the HTTP(S) Read Credential in UUID format .

• instanceTenantId (string) – Discovery’s Deprecated .

• instanceUuid (string) – Discovery’s Deprecated .

• password (string) – Discovery’s HTTP(S) Read Password .

• port (integer) – Discovery’s HTTP(S) Port. Valid port should be in the range of 1 to 65535. .

• secure (boolean) – Discovery’s Flag for HTTPS Read .

• username (string) – Discovery’s HTTP(S) Read Username .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_http_read_credential_v1 .

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_http_write_credentials_v1 . :param comments: Discovery’s Comments to identify the HTTP(S) Write credential . :type comments: string :param credentialType: Discovery’s Credential type to identify the application that uses the HTTP(S)

Write credential . Available values are ‘GLOBAL’ and ‘APP’.

Parameters:

• description (string) – Discovery’s Description for HTTP(S) Write Credential .

• id (string) – Discovery’s Id of the HTTP(S) Write Credential in UUID format .

• instanceTenantId (string) – Discovery’s Deprecated .

• instanceUuid (string) – Discovery’s Deprecated .

• password (string) – Discovery’s HTTP(S) Write Password .

• port (integer) – Discovery’s HTTP(S) Port. Valid port should be in the range of 1 to 65535. .

• secure (boolean) – Discovery’s Flag for HTTPS Write .

• username (string) – Discovery’s HTTP(S) Write Username .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_http_write_credentials_v1 .

delete_global_credential(id, headers=None, **request_parameters)

This function is an alias of delete_global_credential_v2 . :param id: id path parameter. Global Credential id . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of delete_global_credential_v2 .

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_http_write_credentials_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_http_write_credentials_v1 .

get_discovery_by_id(id, headers=None, **request_parameters)

This function is an alias of get_discovery_by_id_v1 . :param id: id path parameter. Discovery ID . :type id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_discovery_by_id_v1 .

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_update_snmp_properties_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_update_snmp_properties_v1 .

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_snmpv3_credentials_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_snmpv3_credentials_v1 .

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of create_netconf_credentials_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of create_netconf_credentials_v1 .

update_snmp_write_community(comments=None, credentialType=None, description=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)

This function is an alias of update_snmp_write_community_v1 . :param comments: Discovery’s Comments to identify the credential . :type comments: string :param credentialType: Discovery’s Credential type to identify the application that uses the credential

. Available values are ‘GLOBAL’ and ‘APP’.

Parameters:

• description (string) – Discovery’s Name/Description of the credential .

• instanceUuid (string) – Discovery’s Credential UUID .

• writeCommunity (string) – Discovery’s SNMP write community. NO!$DATA!$ for no value change .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload() – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of update_snmp_write_community_v1 .

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)

This function is an alias of get_discovery_jobs_by_ip_v1 . :param offset: offset query parameter. :type offset: int :param limit: limit query parameter. :type limit: int :param ip_address: ipAddress query parameter. :type ip_address: basestring :param name: name query parameter. :type name: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_discovery_jobs_by_ip_v1 .

eox

class EoX

Cisco DNA Center EoX API (version: 2.3.7.6).

Wraps the DNA Center EoX API and exposes the API as native Python methods that return native Python objects.

get_eox_status_for_all_devices_v1(headers=None, **request_parameters)

Retrieves EoX status for all devices in the network .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-eox-status-for-all-devices

get_eox_details_per_device_v1(device_id, headers=None, **request_parameters)

Retrieves EoX details for a device .

Parameters:

• device_id (str) – deviceId path parameter. Device instance UUID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-eox-details-per-device

get_eox_summary_v1(headers=None, **request_parameters)

Retrieves EoX summary for all devices in the network .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-eox-summary

get_eox_details_per_device(device_id, headers=None, **request_parameters)

This function is an alias of get_eox_details_per_device_v1 . :param device_id: deviceId path parameter. Device instance UUID . :type device_id: basestring :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_eox_details_per_device_v1 .

get_eox_status_for_all_devices(headers=None, **request_parameters)

This function is an alias of get_eox_status_for_all_devices_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_eox_status_for_all_devices_v1 .

get_eox_summary(headers=None, **request_parameters)

This function is an alias of get_eox_summary_v1 . :param headers: Dictionary of HTTP Headers to send with the Request

.

Parameters:

**request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

This function returns the output of get_eox_summary_v1 .

event_management

class EventManagement

Cisco DNA Center Event Management API (version: 2.3.7.6).

Wraps the DNA Center Event Management API and exposes the API as native Python methods that return native Python objects.

get_audit_log_parent_records_v1(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)

Get Parent Audit Log Event instances from the Event-Hub .

Parameters:

• instance_id (str) – instanceId query parameter. InstanceID of the Audit Log. .

• name (str) – name query parameter. Audit Log notification event name. .

• event_id (str) – eventId query parameter. Audit Log notification’s event ID. .

• category (str) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

• severity (str) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

• domain (str) – domain query parameter. Audit Log notification’s event domain. .

• sub_domain (str) – subDomain query parameter. Audit Log notification’s event sub-domain. .

• source (str) – source query parameter. Audit Log notification’s event source. .

• user_id (str) – userId query parameter. Audit Log notification’s event userId. .

• context (str) – context query parameter. Audit Log notification’s event correlationId. .

• event_hierarchy (str) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

• site_id (str) – siteId query parameter. Audit Log notification’s siteId. .

• device_id (str) – deviceId query parameter. Audit Log notification’s deviceId. .

• is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

• description (str) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

• offset (int) – offset query parameter. Position of a particular Audit Log record in the data. .

• limit (int) – limit query parameter. Number of Audit Log records to be returned per page. .

• start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

• end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

• sort_by (str) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

• order (str) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-audit-log-parent-records

get_audit_log_summary_v1(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_parent_only=None, is_system_events=None, name=None, parent_instance_id=None, severity=None, site_id=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)

Get Audit Log Summary from the Event-Hub .

Parameters:

• parent_instance_id (str) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

• is_parent_only (bool) – isParentOnly query parameter. Parameter to filter parent only audit-logs. .

• instance_id (str) – instanceId query parameter. InstanceID of the Audit Log. .

• name (str) – name query parameter. Audit Log notification event name. .

• event_id (str) – eventId query parameter. Audit Log notification’s event ID. .

• category (str) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

• severity (str) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

• domain (str) – domain query parameter. Audit Log notification’s event domain. .

• sub_domain (str) – subDomain query parameter. Audit Log notification’s event sub-domain. .

• source (str) – source query parameter. Audit Log notification’s event source. .

• user_id (str) – userId query parameter. Audit Log notification’s event userId. .

• context (str) – context query parameter. Audit Log notification’s event correlationId. .

• event_hierarchy (str) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

• site_id (str) – siteId query parameter. Audit Log notification’s siteId. .

• device_id (str) – deviceId query parameter. Audit Log notification’s deviceId. .

• is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

• description (str) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

• start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

• end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-audit-log-summary

get_audit_log_records_v1(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, parent_instance_id=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)

Get Audit Log Event instances from the Event-Hub .

Parameters:

• parent_instance_id (str) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

• instance_id (str) – instanceId query parameter. InstanceID of the Audit Log. .

• name (str) – name query parameter. Audit Log notification event name. .

• event_id (str) – eventId query parameter. Audit Log notification’s event ID. .

• category (str) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

• severity (str) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

• domain (str) – domain query parameter. Audit Log notification’s event domain. .

• sub_domain (str) – subDomain query parameter. Audit Log notification’s event sub-domain. .

• source (str) – source query parameter. Audit Log notification’s event source. .

• user_id (str) – userId query parameter. Audit Log notification’s event userId. .

• context (str) – context query parameter. Audit Log notification’s event correlationId. .

• event_hierarchy (str) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

• site_id (str) – siteId query parameter. Audit Log notification’s siteId. .

• device_id (str) – deviceId query parameter. Audit Log notification’s deviceId. .

• is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

• description (str) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

• offset (int) – offset query parameter. Position of a particular Audit Log record in the data. .

• limit (int) – limit query parameter. Number of Audit Log records to be returned per page. .

• start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

• end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

• sort_by (str) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

• order (str) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-audit-log-records

get_snmp_destination_v1(config_id=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Get SNMP Destination .

Parameters:

• config_id (str) – configId query parameter. List of SNMP configurations .

• offset (int) – offset query parameter. The number of SNMP configuration’s to offset in the resultset whose default value 0 .

• limit (int) – limit query parameter. The number of SNMP configuration’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-snmp-destination

get_status_api_for_events_v1(execution_id, headers=None, **request_parameters)

Get the Status of events API calls with provided executionId as mandatory path parameter .

Parameters:

• execution_id (str) – executionId path parameter. Execution ID .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-status-api-for-events

update_email_destination_v1(emailConfigId=None, fromEmail=None, primarySMTPConfig=None, secondarySMTPConfig=None, subject=None, toEmail=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update Email Destination .

Parameters:

• emailConfigId (string) – Event Management’s Required only for update email configuration .

• fromEmail (string) – Event Management’s From Email.

• primarySMTPConfig (object) – Event Management’s primarySMTPConfig.

• secondarySMTPConfig (object) – Event Management’s secondarySMTPConfig.

• subject (string) – Event Management’s Subject.

• toEmail (string) – Event Management’s To Email.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-email-destination

get_email_destination_v1(headers=None, **request_parameters)

Get Email Destination .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-email-destination

create_email_destination_v1(emailConfigId=None, fromEmail=None, primarySMTPConfig=None, secondarySMTPConfig=None, subject=None, toEmail=None, headers=None, payload=None, active_validation=True, **request_parameters)

Create Email Destination .

Parameters:

• emailConfigId (string) – Event Management’s Required only for update email configuration .

• fromEmail (string) – Event Management’s From Email.

• primarySMTPConfig (object) – Event Management’s primarySMTPConfig.

• secondarySMTPConfig (object) – Event Management’s secondarySMTPConfig.

• subject (string) – Event Management’s Subject.

• toEmail (string) – Event Management’s To Email.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-email-destination

get_notifications_v1(category=None, domain=None, end_time=None, event_ids=None, limit=None, namespace=None, offset=None, order=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, tags=None, type=None, headers=None, **request_parameters)

Get the list of Published Notifications .

Parameters:

• event_ids (str) – eventIds query parameter. The registered EventId should be provided .

• start_time (int) – startTime query parameter. Start Time in milliseconds .

• end_time (int) – endTime query parameter. End Time in milliseconds .

• category (str) – category query parameter.

• type (str) – type query parameter.

• severity (str) – severity query parameter.

• domain (str) – domain query parameter.

• sub_domain (str) – subDomain query parameter. Sub Domain .

• source (str) – source query parameter.

• offset (int) – offset query parameter. Start Offset .

• limit (int) – limit query parameter. # of records .

• sort_by (str) – sortBy query parameter. Sort By column .

• order (str) – order query parameter. Ascending/Descending order [asc/desc] .

• tags (str) – tags query parameter.

• namespace (str) – namespace query parameter.

• site_id (str) – siteId query parameter. Site Id .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-notifications

count_of_notifications_v1(category=None, domain=None, end_time=None, event_ids=None, severity=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)

Get the Count of Published Notifications .

Parameters:

• event_ids (str) – eventIds query parameter. The registered EventId should be provided .

• start_time (int) – startTime query parameter. Start Time in milliseconds .

• end_time (int) – endTime query parameter. End Time in milliseconds .

• category (str) – category query parameter.

• type (str) – type query parameter.

• severity (str) – severity query parameter.

• domain (str) – domain query parameter.

• sub_domain (str) – subDomain query parameter. Sub Domain .

• source (str) – source query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!count-of-notifications

create_snmp_destination_v1(authPassword=None, community=None, description=None, ipAddress=None, name=None, port=None, privacyPassword=None, snmpAuthType=None, snmpMode=None, snmpPrivacyType=None, snmpVersion=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Create SNMP Destination .

Parameters:

• authPassword (string) – Event Management’s Auth Password.

• community (string) – Event Management’s Required only if snmpVersion is V2C .

• description (string) – Event Management’s Description.

• ipAddress (string) – Event Management’s Ip Address.

• name (string) – Event Management’s Name.

• port (string) – Event Management’s Port.

• privacyPassword (string) – Event Management’s Privacy Password.

• snmpAuthType (string) – Event Management’s Snmp Auth Type. Available values are ‘SHA’, ‘MD5’ and ‘NONE’.

• snmpMode (string) – Event Management’s If snmpVersion is V3 it is required and cannot be NONE . Available values are ‘AUTH_PRIVACY’, ‘AUTH_NO_PRIVACY’, ‘NO_AUTH_NO_PRIVACY’ and ‘NONE’.

• snmpPrivacyType (string) – Event Management’s Snmp Privacy Type. Available values are ‘AES128’, ‘DES’ and ‘NONE’.

• snmpVersion (string) – Event Management’s Snmp Version. Available values are ‘V2C’ and ‘V3’.

• userName (string) – Event Management’s Required only if snmpVersion is V3 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-snmp-destination

update_snmp_destination_v1(authPassword=None, community=None, configId=None, description=None, ipAddress=None, name=None, port=None, privacyPassword=None, snmpAuthType=None, snmpMode=None, snmpPrivacyType=None, snmpVersion=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update SNMP Destination .

Parameters:

• authPassword (string) – Event Management’s Auth Password.

• community (string) – Event Management’s Required only if snmpVersion is V2C .

• configId (string) – Event Management’s Config Id.

• description (string) – Event Management’s description.

• ipAddress (string) – Event Management’s Ip Address.

• name (string) – Event Management’s Name.

• port (string) – Event Management’s Port.

• privacyPassword (string) – Event Management’s Privacy Password.

• snmpAuthType (string) – Event Management’s Snmp Auth Type. Available values are ‘SHA’, ‘MD5’ and ‘NONE’.

• snmpMode (string) – Event Management’s If snmpVersion is V3 it is required and cannot be NONE . Available values are ‘AUTH_PRIVACY’, ‘AUTH_NO_PRIVACY’, ‘NO_AUTH_NO_PRIVACY’ and ‘NONE’.

• snmpPrivacyType (string) – Event Management’s Snmp Privacy Type. Available values are ‘AES128’, ‘DES’ and ‘NONE’.

• snmpVersion (string) – Event Management’s Snmp Version. Available values are ‘V2C’ and ‘V3’.

• userName (string) – Event Management’s Required only if snmpVersion is V3 .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-snmp-destination

get_event_subscriptions_v1(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Gets the list of Subscriptions’s based on provided offset and limit (Deprecated) .

Parameters:

• event_ids (str) – eventIds query parameter. List of subscriptions related to the respective eventIds .

• offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

• limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-event-subscriptions

delete_event_subscriptions_v1(subscriptions, headers=None, **request_parameters)

Delete EventSubscriptions .

Parameters:

• subscriptions (str) – subscriptions query parameter. List of EventSubscriptionId’s for removal .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-event-subscriptions

update_event_subscriptions_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Update SubscriptionEndpoint to list of registered events(Deprecated) .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-event-subscriptions

create_event_subscriptions_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Subscribe SubscriptionEndpoint to list of registered events (Deprecated) .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-event-subscriptions

get_email_subscription_details_v1(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Gets the list of subscription details for specified connectorType .

Parameters:

• name (str) – name query parameter. Name of the specific configuration .

• instance_id (str) – instanceId query parameter. Instance Id of the specific configuration .

• offset (int) – offset query parameter. The number of Email Subscription detail’s to offset in the resultset whose default value 0 .

• limit (int) – limit query parameter. The number of Email Subscription detail’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-email-subscription-details

get_rest_webhook_subscription_details_v1(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Gets the list of subscription details for specified connectorType .

Parameters:

• name (str) – name query parameter. Name of the specific configuration .

• instance_id (str) – instanceId query parameter. Instance Id of the specific configuration .

• offset (int) – offset query parameter. The number of Rest/Webhook Subscription detail’s to offset in the resultset whose default value 0 .

• limit (int) – limit query parameter. The number of Rest/Webhook Subscription detail’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-rest-webhook-subscription-details

get_syslog_subscription_details_v1(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)

Gets the list of subscription details for specified connectorType .

Parameters:

• name (str) – name query parameter. Name of the specific configuration .

• instance_id (str) – instanceId query parameter. Instance Id of the specific configuration .

• offset (int) – offset query parameter. The number of Syslog Subscription detail’s to offset in the resultset whose default value 0 .

• limit (int) – limit query parameter. The number of Syslog Subscription detail’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-syslog-subscription-details

count_of_event_subscriptions_v1(event_ids, headers=None, **request_parameters)

Returns the Count of EventSubscriptions .

Parameters:

• event_ids (str) – eventIds query parameter. List of subscriptions related to the respective eventIds .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!count-of-event-subscriptions

create_email_event_subscription_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Create Email Subscription Endpoint for list of registered events. .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-email-event-subscription

update_email_event_subscription_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Update Email Subscription Endpoint for list of registered events .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-email-event-subscription

get_email_event_subscriptions_v1(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)

Gets the list of email Subscriptions’s based on provided query params .

Parameters:

• event_ids (str) – eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids) .

• offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

• limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• domain (str) – domain query parameter. List of email subscriptions related to the respective domain .

• sub_domain (str) – subDomain query parameter. List of email subscriptions related to the respective sub-domain .

• category (str) – category query parameter. List of email subscriptions related to the respective category .

• type (str) – type query parameter. List of email subscriptions related to the respective type .

• name (str) – name query parameter. List of email subscriptions related to the respective name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-email-event-subscriptions

create_rest_webhook_event_subscription_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Create Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-rest-webhook-event-subscription

get_rest_webhook_event_subscriptions_v1(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)

Gets the list of Rest/Webhook Subscriptions’s based on provided query params .

Parameters:

• event_ids (str) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

• offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

• limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• domain (str) – domain query parameter. List of subscriptions related to the respective domain .

• sub_domain (str) – subDomain query parameter. List of subscriptions related to the respective sub- domain .

• category (str) – category query parameter. List of subscriptions related to the respective category .

• type (str) – type query parameter. List of subscriptions related to the respective type .

• name (str) – name query parameter. List of subscriptions related to the respective name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-rest-webhook-event-subscriptions

update_rest_webhook_event_subscription_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Update Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-rest-webhook-event-subscription

update_syslog_event_subscription_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Update Syslog Subscription Endpoint for list of registered events .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-syslog-event-subscription

create_syslog_event_subscription_v1(headers=None, payload=None, active_validation=True, **request_parameters)

Create Syslog Subscription Endpoint for list of registered events .

Parameters:

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (list) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-syslog-event-subscription

get_syslog_event_subscriptions_v1(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)

Gets the list of Syslog Subscriptions’s based on provided offset and limit .

Parameters:

• event_ids (str) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

• offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

• limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• domain (str) – domain query parameter. List of subscriptions related to the respective domain .

• sub_domain (str) – subDomain query parameter. List of subscriptions related to the respective sub- domain .

• category (str) – category query parameter. List of subscriptions related to the respective category .

• type (str) – type query parameter. List of subscriptions related to the respective type .

• name (str) – name query parameter. List of subscriptions related to the respective name .

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-syslog-event-subscriptions

update_syslog_destination_v1(configId=None, description=None, host=None, name=None, port=None, protocol=None, headers=None, payload=None, active_validation=True, **request_parameters)

Update Syslog Destination .

Parameters:

• configId (string) – Event Management’s Required only for update syslog configuration .

• description (string) – Event Management’s Description.

• host (string) – Event Management’s Host.

• name (string) – Event Management’s Name.

• port (integer) – Event Management’s Port.

• protocol (string) – Event Management’s Protocol. Available values are ‘UDP’ and ‘TCP’.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• payload (dict) – A JSON serializable Python object to send in the body of the Request.

• active_validation (bool) – Enable/Disable payload validation. Defaults to True.

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-syslog-destination

get_syslog_destination_v1(config_id=None, limit=None, name=None, offset=None, order=None, protocol=None, sort_by=None, headers=None, **request_parameters)

Get Syslog Destination .

Parameters:

• config_id (str) – configId query parameter. Config id of syslog server .

• name (str) – name query parameter. Name of syslog server .

• protocol (str) – protocol query parameter. Protocol of syslog server .

• offset (int) – offset query parameter. The number of syslog configuration’s to offset in the resultset whose default value 0 .

• limit (int) – limit query parameter. The number of syslog configuration’s to limit in the resultset whose default value 10 .

• sort_by (str) – sortBy query parameter. SortBy field name .

• order (str) – order query parameter.

• headers (dict) – Dictionary of HTTP Headers to send with the Request .

• **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:

• TypeError – If the parameter types are incorrect.

• MalformedRequest – If the request body created is invalid.

• ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-syslog-destination

create_syslog_destination_v1(configId=None, description=None, host=None, name=None, port=None, protocol=None, headers=None, payload=None, active_validation=True, **request_parameters)

Create Syslog Destination .

Parameters:

• configId (string) – Event Management’s Required only for update syslog conf