Модуль cisco.mso.mso_backup — управление резервными копиями

Примечание

Этот модуль входит в коллекцию cisco.mso (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.mso. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.mso.mso_backup.

Обзор
Требования
Параметры
Примечания
Примеры

Обзор

Управление резервными копиями в Cisco ACI Multi-Site.

Требования

Перечисленные ниже компоненты должны быть установлены на узле, который выполняет этот модуль.

Multi Site Orchestrator v2.1 или новее

Параметры

Параметр	Комментарии
backup псевдонимы: name string	Имя резервной копии `backup` взаимоисключающий с `backup_id`. Используйте только один из этих параметров.
backup_id псевдонимы: id string	Идентификатор конкретной резервной копии `backup_id` взаимоисключающий с `backup`. Используйте только один из этих параметров.
description string	Краткая информация о резервной копии.
destination string	Место для загрузки резервной копии
host псевдонимы: hostname string	IP-адрес или имя узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_HOST`.
location_type string	Тип расположения для хранения резервной копии Варианты: `"local"` ← (по умолчанию) `"remote"`
login_domain string	Имя домена входа для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_LOGIN_DOMAIN`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использована переменная инвентаризации `ansible_httpapi_login_domain`.
output_level string	Определяет состав выходных данных этого модуля MSO. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационные данные, включая `previous`, `proposed` и словари `sent` `debug` добавляет отладочные данные, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password string	Пароль для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта для REST-соединения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_PORT`.
remote_location string	Имя удалённого расположения для хранения резервной копии
remote_path string	Этот путь указывается относительно удалённого расположения. Между папкой удалённого расположения и этим путём автоматически добавляется символ «/». Эта структура папок уже должна существовать в удалённом расположении.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для получения списка одного или нескольких объектов. Используйте `upload` для загрузки резервной копии. Используйте `restore` для восстановления резервной копии. Используйте `download` для скачивания резервной копии. Используйте `move` для перемещения резервной копии из локального расположения в удалённое. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"` `"upload"` `"restore"` `"download"` `"move"`
timeout integer	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_TIMEOUT`.
use_proxy boolean	Если `false`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_USE_PROXY`. По умолчанию — `true`. Варианты: `false` `true`
use_ssl boolean	Если `false`, вместо соединения HTTPS, используемого по умолчанию, будет использоваться соединение HTTP. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_USE_SSL`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использована переменная инвентаризации `ansible_httpapi_use_ssl`. По умолчанию используется `false` при подключении через HTTPAPI (mso или nd) и `true` при использовании устаревшего метода подключения (только для mso). Варианты: `false` `true`
username string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs boolean	Если `false`, проверка SSL-сертификатов выполняться не будет. Устанавливайте значение `false` только на сайтах, находящихся под вашим контролем и использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_VALIDATE_CERTS`. По умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

Этот модуль создан для поддержки Multi Site Orchestrator v2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

Примеры

- 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

- 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

- 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

- name: Download a backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup
    destination: ./
    state: download

- name: Upload a backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: ./Backup
    state: upload

- name: Restore a backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup
    state: restore

- name: Remove a Backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup
    state: absent

- name: Query a backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup
    state: query
  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
  register: query_result

- name: Query all backups
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    state: query
  register: query_result

Авторы

Shreyas Srish (@shrsr)
Lionel Hercot (@lhercot)
Sabari Jaganathan (@sajagana)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/mso/mso_backup_module.html