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

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

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

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

Новое в community.general 1.2.0

Краткое описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout целое число	Таймаут HTTP для API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка / обязательно	Токен OAuth Scaleway.
api_url псевдонимы: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
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 строка / обязательно	Регион Scaleway для использования (например, `fr-par`). Варианты: `"fr-par"` `"nl-ams"` `"pl-waw"`
state строка	Указывает желаемое состояние резервной копии базы данных. `present` создает резервную копию. `absent` удаляет резервную копию. `exported` создает ссылку для загрузки резервной копии. `restored` восстанавливает резервную копию в новую базу данных. Варианты: `"present"` ← (по умолчанию) `"absent"` `"exported"` `"restored"`
validate_certs логическое значение	Проверять SSL-сертификаты API Scaleway. Варианты: `false` `true` ← (по умолчанию)
wait логическое значение	Ожидать, пока экземпляр не достигнет желаемого состояния, прежде чем возвращать результат. Варианты: `false` ← (по умолчанию) `true`
wait_sleep_time целое число	Время ожидания перед каждой попыткой проверить состояние резервной копии. По умолчанию: `3`
wait_timeout целое число	Время ожидания достижения резервной копией ожидаемого состояния. По умолчанию: `300`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в `check_mode` и возвращать прогноз изменённого статуса без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	В режиме diff будет возвращать подробную информацию о том, что изменилось (или, возможно, нужно изменить в `check_mode`).

Примечания

Примечание

Также см. документацию 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": null, "download_url_expires_at": null, "expires_at": null, "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"}}`

Ключ

Описание

metadata

словарь

Метаданные резервной копии.

Возвращается: когда state=present, state=exported, или state=restored

Пример: {"metadata": {"created_at": "2020-08-06T12:42:05.631049Z", "database_name": "my-database", "download_url": null, "download_url_expires_at": null, "expires_at": null, "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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/scaleway_database_backup_module.html