Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_cgnat_lsn_pool — управление пулами CGNAT LSN

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

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

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

Чтобы использовать коллекцию в плейбуке, укажите: f5networks.f5_modules.bigip_cgnat_lsn_pool.

Добавлено в f5networks.f5_modules 1.0.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

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

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

Параметры

Параметр

Комментарии

backup_members

list / elements=string

Указывает IP-адреса для трансляции, доступные для резервных участников. Они используются в режиме детерминированной трансляции, если трансляция в режиме deterministic завершается с ошибкой и система переключается на режим napt.

Это набор префиксов IP-адресов с длиной префикса.

client_conn_limit

integer

Указывает максимальное количество одновременных транслируемых подключений, разрешенное для клиента или абонента.

Допустимый диапазон значений — от 0 до 4294967295 включительно.

description

string

Описание пула LSN, заданное пользователем.

egress_interfaces

list / elements=string

Указывает набор интерфейсов, на которых разрешена или запрещена трансляция адресов источника, в соответствии с настройкой egress_intf_enabled.

egress_intf_enabled

boolean

Указывает, как система обрабатывает трансляцию адресов на интерфейсах, заданных в egress_interfaces.

Если задано значение true, трансляция адресов источника разрешена только на указанных egress_interfaces.

Если задано значение false, трансляция адресов источника отключена на указанных egress_interfaces.

Варианты:

  • false
  • true

harpin_mode

boolean

Включает или отключает hairpin-трансляцию для входящих подключений к активным конечным точкам трансляции.

Варианты:

  • false
  • true

icmp_echo

boolean

Включает или отключает эхо-запросы ICMP для транслируемых адресов.

Варианты:

  • false
  • true

inbound_connections

string

Определяет, поддерживает ли система BIG-IP входящие подключения для каждого исходящего сопоставления.

Если задано значение disabled, система не поддерживает входящие подключения для исходящих сопоставлений, что не позволяет работать протоколу Port Control Protocol pcp.

Если задано значение explicit, система поддерживает входящие подключения для явных исходящих сопоставлений.

Если задано значение automatic, система поддерживает входящие подключения для каждого используемого исходящего сопоставления.

Варианты:

  • "disabled"
  • "explicit"
  • "automatic"

log_profile

string

Указывает имя профиля ведения журнала, используемого пулом.

log_publisher

string

Указывает имя издателя журналов, который регистрирует события трансляции.

members

list / elements=string

Указывает набор IP-адресов для трансляции, доступных в пуле. Это набор префиксов IP-адресов с длиной префикса.

Все адреса на общедоступной стороне берутся из адресов этой группы подсетей. Участники двух или более детерминированных пулов LSN не должны пересекаться. Каждый внешний адрес, используемый для детерминированного сопоставления, должен присутствовать только в одном пуле LSN.

mode

string

Указывает режим сопоставления адресов при трансляции.

Режим napt выполняет стандартную трансляцию адресов и портов, позволяя нескольким клиентам частной сети получать доступ к удаленным сетям через один IP-адрес, назначенный их маршрутизатору.

Режим трансляции адресов deterministic обеспечивает трансляцию адресов без регистрации каждого сопоставления адресов, при этом отслеживание внутренних адресов клиентов выполняется только с использованием внешнего адреса и порта, а также адреса и порта назначения.

В режиме pba регистрируется выделение и освобождение блоков портов для запросов трансляции абонентов, а не каждый запрос на трансляцию по отдельности.

Варианты:

  • "napt"
  • "deterministic"
  • "pba"

name

string / обязательный

Указывает имя пула LSN, которым необходимо управлять.

partition

string

Раздел устройства, в котором необходимо управлять ресурсами.

По умолчанию: "Common"

pba_block_idle_timeout

integer

Указывает длительность тайм-аута после того, как блок портов переходит в неактивное состояние.

Допустимый диапазон значений — от 0 до 4294967295 включительно.»

pba_block_lifetime

integer

Указывает тайм-аут блока портов, по истечении которого блок не используется для выделения новых портов.

Допустимый диапазон значений — от 0 до 4294967295 включительно.

Значение 0 соответствует бесконечному тайм-ауту.

pba_block_size

integer

Указывает количество портов в блоке.

Допустимый диапазон значений — от 0 до 65535 включительно.

Значение pba_block_size должно быть меньше или равно диапазону пула LSN, то есть диапазону портов, определяемому значениями port_range_low и port_range_high.

pba_client_block_limit

integer

Указывает количество блоков, которые можно назначить одному IP-адресу абонента.

pba_zombie_timeout

integer

Указывает длительность тайм-аута для блока портов-зомби — блока с истекшим тайм-аутом, в котором остается одно или несколько активных подключений. По истечении тайм-аута подключения, использующие блок-зомби, разрываются, а блок портов-зомби становится доступным.

Значение 0 соответствует бесконечному тайм-ауту.

Система игнорирует значение этого параметра, если pba_block_lifetime имеет значение 0.

persistence_mode

string

Указывает параметры сохранения записей трансляции LSN.

Если задано значение address, трансляция пытается повторно использовать сопоставление адреса, но не сопоставление порта.

Если задано значение address-port, трансляция пытается повторно использовать сопоставления адреса и порта для последующих пакетов, отправленных с того же внутреннего IP-адреса и порта.

Если задано значение none, сохранение отключено.

Варианты:

  • "address"
  • "address-port"
  • "none"

persistence_timeout

integer

Указывает значение тайм-аута сохранения для записей трансляции LSN.

