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

Примечание

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

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

Для использования в playbook укажите: 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`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию — `get`, если не указано.
api_key строка		Ключ API CloudStack API. Если не задано, используется значение переменной среды `CLOUDSTACK_KEY`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания.
api_region строка	По умолчанию: "cloudstack"	Имя раздела ini в файле `cloustack.ini`. Если не задано, используется значение переменной среды `CLOUDSTACK_REGION`.
api_secret строка		Секретный ключ CloudStack API. Если не задано, используется значение переменной среды `CLOUDSTACK_SECRET`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания.
api_timeout целое число		Таймаут HTTP в секундах. Если не задано, используется значение переменной среды `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию — 10 секунд, если не указано.
api_url строка		URL CloudStack API, например, https://cloud.example.com/client/api. Если не задано, используется значение переменной среды `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания.
api_verify_ssl_cert строка		Файл сертификата CA. Если не задано, используется значение переменной среды `CLOUDSTACK_VERIFY`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию — `null`, если не указано.
device_id целое число		Идентификатор устройства на виртуальной машине, к которому прикреплен том. Будет учитываться только в том случае, если у виртуальной машины несколько томов 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, если у виртуальной машины есть том DATADISK и ROOT. В случае volume_type=DATADISK, дополнительно используйте device_id, если у виртуальной машины более одного тома DATADISK. Требуется либо volume, либо vm.
volume строка		Имя тома. Требуется либо volume, либо vm.
volume_type строка	Варианты: DATADISK ROOT	Тип тома.
vpc строка		Имя VPC, в котором развернут экземпляр.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация считывается из нескольких источников в указанном порядке. CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменные среды CLOUDSTACK_TIMEOUT. Переменная среды CLOUDSTACK_CONFIG, указывающая на файл .ini. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Дополнительно, можно указать несколько учетных данных и точек входа, используя разделы ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию раздел cloudstack. Для получения дополнительной информации обратитесь к https://github.com/exoscale/cs.
Подробное руководство по модулям 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 строка	success	Аккаунт, к которому относится том. Пример: example account
domain строка	success	Домен, к которому относится том. Пример: example domain
id строка	success	UUID политики создания моментальных снимков. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
interval_type строка	success	Тип интервала политики создания моментальных снимков. Пример: daily
max_snaps целое число	success	Максимальное число сохраняемых снимков. Пример: 10
project строка	success	Имя проекта, к которому относится том. Пример: Production
schedule строка	success	График политики создания моментальных снимков.
time_zone строка	success	Часовой пояс политики создания моментальных снимков. Пример: Etc/UTC
volume строка	success	том политики создания моментальных снимков. Пример: Etc/UTC
zone строка	success	Имя зоны, к которой относится том. Пример: ch-gva-2

Авторы

René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ngine_io/cloudstack/cs_snapshot_policy_module.html