Модуль hetzner.hcloud.location_info – Сбор информации о расположениях Hetzner Cloud.

Примечание

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

Возможная установка этой коллекции при использовании пакета ansible. Она не включена в ansible-core. Проверьте установку, выполнив ansible-galaxy collection list.

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

Для использования в плейбуке укажите: hetzner.hcloud.location_info.

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

Обзор

Сбор информации о расположениях Hetzner Cloud.

Псевдонимы: hcloud_location_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 недействителен.
name строка	Имя расположения, которое требуется получить.

См. также

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

Примеры

- name: Gather hcloud location infos
  hetzner.hcloud.location_info:
  register: output

- name: Print the gathered infos
  debug:
    var: output

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

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

Ключ	Описание
hcloud_location_info сложный	Информация о расположении как список Возвращается: всегда
city строка	Город расположения Возвращается: всегда Пример: `"Falkenstein"`
country строка	Код страны расположения Возвращается: всегда Пример: `"DE"`
description строка	Подробное описание расположения Возвращается: всегда Пример: `"Falkenstein DC Park 1"`
id целое число	Числовой идентификатор расположения Возвращается: всегда Пример: `1937415`
name строка	Имя расположения Возвращается: всегда Пример: `"fsn1"`

Авторы

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/location_info_module.html