/ home / cisco / cisco.dnac / 6.13.3 / module / network_device_lexicographically_sorted_info

cisco.dnac.network_device_lexicographically_sorted_info (6.13.3) — module

Information module for Network Device Lexicographically Sorted

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Network Device Lexicographically Sorted.

Returns the list of values of the first given required parameter.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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

Inputs

    
role:
    description:
    - Role query parameter.
    type: str

type:
    description:
    - Type query parameter.
    type: str

limit:
    description:
    - Limit query parameter.
    type: int

family:
    description:
    - Family query parameter.
    type: str

offset:
    description:
    - Offset query parameter.
    type: int

series:
    description:
    - Series query parameter.
    type: str

upTime:
    description:
    - UpTime query parameter.
    type: str

headers:
    description: Additional headers.
    type: dict

vrfName:
    description:
    - VrfName query parameter.
    type: str

hostname:
    description:
    - Hostname query parameter.
    type: str

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

errorCode:
    description:
    - ErrorCode query parameter.
    type: str

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

macAddress:
    description:
    - MacAddress query parameter.
    type: str

platformId:
    description:
    - PlatformId query parameter.
    type: str

roleSource:
    description:
    - RoleSource query parameter.
    type: str

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

serialNumber:
    description:
    - SerialNumber query parameter.
    type: str

softwareType:
    description:
    - SoftwareType query parameter.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

associatedWlcIp:
    description:
    - AssociatedWlcIp query parameter.
    type: str

softwareVersion:
    description:
    - SoftwareVersion query parameter.
    type: str

collectionStatus:
    description:
    - CollectionStatus query parameter.
    type: str

collectionInterval:
    description:
    - CollectionInterval query parameter.
    type: str

reachabilityStatus:
    description:
    - ReachabilityStatus query parameter.
    type: str

managementIpAddress:
    description:
    - ManagementIpAddress query parameter.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

reachabilityFailureReason:
    description:
    - ReachabilityFailureReason query parameter.
    type: str

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": [\n    \"string\"\n  ],\n  \"version\": \"string\"\n\
    }\n"
  type: dict