Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: hetzner.hcloud.network_info.

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

Описание

  • Сбор информации о сетях Hetzner Cloud.

Псевдонимы: hcloud_network_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 network info
  local_action:
    module: hcloud_network_info

- name: Print the gathered info
  debug:
    var: hcloud_network_info

Значения возврата

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

Ключ

Описание

hcloud_network_info

сложный

Информация о сети в виде списка

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

delete_protection

логическое

добавлено в hetzner.hcloud 0.1.0

Истина, если сеть защищена от удаления

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

expose_routes_to_vswitch

логическое

Указывает, должны ли маршруты из этой сети быть доступны для подключения vSwitch.

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

Пример: false

id

целое число

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

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

Пример: 1937415

ip_range

строка

Диапазон IP-адресов сети

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

Пример: "10.0.0.0/16"

labels

словарь

Метки сети

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

name

строка

Имя сети

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

Пример: "awesome-network"

routes

сложный

Маршруты, принадлежащие сети

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

gateway

строка

Шлюз этого маршрута

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

Пример: "10.0.0.1"

ip_range

строка

Целевая сеть или хост этого маршрута.

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

Пример: "10.0.0.0/16"

servers

сложный

Серверы, подключенные к сети

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

backup_window

логическое

Временной интервал (UTC), в который будет выполняться резервное копирование, или null, если резервное копирование не включено

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

Пример: "22-02"

datacenter

строка

Название ЦОД сервера

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

Пример: "fsn1-dc14"

id

целое число

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

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

Пример: 1937415

ipv4_address

строка

Публичный IPv4-адрес сервера, None, если не существует

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

Пример: "116.203.104.109"

ipv6

строка

IPv6 сеть сервера, None, если не существует

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

Пример: "2a01:4f8:1c1c:c140::/64"

labels

словарь

Пользовательские метки (пары ключ-значение)

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

location

строка

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

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

Пример: "fsn1"

имя

строка

Имя сервера

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

Пример: "my-server"

rescue_enabled

логическое значение

Истина, если режим восстановления включен; сервер затем загрузится в систему восстановления при следующем перезапуске

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

Пример: false

тип_сервера

строка

Имя типа сервера

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

Пример: "cx11"

статус

строка

Статус сервера

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

Пример: "running"

подсети

сложный тип

Подсети, принадлежащие сети

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

шлюз

строка

Шлюз этой подсети

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

Пример: "10.0.0.1"

диапазон_ip

строка

Диапазон IP-адресов подсети

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

Пример: "10.0.0.0/24"

зона_сети

строка

Сеть подсети.

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

Пример: "eu-central"

тип

строка

Тип подсети.

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

Пример: "cloud"

Авторы

  • Christopher Schmitt (@cschmitt-hcloud)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Справочная информация по API Hetzner Cloud
  • Журнал изменений API Hetzner Cloud

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

Spec-Zone.ru

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