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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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 типа ToS, который система вставляет в TCP-пакеты, предназначенные для клиентов. При `pass-through`, настройка IP ToS остается без изменений. При `mimic`, система устанавливает уровень ToS исходящих пакетов в соответствии с уровнем ToS последнего полученного входящего пакета. При указании числового значения, это число указывает на устанавливаемое системой значение IP ToS в заголовке IP-пакета. Допустимый диапазон чисел — 0—255 включительно. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
keep_alive_interval string добавлено в f5networks.f5_modules 1.22.0	Устанавливает частоту отправки данных системой по idle TCP-соединению для определения его актуальности. При создании нового профиля, если этот параметр не указан, удаленный узел выберет значение по умолчанию, соответствующее профилю, на основе его `parent` профиля. При `0`, или `indefinite`, система не отправляет keep-alive сообщения.
nagle string	При `enabled`, система применяет алгоритм Nagle для уменьшения количества коротких сегментов в сети. При `auto`, использование алгоритма Nagle определяется на основе сетевых условий. Для интерактивных протоколов, таких как Telnet, rlogin или SSH, F5 рекомендует отключить эту настройку в сетях с высокой задержкой для повышения отзывчивости приложения. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию. Варианты: `"auto"` `"enabled"` `"disabled"`
name string / обязательно	Указывает имя профиля.
parent string	Указывает профиль, из которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, по умолчанию используется `tcp` профиль системы.
partition string	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект словаря, содержащий сведения о подключении.
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 строка / обязательно	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное соединение для подключения к удалённому устройству. Допустимые значения: `"rest"` ← (по умолчанию)
user строка / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs булево	Если `no`, сертификаты SSL не будут проверены. Используйте это только на сайтах под собственным контролем, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Допустимые значения: `false` `true` ← (по умолчанию)
proxy_options булево	Когда `true`, система предоставляет параметр, например, отметку времени, серверу только в том случае, если он был согласован с клиентом. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля. Допустимые значения: `false` `true`
state строка	Когда `present`, гарантирует, что профиль существует. Когда `absent`, гарантирует удаление профиля. Допустимые значения: `"present"` ← (по умолчанию) `"absent"`
syn_rto_base целое число	Указывает начальный множитель RTO `Retransmission TimeOut` базового значения для повторной передачи SYN в `milliseconds`. Это значение изменяется таблицей экспоненциального отката для выбора интервала последующих повторных передач. Допустимый диапазон значений: от 0 до 5000 включительно. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля.
time_wait_recycle булево	Указывает, что соединения в состоянии TIME-WAIT повторно используются, если получен пакет SYN (указывающий запрос на новое соединение). Если `false`, соединения в состоянии TIME-WAIT остаются неиспользуемыми в течение указанного времени. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля. Допустимые значения: `false` `true`
time_wait_timeout строка добавлен в 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 на каждый полученный сегмент данных. Возвращено: changed Пример: `true`
early_retransmit boolean	Указывает использование быстрой переотправки. Возвращено: changed Пример: `true`
idle_timeout integer	Новое время ожидания бездействия ресурса. Возвращено: changed Пример: `100`
initial_congestion_window_size integer	Задает начальный размер окна задержки для соединений с этим назначением. Возвращено: changed Пример: `5`
initial_receive_window_size integer	Задает начальный размер окна приема для соединений с этим назначением. Возвращено: changed Пример: `10`
ip_tos_to_client string	Указывает уровень приоритета L3, который система вставляет в пакеты TCP, предназначенные для клиентов. Возвращено: changed Пример: `"mimic"`
keep_alive_interval string	Указывает, как часто система отправляет данные по неактивному TCP-соединению. Возвращено: changed Пример: `"indefinite"`
nagle string	Указывает использование алгоритма Нейгла. Возвращено: changed Пример: `"auto"`
parent string	Новый родительский элемент ресурса. Возвращено: changed Пример: `"f5-tcp-optimized"`
proxy_options boolean	Указывает, объявляет ли система согласованные параметры серверу. Возвращено: changed Пример: `false`
syn_rto_base integer	Задает базовый множитель начального тайм-аута переотправки для переотправки SYN. Возвращено: changed Пример: `2000`
time_wait_recycle boolean	Повторное использование соединений в состоянии TIME-WAIT. Возвращено: changed Пример: `true`
time_wait_timeout string	Указывает количество миллисекунд, в течение которых соединение находится в состоянии TIME-WAIT перед закрытием. Возвращено: changed Пример: `"immediate"`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

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

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