cisco.dnac.pnp_device_info module -- Information module for Pnp Device

Note

This module is part of the cisco.dnac collection (version 6.13.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 3.1.0

Synopsis 

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.

Note

This module has a corresponding action plugin.

Requirements 

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

dnacentersdk >= 2.5.5
python >= 3.5

Parameters 

Parameter	Comments
cmState list / elements=string	CmState query parameter. Device Connection Manager State.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: :ansible-option-default:`443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.5.3"`
headers dictionary	Additional headers.
hostname string	Hostname query parameter. Device Hostname.
id string	Id path parameter.
lastContact boolean	LastContact query parameter. Device Has Contacted lastContact > 0. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
limit integer	Limit query parameter. Limits number of results.
macAddress string	MacAddress query parameter. Device Mac Address.
name list / elements=string	Name query parameter. Device Name.
offset integer	Offset query parameter. Index of first result.
onbState list / elements=string	OnbState query parameter. Device Onboarding State.
pid list / elements=string	Pid query parameter. Device ProductId.
projectId list / elements=string	ProjectId query parameter. Device Project Id.
projectName list / elements=string	ProjectName query parameter. Device Project Name.
serialNumber list / elements=string	SerialNumber query parameter. Device Serial Number.
siteName string	SiteName query parameter. Device Site Name.
smartAccountId list / elements=string	SmartAccountId query parameter. Device Smart Account.
sort list / elements=string	Sort query parameter. Comma seperated list of fields to sort on.
sortOrder string	SortOrder query parameter. Sort Order Ascending (asc) or Descending (des).
source list / elements=string	Source query parameter. Device Source.
state_ list / elements=string	State query parameter. Device State.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
virtualAccountId list / elements=string	VirtualAccountId query parameter. Device Virtual Account.
workflowId list / elements=string	WorkflowId query parameter. Device Workflow Id.
workflowName list / elements=string	WorkflowName query parameter. Device Workflow Name.

Notes 

Note

SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.get_device_by_id, device_onboarding_pnp.DeviceOnboardingPnp.get_device_list,
Paths used are get /dna/intent/api/v1/onboarding/pnp-device, get /dna/intent/api/v1/onboarding/pnp-device/{id},
Supports check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

Examples 

- 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

Return Values 

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Authors

Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)

cisco.dnac.pnp_device_info module -- Information module for Pnp Device

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 