Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.scaleway_database_backup.

Добавлено в community.general 1.2.0

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

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

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

Требования

Указанные ниже компоненты должны быть установлены на узле, где выполняется этот модуль.

  • PyYAML (если используется profile)

Параметры

Параметр

Комментарии

api_timeout

псевдонимы: timeout

integer

Тайм-аут HTTP-запросов к API Scaleway в секундах.

По умолчанию: 30

api_token

псевдонимы: oauth_token

string

Токен OAuth Scaleway.

Обязателен, если не указан profile.

api_url

псевдонимы: base_url

string

URL API Scaleway.

По умолчанию: "https://api.scaleway.com"

database_name

string

Имя для идентификации базы данных.

Обязательно для состояний present и restored.

Игнорируется в состояниях state=absent или state=exported.

expires_at

string

Дата и время истечения срока действия резервной копии базы данных (формат ISO 8601).

Игнорируется в состояниях state=absent, state=exported или state=restored.

id

string

UUID для идентификации резервной копии базы данных.

Обязательно для состояний absent, exported и restored.

instance_id

string

UUID экземпляра, связанного с резервной копией базы данных.

Обязательно для состояний present и restored.

Игнорируется в состояниях state=absent или state=exported.

name

string

Имя для идентификации резервной копии базы данных.

Обязательно для состояния present.

Игнорируется в состояниях state=absent, state=exported или state=restored.

profile

псевдонимы: scw_profile

string

добавлено в community.general 12.2.0

Профиль конфигурации в файле конфигурации, из которого загружается токен OAuth Scaleway; используется вместо api_token.

Также можно задать SCW_PROFILE, чтобы использовать профиль конфигурации SCW CLI.

query_parameters

dictionary

Список параметров, передаваемых в строке запроса.

По умолчанию: {}

region

string / обязательный

Регион Scaleway (например, fr-par).

Варианты:

  • "fr-par"
  • "nl-ams"
  • "pl-waw"

state

string

Указывает требуемое состояние резервной копии базы данных.

present создает резервную копию.

absent удаляет резервную копию.

exported создает ссылку для скачивания резервной копии.

restored восстанавливает резервную копию в новую базу данных.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
  • "exported"
  • "restored"

validate_certs

boolean

Проверять SSL-сертификаты API Scaleway.

Варианты:

  • false
  • true ← (по умолчанию)

wait

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

wait_sleep_time

integer

Время ожидания перед каждой попыткой проверить состояние резервной копии.

По умолчанию: 3

wait_timeout

integer

Время ожидания перехода резервной копии в ожидаемое состояние.

По умолчанию: 300

Атрибуты

Атрибут

Поддержка

Описание

action_group

Группа действий: community.general.scaleway

добавлено в community.general 11.3.0

Используйте group/community.general.scaleway в module_defaults, чтобы задать значения по умолчанию для этого модуля.

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

dictionary

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

Возвращается: если 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/scaleway_database_backup_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API