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

Примечание

Этот плагин является частью коллекции ngine_io.cloudstack (версия 2.0.0).

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

Для использования в плейбуке укажите: ngine_io.cloudstack.cs_snapshot_policy.

Добавлена в версии 0.1.0: модуля ngine_io.cloudstack

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

Обзор

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

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится том.
api_http_method строка	Варианты: get ← post	HTTP-метод, используемый для запроса к API-точке. Если не указано, используется значение переменной среды `CLOUDSTACK_METHOD`.
api_key строка / обязательно		API-ключ CloudStack API. Если не указано, используется значение переменной среды `CLOUDSTACK_KEY`.
api_secret строка / обязательно		Секретный ключ CloudStack API. Если не указано, используется значение переменной среды `CLOUDSTACK_SECRET`.
api_timeout целое число	По умолчанию: 10	Таймаут HTTP в секундах. Если не указано, используется значение переменной среды `CLOUDSTACK_TIMEOUT`.
api_url строка / обязательно		URL CloudStack API, например, https://cloud.example.com/client/api. Если не указано, используется значение переменной среды `CLOUDSTACK_ENDPOINT`.
api_verify_ssl_cert строка		Проверка сертификата CA. Если не указано, используется значение переменной среды `CLOUDSTACK_VERIFY`.
device_id целое число		ID устройства на виртуальной машине, к которому подключен том. Это учитывается только если у VM несколько томов DATADISK.
domain строка		Домен, к которому относится том.
interval_type строка	Варианты: hourly daily ← weekly monthly	Интервал создания снимка. псевдонимы: interval
max_snaps целое число	По умолчанию: 8	Максимальное количество снимков. псевдонимы: max
project строка		Имя проекта, к которому относится том.
schedule строка		Время планируемого создания снимка. Обязательно, если 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 строка	Варианты: present ← absent	Состояние политики снимка.
time_zone строка	По умолчанию: "UTC"	Указывает часовой пояс для данной команды. псевдонимы: timezone
vm строка		Имя экземпляра для выбора тома. Используйте volume_type, если у VM есть том DATADISK и ROOT. В случае volume_type=DATADISK дополнительно используйте device_id, если у VM несколько томов DATADISK. Требуется либо volume, либо vm.
volume строка		Имя тома. Требуется либо volume, либо vm.
volume_type строка	Варианты: DATADISK ROOT	Тип тома.
vpc строка		Имя VPC, в котором развернут экземпляр.

Примечания

Примечание

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

Примеры

- name: ensure a snapshot policy daily at 1h00 UTC
  ngine_io.cloudstack.cs_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.cs_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.cs_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.cs_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.cs_snapshot_policy:
    volume: ROOT-478
    interval_type: hourly
    state: absent

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

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

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

Авторы

René Moser (@resmo)

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