bigip_tunnel – Управление туннелями на BIG-IP

Новая в версии 2.7.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Управляет туннелями на BIG-IP. Туннели обычно основаны на профиле туннеля, который определяет как значения по умолчанию, так и ограничения для туннеля.
Из-за этого модуль предоставляет ряд настроек, которые могут или не могут относиться к типу туннеля, с которым вы работаете. Важно учитывать это при объявлении конфигурации туннеля.
Если конкретный туннель не поддерживает параметр, который вы рассматриваете, в документации параметра обычно упоминается об этом. В противном случае, при конфигурировании этого параметра на устройстве, устройство уведомит вас.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auto_last_hop строка		Варианты: default enabled disabled	Позволяет настроить автоматическое определение последнего узла для каждого туннеля. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `default`. Когда `default`, система использует глобальную настройку авто-последнего узла для отправки запроса обратно. Когда `enabled`, позволяет системе отправлять ответный трафик на MAC-адрес, который передал запрос, даже если таблица маршрутизации указывает на другую сеть или интерфейс. В результате система может отправлять ответный трафик клиентам, даже если нет соответствующего маршрута.
description строка			Описание туннеля.
key целое число			При применении к GRE-туннелю это значение определяет необязательное поле в заголовке GRE, используемое для аутентификации источника пакета. При применении к VXLAN- или Geneve-туннелю это значение определяет идентификатор виртуальной сети (VNI). При применении к NVGRE-туннелю это значение определяет идентификатор виртуальной подсети (VSID). При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `0`.
local_address строка			Указывает IP-адрес локального конечного узла туннеля.
mode строка		Варианты: двунаправленный входящий исходящий	Указывает, как туннель переносит трафик. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `bidirectional`. Когда `bidirectional`, указывает, что туннель переносит как входящий, так и исходящий трафик. Когда `inbound`, указывает, что туннель переносит только входящий трафик. Когда `outbound`, указывает, что туннель переносит только исходящий трафик.
mtu целое число			Указывает максимальное значение MTU (Maximum Transmission Unit) туннеля. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `0`. Допустимый диапазон — от `0` до `65515`.
name строка / обязательно			Указывает имя туннеля.
partition строка		По умолчанию: "Общие"	Раздел устройства для управления ресурсами.
password строка / обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
profile строка			Указывает профиль, который нужно ассоциировать с туннелем для обработки трафика. В зависимости от вашего выбора, другие настройки могут стать доступными или исчезнуть. После установки этот параметр изменить нельзя.
provider словарь добавлен в 2.5			Объект словаря, содержащий сведения о подключении.
	password строка / обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Можно опустить этот параметр, установив переменную окружения `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Можно опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспортов cli. Можно опустить этот параметр, установив переменную окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение, которое будет использоваться при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых вами лично, которые используют самозаверяющие сертификаты. Можно опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
remote_address строка			Указывает IP-адрес удаленного конечного узла туннеля. Для `dslite`, `fec` (при настройке туннеля FEC только для получения трафика), `v6rd` (настроенного как ретранслятор границы), или `map`, туннель должен иметь не указанный удаленный адрес (любой).
secondary_address строка			Указывает не плавающий IP-адрес для туннеля, который будет использоваться с трафиком, инициализированным хостом.
server строка / обязательно			Хост BIG-IP. Можно опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port целое число добавлен в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Можно опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
state строка		Варианты: present ← absent	Когда `present`, гарантирует существование туннеля. Когда `absent`, гарантирует удаление туннеля.
tos строка			Указывает значение Type of Service (TOS) для вставки в заголовок инкапсулированных пакетов. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `preserve`. Когда `preserve`, система копирует значение TOS из внутреннего заголовка во внешний заголовок. Вы также можете указать числовое значение. Возможные значения от `0` до `255`.
traffic_group строка			Указывает группу трафика, которую нужно ассоциировать с туннелем. Это значение изменить нельзя после установки. Это ограничение BIG-IP.

transparent boolean	Варианты: нет да	Указывает, что туннель работает в прозрачном режиме. Когда `yes`, вы можете просматривать и изменять зашифрованный трафик, проходящий через систему BIG-IP. Прозрачный туннель завершает туннель, создавая иллюзию, что туннель проходит через устройство без изменений (то есть, система BIG-IP выглядит как промежуточный маршрутизатор, который просто направляет IP-трафик через устройство).
use_pmtu boolean	Варианты: нет да	Включает или отключает использование туннелем информации PMTU (Path MTU), полученной из сообщений об ошибках ICMP NeedFrag. Если `yes` и туннель `mtu` установлен в `0`, туннель будет использовать информацию PMTU. Если `yes` и туннель `mtu` установлен на ненулевое значение, туннель будет использовать минимум PMTU и MTU. Если `no`, туннель будет использовать фиксированное MTU или рассчитать MTU, используя настройки инкапсуляции туннеля.
user string / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean добавлено в 2.0	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 обрабатывают только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, необходимо включить хотя бы одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля, чтобы сохранить текущую конфигурацию.

Примеры

- name: Create a VXLAN tunnel
  bigip_tunnel:
    name: openshift-tunnel
    local_address: 192.1681.240
    key: 0
    secondary_address: 192.168.1.100
    mtu: 0
    use_pmtu: yes
    tos: preserve
    auto_last_hop: default
    traffic_group: traffic-group-1
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
param1 boolean	changed	Новое значение параметра param1 ресурса. Пример: True
param2 строка	changed	Новое значение параметра param2 ресурса. Пример: Foo is bar

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

Tim Rupp (@caphrim007)

Подсказка

Если вы заметили проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_tunnel_module.html