cisco.dnac.network_device_lexicographically_sorted_info – Information module for Network Device Lexicographically Sorted

Note

This plugin is part of the cisco.dnac collection (version 3.2.3).

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.

To use it in a playbook, specify: cisco.dnac.network_device_lexicographically_sorted_info.

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get all Network Device Lexicographically Sorted.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.3.3

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
associatedWlcIp
string
AssociatedWlcIp query parameter.
collectionInterval
string
CollectionInterval query parameter.
collectionStatus
string
CollectionStatus query parameter.
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.2.3"
Informs the SDK which version of Cisco DNA Center to use.
errorCode
string
ErrorCode query parameter.
family
string
Family query parameter.
headers
dictionary
Additional headers.
hostname
string
Hostname query parameter.
limit
string
Limit query parameter.
macAddress
string
MacAddress query parameter.
managementIpAddress
string
ManagementIpAddress query parameter.
offset
string
Offset query parameter.
platformId
string
PlatformId query parameter.
reachabilityFailureReason
string
ReachabilityFailureReason query parameter.
reachabilityStatus
string
ReachabilityStatus query parameter.
role
string
Role query parameter.
roleSource
string
RoleSource query parameter.
serialNumber
string
SerialNumber query parameter.
series
string
Series query parameter.
softwareType
string
SoftwareType query parameter.
softwareVersion
string
SoftwareVersion query parameter.
type
string
Type query parameter.
upTime
string
UpTime query parameter.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
vrfName
string
VrfName query parameter.

Notes

Note

  • 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

Network Device Lexicographically Sorted reference

Complete reference of the Network Device Lexicographically Sorted object model.

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:
      custom: value
    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: string
    limit: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dnac_response
string
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
"string"


Authors

  • Rafael Campos (@racampos)