bigip_profile_tcp – Управление профилями TCP на BIG-IP

Новое в версии 2.6.

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

Обзор

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

Требования

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

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
idle_timeout -			Указывает время бездействия соединения (отсутствия трафика), после которого соединение может быть удалено. При создании нового профиля, если этот параметр не указан, удалённое устройство выберет значение по умолчанию, соответствующее профилю на основе его `parent` профиля. При указании числа, указывает количество секунд, которое TCP-соединение может оставаться бездействующим, прежде чем система удалит его. Если `0`, или `indefinite`, указывает, что система не удаляет TCP-соединения независимо от того, как долго они остаются бездействующими.
name - / обязательно			Указывает имя профиля.
parent -			Указывает профиль, из которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, по умолчанию используется системный профиль `tcp`.
partition -		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
password - / обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
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`.
server - / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port - добавлен в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
state -		Варианты: present ← absent	Если `present`, гарантирует, что профиль существует. Если `absent`, гарантирует удаление профиля.
time_wait_recycle boolean добавлен в 2.7		Варианты: no yes	Указывает, что соединения в состоянии TIME-WAIT повторно используются, если получен пакет SYN, указывающий на запрос нового соединения. Если `no`, соединения в состоянии TIME-WAIT остаются неиспользуемыми в течение заданного промежутка времени. При создании нового профиля, если этот параметр не указан, значение по умолчанию определяется родительским профилем.
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 TCP profile
  bigip_profile_tcp:
    name: foo
    parent: f5-tcp-progressive
    time_wait_recycle: no
    idle_timeout: 300
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
idle_timeout целое число	изменённое	Новое значение таймаута бездействия ресурса. Пример: 100
parent строка	изменённое	Новый родительский ресурс. Пример: f5-tcp-optimized
time_wait_recycle булево значение	изменённое	Использовать повторно соединения в состоянии TIME-WAIT Пример: True

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

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