cisco.mso.mso_backup module – Manages backups
Note
This module is part of the cisco.mso collection (version 2.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.mso
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.mso.mso_backup
.
Synopsis
Manage backups on Cisco ACI Multi-Site.
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
The name given to the backup |
|
Brief information about the backup. |
|
Location where to download the backup to |
|
IP Address or hostname of the ACI Multi Site Orchestrator host. If the value is not specified in the task, the value of environment variable |
|
The type of location for the backup to be stored Choices:
|
|
The login domain name to use for authentication. The default value is Local. If the value is not specified in the task, the value of environment variable |
|
Influence the output of this MSO module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
The password to use for authentication. If the value is not specified in the task, the value of environment variables |
|
Port number to be used for the REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable |
|
The remote location’s name where the backup should be stored |
|
This path is relative to the remote location. A ‘/’ is automatically added between the remote location folder and this path. This folder structure should already exist on the remote location. |
|
Use Use Use Use Use Use Choices:
|
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable Default: |
|
If If the value is not specified in the task, the value of environment variable The default is Choices:
|
|
If If the value is not specified in the task, the value of environment variable When using a HTTPAPI connection plugin the inventory variable The default is Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default is Choices:
|
Notes
Note
This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.
Examples
- name: Create a new local backup
cisco.mso.mso_backup:
host: mso_host
username: admin
password: SomeSecretPassword
backup: Backup
description: via Ansible
location_type: local
state: present
delegate_to: localhost
- name: Create a new remote backup
cisco.mso.mso_backup:
host: mso_host
username: admin
password: SomeSecretPassword
backup: Backup
description: via Ansible
location_type: remote
remote_location: ansible_test
state: present
delegate_to: localhost
- name: Move backup to remote location
cisco.mso.mso_backup:
host: mso_host
username: admin
password: SomeSecretPassword
backup: Backup0
remote_location: ansible_test
remote_path: test
state: move
delegate_to: localhost
- name: Download a backup
cisco.mso.mso_backup:
host: mso_host
username: admin
password: SomeSecretPassword
backup: Backup
destination: ./
state: download
delegate_to: localhost
- name: Upload a backup
cisco.mso.mso_backup:
host: mso_host
username: admin
password: SomeSecretPassword
backup: ./Backup
state: upload
delegate_to: localhost
- name: Restore a backup
cisco.mso.mso_backup:
host: mso_host
username: admin
password: SomeSecretPassword
backup: Backup
state: restore
delegate_to: localhost
- name: Remove a Backup
cisco.mso.mso_backup:
host: mso_host
username: admin
password: SomeSecretPassword
backup: Backup
state: absent
delegate_to: localhost
- name: Query a backup
cisco.mso.mso_backup:
host: mso_host
username: admin
password: SomeSecretPassword
backup: Backup
state: query
delegate_to: localhost
register: query_result
- name: Query a backup with its complete name
cisco.mso.mso_backup:
host: mso_host
username: admin
password: SomeSecretPassword
backup: Backup_20200721220043
state: query
delegate_to: localhost
register: query_result
- name: Query all backups
cisco.mso.mso_backup:
host: mso_host
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result