/ home / cisco / cisco.dnac / 6.13.3 / module / pnp_device_history_info

cisco.dnac.pnp_device_history_info (6.13.3) — module

Information module for Pnp Device History

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Pnp Device History.

Returns history for a specific device. Serial number is a required parameter.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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: "{{my_headers | from_json}}"
    serialNumber: string
    sort: []
    sortOrder: string
  register: result

Inputs

    
sort:
    description:
    - Sort query parameter. Comma seperated list of fields to sort on.
    elements: str
    type: list

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

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

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

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.
    type: str

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

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

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": [\n    {\n      \"timestamp\": 0,\n      \"details\"\
    : \"string\",\n      \"historyTaskInfo\": {\n        \"name\": \"string\",\n \
    \       \"type\": \"string\",\n        \"timeTaken\": 0,\n        \"workItemList\"\
    : [\n          {\n            \"state\": \"string\",\n            \"command\"\
    : \"string\",\n            \"startTime\": 0,\n            \"endTime\": 0,\n  \
    \          \"timeTaken\": 0,\n            \"outputStr\": \"string\"\n        \
    \  }\n        ],\n        \"addnDetails\": [\n          {\n            \"key\"\
    : \"string\",\n            \"value\": \"string\"\n          }\n        ]\n   \
    \   },\n      \"errorFlag\": true\n    }\n  ],\n  \"statusCode\": 0\n}\n"
  type: dict