cisco / cisco.dnac / 6.13.3 / module / pnp_device_info Information module for Pnp Device | "added in version" 3.1.0 of cisco.dnac" Authors: Rafael Campos (@racampos) This plugin has a corresponding action plugin.cisco.dnac.pnp_device_info (6.13.3) — module
Install with ansible-galaxy collection install cisco.dnac:==6.13.3
collections: - name: cisco.dnac version: 6.13.3
Get all Pnp Device.
Get Pnp Device by id.
Returns device details specified by device id.
Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint.
- name: Get all Pnp Device cisco.dnac.pnp_device_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}}" limit: 0 offset: 0 sort: [] sortOrder: string serialNumber: [] state_: [] onbState: [] cmState: [] name: [] pid: [] source: [] projectId: [] workflowId: [] projectName: [] workflowName: [] smartAccountId: [] virtualAccountId: [] lastContact: True macAddress: string hostname: string siteName: string register: result
- name: Get Pnp Device by id cisco.dnac.pnp_device_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}}" id: string register: result
id: description: - Id path parameter. type: str pid: description: - Pid query parameter. Device ProductId. elements: str type: list name: description: - Name query parameter. Device Name. elements: str type: list sort: description: - Sort query parameter. Comma seperated list of fields to sort on. elements: str type: list limit: description: - Limit query parameter. Limits number of results. type: int offset: description: - Offset query parameter. Index of first result. type: int source: description: - Source query parameter. Device Source. elements: str type: list state_: description: - State query parameter. Device State. elements: str type: list cmState: description: - CmState query parameter. Device Connection Manager State. elements: str type: list headers: description: Additional headers. type: dict hostname: description: - Hostname query parameter. Device Hostname. type: str onbState: description: - OnbState query parameter. Device Onboarding State. elements: str type: list siteName: description: - SiteName query parameter. Device Site Name. 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 projectId: description: - ProjectId query parameter. Device Project Id. elements: str type: list sortOrder: description: - SortOrder query parameter. Sort Order Ascending (asc) or Descending (des). type: str dnac_debug: default: false description: - Flag for Cisco DNA Center SDK to enable debugging. type: bool macAddress: description: - MacAddress query parameter. Device Mac Address. type: str workflowId: description: - WorkflowId query parameter. Device Workflow Id. elements: str type: list dnac_verify: default: true description: - Flag to enable or disable SSL certificate verification. type: bool lastContact: description: - LastContact query parameter. Device Has Contacted lastContact > 0. type: bool projectName: description: - ProjectName query parameter. Device Project Name. elements: str type: list dnac_version: default: 2.3.5.3 description: - Informs the SDK which version of Cisco DNA Center to use. type: str serialNumber: description: - SerialNumber query parameter. Device Serial Number. elements: str type: list workflowName: description: - WorkflowName query parameter. Device Workflow Name. elements: str type: list 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 smartAccountId: description: - SmartAccountId query parameter. Device Smart Account. elements: str type: list virtualAccountId: description: - VirtualAccountId query parameter. Device Virtual Account. 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
dnac_response: description: A dictionary or list with the response returned by the Cisco DNAC Python SDK returned: always sample: "{\n \"_id\": \"string\",\n \"deviceInfo\": {\n \"source\": \"string\"\ ,\n \"serialNumber\": \"string\",\n \"stack\": true,\n \"mode\": \"string\"\ ,\n \"state\": \"string\",\n \"location\": {\n \"siteId\": \"string\"\ ,\n \"address\": \"string\",\n \"latitude\": \"string\",\n \"longitude\"\ : \"string\",\n \"altitude\": \"string\"\n },\n \"description\": \"\ string\",\n \"onbState\": \"string\",\n \"authenticatedMicNumber\": \"string\"\ ,\n \"authenticatedSudiSerialNo\": \"string\",\n \"capabilitiesSupported\"\ : [\n \"string\"\n ],\n \"featuresSupported\": [\n \"string\"\n\ \ ],\n \"cmState\": \"string\",\n \"firstContact\": 0,\n \"lastContact\"\ : 0,\n \"macAddress\": \"string\",\n \"pid\": \"string\",\n \"deviceSudiSerialNos\"\ : [\n \"string\"\n ],\n \"lastUpdateOn\": 0,\n \"workflowId\": \"\ string\",\n \"workflowName\": \"string\",\n \"projectId\": \"string\",\n\ \ \"projectName\": \"string\",\n \"deviceType\": \"string\",\n \"agentType\"\ : \"string\",\n \"imageVersion\": \"string\",\n \"fileSystemList\": [\n\ \ {\n \"type\": \"string\",\n \"writeable\": true,\n \ \ \"freespace\": 0,\n \"name\": \"string\",\n \"readable\": true,\n\ \ \"size\": 0\n }\n ],\n \"pnpProfileList\": [\n {\n \ \ \"profileName\": \"string\",\n \"discoveryCreated\": true,\n \ \ \"createdBy\": \"string\",\n \"primaryEndpoint\": {\n \"\ port\": 0,\n \"protocol\": \"string\",\n \"ipv4Address\": {},\n\ \ \"ipv6Address\": {},\n \"fqdn\": \"string\",\n \"\ certificate\": \"string\"\n },\n \"secondaryEndpoint\": {\n \ \ \"port\": 0,\n \"protocol\": \"string\",\n \"ipv4Address\"\ : {},\n \"ipv6Address\": {},\n \"fqdn\": \"string\",\n \ \ \"certificate\": \"string\"\n }\n }\n ],\n \"imageFile\"\ : \"string\",\n \"httpHeaders\": [\n {\n \"key\": \"string\",\n\ \ \"value\": \"string\"\n }\n ],\n \"neighborLinks\": [\n \ \ {\n \"localInterfaceName\": \"string\",\n \"localShortInterfaceName\"\ : \"string\",\n \"localMacAddress\": \"string\",\n \"remoteInterfaceName\"\ : \"string\",\n \"remoteShortInterfaceName\": \"string\",\n \"remoteMacAddress\"\ : \"string\",\n \"remoteDeviceName\": \"string\",\n \"remotePlatform\"\ : \"string\",\n \"remoteVersion\": \"string\"\n }\n ],\n \"\ lastSyncTime\": 0,\n \"ipInterfaces\": [\n {\n \"status\": \"string\"\ ,\n \"macAddress\": \"string\",\n \"ipv4Address\": {},\n \ \ \"ipv6AddressList\": [\n {}\n ],\n \"name\": \"string\"\ \n }\n ],\n \"hostname\": \"string\",\n \"authStatus\": \"string\"\ ,\n \"stackInfo\": {\n \"supportsStackWorkflows\": true,\n \"isFullRing\"\ : true,\n \"stackMemberList\": [\n {\n \"serialNumber\":\ \ \"string\",\n \"state\": \"string\",\n \"role\": \"string\"\ ,\n \"macAddress\": \"string\",\n \"pid\": \"string\",\n \ \ \"licenseLevel\": \"string\",\n \"licenseType\": \"string\",\n\ \ \"sudiSerialNumber\": \"string\",\n \"hardwareVersion\": \"\ string\",\n \"stackNumber\": 0,\n \"softwareVersion\": \"string\"\ ,\n \"priority\": 0\n }\n ],\n \"stackRingProtocol\"\ : \"string\",\n \"validLicenseLevels\": [\n \"string\"\n ],\n\ \ \"totalMemberCount\": 0\n },\n \"reloadRequested\": true,\n \"\ addedOn\": 0,\n \"siteId\": \"string\",\n \"aaaCredentials\": {\n \"\ password\": \"string\",\n \"username\": \"string\"\n },\n \"userMicNumbers\"\ : [\n \"string\"\n ],\n \"userSudiSerialNos\": [\n \"string\"\n\ \ ],\n \"addnMacAddrs\": [\n \"string\"\n ],\n \"preWorkflowCliOuputs\"\ : [\n {\n \"cli\": \"string\",\n \"cliOutput\": \"string\"\n\ \ }\n ],\n \"tags\": {},\n \"sudiRequired\": true,\n \"smartAccountId\"\ : \"string\",\n \"virtualAccountId\": \"string\",\n \"populateInventory\"\ : true,\n \"siteName\": \"string\",\n \"name\": \"string\"\n },\n \"systemResetWorkflow\"\ : {\n \"_id\": \"string\",\n \"state\": \"string\",\n \"type\": \"string\"\ ,\n \"description\": \"string\",\n \"lastupdateOn\": 0,\n \"imageId\"\ : \"string\",\n \"currTaskIdx\": 0,\n \"addedOn\": 0,\n \"tasks\": [\n\ \ {\n \"state\": \"string\",\n \"type\": \"string\",\n \ \ \"currWorkItemIdx\": 0,\n \"taskSeqNo\": 0,\n \"endTime\":\ \ 0,\n \"startTime\": 0,\n \"workItemList\": [\n {\n \ \ \"state\": \"string\",\n \"command\": \"string\",\n \ \ \"outputStr\": \"string\",\n \"endTime\": 0,\n \ \ \"startTime\": 0,\n \"timeTaken\": 0\n }\n ],\n \ \ \"timeTaken\": 0,\n \"name\": \"string\"\n }\n ],\n \ \ \"addToInventory\": true,\n \"instanceType\": \"string\",\n \"endTime\"\ : 0,\n \"execTime\": 0,\n \"startTime\": 0,\n \"useState\": \"string\"\ ,\n \"configId\": \"string\",\n \"name\": \"string\",\n \"version\":\ \ 0,\n \"tenantId\": \"string\"\n },\n \"systemWorkflow\": {\n \"_id\"\ : \"string\",\n \"state\": \"string\",\n \"type\": \"string\",\n \"description\"\ : \"string\",\n \"lastupdateOn\": 0,\n \"imageId\": \"string\",\n \"\ currTaskIdx\": 0,\n \"addedOn\": 0,\n \"tasks\": [\n {\n \"\ state\": \"string\",\n \"type\": \"string\",\n \"currWorkItemIdx\"\ : 0,\n \"taskSeqNo\": 0,\n \"endTime\": 0,\n \"startTime\"\ : 0,\n \"workItemList\": [\n {\n \"state\": \"string\"\ ,\n \"command\": \"string\",\n \"outputStr\": \"string\"\ ,\n \"endTime\": 0,\n \"startTime\": 0,\n \"\ timeTaken\": 0\n }\n ],\n \"timeTaken\": 0,\n \"\ name\": \"string\"\n }\n ],\n \"addToInventory\": true,\n \"instanceType\"\ : \"string\",\n \"endTime\": 0,\n \"execTime\": 0,\n \"startTime\": 0,\n\ \ \"useState\": \"string\",\n \"configId\": \"string\",\n \"name\": \"\ string\",\n \"version\": 0,\n \"tenantId\": \"string\"\n },\n \"workflow\"\ : {\n \"_id\": \"string\",\n \"state\": \"string\",\n \"type\": \"string\"\ ,\n \"description\": \"string\",\n \"lastupdateOn\": 0,\n \"imageId\"\ : \"string\",\n \"currTaskIdx\": 0,\n \"addedOn\": 0,\n \"tasks\": [\n\ \ {\n \"state\": \"string\",\n \"type\": \"string\",\n \ \ \"currWorkItemIdx\": 0,\n \"taskSeqNo\": 0,\n \"endTime\":\ \ 0,\n \"startTime\": 0,\n \"workItemList\": [\n {\n \ \ \"state\": \"string\",\n \"command\": \"string\",\n \ \ \"outputStr\": \"string\",\n \"endTime\": 0,\n \ \ \"startTime\": 0,\n \"timeTaken\": 0\n }\n ],\n \ \ \"timeTaken\": 0,\n \"name\": \"string\"\n }\n ],\n \ \ \"addToInventory\": true,\n \"instanceType\": \"string\",\n \"endTime\"\ : 0,\n \"execTime\": 0,\n \"startTime\": 0,\n \"useState\": \"string\"\ ,\n \"configId\": \"string\",\n \"name\": \"string\",\n \"version\":\ \ 0,\n \"tenantId\": \"string\"\n },\n \"runSummaryList\": [\n {\n \ \ \"details\": \"string\",\n \"historyTaskInfo\": {\n \"type\":\ \ \"string\",\n \"workItemList\": [\n {\n \"state\"\ : \"string\",\n \"command\": \"string\",\n \"outputStr\"\ : \"string\",\n \"endTime\": 0,\n \"startTime\": 0,\n \ \ \"timeTaken\": 0\n }\n ],\n \"timeTaken\": 0,\n\ \ \"addnDetails\": [\n {\n \"key\": \"string\",\n \ \ \"value\": \"string\"\n }\n ],\n \"name\":\ \ \"string\"\n },\n \"errorFlag\": true,\n \"timestamp\": 0\n \ \ }\n ],\n \"workflowParameters\": {\n \"topOfStackSerialNumber\": \"string\"\ ,\n \"licenseLevel\": \"string\",\n \"licenseType\": \"string\",\n \"\ configList\": [\n {\n \"configParameters\": [\n {\n \ \ \"key\": \"string\",\n \"value\": \"string\"\n }\n\ \ ],\n \"configId\": \"string\"\n }\n ]\n },\n \"dayZeroConfig\"\ : {\n \"config\": \"string\"\n },\n \"dayZeroConfigPreview\": {},\n \"version\"\ : 0,\n \"tenantId\": \"string\"\n}\n" type: dict