Модуль hetzner.hcloud.volume_info – Сбор информации о ваших томах Hetzner Cloud.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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_token строка / обязательно	Токен API Hetzner Cloud. Вы также можете задать этот параметр, используя переменную среды `HCLOUD_TOKEN`.
id целое число	ID тома, информацию о котором вы хотите получить. Модуль завершит работу с ошибкой, если предоставленный ID некорректен.
label_selector строка	Селектор меток для тома, информацию о котором вы хотите получить.
name строка	Имя тома, информацию о котором вы хотите получить.

См. также

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

Примеры

- 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	Истинно, если том защищен от удаления Возвращается: всегда
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/volume_info_module.html