community.hrobot.v_switch модуль – Управление vSwitch Hetzner

Примечание

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

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

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

Для использования в playbook, укажите: community.hrobot.v_switch.

Новое в community.hrobot 1.7.0

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

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

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

Параметры

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

Атрибуты

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

См. также

Документация по 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

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

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

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

vlan

целое число

Идентификатор VLAN виртуального коммутатора.

Возвращаемое значение: успех

Пример: 4000

Авторы

Alexander Gil Casas (@pando85)

Ссылки на сборку

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