cisco.dnac.discovery (6.13.3) — module

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

Manage operations create, update and delete of the resource Discovery.

Initiates discovery with the given parameters.

Stops all the discoveries and removes them.

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the "Get Discoveries by range" API.

Stops or starts an existing discovery.

Requirements

• dnacentersdk >= 2.6.0
• python >= 3.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete all
  cisco.dnac.discovery:
    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}}"
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Update all
  cisco.dnac.discovery:
    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}}"
    state: present
    attributeInfo: {}
    cdpLevel: 0
    deviceIds: string
    discoveryCondition: string
    discoveryStatus: string
    discoveryType: string
    enablePasswordList: string
    globalCredentialIdList:
    - string
    httpReadCredential:
      comments: string
      credentialType: string
      description: string
      id: string
      instanceTenantId: string
      instanceUuid: string
      password: string
      port: 0
      secure: true
      username: string
    httpWriteCredential:
      comments: string
      credentialType: string
      description: string
      id: string
      instanceTenantId: string
      instanceUuid: string
      password: string
      port: 0
      secure: true
      username: string
    id: string
    ipAddressList: string
    ipFilterList: string
    isAutoCdp: true
    lldpLevel: 0
    name: string
    netconfPort: string
    numDevices: 0
    parentDiscoveryId: string
    passwordList: string
    preferredMgmtIPMethod: string
    protocolOrder: string
    retryCount: 0
    snmpAuthPassphrase: string
    snmpAuthProtocol: string
    snmpMode: string
    snmpPrivPassphrase: string
    snmpPrivProtocol: string
    snmpRoCommunity: string
    snmpRoCommunityDesc: string
    snmpRwCommunity: string
    snmpRwCommunityDesc: string
    snmpUserName: string
    timeOut: 0
    updateMgmtIp: true
    userNameList: string

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create
  cisco.dnac.discovery:
    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}}"
    state: present
    cdpLevel: 0
    discoveryType: string
    enablePasswordList:
    - string
    globalCredentialIdList:
    - string
    httpReadCredential:
      password: string
      port: 0
      secure: true
      username: string
    httpWriteCredential:
      password: string
      port: 0
      secure: true
      username: string
    ipAddressList: string
    ipFilterList:
    - string
    lldpLevel: 0
    name: string
    netconfPort: string
    passwordList:
    - string
    preferredMgmtIPMethod: string
    protocolOrder: string
    retry: 0
    snmpAuthPassphrase: string
    snmpAuthProtocol: string
    snmpMode: string
    snmpPrivPassphrase: string
    snmpPrivProtocol: string
    snmpROCommunity: string
    snmpROCommunityDesc: string
    snmpRWCommunity: string
    snmpRWCommunityDesc: string
    snmpUserName: string
    snmpVersion: string
    timeout: 0
    userNameList:
    - string

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete by id
  cisco.dnac.discovery:
    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}}"
    state: absent
    id: string

Inputs

    
id:
    description: Discovery's id.
    type: str

name:
    description: Discovery's name.
    type: str

retry:
    description: Number of times to try establishing connection to device.
    type: int

timeOut:
    description: Discovery's timeOut.
    type: int

timeout:
    description: Time to wait for device response in seconds.
    type: int

cdpLevel:
    description: Discovery's cdpLevel.
    type: int

snmpMode:
    description: Discovery's snmpMode.
    type: str

deviceIds:
    description: Discovery's deviceIds.
    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

isAutoCdp:
    description: IsAutoCdp flag.
    type: bool

lldpLevel:
    description: Discovery's lldpLevel.
    type: int

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

numDevices:
    description: Discovery's numDevices.
    type: int

retryCount:
    description: Discovery's retryCount.
    type: int

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

netconfPort:
    description: Discovery's netconfPort.
    type: str

snmpVersion:
    description: Version of SNMP. V2 or v3.
    type: str

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

ipFilterList:
    description: Discovery's ipFilterList.
    type: str

passwordList:
    description: Discovery's passwordList.
    type: str

snmpUserName:
    description: Discovery's snmpUserName.
    type: str

updateMgmtIp:
    description: UpdateMgmtIp flag.
    type: bool

