cisco.catalystcenter.device_reboot_apreboot_info module -- Information module for Device Reboot Apreboot

Note

This module is part of the cisco.catalystcenter collection (version 2.2.1).

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

To use it in a playbook, specify: cisco.catalystcenter.device_reboot_apreboot_info.

New in cisco.catalystcenter 3.1.0

Synopsis

• Get all Device Reboot Apreboot.

• Users can query the access point reboot status using this intent API.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
catc_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catc_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catc_host string / required	The Cisco Catalyst Center hostname.
catc_password string	The Cisco Catalyst Center password to authenticate.
catc_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catc_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catc_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
headers dictionary	Additional headers.
parentTaskId string	ParentTaskId query parameter. Task id of ap reboot request.
validate_response_schema boolean	Flag for Cisco Catalyst 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)

Notes

Note

• SDK Method used are wireless.Wireless.get_access_point_reboot_task_result,

• Paths used are get /dna/intent/api/v1/device-reboot/apreboot/status,

• Supports check_mode

• The plugin runs on the control node and does not use any ansible connection plugins,

• but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Wireless GetAccessPointRebootTaskResult

Complete reference of the GetAccessPointRebootTaskResult API.

Examples

---
- name: Get all Device Reboot Apreboot
  cisco.catalystcenter.device_reboot_apreboot_info:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    headers: "{{my_headers | from_json}}"
    parentTaskId: string
  register: result

Return Values

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

Key	Description
dnac_response list / elements=dictionary	A dictionary or list with the response returned by the Cisco CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`"[\\n {\\n \\"wlcIP\\": \\"string\\",\\n \\"apList\\": [\\n {\\n \\"apName\\": \\"string\\",\\n \\"rebootStatus\\": \\"string\\",\\n \\"failureReason\\": {}\\n }\\n ]\\n }\\n]\\n"`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)