cisco.dnac.discovery – Manage Discovery objects of Discovery

Note

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

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

• Stops all the discoveries and removes them.

• Initiates Discovery with the given parameters.

• Stops or starts an existing Discovery.

• Returns the count of all available Discovery jobs.

• Stops the Discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API.

• Returns Discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

• Stops Discovery for the given range and removes them.

• Returns the Discovery by specified range.

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			DiscoveryNIO's attributeInfo.
cdpLevel integer			InventoryRequest's cdpLevel. DiscoveryNIO's cdpLevel.
count boolean		Choices: no yes	If true gets the number of objects. Required for state query.
deviceIds string			DiscoveryNIO's deviceIds.
discoveryCondition string			DiscoveryNIO's DiscoveryCondition.
discoveryStatus string			DiscoveryNIO's DiscoveryStatus. Required for state update.
discoveryType string / required			InventoryRequest's DiscoveryType. DiscoveryNIO's DiscoveryType. Required for state create.
enablePasswordList raw			InventoryRequest's enablePasswordList (list of strings). DiscoveryNIO's enablePasswordList. Type list for state create. Type str for state update.
globalCredentialIdList list / elements=string			InventoryRequest's globalCredentialIdList (list of strings). DiscoveryNIO's globalCredentialIdList (list of strings).
httpReadCredential dictionary			InventoryRequest's httpReadCredential. DiscoveryNIO's httpReadCredential.
	comments string		It is the Discovery's comments.
	credentialType string		It is the Discovery's credentialType.
	description string		It is the Discovery's description.
	id string		It is the Discovery's id.
	instanceTenantId string		It is the Discovery's instanceTenantId.
	instanceUuid string		It is the Discovery's instanceUuid.
	password string		It is the Discovery's password.
	port integer		It is the Discovery's port.
	secure boolean	Choices: no yes	It is the Discovery's secure.
	username string		It is the Discovery's username.
httpWriteCredential dictionary			InventoryRequest's httpWriteCredential. DiscoveryNIO's httpWriteCredential.
	comments string		It is the Discovery's comments.
	credentialType string		It is the Discovery's credentialType.
	description string		It is the Discovery's description.
	id string		It is the Discovery's id.
	instanceTenantId string		It is the Discovery's instanceTenantId.
	instanceUuid string		It is the Discovery's instanceUuid.
	password string		It is the Discovery's password.
	port integer		It is the Discovery's port.
	secure boolean	Choices: no yes	It is the Discovery's secure.
	username string		It is the Discovery's username.
id string / required			DiscoveryNIO's id. Discovery ID.
ipAddressList string / required			InventoryRequest's ipAddressList. DiscoveryNIO's ipAddressList. Required for state create.
ipFilterList raw			InventoryRequest's ipFilterList (list of strings). DiscoveryNIO's ipFilterList. Type list for state create. Type str for state update.
isAutoCdp boolean		Choices: no yes	DiscoveryNIO's isAutoCdp.
lldpLevel integer			InventoryRequest's lldpLevel. DiscoveryNIO's lldpLevel.
name string / required			InventoryRequest's name. DiscoveryNIO's name. Required for state create.
netconfPort string			InventoryRequest's netconfPort. DiscoveryNIO's netconfPort.
noAddNewDevice boolean		Choices: no yes	InventoryRequest's noAddNewDevice.
numDevices integer			DiscoveryNIO's numDevices.
parentDiscoveryId string			InventoryRequest's parentDiscoveryId. DiscoveryNIO's parentDiscoveryId.
passwordList raw			InventoryRequest's passwordList (list of strings). DiscoveryNIO's passwordList. Type list for state create. Type str for state update.
preferredMgmtIPMethod string			InventoryRequest's preferredMgmtIPMethod. DiscoveryNIO's preferredMgmtIPMethod.
protocolOrder string			InventoryRequest's protocolOrder. DiscoveryNIO's protocolOrder.
records_to_delete integer			Number of records to delete. Required for state delete.
records_to_return integer			Number of records to return. Required for state query.
reDiscovery boolean		Choices: no yes	InventoryRequest's reDiscovery.
retry integer			InventoryRequest's retry.
retryCount integer			DiscoveryNIO's retryCount.
snmpAuthPassphrase string			InventoryRequest's snmpAuthPassphrase. DiscoveryNIO's snmpAuthPassphrase.
snmpAuthProtocol string			InventoryRequest's snmpAuthProtocol. DiscoveryNIO's snmpAuthProtocol.
snmpMode string			InventoryRequest's snmpMode. DiscoveryNIO's snmpMode.
snmpPrivPassphrase string			InventoryRequest's snmpPrivPassphrase. DiscoveryNIO's snmpPrivPassphrase.
snmpPrivProtocol string			InventoryRequest's snmpPrivProtocol. DiscoveryNIO's snmpPrivProtocol.
snmpROCommunity string			InventoryRequest's snmpROCommunity.
snmpRoCommunity string			DiscoveryNIO's snmpRoCommunity.
snmpROCommunityDesc string			InventoryRequest's snmpROCommunityDesc.
snmpRoCommunityDesc string			DiscoveryNIO's snmpRoCommunityDesc.
snmpRWCommunity string			InventoryRequest's snmpRWCommunity.
snmpRwCommunity string			DiscoveryNIO's snmpRwCommunity.
snmpRWCommunityDesc string			InventoryRequest's snmpRWCommunityDesc.
snmpRwCommunityDesc string			DiscoveryNIO's snmpRwCommunityDesc.
snmpUserName string			InventoryRequest's snmpUserName. DiscoveryNIO's snmpUserName.
snmpVersion string			InventoryRequest's snmpVersion. Required for state create.
start_index integer / required			Start index.
timeOut integer			DiscoveryNIO's timeOut.
timeout integer			InventoryRequest's timeout.
updateMgmtIp boolean		Choices: no yes	InventoryRequest's updateMgmtIp. DiscoveryNIO's updateMgmtIp.
userNameList raw			InventoryRequest's userNameList (list of strings). DiscoveryNIO's userNameList. Type list for state create. Type str for state update.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.discovery

