# -*- coding: utf-8 -*-
"""Cisco DNA Center SDA API wrapper.
Copyright (c) 2019-2021 Cisco Systems.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
from builtins import *
from past.builtins import basestring
from ...restsession import RestSession
from ...utils import (
check_type,
dict_from_items_with_values,
apply_path_params,
dict_of_str,
)
[docs]class Sda(object):
"""Cisco DNA Center SDA API (version: 2.2.3.3).
Wraps the DNA Center SDA
API and exposes the API as native Python
methods that return native Python objects.
"""
def __init__(self, session, object_factory, request_validator):
"""Initialize a new Sda
object with the provided RestSession.
Args:
session(RestSession): The RESTful session object to be used for
API calls to the DNA Center service.
Raises:
TypeError: If the parameter types are incorrect.
"""
check_type(session, RestSession)
super(Sda, self).__init__()
self._session = session
self._object_factory = object_factory
self._request_validator = request_validator
[docs] def get_default_authentication_profile(self,
site_name_hierarchy,
authenticate_template_name=None,
headers=None,
**request_parameters):
"""Get default authentication profile from SDA Fabric .
Args:
site_name_hierarchy(basestring): siteNameHierarchy query parameter.
authenticate_template_name(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(site_name_hierarchy, basestring,
may_be_none=False)
check_type(authenticate_template_name, basestring)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'siteNameHierarchy':
site_name_hierarchy,
'authenticateTemplateName':
authenticate_template_name,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/authentication-profile')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_e414dcbeeabd5a359352a0e2ad5ec3f5_v2_2_3_3', json_data)
[docs] def add_default_authentication_profile(self,
authenticateTemplateName=None,
siteNameHierarchy=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Deploy authentication template in SDA Fabric .
Args:
authenticateTemplateName(string): SDA's Authenticate Template Name. Allowed values are 'No
Authentication ', 'Open Authentication', 'Closed Authentication', 'Low Impact'. .
siteNameHierarchy(string): SDA's Site Name Hierarchy should be a valid fabric site name hierarchy. e.g
Global/USA/San Jose .
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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'siteNameHierarchy':
siteNameHierarchy,
'authenticateTemplateName':
authenticateTemplateName,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_d1d42ef2f1895a82a2830bf1353e6baa_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/authentication-profile')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_d1d42ef2f1895a82a2830bf1353e6baa_v2_2_3_3', json_data)
[docs] def update_default_authentication_profile(self,
authenticateTemplateName=None,
authenticationOrder=None,
dot1xToMabFallbackTimeout=None,
numberOfHosts=None,
siteNameHierarchy=None,
wakeOnLan=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Update default authentication profile in SDA Fabric .
Args:
authenticateTemplateName(string): SDA's Authenticate Template Name. Allowed values are 'Open
Authentication', 'Closed Authentication', 'No Authentication', 'Low Impact'. .
authenticationOrder(string): SDA's Authentication Order. Allowed values are 'dot1x ', 'mac'. .
dot1xToMabFallbackTimeout(string): SDA's In a network that includes both devices that support and
devices that do not support IEEE 802.1X, MAB can be deployed as a fallback, or
complementary, mechanism to IEEE 802.1X. If the network does not have any IEEE
802.1X-capable devices, MAB can be deployed as a standalone authentication mechanism
(e.g. [3-120]) .
numberOfHosts(string): SDA's Number of hosts specifies the number of data hosts that can be connected to
a port. With Single selected, you can have only one data client on the port. With
Unlimited selected, you can have multiple data clients and one voice client on the port
. Available values are 'Unlimited' and 'Single'.
siteNameHierarchy(string): SDA's siteNameHierarchy should be a valid fabric site name hierarchy. e.g
Global/USA/San Jose .
wakeOnLan(boolean): SDA's The IEEE 802.1X Wake on LAN (WoL) Support feature allows dormant systems to be
powered up when the switch receives a specific Ethernet frame. You can use this feature
in cases when hosts on power save and needs to receive a magic packet to turn them on.
This feature works on a per subnet basis and send the subnet broadcast to all hosts in
the subnet .
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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'siteNameHierarchy':
siteNameHierarchy,
'authenticateTemplateName':
authenticateTemplateName,
'authenticationOrder':
authenticationOrder,
'dot1xToMabFallbackTimeout':
dot1xToMabFallbackTimeout,
'wakeOnLan':
wakeOnLan,
'numberOfHosts':
numberOfHosts,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_d999a1d36ee52babb6b619877dad734_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/authentication-profile')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.put(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.put(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_d999a1d36ee52babb6b619877dad734_v2_2_3_3', json_data)
[docs] def delete_default_authentication_profile(self,
site_name_hierarchy,
headers=None,
**request_parameters):
"""Add default authentication profile in SDA Fabric .
Args:
site_name_hierarchy(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(site_name_hierarchy, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'siteNameHierarchy':
site_name_hierarchy,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/authentication-profile')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_b2be8b5dda8b81620b903afe9f_v2_2_3_3', json_data)
[docs] def adds_border_device(self,
borderSessionType=None,
connectedToInternet=None,
deviceManagementIpAddress=None,
externalAutonomouSystemNumber=None,
externalConnectivityIpPoolName=None,
externalConnectivitySettings=None,
externalDomainRoutingProtocolName=None,
interfaceName=None,
internalAutonomouSystemNumber=None,
l3Handoff=None,
siteNameHierarchy=None,
virtualNetwork=None,
virtualNetworkName=None,
vlanId=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Adds border device in SDA Fabric .
Args:
borderSessionType(string): SDA's Border Session Type . Available values are 'EXTERNAL', 'INTERNAL' and
'ANYWHERE'.
connectedToInternet(boolean): SDA's Connected to Internet .
deviceManagementIpAddress(string): SDA's Management Ip Address of the Device which is provisioned
successfully .
externalAutonomouSystemNumber(string): SDA's External Autonomous System Number will be used to automate
IP routing between Border Node and remote peer (e.g.,1-65535) .
externalConnectivityIpPoolName(string): SDA's IP pool to use to automate IP routing between the border
node and remote peer. .
externalConnectivitySettings(object): SDA's External Connectivity Settings information of L3 Handoff .
externalDomainRoutingProtocolName(string): SDA's External Domain Routing Protocol Name. (Example: BGP)
.
interfaceName(string): SDA's Interface Name .
internalAutonomouSystemNumber(string): SDA's Internal Autonomouns System Number used by border node to
communicate with remote peer (e.g.,1-65535) .
l3Handoff(object): SDA's L3 Handoff information .
siteNameHierarchy(string): SDA's Site Name Hierarchy for device location(site should be fabric site) .
virtualNetwork(object): SDA's Virtual Network information of L3 Hand off .
virtualNetworkName(string): SDA's Virtual Network Name assigned to site .
vlanId(string): SDA's Vlan Id (e.g.,2-4096 except for reserved VLANs (1002-1005, 2046, 4095)) .
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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'deviceManagementIpAddress':
deviceManagementIpAddress,
'siteNameHierarchy':
siteNameHierarchy,
'externalDomainRoutingProtocolName':
externalDomainRoutingProtocolName,
'externalConnectivityIpPoolName':
externalConnectivityIpPoolName,
'internalAutonomouSystemNumber':
internalAutonomouSystemNumber,
'borderSessionType':
borderSessionType,
'connectedToInternet':
connectedToInternet,
'externalConnectivitySettings':
externalConnectivitySettings,
'interfaceName':
interfaceName,
'externalAutonomouSystemNumber':
externalAutonomouSystemNumber,
'l3Handoff':
l3Handoff,
'virtualNetwork':
virtualNetwork,
'virtualNetworkName':
virtualNetworkName,
'vlanId':
vlanId,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_b6f2d8e46cdd5f05bb06f52cd1b26fb2_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/border-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_b6f2d8e46cdd5f05bb06f52cd1b26fb2_v2_2_3_3', json_data)
[docs] def gets_border_device_detail(self,
device_management_ip_address,
headers=None,
**request_parameters):
"""Gets border device detail from SDA Fabric .
Args:
device_management_ip_address(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/border-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_aae881ff75d5488a5325ea949be4c5b_v2_2_3_3', json_data)
[docs] def deletes_border_device(self,
device_management_ip_address,
headers=None,
**request_parameters):
"""Deletes border device from SDA Fabric .
Args:
device_management_ip_address(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/border-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_a102ba155e35f84b7af3396aa407d02_v2_2_3_3', json_data)
[docs] def delete_control_plane_device(self,
device_management_ip_address,
headers=None,
**request_parameters):
"""Delete control plane device in SDA Fabric .
Args:
device_management_ip_address(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/control-plane-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_c05702ed7075a2f9ab14c051f1ac883_v2_2_3_3', json_data)
[docs] def get_control_plane_device(self,
device_management_ip_address,
headers=None,
**request_parameters):
"""Get control plane device from SDA Fabric .
Args:
device_management_ip_address(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/control-plane-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_c1a89e4a8ff15608bc6c10d7ef7389d7_v2_2_3_3', json_data)
[docs] def add_control_plane_device(self,
deviceManagementIpAddress=None,
siteNameHierarchy=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Add control plane device in SDA Fabric .
Args:
deviceManagementIpAddress(string): SDA's Management Ip Address of the Device which is provisioned
successfully .
siteNameHierarchy(string): SDA's Site Name Hierarchy of provisioned Device(site should be 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'deviceManagementIpAddress':
deviceManagementIpAddress,
'siteNameHierarchy':
siteNameHierarchy,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_ae7f02a3d051f2baf7cc087990d658_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/control-plane-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_ae7f02a3d051f2baf7cc087990d658_v2_2_3_3', json_data)
[docs] def get_device_info(self,
device_management_ip_address,
headers=None,
**request_parameters):
"""Get device info from SDA Fabric .
Args:
device_management_ip_address(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_d12790f461c553a08142ec740db5efbf_v2_2_3_3', json_data)
[docs] def get_device_role_in_sda_fabric(self,
device_management_ip_address,
headers=None,
**request_parameters):
"""Get device role in SDA Fabric .
Args:
device_management_ip_address(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/device/role')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_ea24b22ce355a229b7fd067401ddf3a_v2_2_3_3', json_data)
[docs] def add_edge_device(self,
deviceManagementIpAddress=None,
siteNameHierarchy=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Add edge device in SDA Fabric .
Args:
deviceManagementIpAddress(string): SDA's Management Ip Address of the Device which is provisioned
successfully .
siteNameHierarchy(string): SDA's Site Name Hierarchy of 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'deviceManagementIpAddress':
deviceManagementIpAddress,
'siteNameHierarchy':
siteNameHierarchy,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_e0c7b28d55c85d49a84c1403ca14bd5f_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/edge-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_e0c7b28d55c85d49a84c1403ca14bd5f_v2_2_3_3', json_data)
[docs] def delete_edge_device(self,
device_management_ip_address,
headers=None,
**request_parameters):
"""Delete edge device from SDA Fabric. .
Args:
device_management_ip_address(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/edge-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_b70d8c6f85254a053ab281fd9e8fc_v2_2_3_3', json_data)
[docs] def get_edge_device(self,
device_management_ip_address,
headers=None,
**request_parameters):
"""Get edge device from SDA Fabric .
Args:
device_management_ip_address(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/edge-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_a2ee396d6595001acfbbcdfa25093ff_v2_2_3_3', json_data)
[docs] def delete_sda_fabric(self,
fabric_name,
headers=None,
**request_parameters):
"""Delete SDA Fabric .
Args:
fabric_name(basestring): fabricName query parameter. Fabric 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(fabric_name, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'fabricName':
fabric_name,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/fabric')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_e14e65da844f55448c1378ca851c7d43_v2_2_3_3', json_data)
[docs] def get_sda_fabric_info(self,
fabric_name,
headers=None,
**request_parameters):
"""Get SDA Fabric Info .
Args:
fabric_name(basestring): fabricName query parameter. Fabric 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(fabric_name, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'fabricName':
fabric_name,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/fabric')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_b7335c6b5057b183a339aa30e7c233_v2_2_3_3', json_data)
[docs] def add_fabric(self,
fabricName=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Add SDA Fabric .
Args:
fabricName(string): SDA's Fabric Name (from DNAC2.2.3 onwards following default fabric name
Default_LAN_Fabric) .
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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'fabricName':
fabricName,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_c31231005eaf51faa0bf1b651bdcb7a0_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/fabric')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_c31231005eaf51faa0bf1b651bdcb7a0_v2_2_3_3', json_data)
[docs] def get_site(self,
site_name_hierarchy,
headers=None,
**request_parameters):
"""Get Site info from SDA Fabric .
Args:
site_name_hierarchy(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(site_name_hierarchy, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'siteNameHierarchy':
site_name_hierarchy,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/fabric-site')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_d23f3e54f8c59caac3ca905f7bf543a_v2_2_3_3', json_data)
[docs] def delete_site(self,
site_name_hierarchy,
headers=None,
**request_parameters):
"""Delete Site from SDA Fabric .
Args:
site_name_hierarchy(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(site_name_hierarchy, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'siteNameHierarchy':
site_name_hierarchy,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/fabric-site')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_f9db3b115f0b8c8b3ce14bc5f975_v2_2_3_3', json_data)
[docs] def add_site(self,
fabricName=None,
siteNameHierarchy=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Add Site in SDA Fabric .
Args:
fabricName(string): SDA's Fabric Name (should be existing fabric name) .
siteNameHierarchy(string): SDA's Site Name Hierarchy for provision device location. .
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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'fabricName':
fabricName,
'siteNameHierarchy':
siteNameHierarchy,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_a764c85d8df5c30b9143619d4f9cde9_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/fabric-site')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_a764c85d8df5c30b9143619d4f9cde9_v2_2_3_3', json_data)
[docs] def get_sda_fabric_count(self,
headers=None,
**request_parameters):
"""Get SDA Fabric Count .
Args:
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/fabric/count')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_a74fcc0d07935a06a74662dc648ac0b7_v2_2_3_3', json_data)
[docs] def add_port_assignment_for_access_point(self,
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 .
Args:
authenticateTemplateName(string): SDA's Authenticate TemplateName associated to siteNameHierarchy. .
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 assignment .
interfaceName(string): SDA's Interface Name of the edge device .
siteNameHierarchy(string): SDA's Site Name Hierarchy should be a valid fabric site name hierarchy. e.g
Global/USA/San Jose .
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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'siteNameHierarchy':
siteNameHierarchy,
'deviceManagementIpAddress':
deviceManagementIpAddress,
'interfaceName':
interfaceName,
'dataIpAddressPoolName':
dataIpAddressPoolName,
'authenticateTemplateName':
authenticateTemplateName,
'interfaceDescription':
interfaceDescription,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_e4a09bf566f35babad9e27f5eb61a86d_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/hostonboarding/access-'
+ 'point')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_e4a09bf566f35babad9e27f5eb61a86d_v2_2_3_3', json_data)
[docs] def delete_port_assignment_for_access_point(self,
device_management_ip_address,
interface_name,
headers=None,
**request_parameters):
"""Delete Port assignment for access point in SDA Fabric .
Args:
device_management_ip_address(basestring): deviceManagementIpAddress query parameter.
interface_name(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
check_type(interface_name, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
'interfaceName':
interface_name,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/hostonboarding/access-'
+ 'point')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_bd26b08b64545bae20f60c56891576_v2_2_3_3', json_data)
[docs] def get_port_assignment_for_access_point(self,
device_management_ip_address,
interface_name,
headers=None,
**request_parameters):
"""Get Port assignment for access point in SDA Fabric .
Args:
device_management_ip_address(basestring): deviceManagementIpAddress query parameter.
interface_name(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
check_type(interface_name, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
'interfaceName':
interface_name,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/hostonboarding/access-'
+ 'point')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_b035b0b3b60b5f2bb7c8c82e7f94b63b_v2_2_3_3', json_data)
[docs] def delete_port_assignment_for_user_device(self,
device_management_ip_address,
interface_name,
headers=None,
**request_parameters):
"""Delete Port assignment for user device in SDA Fabric. .
Args:
device_management_ip_address(basestring): deviceManagementIpAddress query parameter.
interface_name(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
check_type(interface_name, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
'interfaceName':
interface_name,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/hostonboarding/user-'
+ 'device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_cb88b50dd5ead96ecfb4ab0390f47_v2_2_3_3', json_data)
[docs] def add_port_assignment_for_user_device(self,
authenticateTemplateName=None,
dataIpAddressPoolName=None,
deviceManagementIpAddress=None,
interfaceDescription=None,
interfaceName=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. .
Args:
authenticateTemplateName(string): SDA's Authenticate TemplateName associated to siteNameHierarchy.
Allowed values are 'Open Authentication', 'Closed Authentication', 'Low Impact', 'No
Authentication', ''. . Available values are 'Open Authentication', 'Closed
Authentication', 'Low Impact', 'No Authentication' and ''.
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 device .
interfaceDescription(string): SDA's Details or note of interface assignment .
interfaceName(string): SDA's Interface Name of the edge device .
scalableGroupName(string): SDA's valid name of a scalable group associated with virtual network(Scalable
groups are only supported on No Auth profile because the other profiles assign SGTs from
ISE) .
siteNameHierarchy(string): SDA's Site Name Hierarchy should be a valid fabric site name hierarchy. e.g
Global/USA/San Jose .
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 emty) .
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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'siteNameHierarchy':
siteNameHierarchy,
'deviceManagementIpAddress':
deviceManagementIpAddress,
'interfaceName':
interfaceName,
'dataIpAddressPoolName':
dataIpAddressPoolName,
'voiceIpAddressPoolName':
voiceIpAddressPoolName,
'authenticateTemplateName':
authenticateTemplateName,
'scalableGroupName':
scalableGroupName,
'interfaceDescription':
interfaceDescription,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_af29516f0c8591da2a92523b5ab3386_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/hostonboarding/user-'
+ 'device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_af29516f0c8591da2a92523b5ab3386_v2_2_3_3', json_data)
[docs] def get_port_assignment_for_user_device(self,
device_management_ip_address,
interface_name,
headers=None,
**request_parameters):
"""Get Port assignment for user device in SDA Fabric. .
Args:
device_management_ip_address(basestring): deviceManagementIpAddress query parameter.
interface_name(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
check_type(interface_name, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
'interfaceName':
interface_name,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/hostonboarding/user-'
+ 'device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_a446d7327733580e9a6b661715eb4c09_v2_2_3_3', json_data)
[docs] def add_multicast_in_sda_fabric(self,
multicastMethod=None,
multicastVnInfo=None,
muticastType=None,
siteNameHierarchy=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Add multicast in SDA fabric .
Args:
multicastMethod(string): SDA's Multicast Methods . Available values are 'native_multicast' and ''.
multicastVnInfo(object): SDA's multicastVnInfo.
muticastType(string): SDA's Muticast Type . Available values are 'ssm', 'asm_with_external_rp' and ''.
siteNameHierarchy(string): SDA's Full path of sda fabric siteNameHierarchy .
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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'siteNameHierarchy':
siteNameHierarchy,
'multicastMethod':
multicastMethod,
'muticastType':
muticastType,
'multicastVnInfo':
multicastVnInfo,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_b7079a38844e56dd8f1b6b876880a02e_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/multicast')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_b7079a38844e56dd8f1b6b876880a02e_v2_2_3_3', json_data)
[docs] def get_multicast_details_from_sda_fabric(self,
site_name_hierarchy,
headers=None,
**request_parameters):
"""Get multicast details from SDA fabric .
Args:
site_name_hierarchy(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(site_name_hierarchy, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'siteNameHierarchy':
site_name_hierarchy,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/multicast')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_c27bbb42365955bc210924e1362c34_v2_2_3_3', json_data)
[docs] def delete_multicast_from_sda_fabric(self,
site_name_hierarchy,
headers=None,
**request_parameters):
"""Delete multicast from SDA fabric .
Args:
site_name_hierarchy(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(site_name_hierarchy, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'siteNameHierarchy':
site_name_hierarchy,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/multicast')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_e8e007d3e25f7fb83a6579016aea72_v2_2_3_3', json_data)
[docs] def delete_provisioned_wired_device(self,
device_management_ip_address,
headers=None,
**request_parameters):
"""Delete provisioned Wired Device .
Args:
device_management_ip_address(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/provision-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_e5bd8dbbf65253f0aadd77a62b1b8b58_v2_2_3_3', json_data)
[docs] def re_provision_wired_device(self,
deviceManagementIpAddress=None,
siteNameHierarchy=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Re-Provision Wired Device .
Args:
deviceManagementIpAddress(string): SDA's Management Ip Address of the device to be re-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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'deviceManagementIpAddress':
deviceManagementIpAddress,
'siteNameHierarchy':
siteNameHierarchy,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_fd488ff002115f3b8f0ee165e5347609_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/provision-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.put(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.put(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_fd488ff002115f3b8f0ee165e5347609_v2_2_3_3', json_data)
[docs] def provision_wired_device(self,
deviceManagementIpAddress=None,
siteNameHierarchy=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Provision Wired Device .
Args:
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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'deviceManagementIpAddress':
deviceManagementIpAddress,
'siteNameHierarchy':
siteNameHierarchy,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_d1608b2751c883a072ee3fb80228_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/provision-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_d1608b2751c883a072ee3fb80228_v2_2_3_3', json_data)
[docs] def get_provisioned_wired_device(self,
device_management_ip_address,
headers=None,
**request_parameters):
"""Get Provisioned Wired Device .
Args:
device_management_ip_address(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(device_management_ip_address, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'deviceManagementIpAddress':
device_management_ip_address,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/provision-device')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_d8f10868c21856eab31776f109aba2bb_v2_2_3_3', json_data)
[docs] def delete_vn(self,
site_name_hierarchy,
virtual_network_name,
headers=None,
**request_parameters):
"""Delete virtual network (VN) from SDA Fabric .
Args:
virtual_network_name(basestring): virtualNetworkName query parameter.
site_name_hierarchy(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(virtual_network_name, basestring,
may_be_none=False)
check_type(site_name_hierarchy, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'virtualNetworkName':
virtual_network_name,
'siteNameHierarchy':
site_name_hierarchy,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/virtual-network')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_cb9f8ad5359b2b2cbc151ac3a842a_v2_2_3_3', json_data)
[docs] def get_vn(self,
site_name_hierarchy,
virtual_network_name,
headers=None,
**request_parameters):
"""Get virtual network (VN) from SDA Fabric .
Args:
virtual_network_name(basestring): virtualNetworkName query parameter.
site_name_hierarchy(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(virtual_network_name, basestring,
may_be_none=False)
check_type(site_name_hierarchy, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'virtualNetworkName':
virtual_network_name,
'siteNameHierarchy':
site_name_hierarchy,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/virtual-network')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_cb1fe08692b85767a42b84340c4c7d53_v2_2_3_3', json_data)
[docs] def add_vn(self,
siteNameHierarchy=None,
virtualNetworkName=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Add virtual network (VN) in SDA Fabric .
Args:
siteNameHierarchy(string): SDA's Site Name Hierarchy should be a valid fabric site name hierarchy.( e.g.
Global/USA/San Jose) .
virtualNetworkName(string): SDA's Virtual Network Name, that is created in 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'virtualNetworkName':
virtualNetworkName,
'siteNameHierarchy':
siteNameHierarchy,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_e3a724a35854758d65a83823c88435_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/virtual-network')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_e3a724a35854758d65a83823c88435_v2_2_3_3', json_data)
[docs] def get_ip_pool_from_sda_virtual_network(self,
ip_pool_name,
virtual_network_name,
headers=None,
**request_parameters):
"""Get IP Pool from SDA Virtual Network .
Args:
ip_pool_name(basestring): ipPoolName query parameter.
virtual_network_name(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(ip_pool_name, basestring,
may_be_none=False)
check_type(virtual_network_name, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'ipPoolName':
ip_pool_name,
'virtualNetworkName':
virtual_network_name,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/virtualnetwork/ippool')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_b88723912610599ba42292db52d1dae4_v2_2_3_3', json_data)
[docs] def delete_ip_pool_from_sda_virtual_network(self,
ip_pool_name,
virtual_network_name,
headers=None,
**request_parameters):
"""Delete IP Pool from SDA Virtual Network .
Args:
ip_pool_name(basestring): ipPoolName query parameter.
virtual_network_name(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(ip_pool_name, basestring,
may_be_none=False)
check_type(virtual_network_name, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'ipPoolName':
ip_pool_name,
'virtualNetworkName':
virtual_network_name,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/virtualnetwork/ippool')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_c923d016d5401b7a9943724df3844_v2_2_3_3', json_data)
[docs] def add_ip_pool_in_sda_virtual_network(self,
authenticationPolicyName=None,
ipPoolName=None,
isL2FloodingEnabled=None,
isThisCriticalPool=None,
isWirelessPool=None,
poolType=None,
scalableGroupName=None,
siteNameHierarchy=None,
trafficType=None,
virtualNetworkName=None,
vlanName=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Add IP Pool in SDA Virtual Network .
Args:
authenticationPolicyName(string): SDA's Deprecated, same as vlanName, please use vlanName .
ipPoolName(string): SDA's Ip Pool Name, that is reserved to fabric siteNameHierarchy .
isL2FloodingEnabled(boolean): SDA's Layer2 flooding enablement flag .
isThisCriticalPool(boolean): SDA's Critical pool enablement flag where depending on the pool type (data
or voice), a corresponding Critical Vlan gets assigned to the Critical Pool .
isWirelessPool(string): SDA's Wireless Pool enablement flag .
poolType(string): SDA's Pool Type (needed when assigning segment to INFRA_VN) (Example: AP.) .
scalableGroupName(string): SDA's Scalable Group, that is associated to Virtual Network .
siteNameHierarchy(string): SDA's Full path of sda fabric siteNameHierarchy .
trafficType(string): SDA's Traffic type . Available values are 'data' and 'voice'.
virtualNetworkName(string): SDA's Virtual Network Name, that is associated to fabric siteNameHierarchy .
vlanName(string): SDA's Vlan name for this segment, 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'siteNameHierarchy':
siteNameHierarchy,
'virtualNetworkName':
virtualNetworkName,
'ipPoolName':
ipPoolName,
'trafficType':
trafficType,
'authenticationPolicyName':
authenticationPolicyName,
'scalableGroupName':
scalableGroupName,
'isL2FloodingEnabled':
isL2FloodingEnabled,
'isThisCriticalPool':
isThisCriticalPool,
'poolType':
poolType,
'vlanName':
vlanName,
'isWirelessPool':
isWirelessPool,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_b07f187b7456c8bbb6088a2f24dcee_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/business/sda/virtualnetwork/ippool')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_b07f187b7456c8bbb6088a2f24dcee_v2_2_3_3', json_data)
[docs] def add_virtual_network_with_scalable_groups(self,
isGuestVirtualNetwork=None,
scalableGroupNames=None,
virtualNetworkName=None,
virtualNetworkType=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Add virtual network with scalable groups at global level .
Args:
isGuestVirtualNetwork(boolean): SDA's To create guest virtual network .
scalableGroupNames(list): SDA's Scalable Group to be associated to virtual network (list of strings).
virtualNetworkName(string): SDA's Virtual Network Name to be assigned global level .
virtualNetworkType(string): SDA's Virtual Network 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'virtualNetworkName':
virtualNetworkName,
'isGuestVirtualNetwork':
isGuestVirtualNetwork,
'scalableGroupNames':
scalableGroupNames,
'virtualNetworkType':
virtualNetworkType,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_f5ebb9d50aab287f320d32181c0_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/virtual-network')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.post(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_f5ebb9d50aab287f320d32181c0_v2_2_3_3', json_data)
[docs] def delete_virtual_network_with_scalable_groups(self,
virtual_network_name,
headers=None,
**request_parameters):
"""Delete virtual network with scalable groups .
Args:
virtual_network_name(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(virtual_network_name, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'virtualNetworkName':
virtual_network_name,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/virtual-network')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_f2e8552eabc5e5f97e1f40bcc4b4c75_v2_2_3_3', json_data)
[docs] def get_virtual_network_with_scalable_groups(self,
virtual_network_name,
headers=None,
**request_parameters):
"""Get virtual network with scalable groups .
Args:
virtual_network_name(basestring): 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(virtual_network_name, basestring,
may_be_none=False)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
'virtualNetworkName':
virtual_network_name,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/virtual-network')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_ea4b1c052b855bd9a0e99f803e6185a5_v2_2_3_3', json_data)
[docs] def update_virtual_network_with_scalable_groups(self,
isGuestVirtualNetwork=None,
scalableGroupNames=None,
virtualNetworkName=None,
virtualNetworkType=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters):
"""Update virtual network with scalable groups .
Args:
isGuestVirtualNetwork(boolean): SDA's To create guest virtual network .
scalableGroupNames(list): SDA's Scalable Group to be associated to virtual network (list of strings).
virtualNetworkName(string): SDA's Virtual Network Name to be assigned global level .
virtualNetworkType(string): SDA's Virtual Network 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:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the DNA Center cloud returns an error.
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if 'X-Auth-Token' in headers:
check_type(headers.get('X-Auth-Token'),
basestring, may_be_none=False)
_params = {
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
_payload = {
'virtualNetworkName':
virtualNetworkName,
'virtualNetworkType':
virtualNetworkType,
'isGuestVirtualNetwork':
isGuestVirtualNetwork,
'scalableGroupNames':
scalableGroupNames,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator('jsd_f9492367570c5f009cf8b5955790e87c_v2_2_3_3')\
.validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = ('/dna/intent/api/v1/virtual-network')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.put(endpoint_full_url, params=_params,
json=_payload,
headers=_headers)
else:
json_data = self._session.put(endpoint_full_url, params=_params,
json=_payload)
return self._object_factory('bpm_f9492367570c5f009cf8b5955790e87c_v2_2_3_3', json_data)