f5networks.f5_modules.bigip_cgnat_lsn_pool – Управление пулами CGNAT LSN

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

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

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_cgnat_lsn_pool.

Введено в версии 1.0.0: модуля f5networks.f5_modules

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управление пулами CGNAT LSN (Large Scale NAT).

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
backup_members список / элементы=строка			Указывает IP-адреса перевода, доступные для резервных членов, которые используются режимом детерминированного перевода, если перевод в режиме `deterministic` терпит неудачу и переходит к режиму `napt`. Это набор префиксов IP-адресов с их длиной префикса.
client_conn_limit целое число			Устанавливает максимальное количество одновременных подключений к переводу, которые разрешено иметь клиенту или подписчику. Допустимый диапазон значений находится в пределах от `0` до `4294967295` включительно.
description строка			Описание пула LSN, созданное пользователем.
egress_interfaces список / элементы=строка			Указывает набор интерфейсов, на которых разрешен или запрещен перевод исходного адреса, как определяется значением `egress_intf_enabled`.
egress_intf_enabled булево		Варианты: нет да	Указывает, как система обрабатывает перевод адресов на интерфейсах, указанных в `egress_interfaces`. При значении `yes`, перевод исходного адреса разрешен только на указанных `egress_interfaces`. При значении `no`, перевод исходного адреса отключен на указанных `egress_interfaces`.
harpin_mode булево		Варианты: нет да	Включает или отключает hairpinning для входящих подключений к активным точкам перевода.
icmp_echo булево		Варианты: нет да	Включает или отключает ICMP echo на переведенных адресах.
inbound_connections строка		Варианты: отключено явное автоматическое	Управляет тем, поддерживает ли система BIG-IP входящие подключения для каждого исходящего сопоставления. При значении `disabled`, система не поддерживает входящие подключения для исходящих сопоставлений, что предотвращает работу протокола Port Control Protocol `pcp`. При значении `explicit`, система поддерживает входящие подключения для явных исходящих сопоставлений. При значении `automatic`, система поддерживает входящие подключения для каждого исходящего сопоставления по мере его использования.
log_profile строка			Указывает имя профиля ведения журнала, используемого пулом.
log_publisher строка			Указывает имя издателя журнала, который записывает события перевода.
members список / элементы=строка			Указывает набор IP-адресов перевода, доступных в пуле. Это набор префиксов IP-адресов с их длиной префикса. Все адреса со стороны публичной сети берутся из адресов в этой группе подсетей. Члены двух или более детерминированных пулов LSN не должны перекрываться. Каждый внешний адрес, используемый для детерминированного сопоставления, должен встречаться только в одном пуле LSN.
mode строка		Варианты: napt детерминированный pba	Указывает режим сопоставления адресов перевода. Режим `napt` обеспечивает стандартный перевод адресов и портов, позволяя нескольким клиентам в частной сети получить доступ к удаленным сетям с использованием одного IP-адреса, назначенного их маршрутизатору. Режим перевода адресов `deterministic` обеспечивает перевод адресов, исключающий протоколирование каждого сопоставления адресов, при этом позволяя отслеживать внутренние адреса клиентов с использованием только внешнего адреса и порта и адреса и порта назначения. Режим `pba` регистрирует выделение и освобождение блоков портов для запросов перевода подписчиков вместо отдельного протоколирования каждого запроса перевода.
name строка / обязательно			Указывает имя пула LSN для управления.
partition строка		Значение по умолчанию: "Общие"	Раздел устройства, на котором нужно управлять ресурсами.
pba_block_idle_timeout целое число			Указывает время ожидания после того, как блок портов становится неактивным. Допустимый диапазон значений находится в пределах от `0` до `4294967295` включительно.
pba_block_lifetime целое число			Указывает время ожидания для блока портов, по истечении которого блок не используется для новых выделений портов. Допустимый диапазон значений находится в пределах от `0` до `4294967295` включительно. Значение `0` соответствует бесконечному времени ожидания.
pba_block_size целое число			Указывает количество портов в блоке. Допустимый диапазон значений находится в пределах от `0` до `65535` включительно. Значение `pba_block_size` должно быть меньше или равно диапазону пула LSN, то есть диапазону портов, определенному значениями `port_range_low` и `port_range_high`.
pba_client_block_limit целое число			Указывает количество блоков, которые могут быть назначены одному IP-адресу подписчика.
pba_zombie_timeout целое число			Указывает время ожидания для блока портов-зомби, который представляет собой истекший блок портов с одним или несколькими активными подключениями. По истечении времени ожидания подключения, использующие блок зомби, закрываются, а блок зомби-порта становится доступным блоком портов. Значение `0` соответствует бесконечному времени ожидания. Система игнорирует это значение параметра, если `pba_block_lifetime` равно `0`.
persistence_mode строка		Варианты: адрес адрес-порт ничего	Указывает параметры сохранения для записей перевода LSN. При значении `address`, попытка перевода повторно использует сопоставление адресов, но не сопоставление портов. При значении `address-port`, перевод пытается повторно использовать как сопоставление адреса, так и сопоставление порта для последующих пакетов, отправленных с того же внутреннего IP-адреса и порта. При значении `none`, сохранение отключено.
persistence_timeout целое число			Указывает время ожидания сохранения для записей перевода LSN. Если определенное сопоставление не используется в течение этого времени, оно истекает, и пара адрес/порт со стороны публичной сети становится доступной для использования в других сопоставлениях. Допустимый диапазон значений находится в пределах от `0` до `31536000` включительно.
port_range_high целое число			Указывает верхнюю границу диапазона номеров портов, доступных для использования с IP-адресами перевода. Значение `port_range_high` должно всегда быть больше или равно значению `port_range_high`. Допустимый диапазон значений находится в пределах от `0` до `65535` включительно.
port_range_low целое число			Указывает нижнюю границу диапазона номеров портов, доступных для использования с IP-адресами перевода. Значение `port_range_low` должно всегда быть меньше или равно значению `port_range_high`. Допустимый диапазон значений находится в пределах от `0` до `65535` включительно.
provider словарь добавлен в 1.0.0 f5networks.f5_modules			Объект dict, содержащий данные о подключении.
	auth_provider строка		Настраивает поставщика авторизации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: нет да	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, задав переменную среды `F5_TEEM`.
	password строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_SERVER_PORT`.
	timeout целое число		Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.

	пользователь строка / обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs логический	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
route_advertisement логический		Варианты: нет да	Указывает, передаются ли адреса перевода модулю маршрутизации высокого уровня для объявления динамическими протоколами маршрутизации.
состояние строка		Варианты: присутствует ← отсутствует	Когда `state` равно `present`, гарантирует, что пул LSN существует. Когда `state` равно `absent`, гарантирует, что пул LSN удален.

Примечания

Примечание

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

Примеры

- name: Create an lsn pool
  bigip_cgnat_lsn_pool:
    name: foo
    mode: napt
    client_conn_limit: 100
    log_profile: foo_profile
    log_publisher: foo_publisher
    members:
      - 10.1.1.0/24
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update lsn pool
  bigip_cgnat_lsn_pool:
    name: foo
    mode: pba
    pba_block_size: 128
    pba_block_lifetime: 7200
    pba_block_idle_timeout: 1800
    pba_zombie_timeout: 900
    log_profile: foo_profile
    log_publisher: foo_publisher
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove lsn pool
  bigip_cgnat_lsn_pool:
    name: foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
backup_members список / элементы=строка	изменено	Доступные адреса перевода для резервных членов. Пример: ['/Common/10.10.10.0/24', '/Common/11.11.11.0/25']
client_conn_limit целое число	изменено	Максимальное количество одновременных подключений перевода, разрешенных клиенту или подписчику. Пример: 50
описание строка	изменено	Описание пула LSN, созданного пользователем. Пример: некоторое описание
egress_interfaces список / элементы=строка	изменено	Набор интерфейсов, на которых разрешен или запрещен перевод адресов источника. Пример: ['/Common/tunnel1', '/Common/tunnel2']
egress_intf_enabled логический	изменено	Определяет, как система обрабатывает перевод адресов на выходных интерфейсах.
harpin_mode логический	изменено	Включает или отключает hairpinning для входящих подключений к активным точкам перевода. Пример: True
icmp_echo логический	изменено	Включает или отключает ICMP echo по переведенным адресам.
inbound_connections строка	изменено	Управляет поддержкой BIG-IP системы входящих подключений для каждого исходящего отображения. Пример: явное
log_profile строка	изменено	Имя профиля регистрации, используемого пулом. Пример: /Common/foo_log_profile
log_publisher список / элементы=строка	изменено	Имя издателя журнала, который регистрирует события перевода. Пример: /Common/publisher_1
members список / элементы=строка	изменено	Набор адресов перевода, доступных в пуле. Пример: ['/Common/10.10.10.0/24', '/Common/11.11.11.0/25']
mode строка	изменено	Определяет режим отображения адресов перевода. Пример: napt
pba_block_idle_timeout целое число	изменено	Срок ожидания после момента, когда блок порта становится неактивным. Пример: 3600
pba_block_lifetime целое число	изменено	Срок ожидания для блока порта. Пример: 7200
pba_block_size целое число	изменено	Количество портов в блоке. Пример: 128
pba_client_block_limit целое число	изменено	Количество блоков, которые могут быть назначены одному IP-адресу подписчика. Пример: 3
pba_zombie_timeout целое число	изменено	Срок ожидания для блока зумби-порта. Пример: 180
persistence_mode строка	изменено	Определяет настройки сохранения для записей перевода LSN. Пример: адрес
persistence_timeout целое число	изменено	Определяет значение таймаута сохранения для записей перевода LSN. Пример: 500
port_range_high целое число	изменено	Верхняя граница диапазона номеров портов, доступных для использования с адресами перевода. Пример: 65535
port_range_low целое число	изменено	Нижняя граница диапазона номеров портов, доступных для использования с адресами перевода. Пример: 1025
route_advertisement логический	изменено	Указывает, объявляются ли адреса перевода через динамические протоколы маршрутизации. Пример: True

Авторы

Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_cgnat_lsn_pool_module.html