Repository URL to install this package:
|
Version:
6.0.0 ▾
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: network_info
short_description: Information module for Network
description:
- Get all Network.
- API to get DHCP and DNS center server details.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module_info
author: Rafael Campos (@racampos)
options:
headers:
description: Additional headers.
type: dict
siteId:
description:
- SiteId query parameter. Site id to get the network settings associated with the site.
type: str
requirements:
- dnacentersdk >= 2.4.9
- python >= 3.5
notes:
- SDK Method used are
network_settings.NetworkSettings.get_network,
- Paths used are
get /dna/intent/api/v1/network,
"""
EXAMPLES = r"""
- name: Get all Network
cisco.dnac.network_info:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
headers:
custom: value
siteId: string
register: result
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"response": [
{
"instanceType": "string",
"instanceUuid": "string",
"namespace": "string",
"type": "string",
"key": "string",
"version": 0,
"value": [
{
"ipAddresses": [
"string"
],
"configureDnacIP": true
}
],
"groupUuid": "string",
"inheritedGroupUuid": "string",
"inheritedGroupName": "string"
}
],
"version": "string"
}
"""