Модуль community.general.packet_volume – Создание/удаление тома на хосте Packet

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.

Для использования в playbook, укажите: community.general.packet_volume.

Новое в community.general 0.2.0

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

Краткое описание

Создание/удаление тома на хосте Packet.
API документирован по адресу https://www.packet.com/developers/api/#volumes.

Требования

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

packet-python >= 1.35

Параметры

Параметр	Комментарии
auth_token string	Токен API Packet. Вы также можете указать его в переменной среды `PACKET_API_TOKEN`.
billing_cycle string	Цикл выставления счетов для нового тома. Варианты: `"hourly"` ← (по умолчанию) `"monthly"`
description string	Атрибут описания, определяемый пользователем, для тома Packet. Он используется как идентификатор для идемпотентности — если том с заданным описанием существует, новый не создается.
facility string	Расположение тома. Тома могут быть присоединены только к устройству в том же расположении.
id string	UUID тома.
locked boolean	Создать новый заблокированный том. Варианты: `false` ← (по умолчанию) `true`
name string	Селектор для имени тома, сгенерированного API
plan string	storage_1 для стандартного уровня, storage_2 для премиального (высокопроизводительного) уровня. Уровни описаны по адресу https://www.packet.com/cloud/storage/. Варианты: `"storage_1"` ← (по умолчанию) `"storage_2"`
project_id string / required	ID проекта устройства.
size integer	Размер тома в гигабайтах.
snapshot_policy dictionary	Политика создания снимков для нового тома.
snapshot_count integer / required	Сколько снимков хранить, положительное целое число.
snapshot_frequency string / required	Частота создания снимков. Варианты: `"15min"` `"1hour"` `"1day"` `"1week"` `"1month"` `"1year"`
state string	Требуемое состояние тома. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз состояния «изменено» без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	Возвращает подробную информацию о том, что изменилось (или, возможно, требует изменения в `check_mode`), в режиме diff.

Примеры

# 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 Пример: `"Just another volume"`
id строка	UUID указанного тома. Возвращается: success Пример: `"53000fb2-ee46-4673-93a8-de2c2bdba33c"`
name строка	Сгенерированное API имя ресурса тома. Возвращается: если том прикреплен/откреплен от устройства Пример: `"volume-a91dc506"`

Авторы

Tomas Karasek (@t0mk)
Nurfet Becirevic (@nurfet-becirevic)

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

© 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/community/general/packet_volume_module.html