Если определенное сопоставление не используется в течение этого времени, оно истекает, и пара адрес/порт на общедоступной стороне становится доступной для использования в других сопоставлениях.

Допустимый диапазон значений — от 0 до 31536000 включительно.

port_range_high

integer

Указывает верхнюю границу диапазона номеров портов, доступных для использования с IP-адресами трансляции.

Значение port_range_high всегда должно быть больше или равно значению port_range_high.

Допустимый диапазон значений — от 0 до 65535 включительно.

port_range_low

integer

Указывает нижнюю границу диапазона номеров портов, доступных для использования с IP-адресами трансляции.

Значение port_range_low всегда должно быть меньше или равно значению port_range_high.

Допустимый диапазон значений — от 0 до 65535 включительно.

provider

dictionary

добавлено в f5networks.f5_modules 1.0.0

Объект dict, содержащий сведения о подключении.

auth_provider

string

Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства.

Этот параметр используется при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если задано значение yes, телеметрические данные TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную среды F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM объявлена устаревшей, поскольку ее название было неоднозначным.

Варианты:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

string / обязательный

Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_PASSWORD.

server

string / обязательный

Узел BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_SERVER.

server_port

integer

Порт сервера BIG-IP.

Этот параметр можно не указывать, задав переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

Указывает тайм-аут в секундах для взаимодействия с сетевым устройством при подключении или отправке команд. Если до завершения операции истекает время ожидания, модуль завершится с ошибкой.

transport

string

Настраивает транспортное подключение, используемое при соединении с удаленным устройством.

Варианты:

  • "rest" ← (по умолчанию)

user

string / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь права администратора на устройстве.

Этот параметр можно не указывать, задав переменную среды F5_USER.

validate_certs

boolean

Если задано значение no, SSL-сертификаты не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами.

Этот параметр можно не указывать, задав переменную среды F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

route_advertisement

boolean

Указывает, передаются ли адреса трансляции в модуль Advanced Routing для анонсирования с помощью протоколов динамической маршрутизации.

Варианты:

  • false
  • true

state

string

Если state имеет значение present, обеспечивает существование пула LSN.

Если state имеет значение absent, обеспечивает удаление пула LSN.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

Примечания

Примечание

  • Для 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

list / elements=string

IP-адреса трансляции, доступные для резервных участников.

Возвращается: изменено

Пример: ["/Common/10.10.10.0/24", "/Common/11.11.11.0/25"]

client_conn_limit

integer

Максимальное количество одновременных транслируемых соединений, разрешённое для клиента или абонента.

Возвращается: изменено

Пример: 50

description

string

Описание пула LSN, созданное пользователем.

Возвращается: изменено

Пример: "some description"

egress_interfaces

list / elements=string

Набор интерфейсов, на которых трансляция исходных адресов разрешена или запрещена.

Возвращается: изменено

Пример: ["/Common/tunnel1", "/Common/tunnel2"]

egress_intf_enabled

boolean

Определяет, как система обрабатывает трансляцию адресов на исходящих интерфейсах.

Возвращается: изменено

Пример: false

harpin_mode

boolean

Включает или отключает hairpinning для входящих соединений с активными конечными точками трансляции.

Возвращается: изменено

Пример: true

icmp_echo

boolean

Включает или отключает эхо-запросы ICMP для транслируемых адресов.

Возвращается: изменено

Пример: false

inbound_connections

string

Управляет поддержкой входящих соединений системой BIG-IP для каждого исходящего сопоставления.

Возвращается: изменено

Пример: "explicit"

log_profile

string

Имя профиля ведения журнала, используемого пулом.

Возвращается: изменено

Пример: "/Common/foo_log_profile"

log_publisher

list / elements=string

Имя издателя журналов, который регистрирует события трансляции.

Возвращается: изменено

Пример: ["/Common/publisher_1"]

members

list / elements=string

Набор IP-адресов трансляции, доступных в пуле.

Возвращается: изменено

Пример: ["/Common/10.10.10.0/24", "/Common/11.11.11.0/25"]

mode

string

Указывает режим сопоставления адресов трансляции.

Возвращается: изменено

Пример: "napt"

pba_block_idle_timeout

integer

Длительность тайм-аута после перехода блока портов в состояние простоя.

Возвращается: изменено

Пример: 3600

pba_block_lifetime

integer

Тайм-аут блока портов.

Возвращается: изменено

Пример: 7200

pba_block_size

integer

Количество портов в блоке.

Возвращается: изменено

Пример: 128

pba_client_block_limit

integer

Количество блоков, которые можно назначить одному IP-адресу абонента.

Возвращается: изменено

Пример: 3

pba_zombie_timeout

integer

Длительность тайм-аута для неактивного блока портов.

Возвращается: изменено

Пример: 180

persistence_mode

string

Указывает параметры сохранения записей трансляции LSN.

Возвращается: изменено

Пример: "address"

persistence_timeout

integer

Указывает значение тайм-аута сохранения для записей трансляции LSN.

Возвращается: изменено

Пример: 500

port_range_high

integer

Верхняя граница диапазона номеров портов, доступных для использования с IP-адресами трансляции.

Возвращается: изменено

Пример: 65535

port_range_low

integer

Нижняя граница диапазона номеров портов, доступных для использования с IP-адресами трансляции.

Возвращается: изменено

Пример: 1025

route_advertisement

boolean

Указывает, объявляются ли адреса трансляции с помощью протоколов динамической маршрутизации.

Возвращается: изменено

Пример: true

Авторы

  • Wojciech Wypior (@wojtek0806)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/f5networks/f5_modules/bigip_cgnat_lsn_pool_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API