cisco.dnac.network_device_lexicographically_sorted_info module – Information module for Network Device Lexicographically Sorted
Note
This module is part of the cisco.dnac collection (version 6.18.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_device_lexicographically_sorted_info
.
New in cisco.dnac 3.1.0
Synopsis
Get all Network Device Lexicographically Sorted.
Returns the list of values of the first given required parameter.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
AssociatedWlcIp query parameter. |
|
CollectionInterval query parameter. |
|
CollectionStatus 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. |
|
Family query parameter. |
|
Additional headers. |
|
Hostname query parameter. |
|
Limit query parameter. |
|
MacAddress query parameter. |
|
ManagementIpAddress query parameter. |
|
Offset query parameter. |
|
PlatformId query parameter. |
|
ReachabilityFailureReason query parameter. |
|
ReachabilityStatus query parameter. |
|
Role query parameter. |
|
RoleSource 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:
|
|
VrfName query parameter. |
Notes
Note
SDK Method used are devices.Devices.get_device_values_that_match_fully_or_partially_an_attribute,
Paths used are get /dna/intent/api/v1/network-device/autocomplete,
Supports
check_mode
The 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 GetDeviceValuesThatMatchFullyOrPartiallyAnAttribute
Complete reference of the GetDeviceValuesThatMatchFullyOrPartiallyAnAttribute API.
Examples
- name: Get all Network Device Lexicographically Sorted
cisco.dnac.network_device_lexicographically_sorted_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}}"
vrfName: string
managementIpAddress: string
hostname: string
macAddress: string
family: string
collectionStatus: string
collectionInterval: string
softwareVersion: string
softwareType: string
reachabilityStatus: string
reachabilityFailureReason: string
errorCode: string
platformId: string
series: string
type: string
serialNumber: string
upTime: string
role: string
roleSource: string
associatedWlcIp: string
offset: 0
limit: 0
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: |