/ home / cisco / cisco.dnac / 6.13.3 / module / discovery_device_info

cisco.dnac.discovery_device_info (6.13.3) — module

Information module for Discovery Device

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

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the "Get Discoveries by range" API.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Discovery Device
  cisco.dnac.discovery_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: "{{my_headers | from_json}}"
    taskId: string
    id: string
  register: result

Inputs

    
id:
    description:
    - Id path parameter. Discovery ID.
    type: str

taskId:
    description:
    - TaskId query parameter.
    type: str

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
  returned: always
  sample: "{\n  \"response\": [\n    {\n      \"anchorWlcForAp\": \"string\",\n  \
    \    \"authModelId\": \"string\",\n      \"avgUpdateFrequency\": 0,\n      \"\
    bootDateTime\": \"string\",\n      \"cliStatus\": \"string\",\n      \"duplicateDeviceId\"\
    : \"string\",\n      \"errorCode\": \"string\",\n      \"errorDescription\": \"\
    string\",\n      \"family\": \"string\",\n      \"hostname\": \"string\",\n  \
    \    \"httpStatus\": \"string\",\n      \"id\": \"string\",\n      \"imageName\"\
    : \"string\",\n      \"ingressQueueConfig\": \"string\",\n      \"interfaceCount\"\
    : \"string\",\n      \"inventoryCollectionStatus\": \"string\",\n      \"inventoryReachabilityStatus\"\
    : \"string\",\n      \"lastUpdated\": \"string\",\n      \"lineCardCount\": \"\
    string\",\n      \"lineCardId\": \"string\",\n      \"location\": \"string\",\n\
    \      \"locationName\": \"string\",\n      \"macAddress\": \"string\",\n    \
    \  \"managementIpAddress\": \"string\",\n      \"memorySize\": \"string\",\n \
    \     \"netconfStatus\": \"string\",\n      \"numUpdates\": 0,\n      \"pingStatus\"\
    : \"string\",\n      \"platformId\": \"string\",\n      \"portRange\": \"string\"\
    ,\n      \"qosStatus\": \"string\",\n      \"reachabilityFailureReason\": \"string\"\
    ,\n      \"reachabilityStatus\": \"string\",\n      \"role\": \"string\",\n  \
    \    \"roleSource\": \"string\",\n      \"serialNumber\": \"string\",\n      \"\
    snmpContact\": \"string\",\n      \"snmpLocation\": \"string\",\n      \"snmpStatus\"\
    : \"string\",\n      \"softwareVersion\": \"string\",\n      \"tag\": \"string\"\
    ,\n      \"tagCount\": 0,\n      \"type\": \"string\",\n      \"upTime\": \"string\"\
    ,\n      \"vendor\": \"string\",\n      \"wlcApDeviceStatus\": \"string\"\n  \
    \  }\n  ],\n  \"version\": \"string\"\n}\n"
  type: dict