cisco.dnac.network_device_info module – Information module for Network Device
Note
This module is part of the cisco.dnac collection (version 6.7.2).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.network_device_info.
New in cisco.dnac 3.1.0
Synopsis
Get all Network Device.
Get Network Device by id.
Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc.
Returns the network device details for the given device ID.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.5.5
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
AssociatedWlcIp query parameter. |
|
CollectionInterval query parameter. |
|
CollectionStatus query parameter. |
|
DeviceSupportLevel query parameter. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
ErrorCode query parameter. |
|
ErrorDescription query parameter. |
|
Family query parameter. |
|
Additional headers. |
|
Hostname query parameter. |
|
Id query parameter. Accepts comma separated ids and return list of network-devices for the given ids. If invalid or not-found ids are provided, null entry will be returned in the list. |
|
License.name query parameter. |
|
License.status query parameter. |
|
License.type query parameter. |
|
Limit query parameter. 1 <= limit <= 500 max. No. Of devices to be returned in the result. |
|
Location query parameter. |
|
LocationName query parameter. |
|
MacAddress query parameter. |
|
ManagementIpAddress query parameter. |
|
Module+equpimenttype query parameter. |
|
Module+name query parameter. |
|
Module+operationstatecode query parameter. |
|
Module+partnumber query parameter. |
|
Module+servicestate query parameter. |
|
Module+vendorequipmenttype query parameter. |
|
NotSyncedForMinutes query parameter. |
|
Offset query parameter. Offset >= 1 X gives results from Xth device onwards. |
|
PlatformId query parameter. |
|
ReachabilityStatus query parameter. |
|
Role query parameter. |
|
SerialNumber query parameter. |
|
Series query parameter. |
|
SoftwareType query parameter. |
|
SoftwareVersion query parameter. |
|
Type query parameter. |
|
UpTime query parameter. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are devices.Devices.get_device_by_id, devices.Devices.get_device_list,
Paths used are get /dna/intent/api/v1/network-device, get /dna/intent/api/v1/network-device/{id},
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Devices GetDeviceByID
Complete reference of the GetDeviceByID API.
- Cisco DNA Center documentation for Devices GetDeviceList
Complete reference of the GetDeviceList API.
Examples
- name: Get all Network Device
cisco.dnac.network_device_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: "{{my_headers | from_json}}"
hostname: []
managementIpAddress: []
macAddress: []
locationName: []
serialNumber: []
location: []
family: []
type: []
series: []
collectionStatus: []
collectionInterval: []
notSyncedForMinutes: []
errorCode: []
errorDescription: []
softwareVersion: []
softwareType: []
platformId: []
role: []
reachabilityStatus: []
upTime: []
associatedWlcIp: []
license_name: []
license_type: []
license_status: []
module_name: []
module_equpimenttype: []
module_servicestate: []
module_vendorequipmenttype: []
module_partnumber: []
module_operationstatecode: []
id: string
deviceSupportLevel: string
offset: 0
limit: 0
register: result
- name: Get Network Device by id
cisco.dnac.network_device_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: "{{my_headers | from_json}}"
id: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |