cisco.dnac.device_enrichment_details_info (6.13.3) — module

Information module for Device Enrichment 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 Enrichment Details.

Enriches a given network device context device id or device Mac Address or device management IP address with details about the device and neighbor topology.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get all Device Enrichment Details
  cisco.dnac.device_enrichment_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}}"
  register: result

Inputs

    
headers:
    description: Additional headers.
    type: dict

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

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

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

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
  elements: dict
  returned: always
  sample: "[\n  {\n    \"deviceDetails\": {\n      \"family\": \"string\",\n     \
    \ \"type\": \"string\",\n      \"location\": {},\n      \"errorCode\": \"string\"\
    ,\n      \"macAddress\": \"string\",\n      \"role\": \"string\",\n      \"apManagerInterfaceIp\"\
    : \"string\",\n      \"associatedWlcIp\": \"string\",\n      \"bootDateTime\"\
    : \"string\",\n      \"collectionStatus\": \"string\",\n      \"interfaceCount\"\
    : \"string\",\n      \"lineCardCount\": \"string\",\n      \"lineCardId\": \"\
    string\",\n      \"managementIpAddress\": \"string\",\n      \"memorySize\": \"\
    string\",\n      \"platformId\": \"string\",\n      \"reachabilityFailureReason\"\
    : \"string\",\n      \"reachabilityStatus\": \"string\",\n      \"snmpContact\"\
    : \"string\",\n      \"snmpLocation\": \"string\",\n      \"tunnelUdpPort\": {},\n\
    \      \"waasDeviceMode\": {},\n      \"series\": \"string\",\n      \"inventoryStatusDetail\"\
    : \"string\",\n      \"collectionInterval\": \"string\",\n      \"serialNumber\"\
    : \"string\",\n      \"softwareVersion\": \"string\",\n      \"roleSource\": \"\
    string\",\n      \"hostname\": \"string\",\n      \"upTime\": \"string\",\n  \
    \    \"lastUpdateTime\": 0,\n      \"errorDescription\": \"string\",\n      \"\
    locationName\": {},\n      \"tagCount\": \"string\",\n      \"lastUpdated\": \"\
    string\",\n      \"instanceUuid\": \"string\",\n      \"id\": \"string\",\n  \
    \    \"neighborTopology\": [\n        {\n          \"nodes\": [\n            {\n\
    \              \"role\": \"string\",\n              \"name\": \"string\",\n  \
    \            \"id\": \"string\",\n              \"description\": \"string\",\n\
    \              \"deviceType\": \"string\",\n              \"platformId\": \"string\"\
    ,\n              \"family\": \"string\",\n              \"ip\": \"string\",\n\
    \              \"softwareVersion\": \"string\",\n              \"userId\": {},\n\
    \              \"nodeType\": \"string\",\n              \"radioFrequency\": {},\n\
    \              \"clients\": {},\n              \"count\": {},\n              \"\
    healthScore\": 0,\n              \"level\": 0,\n              \"fabricGroup\"\
    : {},\n              \"connectedDevice\": {}\n            }\n          ],\n  \
    \        \"links\": [\n            {\n              \"source\": \"string\",\n\
    \              \"linkStatus\": \"string\",\n              \"label\": [\n     \
    \           {}\n              ],\n              \"target\": \"string\",\n    \
    \          \"id\": {},\n              \"portUtilization\": {}\n            }\n\
    \          ]\n        }\n      ]\n    }\n  }\n]\n"
  type: list

See also