cisco.dnac.discovery – Resource module for Discovery

Note

This plugin is part of the cisco.dnac collection (version 3.0.0).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.discovery.

New in version 1.0.0: of cisco.dnac

Synopsis

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

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
attributeInfo
dictionary
Discovery's attributeInfo.
cdpLevel
integer
Discovery's cdpLevel.
deviceIds
string
Discovery's deviceIds.
discoveryCondition
string
Discovery's discoveryCondition.
discoveryStatus
string
Discovery's discoveryStatus.
discoveryType
string
Discovery's discoveryType.
enablePasswordList
string
Discovery's enablePasswordList.
globalCredentialIdList
list / elements=string
Discovery's globalCredentialIdList.
httpReadCredential
dictionary
Discovery's httpReadCredential.
comments
string
Discovery's comments.
credentialType
string
Discovery's credentialType.
description
string
Discovery's description.
id
string
Discovery's id.
instanceTenantId
string
Discovery's instanceTenantId.
instanceUuid
string
Discovery's instanceUuid.
password
string
Discovery's password.
port
integer
Discovery's port.
secure
boolean
    Choices:
  • no
  • yes
Secure flag.
username
string
Discovery's username.
httpWriteCredential
dictionary
Discovery's httpWriteCredential.
comments
string
Discovery's comments.
credentialType
string
Discovery's credentialType.
description
string
Discovery's description.
id
string
Discovery's id.
instanceTenantId
string
Discovery's instanceTenantId.
instanceUuid
string
Discovery's instanceUuid.
password
string
Discovery's password.
port
integer
Discovery's port.
secure
boolean
    Choices:
  • no
  • yes
Secure flag.
username
string
Discovery's username.
id
string
Id path parameter. Discovery ID.
ipAddressList
string
Discovery's ipAddressList.
ipFilterList
string
Discovery's ipFilterList.
isAutoCdp
boolean
    Choices:
  • no
  • yes
IsAutoCdp flag.
lldpLevel
integer
Discovery's lldpLevel.
name
string
Discovery's name.
netconfPort
string
Discovery's netconfPort.
numDevices
integer
Discovery's numDevices.
parentDiscoveryId
string
Discovery's parentDiscoveryId.
passwordList
string
Discovery's passwordList.
preferredMgmtIPMethod
string
Discovery's preferredMgmtIPMethod.
protocolOrder
string
Discovery's protocolOrder.
retry
integer
Discovery's retry.
retryCount
integer
Discovery's retryCount.
snmpAuthPassphrase
string
Discovery's snmpAuthPassphrase.
snmpAuthProtocol
string
Discovery's snmpAuthProtocol.
snmpMode
string
Discovery's snmpMode.
snmpPrivPassphrase
string
Discovery's snmpPrivPassphrase.
snmpPrivProtocol
string
Discovery's snmpPrivProtocol.
snmpROCommunity
string
Discovery's snmpROCommunity.
snmpRoCommunity
string
Discovery's snmpRoCommunity.
snmpROCommunityDesc
string
Discovery's snmpROCommunityDesc.
snmpRoCommunityDesc
string
Discovery's snmpRoCommunityDesc.
snmpRWCommunity
string
Discovery's snmpRWCommunity.
snmpRwCommunity
string
Discovery's snmpRwCommunity.
snmpRWCommunityDesc
string
Discovery's snmpRWCommunityDesc.
snmpRwCommunityDesc
string
Discovery's snmpRwCommunityDesc.
snmpUserName
string
Discovery's snmpUserName.
snmpVersion
string
Discovery's snmpVersion.
timeOut
integer
Discovery's timeOut.
timeout
integer
Discovery's timeout.
updateMgmtIp
boolean
    Choices:
  • no
  • yes
UpdateMgmtIp flag.
userNameList
string
Discovery's userNameList.

See Also

See also

Discovery reference

Complete reference of the Discovery object model.

Examples

- 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

- name: Update 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: 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

- 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

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "response": { "taskId": {}, "url": "string" }, "version": "string" }


Authors

  • Rafael Campos (@racampos)