community.general.packet_volume – Создание/удаление тома в хосте Packet.
Примечание
Этот плагин входит в состав коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.packet_volume.
Новое в версии 0.2.0: из community.general
Описание
- Создание/удаление тома в хосте Packet.
- Документация API доступна по адресу https://www.packet.com/developers/api/#volumes.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- packet-python >= 1.35
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_token строка | Токен API Packet. Вы также можете указать его в переменной окружения PACKET_API_TOKEN. | ||
| billing_cycle строка |
| Период выставления счетов для нового тома. | |
| description строка | Пользовательское описание атрибута для тома Packet. Используется в качестве идентификатора для идемпотентности — если том с заданным описанием уже существует, новый не создаётся. | ||
| facility строка | Расположение тома. Томы могут быть подключены только к устройству в том же месте. | ||
| id строка | UUID тома. | ||
| locked логическое |
| Создать новый заблокированный том. | |
| name строка | Выбор имени, сгенерированного API для тома. | ||
| plan строка |
| storage_1 для стандартного уровня, storage_2 для премиального (высокой производительности) уровня. Уровни описаны на странице https://www.packet.com/cloud/storage/. | |
| project_id строка / обязательно | ID проекта устройства. | ||
| size целое число | Размер тома в гигабайтах. | ||
| snapshot_policy словарь | Политика создания снимков для нового тома. | ||
| snapshot_count целое число / обязательно | Количество снимков, которые нужно сохранить. Положительное целое число. | ||
| snapshot_frequency строка / обязательно |
| Частота создания снимков. | |
| state строка |
| Желаемое состояние тома. | |
Примеры
# All the examples assume that you have your Packet API token in env var PACKET_API_TOKEN.
# You can also pass the api token in module param auth_token.
- hosts: localhost
vars:
volname: testvol123
project_id: 53000fb2-ee46-4673-93a8-de2c2bdba33b
tasks:
- name: Create volume
community.general.packet_volume:
description: "{{ volname }}"
project_id: "{{ project_id }}"
facility: 'ewr1'
plan: 'storage_1'
state: present
size: 10
snapshot_policy:
snapshot_count: 10
snapshot_frequency: 1day
register: result_create
- name: Delete volume
community.general.packet_volume:
id: "{{ result_create.id }}"
project_id: "{{ project_id }}"
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в разделе здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка | success | Пользовательское описание ресурса тома. Пример: Просто еще один том |
| id строка | success | UUID указанного тома Пример: 53000fb2-ee46-4673-93a8-de2c2bdba33c |
| name строка | если том подключен/отключен к/от устройства | Сгенерированное API имя ресурса тома. Пример: volume-a91dc506 |
Авторы
- Tomas Karasek (@t0mk) <tom.to.the.k@gmail.com>
- Nurfet Becirevic (@nurfet-becirevic) <nurfet.becirevic@gmail.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/packet_volume_module.html