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

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

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Описание

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

Требования

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

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auto_last_hop -		Варианты: default enabled disabled	Позволяет настроить автоматическое определение последнего узла для каждого туннеля. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `default`. В случае `default`, система использует глобальное значение авто-last-hop для отправки обратно запроса. В случае `enabled`, позволяет системе отправлять ответный трафик на MAC-адрес, который передал запрос, даже если таблица маршрутизации указывает на другую сеть или интерфейс. В результате система может отправлять ответный трафик клиентам, даже если нет соответствующего маршрута.
description -			Описание туннеля.
key -			При применении к GRE-туннелю это значение задает необязательное поле в заголовке GRE, используемое для аутентификации источника пакета. При применении к VXLAN- или Geneve-туннелю это значение задает идентификатор виртуальной сети (VNI). При применении к NVGRE-туннелю это значение задает идентификатор виртуальной подсети (VSID). При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `0`.
local_address -			Указывает IP-адрес локального конечного узла туннеля.
mode -		Варианты: bidirectional inbound outbound	Указывает, как туннель переносит трафик. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `bidirectional`. В случае `bidirectional`, указывает, что туннель переносит входящий и исходящий трафик. В случае `inbound`, указывает, что туннель переносит только входящий трафик. В случае `outbound`, указывает, что туннель переносит только исходящий трафик.
mtu -			Указывает максимальный размер пакета (MTU) туннеля. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `0`. Допустимый диапазон от `0` до `65515`.
name - / обязательно			Указывает имя туннеля.
partition -		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
password - / обязательно			Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
profile -			Указывает профиль, который нужно связать с туннелем для обработки трафика. В зависимости от вашего выбора, другие настройки станут доступными или исчезнут. После установки этот параметр изменить нельзя.
provider - добавлен в 2.5		Значение по умолчанию: null	Объект dict, содержащий данные подключения.
	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 - / обязательно	Варианты: rest cli ←	Настраивает транспортное подключение для использования при подключении к удаленному устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, задав переменную среды `F5_USER`.
	validate_certs boolean	Варианты: 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	Варианты: no yes	Указывает, что туннель работает в прозрачном режиме. Когда `yes`, вы можете инспектировать и изменять трафик, зашифрованный через систему BIG-IP. Прозрачный туннель завершает туннель, создавая иллюзию, что туннель проходит через устройство без изменений (то есть, система BIG-IP выглядит как промежуточный маршрутизатор, который просто маршрутизирует IP-трафик через устройство).
use_pmtu boolean	Варианты: no yes	Включает или отключает использование туннелем информации PMTU (Path MTU), полученной из сообщений об ошибках ICMP NeedFrag. Если `yes` и туннель `mtu` установлен на `0`, туннель будет использовать информацию PMTU. Если `yes` и туннель `mtu` фиксирован на ненулевом значении, туннель будет использовать минимум из PMTU и MTU. Если `no`, туннель будет использовать фиксированную MTU или рассчитать её, используя настройки инкапсуляции туннеля.
user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean добавлено в 2.0	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.
Требуется версия программного обеспечения 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.7/modules/bigip_tunnel_module.html