Модуль hetzner.hcloud.volume_info — сбор информации о томах Hetzner Cloud.

Примечание

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

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

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

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

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

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

Сбор информации о томах Hetzner Cloud.

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

Требования

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

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`.
id целое число	Идентификатор тома, сведения о котором требуется получить. Модуль завершится с ошибкой, если указанный идентификатор недействителен.
label_selector строка	Селектор меток для тома, сведения о котором требуется получить.
name строка	Имя тома, сведения о котором требуется получить.

См. также

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

Примеры

- name: Gather hcloud Volume infos
  hetzner.hcloud.volume_info:
  register: output
- name: Print the gathered infos
  debug:
    var: output.hcloud_volume_info

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

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

Ключ	Описание
hcloud_volume_info список / элементы=строка	Сведения о томах в виде списка Возвращается: всегда
delete_protection логический добавлено в hetzner.hcloud 0.1.0	True, если том защищён от удаления Возвращается: всегда
id целое число	Числовой идентификатор тома Возвращается: всегда Пример: `1937415`
labels словарь	Пользовательские метки (пары ключ-значение) Возвращается: всегда
linux_device строка добавлено в hetzner.hcloud 0.1.0	Путь к устройству, на котором находится том. Возвращается: всегда Пример: `"/dev/disk/by-id/scsi-0HC_Volume_12345"`
location строка	Название местоположения, в котором находится том Возвращается: всегда Пример: `"fsn1"`
name строка	Название тома Возвращается: всегда Пример: `"my-volume"`
server строка	Название сервера, к которому подключён том Возвращается: всегда Пример: `"my-server"`
size строка	Размер тома Возвращается: всегда Пример: `"10"`

Авторы

Lukas Kaemmerling (@LKaemmerling)

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

© 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_info_module.html