Source code for dnacentersdk.api.v2_2_3_3.wireless

# -*- coding: utf-8 -*-
"""Cisco DNA Center Wireless 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 Wireless(object): """Cisco DNA Center Wireless API (version: 2.2.3.3). Wraps the DNA Center Wireless 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 Wireless 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(Wireless, self).__init__() self._session = session self._object_factory = object_factory self._request_validator = request_validator
[docs] def sensor_test_results(self, end_time=None, site_id=None, start_time=None, test_failure_by=None, headers=None, **request_parameters): """Intent API to get SENSOR test result summary . Args: site_id(basestring): siteId query parameter. Assurance site UUID . start_time(int): startTime query parameter. The epoch time in milliseconds . end_time(int): endTime query parameter. The epoch time in milliseconds . test_failure_by(basestring): testFailureBy query parameter. Obtain failure statistics group by "area", "building", or "floor" . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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_id, basestring) check_type(start_time, int) check_type(end_time, int) check_type(test_failure_by, 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 = { 'siteId': site_id, 'startTime': start_time, 'endTime': end_time, 'testFailureBy': test_failure_by, } _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/AssuranceGetSensorTestResults') 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_dde2b077d6d052dcae5a76f4aac09c1d_v2_2_3_3', json_data)
[docs] def create_and_provision_ssid(self, enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters): """Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites . Args: enableFabric(boolean): Wireless's Enable SSID for Fabric . flexConnect(object): Wireless's flexConnect. managedAPLocations(list): Wireless's Managed AP Locations (Enter entire Site(s) hierarchy) (list of strings). ssidDetails(object): Wireless's ssidDetails. ssidType(string): Wireless's SSID Type . Available values are 'Guest' and 'Enterprise'. headers(dict): Dictionary of HTTP Headers to send with the Request . payload(dict): A JSON serializable Python object to send in the body of the Request. active_validation(bool): Enable/Disable payload validation. Defaults to True. **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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 '__persistbapioutput' in headers: check_type(headers.get('__persistbapioutput'), basestring, may_be_none=False) 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 = { 'managedAPLocations': managedAPLocations, 'ssidDetails': ssidDetails, 'ssidType': ssidType, 'enableFabric': enableFabric, 'flexConnect': flexConnect, } _payload.update(payload or {}) _payload = dict_from_items_with_values(_payload) if active_validation: self._request_validator('jsd_d825ae9a117f5b6bb65b7d78fd42513c_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/ssid') 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_d825ae9a117f5b6bb65b7d78fd42513c_v2_2_3_3', json_data)
[docs] def delete_ssid_and_provision_it_to_devices(self, managed_aplocations, ssid_name, headers=None, **request_parameters): """Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center . Args: ssid_name(basestring): ssidName path parameter. managed_aplocations(basestring): managedAPLocations path parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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(ssid_name, basestring, may_be_none=False) check_type(managed_aplocations, basestring, may_be_none=False) if headers is not None: if '__persistbapioutput' in headers: check_type(headers.get('__persistbapioutput'), basestring, may_be_none=False) 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 = { 'ssidName': ssid_name, 'managedAPLocations': managed_aplocations, } 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/ssid/{ssidName}/{managedAPLo' + 'cations}') 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_e56eb2c294159d891b7dbe493ddc434_v2_2_3_3', json_data)
[docs] def get_enterprise_ssid(self, ssid_name=None, headers=None, **request_parameters): """Gets either one or all the enterprise SSID . Args: ssid_name(basestring): ssidName query parameter. Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved. . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: list: JSON response. A list of MyDict objects. 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(ssid_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 = { 'ssidName': ssid_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/enterprise-ssid') 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_fb757e8fce4b51ffa0ba1a8e5ae4d8c0_v2_2_3_3', json_data)
[docs] def create_enterprise_ssid(self, basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters): """Creates enterprise SSID . Args: basicServiceSetClientIdleTimeout(integer): Wireless's Basic Service Set Client Idle Timeout . clientExclusionTimeout(integer): Wireless's Client Exclusion Timeout . enableBasicServiceSetMaxIdle(boolean): Wireless's Enable Basic Service Set Max Idle . enableBroadcastSSID(boolean): Wireless's Enable Broadcast SSID . enableClientExclusion(boolean): Wireless's Enable Client Exclusion . enableDirectedMulticastService(boolean): Wireless's Enable Directed Multicast Service . enableFastLane(boolean): Wireless's Enable Fast Lane . enableMACFiltering(boolean): Wireless's Enable MAC Filtering . enableNeighborList(boolean): Wireless's Enable Neighbor List . enableSessionTimeOut(boolean): Wireless's Enable Session Timeout . fastTransition(string): Wireless's Fast Transition . Available values are 'Adaptive', 'Enable' and 'Disable'. mfpClientProtection(string): Wireless's Management Frame Protection Client . Available values are 'Optional', 'Disabled' and 'Required'. name(string): Wireless's Enter SSID Name . passphrase(string): Wireless's Pass Phrase (Only applicable for SSID with PERSONAL security level) . radioPolicy(string): Wireless's Radio Policy. Allowed values are 'Dual band operation (2.4GHz and 5GHz)', 'Dual band operation with band select', '5GHz only', '2.4GHz only'. . securityLevel(string): Wireless's Security Level . Available values are 'WPA2_ENTERPRISE', 'WPA2_PERSONAL' and 'OPEN'. sessionTimeOut(integer): Wireless's Session Time Out . trafficType(string): Wireless's Traffic Type . Available values are 'voicedata' and 'data'. headers(dict): Dictionary of HTTP Headers to send with the Request . payload(dict): A JSON serializable Python object to send in the body of the Request. active_validation(bool): Enable/Disable payload validation. Defaults to True. **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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 = { 'name': name, 'securityLevel': securityLevel, 'passphrase': passphrase, 'enableFastLane': enableFastLane, 'enableMACFiltering': enableMACFiltering, 'trafficType': trafficType, 'radioPolicy': radioPolicy, 'enableBroadcastSSID': enableBroadcastSSID, 'fastTransition': fastTransition, 'enableSessionTimeOut': enableSessionTimeOut, 'sessionTimeOut': sessionTimeOut, 'enableClientExclusion': enableClientExclusion, 'clientExclusionTimeout': clientExclusionTimeout, 'enableBasicServiceSetMaxIdle': enableBasicServiceSetMaxIdle, 'basicServiceSetClientIdleTimeout': basicServiceSetClientIdleTimeout, 'enableDirectedMulticastService': enableDirectedMulticastService, 'enableNeighborList': enableNeighborList, 'mfpClientProtection': mfpClientProtection, } _payload.update(payload or {}) _payload = dict_from_items_with_values(_payload) if active_validation: self._request_validator('jsd_bc33daf690ec5399a507829abfc4fe64_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/enterprise-ssid') 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_bc33daf690ec5399a507829abfc4fe64_v2_2_3_3', json_data)
[docs] def update_enterprise_ssid(self, basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters): """Update enterprise SSID . Args: basicServiceSetClientIdleTimeout(integer): Wireless's Basic Service Set Client Idle Timeout . clientExclusionTimeout(integer): Wireless's Client Exclusion Timeout . enableBasicServiceSetMaxIdle(boolean): Wireless's Enable Basic Service Set Max Idle . enableBroadcastSSID(boolean): Wireless's Enable Broadcast SSID . enableClientExclusion(boolean): Wireless's Enable Client Exclusion . enableDirectedMulticastService(boolean): Wireless's Enable Directed Multicast Service . enableFastLane(boolean): Wireless's Enable Fast Lane . enableMACFiltering(boolean): Wireless's Enable MAC Filtering . enableNeighborList(boolean): Wireless's Enable Neighbor List . enableSessionTimeOut(boolean): Wireless's Enable Session Timeout . fastTransition(string): Wireless's Fast Transition . Available values are 'Adaptive', 'Enable' and 'Disable'. mfpClientProtection(string): Wireless's Management Frame Protection Client . Available values are 'Optional', 'Disabled' and 'Required'. name(string): Wireless's Enter SSID Name . passphrase(string): Wireless's Pass Phrase (Only applicable for SSID with PERSONAL security level) . radioPolicy(string): Wireless's Radio Policy. Allowed values are 'Dual band operation (2.4GHz and 5GHz)', 'Dual band operation with band select', '5GHz only', '2.4GHz only' . securityLevel(string): Wireless's Security Level . Available values are 'WPA2_ENTERPRISE', 'WPA2_PERSONAL' and 'OPEN'. sessionTimeOut(integer): Wireless's Session Time Out . trafficType(string): Wireless's Traffic Type . Available values are 'voicedata' and 'data'. headers(dict): Dictionary of HTTP Headers to send with the Request . payload(dict): A JSON serializable Python object to send in the body of the Request. active_validation(bool): Enable/Disable payload validation. Defaults to True. **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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 = { 'name': name, 'securityLevel': securityLevel, 'passphrase': passphrase, 'enableFastLane': enableFastLane, 'enableMACFiltering': enableMACFiltering, 'trafficType': trafficType, 'radioPolicy': radioPolicy, 'enableBroadcastSSID': enableBroadcastSSID, 'fastTransition': fastTransition, 'enableSessionTimeOut': enableSessionTimeOut, 'sessionTimeOut': sessionTimeOut, 'enableClientExclusion': enableClientExclusion, 'clientExclusionTimeout': clientExclusionTimeout, 'enableBasicServiceSetMaxIdle': enableBasicServiceSetMaxIdle, 'basicServiceSetClientIdleTimeout': basicServiceSetClientIdleTimeout, 'enableDirectedMulticastService': enableDirectedMulticastService, 'enableNeighborList': enableNeighborList, 'mfpClientProtection': mfpClientProtection, } _payload.update(payload or {}) _payload = dict_from_items_with_values(_payload) if active_validation: self._request_validator('jsd_a94058a99acaaf8eb73c9227_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/enterprise-ssid') 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_a94058a99acaaf8eb73c9227_v2_2_3_3', json_data)
[docs] def delete_enterprise_ssid(self, ssid_name, headers=None, **request_parameters): """Deletes given enterprise SSID . Args: ssid_name(basestring): ssidName path parameter. Enter the SSID name to be deleted . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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(ssid_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 = { } _params.update(request_parameters) _params = dict_from_items_with_values(_params) path_params = { 'ssidName': ssid_name, } 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/enterprise-ssid/{ssidName}') 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_a43afa4d91a5043996c682a7a7a2d62_v2_2_3_3', json_data)
[docs] def delete_wireless_profile(self, wireless_profile_name, headers=None, **request_parameters): """Delete the Wireless Profile from DNAC whose name is provided. . Args: wireless_profile_name(basestring): wirelessProfileName path parameter. Wireless Profile Name . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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(wireless_profile_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 = { } _params.update(request_parameters) _params = dict_from_items_with_values(_params) path_params = { 'wirelessProfileName': wireless_profile_name, } 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/wireless-' + 'profile/{wirelessProfileName}') 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_a850fb6c5451a7ad20ba76f4ff43_v2_2_3_3', json_data)
[docs] def ap_provision(self, headers=None, payload=None, active_validation=True, **request_parameters): """Access Point Provision and ReProvision . Args: headers(dict): Dictionary of HTTP Headers to send with the Request . payload(list): A JSON serializable Python object to send in the body of the Request. active_validation(bool): Enable/Disable payload validation. Defaults to True. **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: list: JSON response. A list of MyDict objects. 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, list) if headers is not None: if '__persistbapioutput' in headers: check_type(headers.get('__persistbapioutput'), basestring) 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 = payload or [] if active_validation: self._request_validator('jsd_f790a930d452708353c374f5c0f90f_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/wireless/ap-provision') 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_f790a930d452708353c374f5c0f90f_v2_2_3_3', json_data)
[docs] def create_update_dynamic_interface(self, interfaceName=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters): """API to create or update an dynamic interface . Args: interfaceName(string): Wireless's dynamic-interface name . vlanId(number): Wireless's Vlan Id . headers(dict): Dictionary of HTTP Headers to send with the Request . payload(dict): A JSON serializable Python object to send in the body of the Request. active_validation(bool): Enable/Disable payload validation. Defaults to True. **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: list: JSON response. A list of MyDict objects. 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 '__runsync' in headers: check_type(headers.get('__runsync'), bool) if '__timeout' in headers: check_type(headers.get('__timeout'), int) 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 = { 'interfaceName': interfaceName, 'vlanId': vlanId, } _payload.update(payload or {}) _payload = dict_from_items_with_values(_payload) if active_validation: self._request_validator('jsd_c00df3623b5a74ad41e75487ed9b77_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/wireless/dynamic-interface') 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_c00df3623b5a74ad41e75487ed9b77_v2_2_3_3', json_data)
[docs] def get_dynamic_interface(self, interface_name=None, headers=None, **request_parameters): """Get one or all dynamic interface(s) . Args: interface_name(basestring): interface-name query parameter. dynamic-interface name, if not specified all the existing dynamic interfaces will be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: list: JSON response. A list of MyDict objects. 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(interface_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 = { 'interface-name': 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/wireless/dynamic-interface') 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_c9fb8b0f5c69ba22f920e4044538_v2_2_3_3', json_data)
[docs] def delete_dynamic_interface(self, interface_name, headers=None, **request_parameters): """Delete a dynamic interface . Args: interface_name(basestring): interfaceName path parameter. valid interface-name to be deleted . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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(interface_name, basestring, may_be_none=False) if headers is not None: if '__runsync' in headers: check_type(headers.get('__runsync'), bool) if '__timeout' in headers: check_type(headers.get('__timeout'), int) 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 = { 'interfaceName': interface_name, } 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/wireless/dynamic-' + 'interface/{interfaceName}') 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_bfd78707835bc8934cf0df1b0169fc_v2_2_3_3', json_data)
[docs] def update_wireless_profile(self, profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters): """Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided. . Args: profileDetails(object): Wireless's profileDetails. headers(dict): Dictionary of HTTP Headers to send with the Request . payload(dict): A JSON serializable Python object to send in the body of the Request. active_validation(bool): Enable/Disable payload validation. Defaults to True. **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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 = { 'profileDetails': profileDetails, } _payload.update(payload or {}) _payload = dict_from_items_with_values(_payload) if active_validation: self._request_validator('jsd_bbf7ce025bc2a291b90c37a6b898_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/wireless/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_bbf7ce025bc2a291b90c37a6b898_v2_2_3_3', json_data)
[docs] def create_wireless_profile(self, profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters): """Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it. . Args: profileDetails(object): Wireless's profileDetails. headers(dict): Dictionary of HTTP Headers to send with the Request . payload(dict): A JSON serializable Python object to send in the body of the Request. active_validation(bool): Enable/Disable payload validation. Defaults to True. **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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 = { 'profileDetails': profileDetails, } _payload.update(payload or {}) _payload = dict_from_items_with_values(_payload) if active_validation: self._request_validator('jsd_b95201b6a6905a10b463e036bf591166_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/wireless/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_b95201b6a6905a10b463e036bf591166_v2_2_3_3', json_data)
[docs] def get_wireless_profile(self, profile_name=None, headers=None, **request_parameters): """Gets either one or all the wireless network profiles if no name is provided for network-profile. . Args: profile_name(basestring): profileName query parameter. Wireless Network Profile Name . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: list: JSON response. A list of MyDict objects. 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(profile_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 = { 'profileName': profile_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/wireless/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_bbc1866a50505c0695ae243718d51936_v2_2_3_3', json_data)
[docs] def provision_update(self, headers=None, payload=None, active_validation=True, **request_parameters): """Updates wireless provisioning . Args: headers(dict): Dictionary of HTTP Headers to send with the Request . payload(list): A JSON serializable Python object to send in the body of the Request. active_validation(bool): Enable/Disable payload validation. Defaults to True. **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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, list) if headers is not None: if '__persistbapioutput' in headers: check_type(headers.get('__persistbapioutput'), basestring, may_be_none=False) 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 = payload or [] if active_validation: self._request_validator('jsd_d0aab00569b258b481afedc35e6db392_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/wireless/provision') 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_d0aab00569b258b481afedc35e6db392_v2_2_3_3', json_data)
[docs] def provision(self, headers=None, payload=None, active_validation=True, **request_parameters): """Provision wireless devices . Args: headers(dict): Dictionary of HTTP Headers to send with the Request . payload(list): A JSON serializable Python object to send in the body of the Request. active_validation(bool): Enable/Disable payload validation. Defaults to True. **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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, list) 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 = payload or [] if active_validation: self._request_validator('jsd_e31c795964b3bdf85da1b5a2a5_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/wireless/provision') 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_e31c795964b3bdf85da1b5a2a5_v2_2_3_3', json_data)
[docs] def psk_override(self, headers=None, payload=None, active_validation=True, **request_parameters): """Update/override pass phrase of enterprise SSID . Args: headers(dict): Dictionary of HTTP Headers to send with the Request . payload(list): A JSON serializable Python object to send in the body of the Request. active_validation(bool): Enable/Disable payload validation. Defaults to True. **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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, list) 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 = payload or [] if active_validation: self._request_validator('jsd_f99c96c3a9b45ddaabc2c75ff8efa67f_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/wireless/psk-override') 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_f99c96c3a9b45ddaabc2c75ff8efa67f_v2_2_3_3', json_data)
[docs] def retrieve_rf_profiles(self, rf_profile_name=None, headers=None, **request_parameters): """Retrieve all RF profiles . Args: rf_profile_name(basestring): rf-profile-name query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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(rf_profile_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 = { 'rf-profile-name': rf_profile_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/wireless/rf-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_ac37d6798c0b593088952123df03bb1b_v2_2_3_3', json_data)
[docs] def create_or_update_rf_profile(self, channelWidth=None, defaultRfProfile=None, enableBrownField=None, enableCustom=None, enableRadioTypeA=None, enableRadioTypeB=None, name=None, radioTypeAProperties=None, radioTypeBProperties=None, headers=None, payload=None, active_validation=True, **request_parameters): """Create or Update RF profile . Args: channelWidth(string): Wireless's rf-profile channel width . defaultRfProfile(boolean): Wireless's isDefault rf-profile . enableBrownField(boolean): Wireless's true if enable brown field for rf-profile else false . enableCustom(boolean): Wireless's true if enable custom rf-profile else false . enableRadioTypeA(boolean): Wireless's tru if Enable Radio Type A else false . enableRadioTypeB(boolean): Wireless's true if Enable Radio Type B else false . name(string): Wireless's custom RF profile name . radioTypeAProperties(object): Wireless's radioTypeAProperties. radioTypeBProperties(object): Wireless's radioTypeBProperties. headers(dict): Dictionary of HTTP Headers to send with the Request . payload(dict): A JSON serializable Python object to send in the body of the Request. active_validation(bool): 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 = { 'name': name, 'defaultRfProfile': defaultRfProfile, 'enableRadioTypeA': enableRadioTypeA, 'enableRadioTypeB': enableRadioTypeB, 'channelWidth': channelWidth, 'enableCustom': enableCustom, 'enableBrownField': enableBrownField, 'radioTypeAProperties': radioTypeAProperties, 'radioTypeBProperties': radioTypeBProperties, } _payload.update(payload or {}) _payload = dict_from_items_with_values(_payload) if active_validation: self._request_validator('jsd_f24f6c07641580ba6ed710e92c2da16_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/wireless/rf-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_f24f6c07641580ba6ed710e92c2da16_v2_2_3_3', json_data)
[docs] def delete_rf_profiles(self, rf_profile_name, headers=None, **request_parameters): """Delete RF profile(s) . Args: rf_profile_name(basestring): rfProfileName path parameter. RF profile name to be deleted(required) non- custom RF profile cannot be deleted . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides support for parameters that may be added in the future). Returns: 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(rf_profile_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 = { } _params.update(request_parameters) _params = dict_from_items_with_values(_params) path_params = { 'rfProfileName': rf_profile_name, } 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/wireless/rf-profile/{rfProfileName}') 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_f3790386da5cd49480cb0503e59047_v2_2_3_3', json_data)