Модуль 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 в секундах. По умолчанию: |
api_token псевдонимы: oauth_token string | Токен OAuth Scaleway. Обязателен, если не указан |
api_url псевдонимы: base_url string | URL API Scaleway. По умолчанию: |
database_name string | Имя для идентификации базы данных. Обязательно для состояний Игнорируется в состояниях |
expires_at string | Дата и время истечения срока действия резервной копии базы данных (формат ISO 8601). Игнорируется в состояниях |
id string | UUID для идентификации резервной копии базы данных. Обязательно для состояний |
instance_id string | UUID экземпляра, связанного с резервной копией базы данных. Обязательно для состояний Игнорируется в состояниях |
name string | Имя для идентификации резервной копии базы данных. Обязательно для состояния Игнорируется в состояниях |
profile псевдонимы: scw_profile string добавлено в community.general 12.2.0 | Профиль конфигурации в файле конфигурации, из которого загружается токен OAuth Scaleway; используется вместо Также можно задать |
query_parameters dictionary | Список параметров, передаваемых в строке запроса. По умолчанию: |
region string / обязательный | Регион Scaleway (например, Варианты:
|
state string | Указывает требуемое состояние резервной копии базы данных.
Варианты:
|
validate_certs boolean | Проверять SSL-сертификаты API Scaleway. Варианты:
|
wait boolean | Ожидать, пока экземпляр не достигнет требуемого состояния, прежде чем вернуть управление. Варианты:
|
wait_sleep_time integer | Время ожидания перед каждой попыткой проверить состояние резервной копии. По умолчанию: |
wait_timeout integer | Время ожидания перехода резервной копии в ожидаемое состояние. По умолчанию: |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
action_group | Группа действий: community.general.scaleway добавлено в community.general 11.3.0 | Используйте |
check_mode | Поддержка: полная | Модуль может работать в режиме |
diff_mode | Поддержка: нет | В режиме diff возвращает сведения об изменениях (или возможных изменениях в |
Примечания
Примечание
- См. также документацию 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 | Метаданные резервной копии. Возвращается: если Пример: |
Ссылки на коллекцию
© 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