Spec-Zone.ru › Ansible

Модуль hetzner.hcloud.network – Создание и управление облачными сетями на Hetzner Cloud.

Примечание

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

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

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

Для использования в книге задач укажите: hetzner.hcloud.network.

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

Описание

  • Создание, обновление и управление облачными сетями на Hetzner Cloud.
  • Вам потребуется не менее hcloud-python 1.3.0.

Псевдонимы: hcloud_network

Требования

Ниже перечислены требования, необходимые на хосте, выполняющем этот модуль.

  • 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.

delete_protection

логическое

Защитить сеть от удаления.

Варианты:

  • false
  • true

expose_routes_to_vswitch

логическое

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

Экспонирование применяется только при активном подключении vSwitch.

Варианты:

  • false
  • true

id

целое число

Идентификатор облачных сетей Hetzner Cloud для управления.

Требуется только если не задано имя сети.

ip_range

строка

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

Требуется, если сеть не существует.

labels

словарь

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

name

строка

Имя облачной сети Hetzner Cloud для управления.

Требуется только если не задан идентификатор сети или сеть не существует.

state

строка

Состояние сети.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

См. также

См. также

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

Полное описание API Hetzner Cloud.

Примеры

- name: Create a basic network
  hetzner.hcloud.network:
    name: my-network
    ip_range: 10.0.0.0/8
    state: present

- name: Ensure the Network is absent (remove if needed)
  hetzner.hcloud.network:
    name: my-network
    state: absent

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

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

Ключ

Описание

hcloud_network

сложный

Сеть

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

delete_protection

булево

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

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

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

Пример: false

expose_routes_to_vswitch

булево

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

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

Пример: false

id

целое число

Идентификатор сети

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

Пример: 12345

ip_range

строка

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

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

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

labels

словарь

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

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

Пример: {"key": "value", "mylabel": 123}

name

строка

Имя сети

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

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

Авторы

  • Lukas Kaemmerling (@lkaemmerling)

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

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

Spec-Zone.ru

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