cs_snapshot_policy - Управляет политиками моментальных снимков томов в облаках на основе Apache CloudStack.
Новая версия 2.2.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Создание, обновление и удаление политик моментальных снимков томов.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязательно | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| account |
нет | Аккаунт, к которому относится том. |
||
| api_http_method |
нет | get |
|
Используемый HTTP-метод. |
| api_key |
нет | Ключ API CloudStack API. |
||
| api_region |
нет | cloudstack | Имя раздела ini в файле cloustack.ini. |
|
| api_secret |
нет | Секретный ключ CloudStack API. |
||
| api_timeout |
нет | 10 | Таймаут HTTP. |
|
| api_url |
нет | URL CloudStack API, например, https://cloud.example.com/client/api. |
||
| device_id (добавлен в 2.3)
|
нет | Идентификатор устройства на виртуальной машине, к которому прикреплен том.
Будет учитываться только если у ВМ несколько томов DATADISK. |
||
| domain |
нет | Домен, к которому относится том. |
||
| interval_type |
нет | daily |
|
Интервал моментального снимка.
псевдонимы: 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 |
|
Состояние политики моментального снимка. |
| time_zone |
нет | UTC | Указывает часовой пояс для этой команды.
псевдонимы: timezone |
|
| vm (добавлен в 2.3)
|
нет | Имя экземпляра для выбора тома.
Используйте
volume_type, если у ВМ есть том DATADISK и ROOT.В случае
volume_type=DATADISK, дополнительно используйте device_id, если у ВМ более одного тома DATADISK.Требуется volume или vm. |
||
| volume |
нет | Название тома.
Требуется volume или vm. |
||
| volume_type (добавлен в 2.3)
|
нет |
|
Тип тома. |
|
| vpc (добавлен в 2.3)
|
нет | Имя VPC, в котором развернут экземпляр. |
Примеры
# Ensure a snapshot policy daily at 1h00 UTC
- local_action:
module: cs_snapshot_policy
volume: ROOT-478
schedule: '00:1'
max_snaps: 3
# 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
# 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
# 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'
# Ensure a snapshot policy is absent
- local_action:
module: 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 | расписание политики моментального снимка. |
успех | строка | None |
| time_zone | часовой пояс политики моментального снимка. |
успех | строка | Etc/UTC |
| volume | том политики моментального снимка. |
успех | строка | Etc/UTC |
| zone | Имя зоны, к которой относится том. |
успех | строка | ch-gva-2 |
Примечания
Примечание
- 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 можно найти на http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет внесено обратной несовместимости в интерфейс.
Для помощи в разработке модулей, если вам это интересно, пожалуйста, прочитайте Информация и участие в сообществе, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_snapshot_policy_module.html