Source code for dnacentersdk.api.v2_3_7_6.platform
# -*- coding: utf-8 -*-
"""Cisco DNA Center Platform API wrapper.
Copyright (c) 2024 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 builtins import *
from ...restsession import RestSession
from ...utils import (
apply_path_params,
check_type,
dict_from_items_with_values,
dict_of_str,
)
[docs]class Platform(object):
"""Cisco DNA Center Platform API (version: 2.3.7.6).
Wraps the DNA Center Platform
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 Platform
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(Platform, self).__init__()
self._session = session
self._object_factory = object_factory
self._request_validator = request_validator
[docs] def cisco_dna_center_packages_summary_v1(self, headers=None, **request_parameters):
"""Provides information such as name, version of packages installed on the DNA center. .
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.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!cisco-dna-center-packages-summary
"""
check_type(headers, dict)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, 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/dnac-packages"
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_c3bdcd996dd5d988d0d77ce8f732014_v2_3_7_6", json_data
)
[docs] def release_summary_v1(self, headers=None, **request_parameters):
"""Provides information such as API version, mandatory core packages for installation or upgrade, optional
packages, Cisco DNACenter name and version, supported direct updates, and tenant ID. .
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.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!cisco-dna-center-release-summary
"""
check_type(headers, dict)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, 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/dnac-release"
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_c9b144b5dc2ba26e51798f8bede_v2_3_7_6", json_data
)
[docs] def nodes_configuration_summary_v1(self, headers=None, **request_parameters):
"""Provides details about the current Cisco DNACenter node configuration, such as API version, node name, NTP
server, intracluster link, LACP mode, network static routes, DNS server, subnet mask, host IP, default
gateway, and interface information. .
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.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!cisco-dna-center-nodes-configuration-summary
"""
check_type(headers, dict)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, 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/nodes-config"
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_f0c26c266e552d6b0f1f68da8e60e16_v2_3_7_6", json_data
)
# Alias Function
[docs] def nodes_configuration_summary(self, headers=None, **request_parameters):
"""This function is an alias of nodes_configuration_summary_v1 .
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:
This function returns the output of nodes_configuration_summary_v1 .
"""
return self.nodes_configuration_summary_v1(
headers=headers, **request_parameters
)
# Alias Function
[docs] def cisco_dna_center_packages_summary(self, headers=None, **request_parameters):
"""This function is an alias of cisco_dna_center_packages_summary_v1 .
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:
This function returns the output of cisco_dna_center_packages_summary_v1 .
"""
return self.cisco_dna_center_packages_summary_v1(
headers=headers, **request_parameters
)
# Alias Function
[docs] def release_summary(self, headers=None, **request_parameters):
"""This function is an alias of release_summary_v1 .
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:
This function returns the output of release_summary_v1 .
"""
return self.release_summary_v1(headers=headers, **request_parameters)