Модуль community.hrobot.v_switch — управление vSwitch Hetzner

Примечание

Этот модуль входит в коллекцию community.hrobot (версия 2.7.2).

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

Для установки используйте: ansible-galaxy collection install community.hrobot.

Чтобы использовать коллекцию в плейбуке, укажите: community.hrobot.v_switch.

Добавлено в community.hrobot 1.7.0

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

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

Управление vSwitch Hetzner.

Параметры

Параметр	Комментарии
hetzner_password string / обязательный	Пароль пользователя веб-службы Robot.
hetzner_user string / обязательный	Имя пользователя веб-службы Robot.
name string / обязательный	Имя vSwitch. Для идентификации vSwitch должны совпадать и имя, и VLAN. В противном случае будет создан новый vSwitch.
rate_limit_retry_timeout integer добавлено в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов. Укажите `0`, чтобы отключить повторные попытки. Укажите отрицательное значение, например `-1`, чтобы выполнять повторные попытки бесконечно. По умолчанию: `-1`
servers list / элементы=string	Список идентификаторов серверов (числовой ID сервера или его основной IPv4- или IPv6-адрес). Если параметр servers не указан, серверы не будут удалены.
state string	Состояние vSwitch. Если state равно `present`, vSwitch создается; если state равно `absent`, vSwitch удаляется. `absent` лишь отменяет vSwitch в конце текущего дня. При отмене необходимо указать `servers=[]`, если требуется активно удалить серверы из vSwitch. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Время ожидания (в секундах) настройки серверов vSwitch. По умолчанию: `180`
vlan integer / обязательный	Идентификатор VLAN для vSwitch. Диапазон значений: от 4000 до 4091. Для идентификации vSwitch должны совпадать и имя, и VLAN. В противном случае будет создан новый vSwitch.
wait boolean	Ожидать ли успешной настройки vSwitch, прежде чем определять дальнейшие действия и возвращать управление из модуля. API возвращает состояние `in process`, когда vSwitch настраивается на серверах. В этом случае модуль будет повторять попытки, пока состояние не изменится на `ready` или сервер не будет удален из vSwitch. Обратите внимание: если отключить ожидание при удалении vSwitch и серверов, модуль завершится с ошибкой `VSWITCH_IN_PROCESS`. Варианты: `false` `true` ← (по умолчанию)
wait_delay integer	Задержка (в секундах) перед повторной проверкой настройки серверов vSwitch. По умолчанию: `10`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.hrobot.robot добавлено в community.hrobot 2.1.0	Используйте `group/community.hrobot.robot` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).
idempotent	Поддержка: полная	При повторном запуске с теми же аргументами вне режима проверки второй запуск сообщает об отсутствии изменений. Это предполагает, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом.

См. также

Документация по vSwitch: Документация Hetzner по vSwitch для подключения выделенных серверов.

Примеры

---
- name: Create vSwitch with VLAN 4010 and name foo
  community.hrobot.v_switch:
    hetzner_user: foo
    hetzner_password: bar
    vlan: 4010
    name: foo

- name: Create vSwitch with VLAN 4020 and name foo with two servers
  community.hrobot.v_switch:
    hetzner_user: foo
    hetzner_password: bar
    vlan: 4010
    name: foo
    servers:
      - 123.123.123.123
      - 154323

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

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

Ключ	Описание
v_switch dictionary	Информация о vSwitch. Возвращается: при успехе
cancelled boolean	Статус отмены. Возвращается: при успехе Пример: `false`
cloud_network list / элементы=dictionary	Список назначенных облачных сетей. Возвращается: при успехе Пример: `[{"gateway": "10.0.2.1", "id": 123, "ip": "10.0.2.0", "mask": 24}]`
gateway string	Шлюз. Возвращается: при успехе Пример: `"10.0.2.1"`
id integer	ID облачной сети. Возвращается: при успехе Пример: `123`
ip string	IP-адрес. Возвращается: при успехе Пример: `"10.0.2.0"`
mask integer	Маска подсети в нотации CIDR. Возвращается: при успехе Пример: `24`
id integer	ID vSwitch. Возвращается: при успехе Пример: `4321`
name string	Имя vSwitch. Возвращается: при успехе Пример: `"my vSwitch"`
server list / элементы=dictionary	VLAN vSwitch. Возвращается: при успехе Пример: `[{"server_ip": "123.123.123.123", "server_ipv6_net": "2a01:4f8:111:4221::", "server_number": 321, "status": "ready"}]`
server_ip string	Основной IP-адрес сервера. Возвращается: при успехе Пример: `"123.123.123.123"`
server_ipv6_net string	Основной сетевой IPv6-адрес сервера. Возвращается: при успехе Пример: `"2a01:f48:111:4221::"`
server_number integer	Числовой ID сервера. Возвращается: при успехе Пример: `321`
status string	Состояние vSwitch для этого сервера. Возвращается: при успехе Возможные возвращаемые значения: `"ready"` `"in process"` `"failed"` Пример: `"ready"`
subnet list / элементы=dictionary	Список назначенных IP-адресов. Возвращается: при успехе Пример: `[{"gateway": "213.239.252.49", "ip": "213.239.252.48", "mask": 29}]`
gateway string	Шлюз подсети. Возвращается: при успехе Пример: `"213.239.252.49"`
ip string	IP-адрес. Возвращается: при успехе Пример: `"213.239.252.48"`
mask integer	Маска подсети в нотации CIDR. Возвращается: при успехе Пример: `29`
vlan integer	Идентификатор VLAN для vSwitch. Возвращается: при успехе Пример: `4000`

Авторы

Alexander Gil Casas (@pando85)

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

© 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/community/hrobot/v_switch_module.html