cisco.dnac.backups_info module -- Information module for Backups
Note
This module is part of the cisco.dnac collection (version 6.46.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.backups_info.
New in cisco.dnac 6.18.0
Synopsis
Get all Backups.
Get Backups by id.
This api is used to get a specific backup based on the provided `backup id`.
This api is used to get all the backup available in the configured storage.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.11.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices: |
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: :ansible-option-default:`443` |
|
The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Additional headers. |
|
Id path parameter. The `id` of the backup to be retrieved. |
|
Limit query parameter. The number of records to show for this page. |
|
Offset query parameter. The first record to show for this page. |
|
Order query parameter. Whether ascending or descending order should be used to sort the response.Use `asc` for ascending and `desc` for descending order . |
|
Query query parameter. Filter based on the provided text on predefined fields. |
|
SortBy query parameter. A property within the response to sort by. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are backup.Backup.get_all_backup, backup.Backup.get_backup_by_id,
Paths used are get /dna/system/api/v1/backups, get /dna/system/api/v1/backups/{id},
Supports
check_modeThe 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
See Also
See also
- Cisco DNA Center documentation for Backup GetAllBackup
Complete reference of the GetAllBackup API.
- Cisco DNA Center documentation for Backup GetBackupById
Complete reference of the GetBackupById API.
Examples
---
- name: Get all Backups
cisco.dnac.backups_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}}"
query: string
offset: 0
limit: 0
sortBy: string
order: string
register: result
- name: Get Backups by id
cisco.dnac.backups_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 |
|---|---|