cisco.catalystcenter.network_device_lexicographically_sorted_v1_info module -- Information module for Network Device Lexicographically Sorted V1

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.network_device_lexicographically_sorted_v1_info.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Get all Network Device Lexicographically Sorted V1.

  • 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.

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

Default: :ansible-option-default:`443`

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

Default: :ansible-option-default:`"admin"`

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

Informs the SDK which version of Cisco CATALYST Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

associatedWlcIp

string

AssociatedWlcIp query parameter.

collectionInterval

string

CollectionInterval query parameter.

collectionStatus

string

CollectionStatus query parameter.

errorCode

string

ErrorCode query parameter.

family

string

Family query parameter.

headers

dictionary

Additional headers.

hostname

string

Hostname query parameter.

limit

integer

Limit query parameter. The number of records to show for this page. Min 1, Max 500.

macAddress

string

MacAddress query parameter.

managementIpAddress

string

ManagementIpAddress query parameter.

offset

integer

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

Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

vrfName

string

VrfName query parameter.

Notes

Note

  • SDK Method used are devices.Devices.get_device_values_that_match_fully_or_partially_an_attribute_v1,

  • 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 CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Devices GetDeviceValuesThatMatchFullyOrPartiallyAnAttributeV1

Complete reference of the GetDeviceValuesThatMatchFullyOrPartiallyAnAttributeV1 API.

Examples

- name: Get all Network Device Lexicographically Sorted V1
  cisco.catalystcenter.network_device_lexicographically_sorted_v1_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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

catalystcenter_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": ["string"], "version": "string"}`

Authors

  • Rafael Campos (@racampos)