racampos / racampos.dnac / 0.0.1 / module / discovery Manage Discovery objects of Discovery | "added in version" 1.0 of racampos.dnac" Authors: first last (@GitHubID) preview | supported by community This plugin has a corresponding action plugin.racampos.dnac.discovery (0.0.1) — module
Install with ansible-galaxy collection install racampos.dnac:==0.0.1
collections: - name: racampos.dnac version: 0.0.1
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.
- 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: query_result
- 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: query_result
- 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: query_result
id: description: - DiscoveryNIO's id. - Discovery ID. required: true type: str name: description: - InventoryRequest's name. - DiscoveryNIO's name. - Required for state create. required: true type: str count: description: - If true gets the number of objects. - Required for state query. type: bool retry: description: - InventoryRequest's retry. type: int timeOut: description: - DiscoveryNIO's timeOut. type: int timeout: description: - InventoryRequest's timeout. type: int cdpLevel: description: - InventoryRequest's cdpLevel. - DiscoveryNIO's cdpLevel. type: int snmpMode: description: - InventoryRequest's snmpMode. - DiscoveryNIO's snmpMode. type: str deviceIds: description: - DiscoveryNIO's deviceIds. type: str isAutoCdp: description: - DiscoveryNIO's isAutoCdp. type: bool lldpLevel: description: - InventoryRequest's lldpLevel. - DiscoveryNIO's lldpLevel. type: int numDevices: description: - DiscoveryNIO's numDevices. type: int retryCount: description: - DiscoveryNIO's retryCount. type: int netconfPort: description: - InventoryRequest's netconfPort. - DiscoveryNIO's netconfPort. type: str reDiscovery: description: - InventoryRequest's reDiscovery. type: bool snmpVersion: description: - InventoryRequest's snmpVersion. - Required for state create. type: str start_index: description: - Start index. required: true type: int ipFilterList: description: - InventoryRequest's ipFilterList (list of strings). - DiscoveryNIO's ipFilterList. - Type list for state create. - Type str for state update. type: raw passwordList: description: - InventoryRequest's passwordList (list of strings). - DiscoveryNIO's passwordList. - Type list for state create. - Type str for state update. type: raw snmpUserName: description: - InventoryRequest's snmpUserName. - DiscoveryNIO's snmpUserName. type: str updateMgmtIp: description: - InventoryRequest's updateMgmtIp. - DiscoveryNIO's updateMgmtIp. type: bool userNameList: description: - InventoryRequest's userNameList (list of strings). - DiscoveryNIO's userNameList. - Type list for state create. - Type str for state update. type: raw attributeInfo: description: - DiscoveryNIO's attributeInfo. type: dict discoveryType: description: - InventoryRequest's DiscoveryType. - DiscoveryNIO's DiscoveryType. - Required for state create. required: true type: str ipAddressList: description: - InventoryRequest's ipAddressList. - DiscoveryNIO's ipAddressList. - Required for state create. required: true type: str protocolOrder: description: - InventoryRequest's protocolOrder. - DiscoveryNIO's protocolOrder. type: str noAddNewDevice: description: - InventoryRequest's noAddNewDevice. type: bool discoveryStatus: description: - DiscoveryNIO's DiscoveryStatus. - Required for state update. type: str snmpROCommunity: description: - InventoryRequest's snmpROCommunity. type: str snmpRWCommunity: description: - InventoryRequest's snmpRWCommunity. type: str snmpRoCommunity: description: - DiscoveryNIO's snmpRoCommunity. type: str snmpRwCommunity: description: - DiscoveryNIO's snmpRwCommunity. type: str snmpAuthProtocol: description: - InventoryRequest's snmpAuthProtocol. - DiscoveryNIO's snmpAuthProtocol. type: str snmpPrivProtocol: description: - InventoryRequest's snmpPrivProtocol. - DiscoveryNIO's snmpPrivProtocol. type: str parentDiscoveryId: description: - InventoryRequest's parentDiscoveryId. - DiscoveryNIO's parentDiscoveryId. type: str records_to_delete: description: - Number of records to delete. - Required for state delete. type: int records_to_return: description: - Number of records to return. - Required for state query. type: int discoveryCondition: description: - DiscoveryNIO's DiscoveryCondition. type: str enablePasswordList: description: - InventoryRequest's enablePasswordList (list of strings). - DiscoveryNIO's enablePasswordList. - Type list for state create. - Type str for state update. type: raw httpReadCredential: description: - InventoryRequest's httpReadCredential. - DiscoveryNIO's httpReadCredential. suboptions: comments: description: - It is the Discovery's comments. type: str credentialType: description: - It is the Discovery's credentialType. type: str description: description: - It is the Discovery's description. type: str id: description: - It is the Discovery's id. type: str instanceTenantId: description: - It is the Discovery's instanceTenantId. type: str instanceUuid: description: - It is the Discovery's instanceUuid. type: str password: description: - It is the Discovery's password. type: str port: description: - It is the Discovery's port. type: int secure: description: - It is the Discovery's secure. type: bool username: description: - It is the Discovery's username. type: str type: dict snmpAuthPassphrase: description: - InventoryRequest's snmpAuthPassphrase. - DiscoveryNIO's snmpAuthPassphrase. type: str snmpPrivPassphrase: description: - InventoryRequest's snmpPrivPassphrase. - DiscoveryNIO's snmpPrivPassphrase. type: str httpWriteCredential: description: - InventoryRequest's httpWriteCredential. - DiscoveryNIO's httpWriteCredential. suboptions: comments: description: - It is the Discovery's comments. type: str credentialType: description: - It is the Discovery's credentialType. type: str description: description: - It is the Discovery's description. type: str id: description: - It is the Discovery's id. type: str instanceTenantId: description: - It is the Discovery's instanceTenantId. type: str instanceUuid: description: - It is the Discovery's instanceUuid. type: str password: description: - It is the Discovery's password. type: str port: description: - It is the Discovery's port. type: int secure: description: - It is the Discovery's secure. type: bool username: description: - It is the Discovery's username. type: str type: dict snmpROCommunityDesc: description: - InventoryRequest's snmpROCommunityDesc. type: str snmpRWCommunityDesc: description: - InventoryRequest's snmpRWCommunityDesc. type: str snmpRoCommunityDesc: description: - DiscoveryNIO's snmpRoCommunityDesc. type: str snmpRwCommunityDesc: description: - DiscoveryNIO's snmpRwCommunityDesc. type: str preferredMgmtIPMethod: description: - InventoryRequest's preferredMgmtIPMethod. - DiscoveryNIO's preferredMgmtIPMethod. type: str globalCredentialIdList: description: - InventoryRequest's globalCredentialIdList (list of strings). - DiscoveryNIO's globalCredentialIdList (list of strings). type: list
delete_all_discovery: contains: null description: Stops all the discoveries and removes them. response: contains: taskId: description: It is the Discovery's taskId. returned: success type: dict url: description: It is the Discovery's url. returned: success sample: <url> type: str description: Response, property of the response body. returned: success type: dict returned: success type: dict version: description: Version, property of the response body. returned: success sample: '1.0' type: str delete_discovery_by_id: contains: null description: Stops the Discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the "Get Discoveries by range" API. response: contains: taskId: description: It is the Discovery's taskId. returned: success type: dict url: description: It is the Discovery's url. returned: success sample: <url> type: str description: Response, property of the response body. returned: success type: dict returned: success type: dict version: description: Version, property of the response body. returned: success sample: '1.0' type: str delete_discovery_by_specified_range: contains: null description: Stops Discovery for the given range and removes them. response: contains: taskId: description: It is the Discovery's taskId. returned: success type: dict url: description: It is the Discovery's url. returned: success sample: <url> type: str description: Response, property of the response body. returned: success type: dict returned: success type: dict version: description: Version, property of the response body. returned: success sample: '1.0' type: str get_count_of_all_discovery_jobs: contains: null description: Returns the count of all available Discovery jobs. response: description: Response, property of the response body. returned: always sample: 0 type: int returned: always type: dict version: description: Version, property of the response body. returned: always sample: '1.0' type: str get_discoveries_by_range: contains: null description: Returns the Discovery by specified range. response: contains: attributeInfo: description: It is the Discovery's attributeInfo. returned: always type: dict cdpLevel: description: It is the Discovery's cdpLevel. returned: always sample: 0 type: int deviceIds: description: It is the Discovery's deviceIds. returned: always sample: <deviceids> type: str discoveryCondition: description: It is the Discovery's DiscoveryCondition. returned: always sample: <discoverycondition> type: str discoveryStatus: description: It is the Discovery's DiscoveryStatus. returned: always sample: <discoverystatus> type: str discoveryType: description: It is the Discovery's DiscoveryType. returned: always sample: <discoverytype> type: str enablePasswordList: description: It is the Discovery's enablePasswordList. returned: always sample: <enablepasswordlist> type: str globalCredentialIdList: description: It is the Discovery's globalCredentialIdList. returned: always type: list httpReadCredential: contains: comments: description: It is the Discovery's comments. returned: always sample: <comments> type: str credentialType: description: It is the Discovery's credentialType. returned: always sample: <credentialtype> type: str description: description: It is the Discovery's description. returned: always sample: <description> type: str id: description: It is the Discovery's id. returned: always sample: '478012' type: str instanceTenantId: description: It is the Discovery's instanceTenantId. returned: always sample: <instancetenantid> type: str instanceUuid: description: It is the Discovery's instanceUuid. returned: always sample: <instanceuuid> type: str password: description: It is the Discovery's password. returned: always sample: '*******' type: str port: description: It is the Discovery's port. returned: always sample: 0 type: int secure: description: It is the Discovery's secure. returned: always sample: false type: bool username: description: It is the Discovery's username. returned: always sample: devnetuser type: str description: It is the Discovery's httpReadCredential. returned: always type: dict httpWriteCredential: contains: comments: description: It is the Discovery's comments. returned: always sample: <comments> type: str credentialType: description: It is the Discovery's credentialType. returned: always sample: <credentialtype> type: str description: description: It is the Discovery's description. returned: always sample: <description> type: str id: description: It is the Discovery's id. returned: always sample: '478012' type: str instanceTenantId: description: It is the Discovery's instanceTenantId. returned: always sample: <instancetenantid> type: str instanceUuid: description: It is the Discovery's instanceUuid. returned: always sample: <instanceuuid> type: str password: description: It is the Discovery's password. returned: always sample: '*******' type: str port: description: It is the Discovery's port. returned: always sample: 0 type: int secure: description: It is the Discovery's secure. returned: always sample: false type: bool username: description: It is the Discovery's username. returned: always sample: devnetuser type: str description: It is the Discovery's httpWriteCredential. returned: always type: dict id: description: It is the Discovery's id. returned: always sample: '478012' type: str ipAddressList: description: It is the Discovery's ipAddressList. returned: always sample: <ipaddresslist> type: str ipFilterList: description: It is the Discovery's ipFilterList. returned: always sample: <ipfilterlist> type: str isAutoCdp: description: It is the Discovery's isAutoCdp. returned: always sample: false type: bool lldpLevel: description: It is the Discovery's lldpLevel. returned: always sample: 0 type: int name: description: It is the Discovery's name. returned: always sample: <name> type: str netconfPort: description: It is the Discovery's netconfPort. returned: always sample: <netconfport> type: str numDevices: description: It is the Discovery's numDevices. returned: always sample: 0 type: int parentDiscoveryId: description: It is the Discovery's parentDiscoveryId. returned: always sample: <parentdiscoveryid> type: str passwordList: description: It is the Discovery's passwordList. returned: always sample: <passwordlist> type: str preferredMgmtIPMethod: description: It is the Discovery's preferredMgmtIPMethod. returned: always sample: <preferredmgmtipmethod> type: str protocolOrder: description: It is the Discovery's protocolOrder. returned: always sample: <protocolorder> type: str retryCount: description: It is the Discovery's retryCount. returned: always sample: 0 type: int snmpAuthPassphrase: description: It is the Discovery's snmpAuthPassphrase. returned: always sample: <snmpauthpassphrase> type: str snmpAuthProtocol: description: It is the Discovery's snmpAuthProtocol. returned: always sample: <snmpauthprotocol> type: str snmpMode: description: It is the Discovery's snmpMode. returned: always sample: <snmpmode> type: str snmpPrivPassphrase: description: It is the Discovery's snmpPrivPassphrase. returned: always sample: <snmpprivpassphrase> type: str snmpPrivProtocol: description: It is the Discovery's snmpPrivProtocol. returned: always sample: <snmpprivprotocol> type: str snmpRoCommunity: description: It is the Discovery's snmpRoCommunity. returned: always sample: <snmprocommunity> type: str snmpRoCommunityDesc: description: It is the Discovery's snmpRoCommunityDesc. returned: always sample: <snmprocommunitydesc> type: str snmpRwCommunity: description: It is the Discovery's snmpRwCommunity. returned: always sample: <snmprwcommunity> type: str snmpRwCommunityDesc: description: It is the Discovery's snmpRwCommunityDesc. returned: always sample: <snmprwcommunitydesc> type: str snmpUserName: description: It is the Discovery's snmpUserName. returned: always sample: <snmpusername> type: str timeOut: description: It is the Discovery's timeOut. returned: always sample: 0 type: int updateMgmtIp: description: It is the Discovery's updateMgmtIp. returned: always sample: false type: bool userNameList: description: It is the Discovery's userNameList. returned: always sample: <usernamelist> type: str description: Response, property of the response body (list of objects). returned: always type: list returned: always type: dict version: description: Version, property of the response body. returned: always sample: '1.0' type: str get_discovery_by_id: contains: null description: Returns Discovery by Discovery ID. Discovery ID can be obtained using the "Get Discoveries by range" API. response: contains: attributeInfo: description: It is the Discovery's attributeInfo. returned: always type: dict cdpLevel: description: It is the Discovery's cdpLevel. returned: always sample: 0 type: int deviceIds: description: It is the Discovery's deviceIds. returned: always sample: <deviceids> type: str discoveryCondition: description: It is the Discovery's DiscoveryCondition. returned: always sample: <discoverycondition> type: str discoveryStatus: description: It is the Discovery's DiscoveryStatus. returned: always sample: <discoverystatus> type: str discoveryType: description: It is the Discovery's DiscoveryType. returned: always sample: <discoverytype> type: str enablePasswordList: description: It is the Discovery's enablePasswordList. returned: always sample: <enablepasswordlist> type: str globalCredentialIdList: description: It is the Discovery's globalCredentialIdList. returned: always type: list httpReadCredential: contains: comments: description: It is the Discovery's comments. returned: always sample: <comments> type: str credentialType: description: It is the Discovery's credentialType. returned: always sample: <credentialtype> type: str description: description: It is the Discovery's description. returned: always sample: <description> type: str id: description: It is the Discovery's id. returned: always sample: '478012' type: str instanceTenantId: description: It is the Discovery's instanceTenantId. returned: always sample: <instancetenantid> type: str instanceUuid: description: It is the Discovery's instanceUuid. returned: always sample: <instanceuuid> type: str password: description: It is the Discovery's password. returned: always sample: '*******' type: str port: description: It is the Discovery's port. returned: always sample: 0 type: int secure: description: It is the Discovery's secure. returned: always sample: false type: bool username: description: It is the Discovery's username. returned: always sample: devnetuser type: str description: It is the Discovery's httpReadCredential. returned: always type: dict httpWriteCredential: contains: comments: description: It is the Discovery's comments. returned: always sample: <comments> type: str credentialType: description: It is the Discovery's credentialType. returned: always sample: <credentialtype> type: str description: description: It is the Discovery's description. returned: always sample: <description> type: str id: description: It is the Discovery's id. returned: always sample: '478012' type: str instanceTenantId: description: It is the Discovery's instanceTenantId. returned: always sample: <instancetenantid> type: str instanceUuid: description: It is the Discovery's instanceUuid. returned: always sample: <instanceuuid> type: str password: description: It is the Discovery's password. returned: always sample: '*******' type: str port: description: It is the Discovery's port. returned: always sample: 0 type: int secure: description: It is the Discovery's secure. returned: always sample: false type: bool username: description: It is the Discovery's username. returned: always sample: devnetuser type: str description: It is the Discovery's httpWriteCredential. returned: always type: dict id: description: It is the Discovery's id. returned: always sample: '478012' type: str ipAddressList: description: It is the Discovery's ipAddressList. returned: always sample: <ipaddresslist> type: str ipFilterList: description: It is the Discovery's ipFilterList. returned: always sample: <ipfilterlist> type: str isAutoCdp: description: It is the Discovery's isAutoCdp. returned: always sample: false type: bool lldpLevel: description: It is the Discovery's lldpLevel. returned: always sample: 0 type: int name: description: It is the Discovery's name. returned: always sample: <name> type: str netconfPort: description: It is the Discovery's netconfPort. returned: always sample: <netconfport> type: str numDevices: description: It is the Discovery's numDevices. returned: always sample: 0 type: int parentDiscoveryId: description: It is the Discovery's parentDiscoveryId. returned: always sample: <parentdiscoveryid> type: str passwordList: description: It is the Discovery's passwordList. returned: always sample: <passwordlist> type: str preferredMgmtIPMethod: description: It is the Discovery's preferredMgmtIPMethod. returned: always sample: <preferredmgmtipmethod> type: str protocolOrder: description: It is the Discovery's protocolOrder. returned: always sample: <protocolorder> type: str retryCount: description: It is the Discovery's retryCount. returned: always sample: 0 type: int snmpAuthPassphrase: description: It is the Discovery's snmpAuthPassphrase. returned: always sample: <snmpauthpassphrase> type: str snmpAuthProtocol: description: It is the Discovery's snmpAuthProtocol. returned: always sample: <snmpauthprotocol> type: str snmpMode: description: It is the Discovery's snmpMode. returned: always sample: <snmpmode> type: str snmpPrivPassphrase: description: It is the Discovery's snmpPrivPassphrase. returned: always sample: <snmpprivpassphrase> type: str snmpPrivProtocol: description: It is the Discovery's snmpPrivProtocol. returned: always sample: <snmpprivprotocol> type: str snmpRoCommunity: description: It is the Discovery's snmpRoCommunity. returned: always sample: <snmprocommunity> type: str snmpRoCommunityDesc: description: It is the Discovery's snmpRoCommunityDesc. returned: always sample: <snmprocommunitydesc> type: str snmpRwCommunity: description: It is the Discovery's snmpRwCommunity. returned: always sample: <snmprwcommunity> type: str snmpRwCommunityDesc: description: It is the Discovery's snmpRwCommunityDesc. returned: always sample: <snmprwcommunitydesc> type: str snmpUserName: description: It is the Discovery's snmpUserName. returned: always sample: <snmpusername> type: str timeOut: description: It is the Discovery's timeOut. returned: always sample: 0 type: int updateMgmtIp: description: It is the Discovery's updateMgmtIp. returned: always sample: false type: bool userNameList: description: It is the Discovery's userNameList. returned: always sample: <usernamelist> type: str description: Response, property of the response body. returned: always type: dict returned: always type: dict version: description: Version, property of the response body. returned: always sample: '1.0' type: str start_discovery: contains: null description: Initiates Discovery with the given parameters. response: contains: taskId: description: It is the Discovery's taskId. returned: success type: dict url: description: It is the Discovery's url. returned: success sample: <url> type: str description: InventoryRequest's response. returned: success type: dict returned: success type: dict version: description: InventoryRequest's version. returned: success sample: '1.0' type: str updates_discovery_by_id: contains: null description: Stops or starts an existing Discovery. response: contains: taskId: description: It is the Discovery's taskId. returned: changed type: dict url: description: It is the Discovery's url. returned: changed sample: <url> type: str description: DiscoveryNIO's response. returned: changed type: dict returned: changed type: dict version: description: DiscoveryNIO's version. returned: changed sample: '1.0' type: str