cisco.dnac.network_devices_intent_v1_info module – Information module for Network Devices Intent V1
Note
This module is part of the cisco.dnac collection (version 6.27.0).
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_devices_intent_v1_info.
New in cisco.dnac 6.17.0
Synopsis
Get all Network Devices Intent V1.
API to fetch the list of network devices using basic filters. Use the `/dna/intent/api/v1/networkDevices/query` API for advanced filtering. Refer features for more details.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
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: |
|
Family query parameter. Product family of the network device. For example, Switches, Routers, etc. |
|
Additional headers. |
|
Id query parameter. Network device Id. |
|
Limit query parameter. The number of records to show for this page. Min 1, Max 500. |
|
ManagementAddress query parameter. Management address of the network device. |
|
ManagementState query parameter. The status of the network device’s manageability. Available statuses are MANAGED, UNDER_MAINTENANCE, NEVER_MANAGED. Refer features for more details. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. |
|
Order query parameter. Whether ascending or descending order should be used to sort the response. |
|
ReachabilityStatus query parameter. Reachability status of the network device. Available values REACHABLE, ONLY_PING_REACHABLE, UNREACHABLE, UNKNOWN. Refer features for more details. |
|
Role query parameter. Role assigned to the network device. Available values BORDER_ROUTER, CORE, DISTRIBUTION, ACCESS, UNKNOWN. |
|
SerialNumber query parameter. Serial number of the network device. |
|
SortBy query parameter. A property within the response to sort by. Available values id, managementAddress, dnsResolvedManagementIpAddress, hostname, macAddress, type, family, series, platformids, softwareType, softwareVersion, vendor, bootTime, role, roleSource, apEthernetMacAddress, apManagerInterfaceIpAddress, apWlcIpAddress, deviceSupportLevel, reachabilityFailureReason, resyncStartTime, resyncEndTime, resyncReasons, pendingResyncRequestCount, pendingResyncRequestReasons, resyncIntervalSource, resyncIntervalMinutes. |
|
StackDevice query parameter. Flag indicating if the device is a stack device. |
|
Status query parameter. Inventory related status of the network device. Available values MANAGED, SYNC_NOT_STARTED, SYNC_INIT_FAILED, SYNC_PRECHECK_FAILED, SYNC_IN_PROGRESS, SYNC_INTERNAL_ERROR, SYNC_DISABLED, DELETING_DEVICE, UNDER_MAINTENANCE, QUARANTINED, UNASSOCIATED, UNREACHABLE, UNKNOWN. Refer features for more details. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
Views query parameter. The specific views being requested. This is an optional parameter which can be passed to get one or more of the network device data. If this is not provided, then it will default to BASIC views. If multiple views are provided, the response will contain the union of the views. Refer features for more details. Available values BASIC, RESYNC, USER_DEFINED_FIELDS. |
Notes
Note
SDK Method used are devices.Devices.retrieve_network_devices_v1,
Paths used are get /dna/intent/api/v1/networkDevices,
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 RetrieveNetworkDevicesV1
Complete reference of the RetrieveNetworkDevicesV1 API.
Examples
- name: Get all Network Devices Intent V1
cisco.dnac.network_devices_intent_v1_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
managementAddress: string
serialNumber: string
family: string
stackDevice: string
role: string
status: string
reachabilityStatus: string
managementState: string
views: string
limit: string
offset: string
sortBy: string
order: 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: |