cisco.catalystcenter.backups_id_restore module -- Resource module for Backups Id Restore

Note

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

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.backups_id_restore.

New in cisco.catalystcenter 6.18.0

Synopsis

• Manage operation create of the resource Backups Id Restore. - > This api is used to trigger restore workflow of a specific backup. Obtain the `id` from the id attribute in the response of the `/dna/system/api/v1/backups` API. To monitor the progress and completion of the backup deletion , please call `/dna/system/api/v1/backupRestoreExecutions/{id}` api , where id is the taskId attribute from the response of the curent endpoint.

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
catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
encryptionPassphrase string	Passphrase to restore backup.
id string	Id path parameter. The `id` of the backup to be restored.Obtain the `id` from the id attribute in the response of the `/dna/system/api/v1/backups` API.
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 backup.Backup.restore_backup,

• Paths used are post /dna/system/api/v1/backups/{id}/restore,

• Does not support 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 Backup RestoreBackup

Complete reference of the RestoreBackup API.

Examples

---
- name: Create
  cisco.catalystcenter.backups_id_restore:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    encryptionPassphrase: string
    id: string

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 CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)