cisco.dnac.pnp_device_history_info – Information module for Pnp Device History

Note

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

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get all Pnp Device History.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.3.1

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.2.3"
Informs the SDK which version of Cisco DNA Center to use.
headers
dictionary
Additional headers.
serialNumber
string
SerialNumber query parameter. Device Serial Number.
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).
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

  • Supports check_mode

See Also

See also

Pnp Device History reference

Complete reference of the Pnp Device History object model.

Examples

- name: Get all Pnp Device History
  cisco.dnac.pnp_device_history_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:
      custom: value
    serialNumber: string
    sort: []
    sortOrder: string
  register: result

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": [ { "timestamp": 0, "details": "string", "historyTaskInfo": { "name": "string", "type": "string", "timeTaken": 0, "workItemList": [ { "state": "string", "command": "string", "startTime": 0, "endTime": 0, "timeTaken": 0, "outputStr": "string" } ], "addnDetails": [ { "key": "string", "value": "string" } ] }, "errorFlag": true } ], "statusCode": 0 }


Authors

  • Rafael Campos (@racampos)