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

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

Описание

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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, см. также примечания.
device_id целое число		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
  cs_snapshot_policy:
    volume: ROOT-478
    schedule: '00:1'
    max_snaps: 3
  delegate_to: localhost

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

- name: ensure a snapshot policy hourly at minute 5 UTC
  cs_snapshot_policy:
    volume: ROOT-478
    schedule: '5'
    interval_type: hourly
    max_snaps: 1
  delegate_to: localhost

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

- name: ensure a snapshot policy is absent
  cs_snapshot_policy:
    volume: ROOT-478
    interval_type: hourly
    state: absent
  delegate_to: localhost

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

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

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

Статус

Этот модуль гарантирует обратную совместимость интерфейса в будущем. [stableinterface]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.9/modules/cs_snapshot_policy_module.html