community.general.scaleway_database_backup – Модуль управления резервными копий баз данных Scaleway

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.scaleway_database_backup.

Новое в версии 1.2.0: of community.general

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

Обзор

Этот модуль управляет резервными копиями баз данных на аккаунте Scaleway https://developer.scaleway.com.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число	Значение по умолчанию: 30	Таймаут HTTP-запросов к API Scaleway в секундах. псевдонимы: timeout
api_token строка / обязательный		Токен Scaleway OAuth. псевдонимы: oauth_token
api_url строка	Значение по умолчанию: "https://api.scaleway.com"	URL API Scaleway. псевдонимы: base_url
database_name строка		Имя, используемое для идентификации базы данных. Требуется для состояний `present` и `restored`. Игнорируется, когда используется `state=absent` или `state=exported`.
expires_at строка		Дата и время истечения срока действия резервной копии базы данных (формат ISO 8601). Игнорируется, когда используются `state=absent`, `state=exported` или `state=restored`.
id строка		UUID, используемый для идентификации резервной копии базы данных. Требуется для состояний `absent`, `exported` и `restored`.
instance_id строка		UUID экземпляра, связанного с резервной копией базы данных. Требуется для состояний `present` и `restored`. Игнорируется, когда используется `state=absent` или `state=exported`.
name строка		Имя, используемое для идентификации резервной копии базы данных. Требуется для состояния `present`. Игнорируется, когда используются `state=absent`, `state=exported` или `state=restored`.
query_parameters словарь	Значение по умолчанию: {}	Список параметров, передаваемых в строку запроса.
region строка / обязательный	Варианты: fr-par nl-ams pl-waw	Регион Scaleway для использования (например, `fr-par`).
state строка	Варианты: present ← absent exported restored	Указывает желаемое состояние резервной копии базы данных. `present` создаёт резервную копию. `absent` удаляет резервную копию. `exported` создаёт ссылку для скачивания резервной копии. `restored` восстанавливает резервную копию в новую базу данных.
validate_certs булево	Варианты: no yes ←	Проверка SSL-сертификатов API Scaleway.
wait булево	Варианты: no ← yes	Ожидание завершения операции над экземпляром перед возвратом.
wait_sleep_time целое число	Значение по умолчанию: 3	Время ожидания перед каждой попыткой проверки состояния резервной копии.
wait_timeout целое число	Значение по умолчанию: 300	Время ожидания достижения резервной копией ожидаемого состояния.

Примечания

Примечание

См. также документацию API на https://developer.scaleway.com/
Если api_token не задано в модуле, можно использовать следующие переменные среды в порядке убывания приоритета: SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN или SCW_API_TOKEN.
Если нужно использовать другой api_url, можно также установить переменную среды SCW_API_URL.

Примеры

- name: Create a backup
  community.general.scaleway_database_backup:
      name: 'my_backup'
      state: present
      region: 'fr-par'
      database_name: 'my-database'
      instance_id: '50968a80-2909-4e5c-b1af-a2e19860dddb'

- name: Export a backup
  community.general.scaleway_database_backup:
      id: '6ef1125a-037e-494f-a911-6d9c49a51691'
      state: exported
      region: 'fr-par'

- name: Restore a backup
  community.general.scaleway_database_backup:
      id: '6ef1125a-037e-494f-a911-6d9c49a51691'
      state: restored
      region: 'fr-par'
      database_name: 'my-new-database'
      instance_id: '50968a80-2909-4e5c-b1af-a2e19860dddb'

- name: Remove a backup
  community.general.scaleway_database_backup:
      id: '6ef1125a-037e-494f-a911-6d9c49a51691'
      state: absent
      region: 'fr-par'

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
metadata словарь	при `state=present`, `state=exported` или `state=restored`	Метаданные резервной копии. Пример: {'metadata': {'created_at': '2020-08-06T12:42:05.631049Z', 'database_name': 'my-database', 'download_url': None, 'download_url_expires_at': None, 'expires_at': None, 'id': 'a15297bd-0c4a-4b4f-8fbb-b36a35b7eb07', 'instance_id': '617be32e-6497-4ed7-b4c7-0ee5a81edf49', 'instance_name': 'my-instance', 'name': 'backup_name', 'region': 'fr-par', 'size': 600000, 'status': 'ready', 'updated_at': '2020-08-06T12:42:10.581649Z'}}

Авторы

Guillaume Rodriguez (@guillaume_ro_fr)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/scaleway_database_backup_module.html