Spec-Zone.ru › Ansible 2.8

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

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

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
idle_timeout
строка
Указывает время бездействия подключения (без трафика), после которого подключение может быть удалено.
При создании нового профиля, если этот параметр не указан, удалённое устройство выберет значение по умолчанию, подходящее для профиля, на основе его parent профиля.
При указании числа, задаётся количество секунд, в течение которого TCP-соединение может оставаться бездействующим перед его удалением системой.
При 0, или indefinite, указывает, что система не удаляет TCP-соединения независимо от того, как долго они остаются бездействующими.
name
строка / обязательно
Указывает имя профиля.
parent
строка
Указывает профиль, из которого этот профиль наследует настройки.
При создании нового профиля, если этот параметр не указан, значением по умолчанию является системный tcp профиль.
partition
строка
Значение по умолчанию:
"Общие"
Раздел устройства для управления ресурсами.
password
строка / обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_PASSWORD.

псевдонимы: pass, pwd
provider
словарь
добавлен в 2.5
Объект словаря, содержащий данные подключения.
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
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное соединение для подключения к удалённому устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве.
Можно опустить этот параметр, установив переменную среды F5_USER.
validate_certs
булево
    Варианты:
  • 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
булево
добавлен в 2.7
    Варианты:
  • no
  • yes
Указывает, что соединения в состоянии TIME-WAIT могут быть повторно использованы, если получен пакет SYN, указывающий на запрос нового соединения.
Если no, соединения в состоянии TIME-WAIT остаются неиспользованными в течение определённого периода времени.
При создании нового профиля, если этот параметр не указан, значение по умолчанию предоставляется родительским профилем.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве.
Можно опустить этот параметр, установив переменную среды F5_USER.
validate_certs
булево
добавлен в 2.0
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под личным контролем, которые используют самозаверяющие сертификаты.
Можно опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
  • Требуется версия ПО 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
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  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.8/modules/bigip_profile_tcp_module.html

Spec-Zone.ru

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