Модуль f5networks.f5_modules.bigip_profile_tcp — управление профилями TCP на BIG-IP

Примечание

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

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

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

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

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

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

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

Управление профилями TCP в системе BIG-IP. Существует множество профилей TCP, каждый из которых содержит собственные настройки стандартного профиля tcp. Пользователям этого модуля следует учитывать, что для многих доступных параметров значение по умолчанию в модуле не задано. Вместо этого значение по умолчанию назначается самой системой BIG-IP и в большинстве случаев является приемлемым.

Параметры

Параметр	Комментарии
delayed_acks boolean	Если `true`, система отправляет менее одного сегмента ACK на каждый полученный сегмент данных. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля. Варианты: `false` `true`
early_retransmit boolean	Если `true`, система использует раннюю быструю повторную передачу, чтобы сократить время восстановления соединений, ограниченных размером буфера приёма или пользовательскими данными. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля. Варианты: `false` `true`
idle_timeout string	Задаёт время, в течение которого соединение может оставаться неактивным (без трафика), прежде чем его можно будет удалить. При создании нового профиля, если этот параметр не указан, удалённое устройство выберет значение по умолчанию, подходящее для профиля и основанное на его профиле `parent`. Если указано число, оно задаёт количество секунд, в течение которых TCP-соединение может оставаться неактивным, прежде чем система удалит его. Если указано `0` или `indefinite`, система не удаляет TCP-соединения независимо от того, как долго они остаются неактивными.
initial_congestion_window_size integer	Задаёт начальный размер окна перегрузки для соединений с этим назначением. Фактический размер окна равен этому значению, умноженному на MSS того же соединения. Если задано значение `0`, система использует значения, указанные в RFC2414. Допустимый диапазон значений: от 0 до 16 включительно. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
initial_receive_window_size integer	Задаёт начальный размер окна приёма для соединений с этим назначением. Фактический размер окна равен этому значению, умноженному на MSS того же соединения. Если задано значение `0`, система использует значение медленного старта. Допустимый диапазон значений: от 0 до 16 включительно. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
ip_tos_to_client string	Задаёт уровень L3 Type of Service, который система добавляет в TCP-пакеты, предназначенные клиентам. Если указано `pass-through`, настройка IP ToS остаётся неизменной. Если указано `mimic`, система устанавливает для исходящих пакетов тот же уровень ToS, что и у последнего полученного входящего пакета. Если задано число, оно указывает настройку IP ToS, которую система добавляет в заголовок IP-пакета. Допустимый диапазон чисел: от 0 до 255 включительно. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
keep_alive_interval string добавлено в f5networks.f5_modules 1.22.0	Задаёт периодичность отправки системой данных по неактивному TCP-соединению для проверки того, что соединение всё ещё действительно. При создании нового профиля, если этот параметр не указан, удалённое устройство выберет значение по умолчанию, подходящее для профиля и основанное на его профиле `parent`. Если указано `0` или `indefinite`, система не отправляет сообщения keep-alive.
nagle string	Если указано `enabled`, система применяет алгоритм Нейгла, чтобы уменьшить количество коротких сегментов в сети. Если указано `auto`, применение алгоритма Нейгла определяется условиями сети. Для интерактивных протоколов, таких как Telnet, rlogin или SSH, F5 рекомендует отключать эту настройку в сетях с высокой задержкой, чтобы повысить скорость отклика приложений. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля. Варианты: `"auto"` `"enabled"` `"disabled"`
name string / обязательный	Задаёт имя профиля.
parent string	Задаёт профиль, от которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, используется системный профиль `tcp`.
partition string	Раздел устройства, в котором следует управлять ресурсами. По умолчанию: `"Common"`
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` ← (по умолчанию)
proxy_options boolean	Если указано `true`, система объявляет серверу параметр, например метку времени, только если он был согласован с клиентом. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля. Варианты: `false` `true`
state string	Если указано `present`, гарантируется наличие профиля. Если указано `absent`, гарантируется удаление профиля. Варианты: `"present"` ← (по умолчанию) `"absent"`
syn_rto_base integer	Задаёт базовый множитель начального RTO `Retransmission TimeOut` для повторной передачи SYN в `milliseconds`. Это значение изменяется с помощью таблицы экспоненциального увеличения интервалов, чтобы выбрать интервал для последующих повторных передач. Допустимый диапазон значений: от 0 до 5000 включительно. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
time_wait_recycle boolean	Задаёт повторное использование соединений в состоянии TIME-WAIT при получении SYN-пакета (указывающего на запрос нового соединения). Если указано `false`, соединения в состоянии TIME-WAIT остаются неиспользуемыми в течение заданного времени. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля. Варианты: `false` `true`
time_wait_timeout string добавлено в f5networks.f5_modules 1.3.0	Задаёт время в миллисекундах, в течение которого соединение находится в состоянии TIME-WAIT перед закрытием. Если указано `immediate`, система закрывает соединение сразу после его перехода в состояние TIME-WAIT. Если указано `indefinite` или `0`, система не закрывает TCP-соединения независимо от того, как долго они остаются в состоянии TIME-WAIT. Допустимый диапазон значений: от 0 до 600000 миллисекунд. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.

Примечания

Примечание

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

Примеры

- name: Create a TCP profile
  bigip_profile_tcp:
    name: foo
    parent: f5-tcp-progressive
    time_wait_recycle: false
    idle_timeout: 300
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ	Описание
delayed_acks boolean	Указывает, отправляет ли система менее одного сегмента ACK на каждый полученный сегмент данных. Возвращается: изменено Пример: `true`
early_retransmit boolean	Указывает, используется ли механизм ранней быстрой повторной передачи. Возвращается: изменено Пример: `true`
idle_timeout integer	Новое время ожидания бездействия ресурса. Возвращается: изменено Пример: `100`
initial_congestion_window_size integer	Указывает начальный размер окна перегрузки для подключений к этому адресу назначения. Возвращается: изменено Пример: `5`
initial_receive_window_size integer	Указывает начальный размер окна приёма для подключений к этому адресу назначения. Возвращается: изменено Пример: `10`
ip_tos_to_client string	Указывает уровень типа обслуживания L3, который система добавляет в TCP-пакеты, предназначенные для клиентов. Возвращается: изменено Пример: `"mimic"`
keep_alive_interval string	Указывает, как часто система отправляет данные по неактивному TCP-подключению. Возвращается: изменено Пример: `"indefinite"`
nagle string	Указывает, используется ли алгоритм Нейгла. Возвращается: изменено Пример: `"auto"`
parent string	Новый родительский объект ресурса. Возвращается: изменено Пример: `"f5-tcp-optimized"`
proxy_options boolean	Указывает, сообщает ли система серверу о согласованных параметрах. Возвращается: изменено Пример: `false`
syn_rto_base integer	Указывает начальный базовый множитель времени ожидания повторной передачи (RTO) для повторной передачи SYN. Возвращается: изменено Пример: `2000`
time_wait_recycle boolean	Повторно использовать подключения в состоянии TIME-WAIT. Возвращается: изменено Пример: `true`
time_wait_timeout string	Указывает, сколько миллисекунд подключение находится в состоянии TIME-WAIT до закрытия. Возвращается: изменено Пример: `"immediate"`

Авторы

Tim Rupp (@caphrim007)
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_profile_tcp_module.html