модуль hetzner.hcloud.storage_box_info — сбор сведений о хранилищах Hetzner Storage Box.

Примечание

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

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

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

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

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

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

Сбор сведений о хранилищах Hetzner Storage Box.
Подробности см. в документации API Storage Boxes.

Псевдонимы: hcloud_storage_box_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 целое число	Идентификатор Storage Box, сведения о котором нужно получить. Если идентификатор недействителен, выполнение модуля завершится ошибкой.
label_selector строка	Селектор меток для фильтрации Storage Box, сведения о которых нужно получить.
name строка	Имя Storage Box, сведения о котором нужно получить.

См. также

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

Примеры

- name: Gather all Storage Boxes
  hetzner.hcloud.storage_box_info:
  register: output
- name: Print the gathered infos
  debug:
    var: output.hcloud_storage_box_info

- name: Gather Storage Boxes by label
  hetzner.hcloud.storage_box_info:
    label_selector: env=prod
  register: output
- name: Print the gathered infos
  debug:
    var: output.hcloud_storage_box_info

- name: Gather a Storage Box by name
  hetzner.hcloud.storage_box_info:
    name: backups
  register: output
- name: Print the gathered infos
  debug:
    var: output.hcloud_storage_box_info[0]

- name: Gather a Storage Box by id
  hetzner.hcloud.storage_box_info:
    name: 12345
  register: output
- name: Print the gathered infos
  debug:
    var: output.hcloud_storage_box_info[0]

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

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

Ключ	Описание
hcloud_storage_box_info список / элементы=словарь	Список Storage Box. Возвращается: всегда
access_settings словарь	Параметры доступа Storage Box. Возвращается: всегда
reachable_externally логическое значение	Разрешён ли доступ извне сети Hetzner. Возвращается: всегда Пример: `false`
samba_enabled логическое значение	Включена ли подсистема Samba. Возвращается: всегда Пример: `false`
ssh_enabled логическое значение	Включена ли подсистема SSH. Возвращается: всегда Пример: `true`
webdav_enabled логическое значение	Включена ли подсистема WebDAV. Возвращается: всегда Пример: `false`
zfs_enabled логическое значение	Видна ли папка снимков ZFS. Возвращается: всегда Пример: `false`
delete_protection логическое значение	Защита Storage Box от удаления. Возвращается: всегда Пример: `false`
id целое число	Идентификатор Storage Box. Возвращается: всегда Пример: `1937415`
labels словарь	Пользовательские метки (пары «ключ—значение») Storage Box. Возвращается: всегда Пример: `{"env": "prod"}`
location строка	Название расположения Storage Box. Возвращается: всегда Пример: `"fsn1"`
name строка	Имя Storage Box. Возвращается: всегда Пример: `"my-storage-box"`
server строка	Полное доменное имя (FQDN) Storage Box. Возвращается: всегда Пример: `"u505337.your-storagebox.de"`
stats словарь	Статистика Storage Box. Возвращается: всегда
size целое число	Текущее использование диска в байтах. Возвращается: всегда Пример: `10485760`
size_data целое число	Текущее использование диска данными в байтах. Возвращается: всегда Пример: `10485760`
size_snapshots целое число	Текущее использование диска снимками в байтах. Возвращается: всегда Пример: `10485760`
status строка	Статус Storage Box. Возвращается: всегда Пример: `"active"`
storage_box_type строка	Название типа Storage Box. Возвращается: всегда Пример: `"bx11"`
system строка	Хост-система Storage Box. Возвращается: всегда Пример: `"HEL1-BX136"`
username строка	Имя пользователя Storage Box. Возвращается: всегда Пример: `"u505337"`

Авторы

Jonas Lammler (@jooola)

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

© 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/storage_box_info_module.html