The official documentation on the cisco.dnac.plugins.module_utils.definitions.discovery module.

Discovery reference

Complete reference of the Discovery object model.

Discovery reference

SDK reference.

Examples

- name: delete_all_discovery
  cisco.dnac.discovery:
    state: delete  # required

- name: start_discovery
  cisco.dnac.discovery:
    state: create  # required
    discoveryType: SomeValue  # string, required
    ipAddressList: SomeValue  # string, required
    name: SomeValue  # string, required
    snmpVersion: SomeValue  # string, required
    cdpLevel: 1  #  integer
    enablePasswordList:
    - SomeValue  # string
    globalCredentialIdList:
    - SomeValue  # string
    httpReadCredential:
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string
      password: SomeValue  # string
      port: 1  #  integer
      secure: True  # boolean
      username: SomeValue  # string
    httpWriteCredential:
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string
      password: SomeValue  # string
      port: 1  #  integer
      secure: True  # boolean
      username: SomeValue  # string
    ipFilterList:
    - SomeValue  # string
    lldpLevel: 1  #  integer
    netconfPort: SomeValue  # string
    noAddNewDevice: True  # boolean
    parentDiscoveryId: SomeValue  # string
    passwordList:
    - SomeValue  # string
    preferredMgmtIPMethod: SomeValue  # string
    protocolOrder: SomeValue  # string
    reDiscovery: True  # boolean
    retry: 1  #  integer
    snmpAuthPassphrase: SomeValue  # string
    snmpAuthProtocol: SomeValue  # string
    snmpMode: SomeValue  # string
    snmpPrivPassphrase: SomeValue  # string
    snmpPrivProtocol: SomeValue  # string
    snmpROCommunity: SomeValue  # string
    snmpROCommunityDesc: SomeValue  # string
    snmpRWCommunity: SomeValue  # string
    snmpRWCommunityDesc: SomeValue  # string
    snmpUserName: SomeValue  # string
    timeout: 1  #  integer
    updateMgmtIp: True  # boolean
    userNameList:
    - SomeValue  # string

- name: updates_discovery_by_id
  cisco.dnac.discovery:
    state: update  # required
    discoveryStatus: SomeValue  # string, required
    id: SomeValue  # string, required
    attributeInfo:
    cdpLevel: 1  #  integer
    deviceIds: SomeValue  # string
    discoveryCondition: SomeValue  # string
    discoveryType: SomeValue  # string
    enablePasswordList: SomeValue  # string
    globalCredentialIdList:
    - SomeValue  # string
    httpReadCredential:
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string
      password: SomeValue  # string
      port: 1  #  integer
      secure: True  # boolean
      username: SomeValue  # string
    httpWriteCredential:
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string
      password: SomeValue  # string
      port: 1  #  integer
      secure: True  # boolean
      username: SomeValue  # string
    ipAddressList: SomeValue  # string
    ipFilterList: SomeValue  # string
    isAutoCdp: True  # boolean
    lldpLevel: 1  #  integer
    name: SomeValue  # string
    netconfPort: SomeValue  # string
    numDevices: 1  #  integer
    parentDiscoveryId: SomeValue  # string
    passwordList: SomeValue  # string
    preferredMgmtIPMethod: SomeValue  # string
    protocolOrder: SomeValue  # string
    retryCount: 1  #  integer
    snmpAuthPassphrase: SomeValue  # string
    snmpAuthProtocol: SomeValue  # string
    snmpMode: SomeValue  # string
    snmpPrivPassphrase: SomeValue  # string
    snmpPrivProtocol: SomeValue  # string
    snmpRoCommunity: SomeValue  # string
    snmpRoCommunityDesc: SomeValue  # string
    snmpRwCommunity: SomeValue  # string
    snmpRwCommunityDesc: SomeValue  # string
    snmpUserName: SomeValue  # string
    timeOut: 1  #  integer
    updateMgmtIp: True  # boolean
    userNameList: SomeValue  # string

- name: get_count_of_all_discovery_jobs
  cisco.dnac.discovery:
    state: query  # required
    count: True  # boolean, required
  register: nm_get_count_of_all_discovery_jobs

- name: delete_discovery_by_id
  cisco.dnac.discovery:
    state: delete  # required
    id: SomeValue  # string, required

- name: get_discovery_by_id
  cisco.dnac.discovery:
    state: query  # required
    id: SomeValue  # string, required
  register: nm_get_discovery_by_id

- name: delete_discovery_by_specified_range
  cisco.dnac.discovery:
    state: delete  # required
    records_to_delete: 1  #  integer, required
    start_index: 1  #  integer, required

- name: get_discoveries_by_range
  cisco.dnac.discovery:
    state: query  # required
    records_to_return: 1  #  integer, required
    start_index: 1  #  integer, required
  register: nm_get_discoveries_by_range

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 with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: discovery.delete_all_discovery

Authors

• Rafael Campos (@racampos)