.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.dnac.network_device_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.network_device_info -- Information module for Network Device +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. 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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.network_device_info`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get all Network Device. - Get Network Device by id. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk >= 2.3.3 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
associatedWlcIp
list / elements=string
AssociatedWlcIp query parameter.
collectionInterval
list / elements=string
CollectionInterval query parameter.
collectionStatus
list / elements=string
CollectionStatus query parameter.
deviceSupportLevel
string
DeviceSupportLevel 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
list / elements=string
ErrorCode query parameter.
errorDescription
list / elements=string
ErrorDescription query parameter.
family
list / elements=string
Family query parameter.
headers
dictionary
Additional headers.
hostname
list / elements=string
Hostname query parameter.
id
string
Id query parameter. Accepts comma separated ids and return list of network-devices for the given ids. If invalid or not-found ids are provided, null entry will be returned in the list.
license_name
list / elements=string
License.name query parameter.
license_status
list / elements=string
License.status query parameter.
license_type
list / elements=string
License.type query parameter.
location
list / elements=string
Location query parameter.
locationName
list / elements=string
LocationName query parameter.
macAddress
list / elements=string
MacAddress query parameter.
managementIpAddress
list / elements=string
ManagementIpAddress query parameter.
module_equpimenttype
list / elements=string
Module+equpimenttype query parameter.
module_name
list / elements=string
Module+name query parameter.
module_operationstatecode
list / elements=string
Module+operationstatecode query parameter.
module_partnumber
list / elements=string
Module+partnumber query parameter.
module_servicestate
list / elements=string
Module+servicestate query parameter.
module_vendorequipmenttype
list / elements=string
Module+vendorequipmenttype query parameter.
notSyncedForMinutes
list / elements=string
NotSyncedForMinutes query parameter.
platformId
list / elements=string
PlatformId query parameter.
reachabilityStatus
list / elements=string
ReachabilityStatus query parameter.
role
list / elements=string
Role query parameter.
serialNumber
list / elements=string
SerialNumber query parameter.
series
list / elements=string
Series query parameter.
softwareType
list / elements=string
SoftwareType query parameter.
softwareVersion
list / elements=string
SoftwareVersion query parameter.
type
list / elements=string
Type query parameter.
upTime
list / elements=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.

.. Attributes .. Notes 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 .. Seealso See Also -------- .. seealso:: `Network Device reference `_ Complete reference of the Network Device object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Get all Network Device cisco.dnac.network_device_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 hostname: [] managementIpAddress: [] macAddress: [] locationName: [] serialNumber: [] location: [] family: [] type: [] series: [] collectionStatus: [] collectionInterval: [] notSyncedForMinutes: [] errorCode: [] errorDescription: [] softwareVersion: [] softwareType: [] platformId: [] role: [] reachabilityStatus: [] upTime: [] associatedWlcIp: [] license_name: [] license_type: [] license_status: [] module_name: [] module_equpimenttype: [] module_servicestate: [] module_vendorequipmenttype: [] module_partnumber: [] module_operationstatecode: [] id: string deviceSupportLevel: string register: result - name: Get Network Device by id cisco.dnac.network_device_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 id: string register: result .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "response": { "apManagerInterfaceIp": "string", "associatedWlcIp": "string", "bootDateTime": "string", "collectionInterval": "string", "collectionStatus": "string", "errorCode": "string", "errorDescription": "string", "family": "string", "hostname": "string", "id": "string", "instanceTenantId": "string", "instanceUuid": "string", "interfaceCount": "string", "inventoryStatusDetail": "string", "lastUpdateTime": 0, "lastUpdated": "string", "lineCardCount": "string", "lineCardId": "string", "location": "string", "locationName": "string", "macAddress": "string", "managementIpAddress": "string", "memorySize": "string", "platformId": "string", "reachabilityFailureReason": "string", "reachabilityStatus": "string", "role": "string", "roleSource": "string", "serialNumber": "string", "series": "string", "snmpContact": "string", "snmpLocation": "string", "softwareType": "string", "softwareVersion": "string", "tagCount": "string", "tunnelUdpPort": "string", "type": "string", "upTime": "string", "waasDeviceMode": "string", "uptimeSeconds": 0 }, "version": "string" }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors