/ home / cisco / cisco.dnac / 6.13.3 / module / discovery_range_info

cisco.dnac.discovery_range_info (6.13.3) — module

Information module for Discovery Range

| "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 Range.

Returns the discovery by specified range.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Discovery Range
  cisco.dnac.discovery_range_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}}"
    startIndex: 0
    recordsToReturn: 0
  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

startIndex:
    description:
    - StartIndex path parameter. Start index.
    type: int

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

recordsToReturn:
    description:
    - RecordsToReturn path parameter. Number of records to return.
    type: int

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      \"attributeInfo\": {},\n      \"cdpLevel\"\
    : 0,\n      \"deviceIds\": \"string\",\n      \"discoveryCondition\": \"string\"\
    ,\n      \"discoveryStatus\": \"string\",\n      \"discoveryType\": \"string\"\
    ,\n      \"enablePasswordList\": \"string\",\n      \"globalCredentialIdList\"\
    : [\n        \"string\"\n      ],\n      \"httpReadCredential\": {\n        \"\
    comments\": \"string\",\n        \"credentialType\": \"string\",\n        \"description\"\
    : \"string\",\n        \"id\": \"string\",\n        \"instanceTenantId\": \"string\"\
    ,\n        \"instanceUuid\": \"string\",\n        \"password\": \"string\",\n\
    \        \"port\": 0,\n        \"secure\": true,\n        \"username\": \"string\"\
    \n      },\n      \"httpWriteCredential\": {\n        \"comments\": \"string\"\
    ,\n        \"credentialType\": \"string\",\n        \"description\": \"string\"\
    ,\n        \"id\": \"string\",\n        \"instanceTenantId\": \"string\",\n  \
    \      \"instanceUuid\": \"string\",\n        \"password\": \"string\",\n    \
    \    \"port\": 0,\n        \"secure\": true,\n        \"username\": \"string\"\
    \n      },\n      \"id\": \"string\",\n      \"ipAddressList\": \"string\",\n\
    \      \"ipFilterList\": \"string\",\n      \"isAutoCdp\": true,\n      \"lldpLevel\"\
    : 0,\n      \"name\": \"string\",\n      \"netconfPort\": \"string\",\n      \"\
    numDevices\": 0,\n      \"parentDiscoveryId\": \"string\",\n      \"passwordList\"\
    : \"string\",\n      \"preferredMgmtIPMethod\": \"string\",\n      \"protocolOrder\"\
    : \"string\",\n      \"retryCount\": 0,\n      \"snmpAuthPassphrase\": \"string\"\
    ,\n      \"snmpAuthProtocol\": \"string\",\n      \"snmpMode\": \"string\",\n\
    \      \"snmpPrivPassphrase\": \"string\",\n      \"snmpPrivProtocol\": \"string\"\
    ,\n      \"snmpRoCommunity\": \"string\",\n      \"snmpRoCommunityDesc\": \"string\"\
    ,\n      \"snmpRwCommunity\": \"string\",\n      \"snmpRwCommunityDesc\": \"string\"\
    ,\n      \"snmpUserName\": \"string\",\n      \"timeOut\": 0,\n      \"updateMgmtIp\"\
    : true,\n      \"userNameList\": \"string\"\n    }\n  ],\n  \"version\": \"string\"\
    \n}\n"
  type: dict