Модуль hetzner.hcloud.volume — создание и управление блочным томом в Hetzner Cloud.

Примечание

Этот модуль входит в коллекцию hetzner.hcloud (версия 6.9.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: hetzner.hcloud.volume.

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

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

Создание, обновление и подключение/отключение блочного тома в Hetzner Cloud.

Псевдонимы: hcloud_volume

Требования

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

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Комментарии
api_endpoint псевдонимы: endpoint строка	Конечная точка API Hetzner Cloud. Это значение также можно задать с помощью переменной окружения `HCLOUD_ENDPOINT`. По умолчанию: `"https://api.hetzner.cloud/v1"`
api_endpoint_hetzner строка	Конечная точка API Hetzner. Это значение также можно задать с помощью переменной окружения `HETZNER_ENDPOINT`. По умолчанию: `"https://api.hetzner.com/v1"`
api_token строка / обязательный	Токен для API Hetzner Cloud. Это значение также можно задать с помощью переменной окружения `HCLOUD_TOKEN`.
automount логическое значение	Автоматически подключать том. Варианты: `false` ← (по умолчанию) `true`
delete_protection логическое значение	Защитить том от удаления. Варианты: `false` `true`
format строка	Автоматически форматировать том при создании. Можно использовать только в том случае, если том ещё не существует. Варианты: `"xfs"` `"ext4"`
id целое число	Идентификатор блочного тома Hetzner Cloud, которым нужно управлять. Требуется, только если не указано имя тома.
labels словарь	Пользовательские пары «ключ — значение».
location строка	Расположение тома Hetzner Cloud. Обязательно, если не указан сервер, а том ещё не существует.
name строка	Имя блочного тома Hetzner Cloud, которым нужно управлять. Требуется, только если не указан идентификатор тома или том ещё не существует.
server строка	Имя сервера, к которому нужно подключить том. Обязательно, если не указано расположение, а том ещё не существует.
size целое число	Размер блочного тома в ГБ. Обязательно, если том ещё не существует.
state строка	Состояние тома. Варианты: `"absent"` `"present"` ← (по умолчанию)

См. также

Документация по API Hetzner: Полный справочник по API Hetzner.

Примеры

- name: Create a Volume
  hetzner.hcloud.volume:
    name: my-volume
    location: fsn1
    size: 100
    state: present
- name: Create a Volume and format it with ext4
  hetzner.hcloud.volume:
    name: my-volume
    location: fsn
    format: ext4
    size: 100
    state: present
- name: Mount a existing Volume and automount
  hetzner.hcloud.volume:
    name: my-volume
    server: my-server
    automount: true
    state: present
- name: Mount a existing Volume and automount
  hetzner.hcloud.volume:
    name: my-volume
    server: my-server
    automount: true
    state: present
- name: Ensure the Volume is absent (remove if needed)
  hetzner.hcloud.volume:
    name: my-volume
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
hcloud_volume словарь	Блочный том Возвращается: всегда
delete_protection логическое значение добавлено в hetzner.hcloud 0.1.0	True, если том защищён от удаления. Возвращается: всегда Пример: `false`
id целое число	Идентификатор тома Возвращается: всегда Пример: `12345`
labels словарь	Пользовательские метки (пары «ключ — значение») Возвращается: всегда Пример: `{"key": "value", "mylabel": 123}`
linux_device строка добавлено в hetzner.hcloud 0.1.0	Путь к устройству, содержащему том. Возвращается: всегда Пример: `"/dev/disk/by-id/scsi-0HC_Volume_12345"`
location строка	Название расположения тома Возвращается: всегда Пример: `"fsn1"`
name строка	Имя тома Возвращается: всегда Пример: `"my-volume"`
server строка	Имя сервера, к которому подключён том Возвращается: всегда Пример: `"my-server"`
size целое число	Размер тома в ГБ Возвращается: всегда Пример: `1337`

Авторы

Christopher Schmitt (@cschmitt-hcloud)

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

© 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/hetzner/hcloud/volume_module.html