cisco.dnac.backup_restore_executions_info module -- Information module for Backup Restore Executions

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

New in cisco.dnac 6.18.0

Synopsis

  • Get all Backup Restore Executions.

  • Get Backup Restore Executions by id.

  • This api is used to get all the backup and restore executions.

  • This api is used to get the execution detail of a specific backup or restore worflow process.

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

backupId

string

BackupId query parameter. The `backupId` of the backup execution to be retrieved.Obtain the `backupId` from the id attribute in the response of the `/dna/system/api/v1/backups` API.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

headers

dictionary

Additional headers.

id

string

Id path parameter. The `id` of the backup execution to be retrieved.

jobType

string

JobType query parameter. Execution type of the backup workflow. If the workflow is `Create Backup` The jobType is `CREATE_BACKUP`. If the workflow is `Delete Backup` The jobType is `DELETE_BACKUP`. If the workflow is `Restore Backup` The jobType is `RESTORE_BACKUP`.

limit

integer

Limit query parameter. The number of records to show for this page.

offset

integer

Offset query parameter. The first record to show for this page.

order

string

Order query parameter. Whether ascending or descending order should be used to sort the response.Use `asc` for ascending and `desc` for descending order .

sortBy

string

SortBy query parameter. A property within the response to sort by.

status

string

Status query parameter. Execution status of the workflow.If the workflow execution has started, the status is `IN_PROGRESS`.If the workflow execution has completed, the status is `SUCCESS`.If the workflow execution has failed, the status is `FAILED`.

validate_response_schema

boolean

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_backup_and_restore_execution, backup.Backup.get_backup_and_restore_executions,

  • Paths used are get /dna/system/api/v1/backupRestoreExecutions, get /dna/system/api/v1/backupRestoreExecutions/{id},

  • Supports check_mode

  • The 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 GetBackupAndRestoreExecution

Complete reference of the GetBackupAndRestoreExecution API.

Cisco DNA Center documentation for Backup GetBackupAndRestoreExecutions

Complete reference of the GetBackupAndRestoreExecutions API.

Examples

---
- name: Get all Backup Restore Executions
  cisco.dnac.backup_restore_executions_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}}"
    backupId: string
    jobType: string
    status: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result
- name: Get Backup Restore Executions by id
  cisco.dnac.backup_restore_executions_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

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"\_metadata": {}, "backupId": "string", "completedPercentage": 0, "createdBy": "string", "duration": 0, "endDate": "string", "errorCode": "string", "errorMessage": "string", "failedTaskDetail": {}, "id": "string", "isForceUpdate": true, "jobType": "string", "scope": "string", "startDate": "string", "status": "string", "systemErrorMessage": "string", "tasks": [{"endDate": "string", "errorCode": "string", "failedTaskDetail": {}, "id": "string", "message": "string", "startDate": "string", "status": "string", "systemErrorMessage": "string", "taskName": "string"}], "updateMessage": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)