Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

  • Сбор информации о зонах Hetzner Cloud.
  • Подробности см. в документации API зон.

Псевдонимы: hcloud_zone_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 Zone infos
  hetzner.hcloud.zone_info:
  register: output
- name: Print the gathered infos
  debug:
    var: output.hcloud_zone_info

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

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

Ключ

Описание

hcloud_zone_info

список / элементы=словарь

Сведения о зонах в виде списка.

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

authoritative_nameservers

словарь

Авторитетные серверы имён зоны.

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

assigned

список / элементы=строка

Назначенные зоне авторитетные серверы имён Hetzner.

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

Пример: ["hydrogen.ns.hetzner.com.", "oxygen.ns.hetzner.com.", "helium.ns.hetzner.de."]

delegated

список / элементы=строка

Авторитетные серверы имён, делегированные родительской DNS-зоне.

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

Пример: ["hydrogen.ns.hetzner.com.", "oxygen.ns.hetzner.com.", "helium.ns.hetzner.de."]

delegation_last_check

строка

Время последней проверки делегирования DNS-зоны (в формате ISO-8601).

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

Пример: "2023-11-06T13:36:56+00:00"

delegation_status

строка

Статус делегирования.

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

Пример: "valid"

delete_protection

логический

Защита зоны от удаления.

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

Пример: false

id

целое число

Идентификатор зоны.

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

Пример: 12345

labels

словарь

Метки, заданные пользователем (пары «ключ — значение»)

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

Пример: {"key": "value"}

mode

строка

Режим зоны.

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

Пример: "primary"

name

строка

Имя зоны.

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

Пример: "example.com"

primary_nameservers

список / элементы=словарь

Первичные серверы имён зоны.

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

address

строка

Публичный адрес IPv4 или IPv6 первичного сервера имён.

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

Пример: "203.0.113.1"

port

целое число

Порт первичного сервера имён.

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

Пример: 53

tsig_algorithm

строка

Алгоритм подписи транзакций (TSIG), используемый для создания ключа TSIG.

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

Пример: "hmac-sha256"

tsig_key

строка

Ключ подписи транзакций (TSIG).

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

record_count

целое число

Количество записей ресурсов (RR) в зоне.

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

Пример: 4

registrar

строка

Регистратор зоны.

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

Пример: "hetzner"

status

строка

Статус зоны.

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

Пример: "ok"

ttl

целое число

TTL зоны.

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

Пример: 10800

Авторы

  • Jonas Lammler (@jooola)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Справочник 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/zone_info_module.html

Spec-Zone.ru

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