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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: 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 / обязательный	ID проекта устройства.
size integer	Размер тома в гигабайтах.
snapshot_policy dictionary	Политика создания снимков для нового тома.
snapshot_count integer / обязательный	Количество снимков, которые нужно сохранить (положительное целое число).
snapshot_frequency string / обязательный	Частота создания снимков. Варианты: `"15min"` `"1hour"` `"1day"` `"1week"` `"1month"` `"1year"`
state string	Требуемое состояние тома. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

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

Примеры

# 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 string	Описание ресурса тома, заданное пользователем. Возвращается: при успешном выполнении Пример: `"Just another volume"`
id string	UUID указанного тома. Возвращается: при успешном выполнении Пример: `"53000fb2-ee46-4673-93a8-de2c2bdba33c"`
name string	Имя ресурса тома, сгенерированное API. Возвращается: если том подключается к устройству или отключается от него Пример: `"volume-a91dc506"`

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/packet_volume_module.html