Spec-Zone.ru › Ansible

Модуль hetzner.hcloud.location_info — сбор сведений о расположениях Hetzner Cloud.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

string

Конечная точка API Hetzner Cloud.

Эту настройку также можно задать с помощью переменной среды HCLOUD_ENDPOINT.

По умолчанию: "https://api.hetzner.cloud/v1"

api_endpoint_hetzner

string

Конечная точка API Hetzner.

Эту настройку также можно задать с помощью переменной среды HETZNER_ENDPOINT.

По умолчанию: "https://api.hetzner.com/v1"

api_token

string / обязательный

Токен для API Hetzner Cloud.

Эту настройку также можно задать с помощью переменной среды HCLOUD_TOKEN.

id

integer

Идентификатор расположения, которое необходимо получить.

Модуль завершится с ошибкой, если указан недопустимый идентификатор.

name

string

Название расположения, которое необходимо получить.

См. также

См. также

Документация по API Hetzner

Полный справочник по API Hetzner.

Примеры

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

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

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

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

Ключ

Описание

hcloud_location_info

list / elements=string

Сведения о расположениях в виде списка

Возвращается: всегда

city

string

Город, в котором находится расположение

Возвращается: всегда

Пример: "Falkenstein"

country

string

Код страны, в которой находится расположение

Возвращается: всегда

Пример: "DE"

description

string

Подробное описание расположения

Возвращается: всегда

Пример: "Falkenstein DC Park 1"

id

integer

Числовой идентификатор расположения

Возвращается: всегда

Пример: 1937415

name

string

Название расположения

Возвращается: всегда

Пример: "fsn1"

Авторы

  • Lukas Kaemmerling (@LKaemmerling)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Справочник по API Hetzner Cloud
  • Журнал изменений API Hetzner Cloud

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API