/ home / cisco / cisco.dnac / 6.13.3 / module / device_details_info

cisco.dnac.device_details_info (6.13.3) — module

Information module for Device Details

| "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 Device Details.

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Device Details
  cisco.dnac.device_details_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}}"
    timestamp: string
    searchBy: string
    identifier: string
  register: result

Inputs

    
headers:
    description: Additional headers.
    type: dict

searchBy:
    description:
    - SearchBy query parameter. MAC Address or Device Name value or UUID of the network
      device.
    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

timestamp:
    description:
    - Timestamp query parameter. Epoch time(in milliseconds) when the device data is required.
    type: str

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

identifier:
    description:
    - Identifier query parameter. One of keywords macAddress or uuid or nwDeviceName.
    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

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

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

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"HALastResetReason\": \"string\",\n  \"managementIpAddr\": \"string\"\
    ,\n  \"HAPrimaryPowerStatus\": \"string\",\n  \"redundancyMode\": \"string\",\n\
    \  \"communicationState\": \"string\",\n  \"nwDeviceName\": \"string\",\n  \"\
    redundancyUnit\": \"string\",\n  \"platformId\": \"string\",\n  \"redundancyPeerState\"\
    : \"string\",\n  \"nwDeviceId\": \"string\",\n  \"redundancyState\": \"string\"\
    ,\n  \"nwDeviceRole\": \"string\",\n  \"nwDeviceFamily\": \"string\",\n  \"macAddress\"\
    : \"string\",\n  \"collectionStatus\": \"string\",\n  \"deviceSeries\": \"string\"\
    ,\n  \"osType\": \"string\",\n  \"clientCount\": \"string\",\n  \"HASecondaryPowerStatus\"\
    : \"string\",\n  \"softwareVersion\": \"string\",\n  \"nwDeviceType\": \"string\"\
    ,\n  \"overallHealth\": 0,\n  \"memoryScore\": 0,\n  \"cpuScore\": 0,\n  \"noiseScore\"\
    : 0,\n  \"utilizationScore\": 0,\n  \"airQualityScore\": 0,\n  \"interferenceScore\"\
    : 0,\n  \"wqeScore\": 0,\n  \"freeMbufScore\": 0,\n  \"packetPoolScore\": 0,\n\
    \  \"freeTimerScore\": 0,\n  \"memory\": \"string\",\n  \"cpu\": \"string\",\n\
    \  \"noise\": \"string\",\n  \"utilization\": \"string\",\n  \"airQuality\": \"\
    string\",\n  \"interference\": \"string\",\n  \"wqe\": \"string\",\n  \"freeMbuf\"\
    : \"string\",\n  \"packetPool\": \"string\",\n  \"freeTimer\": \"string\",\n \
    \ \"location\": \"string\",\n  \"timestamp\": \"string\"\n}\n"
  type: dict