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

Новое в версии 2.2.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

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 (добавлено в 2.3)		ID устройства на виртуальной машине, к которому прикреплён том. Будет учитываться только если у виртуальной машины несколько томов DATADISK.
domain		Домен, к которому относится том.
interval_type	Варианты: hourly daily ← weekly monthly	Интервал создания моментального снимка. Псевдонимы: interval
max_snaps	Значение по умолчанию: 8	Максимальное количество снимков. Псевдонимы: max
project		Имя проекта, к которому относится том.
schedule		Время планирования снимка. Требуется, если `state=present`. Формат для `interval_type=HOURLY`: `MM`\n Формат для `interval_type=DAILY`: `MM:HH`\n Формат для `interval_type=WEEKLY`: `MM:HH:DD (1-7`) Формат для `interval_type=MONTHLY`: `MM:HH:DD (1-28`)
state	Варианты: present ← absent	Состояние политики создания моментального снимка.
time_zone	Значение по умолчанию: "UTC"	Указывает часовой пояс для этой команды. Псевдонимы: timezone
vm (добавлено в 2.3)		Имя экземпляра для выбора тома. Используйте `volume_type`, если у VM есть том DATADISK и том ROOT. В случае `volume_type=DATADISK`, дополнительно используйте `device_id`, если у VM более одного тома DATADISK. Требуется либо `volume`, либо `vm`.
volume		Имя тома. Требуется либо `volume`, либо `vm`.
volume_type (добавлено в 2.3)	Варианты: DATADISK ROOT	Тип тома.
vpc (добавлено в 2.3)		Имя VPC, в котором развернут экземпляр.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учётные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация считывается из нескольких источников, в следующем порядке. CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD переменные окружения. Переменная среды 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
  local_action:
    module: 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
  local_action:
    module: 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
  local_action:
    module: 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
  local_action:
    module: 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
  local_action:
    module: cs_snapshot_policy
    volume: ROOT-478
    interval_type: hourly
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
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, что означает, что разработчики этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.

Техническое обслуживание

Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. Дополнительная информация доступна на странице Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, находится здесь.

Автор

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