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

Примечание

Этот модуль входит в состав коллекции cisco.mso (версия 2.9.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 псевдонимы: имя строка	Имя, данное резервной копии `backup` является взаимоисключающим с `backup_id`. Используйте только один из двух.
backup_id псевдонимы: id строка	Идентификатор конкретной резервной копии `backup_id` является взаимоисключающим с `backup`. Используйте только один из двух.
описание строка	Краткая информация о резервной копии.
пункт назначения строка	Место, куда загрузить резервную копию
хост псевдонимы: имя_хоста строка	IP-адрес или имя хоста хоста ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_HOST`.
тип_местоположения строка	Тип расположения для хранения резервной копии Варианты: `"local"` ← (по умолчанию) `"remote"`
домен_входа строка	Имя домена входа для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI для инвентаризации будет использоваться переменная `ansible_httpapi_login_domain`, если этот атрибут не указан.
уровень_вывода строка	Влияет на вывод этого модуля MSO. `normal` означает стандартный вывод, вкл. `current` dict `info` добавляет информационный вывод, вкл. `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, вкл. `filter_string`, `method`, `response`, `status` и `url` информацию Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
пароль строка	Пароль для аутентификации. Если значение не указано в задаче, вместо него будут использованы переменные среды `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
порт целое число	Номер порта, который будет использоваться для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_PORT`.
удаленное_местоположение строка	Имя удаленного расположения, где должна храниться резервная копия
удаленный_путь строка	Этот путь относительный к удаленному расположению. Символ ‘/’ автоматически добавляется между папкой удаленного расположения и этим путем. Эта структура папок должна уже существовать в удаленном расположении.
состояние строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов. Используйте `upload` для загрузки резервной копии. Используйте `restore` для восстановления резервной копии. Используйте `download` для скачивания резервной копии. Используйте `move` для перемещения резервной копии из локального в удаленное расположение. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"` `"upload"` `"restore"` `"download"` `"move"`
таймаут целое число	Таймаут уровня сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_TIMEOUT`.
использовать_прокси булево	Если `false`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
использовать_ssl булево	Если `false`, вместо стандартного HTTPS соединения будет использовано HTTP-соединение. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_SSL`. При использовании плагина подключения HTTPAPI для инвентаризации будет использоваться переменная `ansible_httpapi_use_ssl`, если этот атрибут не указан. Значение по умолчанию — `false` при использовании плагина HTTPAPI подключения (mso или nd) и `true` при использовании устаревшего метода подключения (только для mso). Варианты: `false` `true`

логин

строка

Имя пользователя для аутентификации.

Если значение не указано в задаче, будет использовано значение переменных среды MSO_USERNAME или ANSIBLE_NET_USERNAME.

validate_certs

булево

Если 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/mso_backup_module.html