userNameList:
    description: Discovery's userNameList.
    type: str

attributeInfo:
    description: Discovery's attributeInfo.
    type: dict

discoveryType:
    description: Discovery's discoveryType.
    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

ipAddressList:
    description: Discovery's ipAddressList.
    type: str

protocolOrder:
    description: Discovery's protocolOrder.
    type: str

discoveryStatus:
    description: Discovery's discoveryStatus.
    type: str

snmpROCommunity:
    description: Snmp RO community of the devices to be discovered.
    type: str

snmpRWCommunity:
    description: Snmp RW community of the devices to be discovered.
    type: str

snmpRoCommunity:
    description: Discovery's snmpRoCommunity.
    type: str

snmpRwCommunity:
    description: Discovery's snmpRwCommunity.
    type: str

snmpAuthProtocol:
    description: Discovery's snmpAuthProtocol.
    type: str

snmpPrivProtocol:
    description: Discovery's snmpPrivProtocol.
    type: str

parentDiscoveryId:
    description: Discovery's parentDiscoveryId.
    type: str

discoveryCondition:
    description: Discovery's discoveryCondition.
    type: str

enablePasswordList:
    description: Discovery's enablePasswordList.
    type: str

httpReadCredential:
    description: Discovery's httpReadCredential.
    suboptions:
      comments:
        description: Discovery's comments.
        type: str
      credentialType:
        description: Discovery's credentialType.
        type: str
      description:
        description: Discovery's description.
        type: str
      id:
        description: Discovery's id.
        type: str
      instanceTenantId:
        description: Discovery's instanceTenantId.
        type: str
      instanceUuid:
        description: Discovery's instanceUuid.
        type: str
      password:
        description: Discovery's password.
        type: str
      port:
        description: Discovery's port.
        type: int
      secure:
        description: Secure flag.
        type: bool
      username:
        description: Discovery's username.
        type: str
    type: dict

snmpAuthPassphrase:
    description: Discovery's snmpAuthPassphrase.
    type: str

snmpPrivPassphrase:
    description: Discovery's snmpPrivPassphrase.
    type: str

httpWriteCredential:
    description: Discovery's httpWriteCredential.
    suboptions:
      comments:
        description: Discovery's comments.
        type: str
      credentialType:
        description: Discovery's credentialType.
        type: str
      description:
        description: Discovery's description.
        type: str
      id:
        description: Discovery's id.
        type: str
      instanceTenantId:
        description: Discovery's instanceTenantId.
        type: str
      instanceUuid:
        description: Discovery's instanceUuid.
        type: str
      password:
        description: Discovery's password.
        type: str
      port:
        description: Discovery's port.
        type: int
      secure:
        description: Secure flag.
        type: bool
      username:
        description: Discovery's username.
        type: str
    type: dict

snmpROCommunityDesc:
    description: Description for Snmp RO community.
    type: str

snmpRWCommunityDesc:
    description: Description for Snmp RW community.
    type: str

snmpRoCommunityDesc:
    description: Discovery's snmpRoCommunityDesc.
    type: str

snmpRwCommunityDesc:
    description: Discovery's snmpRwCommunityDesc.
    type: str

preferredMgmtIPMethod:
    description: Discovery's preferredMgmtIPMethod.
    type: str

globalCredentialIdList:
    description: Discovery's globalCredentialIdList.
    elements: str
    type: list

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    \"taskId\": \"string\",\n    \"url\": \"string\"\
    \n  },\n  \"version\": \"string\"\n}\n"
  type: dict

See also

• Cisco DNA Center documentation for Discovery StartDiscovery: Complete reference of the StartDiscovery API. link
• Cisco DNA Center documentation for Discovery DeleteAllDiscovery: Complete reference of the DeleteAllDiscovery API. link
• Cisco DNA Center documentation for Discovery DeleteDiscoveryById: Complete reference of the DeleteDiscoveryById API. link
• Cisco DNA Center documentation for Discovery UpdatesAnExistingDiscoveryBySpecifiedId: Complete reference of the UpdatesAnExistingDiscoveryBySpecifiedId API. link