ngine_io.cloudstack.volume_snapshot_policy module – Управляет политиками создания снимков томов в облаках на базе Apache CloudStack.

Примечание

Этот модуль входит в коллекцию ngine_io.cloudstack (версия 3.0.0).

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

Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: ngine_io.cloudstack.volume_snapshot_policy.

Добавлено в ngine_io.cloudstack 0.1.0

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

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

Создаёт, обновляет и удаляет политики создания снимков томов.

Псевдонимы: cs_snapshot_policy

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Комментарии
account string	Учётная запись, к которой относится том.
api_http_method string	HTTP-метод, используемый для обращения к конечной точке API. Если не указано, используется переменная окружения `CLOUDSTACK_METHOD`. Варианты: `"get"` ← (по умолчанию) `"post"`
api_key string / обязательный	Ключ API CloudStack. Если не указано, используется переменная окружения `CLOUDSTACK_KEY`.
api_secret string / обязательный	Секретный ключ API CloudStack. Если не указано, используется переменная окружения `CLOUDSTACK_SECRET`.
api_timeout integer	Тайм-аут HTTP в секундах. Если не указано, используется переменная окружения `CLOUDSTACK_TIMEOUT`. По умолчанию: `10`
api_url string / обязательный	URL API CloudStack, например https://cloud.example.com/client/api. Если не указано, используется переменная окружения `CLOUDSTACK_ENDPOINT`.
api_verify_ssl_cert string	Проверять файл сертификата центра сертификации. Если не указано, используется переменная окружения `CLOUDSTACK_VERIFY`.
device_id integer	ID устройства виртуальной машины, к которому подключён том. Учитывается только в том случае, если у виртуальной машины несколько томов DATADISK.
domain string	Домен, к которому относится том.
interval_type псевдонимы: interval string	Интервал создания снимков. Варианты: `"hourly"` `"daily"` ← (по умолчанию) `"weekly"` `"monthly"`
max_snaps псевдонимы: max integer	Максимальное количество снимков. По умолчанию: `8`
project string	Название проекта, к которому относится том.
schedule string	Время создания снимка по расписанию. Обязательно, если state=present. Формат для interval_type=HOURLY: `MM` Формат для interval_type=DAILY: `MM:HH` Формат для interval_type=WEEKLY: `MM:HH:DD (1-7`) Формат для interval_type=MONTHLY: `MM:HH:DD (1-28`)
state string	Состояние политики создания снимков. Варианты: `"present"` ← (по умолчанию) `"absent"`
time_zone псевдонимы: timezone string	Указывает часовой пояс для этой команды. По умолчанию: `"UTC"`
validate_certs boolean добавлено в ngine_io.cloudstack 2.4.0	Если значение равно `false`, SSL-сертификаты проверяться не будут. Если не указано, используется переменная окружения `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY`. Используйте этот параметр только на сайтах под вашим личным контролем, где применяются самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)
vm псевдонимы: instance string	Название виртуальной машины/экземпляра, из которого нужно выбрать том. Используйте volume_type, если у виртуальной машины есть тома DATADISK и ROOT. Если указано volume_type=DATADISK, дополнительно задайте device_id, если у виртуальной машины несколько томов DATADISK. Необходимо указать либо volume, либо vm.
volume string	Название тома. Необходимо указать либо volume, либо vm.
volume_type string	Тип тома. Варианты: `"DATADISK"` `"ROOT"`
vpc string	Название VPC, в которой развёрнут экземпляр.

Примечания

Примечание

Подробное руководство по модулям CloudStack можно найти в руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: ensure a snapshot policy daily at 1h00 UTC
  ngine_io.cloudstack.volume_snapshot_policy:
    volume: ROOT-478
    schedule: '00:1'
    max_snaps: 3

- name: ensure a snapshot policy daily at 1h00 UTC on the second DATADISK of VM web-01
  ngine_io.cloudstack.volume_snapshot_policy:
    vm: web-01
    volume_type: DATADISK
    device_id: 2
    schedule: '00:1'
    max_snaps: 3

- name: ensure a snapshot policy hourly at minute 5 UTC
  ngine_io.cloudstack.volume_snapshot_policy:
    volume: ROOT-478
    schedule: '5'
    interval_type: hourly
    max_snaps: 1

- name: ensure a snapshot policy weekly on Sunday at 05h00, TZ Europe/Zurich
  ngine_io.cloudstack.volume_snapshot_policy:
    volume: ROOT-478
    schedule: '00:5:1'
    interval_type: weekly
    max_snaps: 1
    time_zone: 'Europe/Zurich'

- name: ensure a snapshot policy is absent
  ngine_io.cloudstack.volume_snapshot_policy:
    volume: ROOT-478
    interval_type: hourly
    state: absent

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

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

Ключ	Описание
account string	Учётная запись, к которой относится том. Возвращается: при успехе Пример: `"example account"`
domain string	Домен, к которому относится том. Возвращается: при успехе Пример: `"example domain"`
id string	UUID политики создания снимков. Возвращается: при успехе Пример: `"a6f7a5fc-43f8-11e5-a151-feff819cdc9f"`
interval_type string	Тип интервала политики создания снимков. Возвращается: при успехе Пример: `"daily"`
max_snaps integer	Максимальное количество сохраняемых снимков. Возвращается: при успехе Пример: `10`
project string	Название проекта, к которому относится том. Возвращается: при успехе Пример: `"Production"`
schedule string	Расписание политики создания снимков. Возвращается: при успехе
time_zone string	Часовой пояс политики создания снимков. Возвращается: при успехе Пример: `"Etc/UTC"`
volume string	Том, для которого задана политика создания снимков. Возвращается: при успехе Пример: `"Etc/UTC"`
zone string	Название зоны, к которой относится том. Возвращается: при успехе Пример: `"ch-gva-2"`

Авторы

René Moser (@resmo)

Ссылки на коллекцию

© 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/ngine_io/cloudstack/volume_snapshot_policy_module.html