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

Примечание

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

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

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

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

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

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

Обзор

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

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Комментарии
account string	Учетная запись, к которой относится том.
api_http_method string	HTTP-метод, используемый для запроса к конечной точке API. Если не указано, используется переменная окружения `CLOUDSTACK_METHOD`. Варианты: `"get"` ← (default) `"post"`
api_key string / required	API-ключ CloudStack API. Если не указано, используется переменная окружения `CLOUDSTACK_KEY`.
api_secret string / required	Секретный ключ CloudStack API. Если не указано, используется переменная окружения `CLOUDSTACK_SECRET`.
api_timeout integer	Таймаут HTTP в секундах. Если не указано, используется переменная окружения `CLOUDSTACK_TIMEOUT`. По умолчанию: `10`
api_url string / required	URL CloudStack API, например https://cloud.example.com/client/api. Если не указано, используется переменная окружения `CLOUDSTACK_ENDPOINT`.
api_verify_ssl_cert string	Проверить файл сертификата центра сертификации. Если не указано, используется переменная окружения `CLOUDSTACK_VERIFY`.
device_id integer	ID устройства на виртуальной машине, к которой присоединен том. Это будет учитываться только в том случае, если виртуальная машина имеет несколько томов DATADISK.
domain string	Домен, к которому относится том.
interval_type aliases: interval string	Интервал снимка. Варианты: `"hourly"` `"daily"` ← (default) `"weekly"` `"monthly"`
max_snaps aliases: 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"` ← (default) `"absent"`
time_zone aliases: timezone string	Указывает часовой пояс для этой команды. По умолчанию: `"UTC"`
validate_certs boolean added in ngine_io.cloudstack 2.4.0	Если `false`, SSL-сертификаты проверяться не будут. Если не указано, используется переменная окружения `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY`. Это следует использовать только на лично контролируемых сайтах, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (default)
vm 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.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 string	Аккаунт, к которому относится том. Возвращается: success Пример: `"example account"`
domain string	Домен, к которому относится том. Возвращается: success Пример: `"example domain"`
id string	UUID политики создания моментальных снимков. Возвращается: success Пример: `"a6f7a5fc-43f8-11e5-a151-feff819cdc9f"`
interval_type string	Тип интервала политики создания моментальных снимков. Возвращается: success Пример: `"daily"`
max_snaps integer	Максимальное количество сохранённых снимков. Возвращается: success Пример: `10`
project string	Имя проекта, к которому относится том. Возвращается: success Пример: `"Production"`
schedule string	Расписание политики создания моментальных снимков. Возвращается: success
time_zone string	Часовой пояс политики создания моментальных снимков. Возвращается: success Пример: `"Etc/UTC"`
volume string	Том политики создания моментальных снимков. Возвращается: success Пример: `"Etc/UTC"`
zone string	Имя зоны, к которой относится том. Возвращается: success Пример: `"ch-gva-2"`

Авторы

René Moser (@resmo)

Ссылки на сборку

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