Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_profile_oneconnect — Управление профилями OneConnect на 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_oneconnect.

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

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

Описание

  • Управление профилями OneConnect на системе BIG-IP.

Параметры

Параметр

Комментарии

description

string

Описание профиля.

idle_timeout_override

string

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

При создании нового профиля, если этот параметр не указан, значение по умолчанию предоставляется родительским профилем.

Можно указать количество секунд для переопределения времени ожидания.

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

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

limit_type

string

Когда none, одновременные незавершенные запросы и ответы по TCP-соединениям с участником пула учитываются в лимите. Это историческое поведение.

Когда idle, неактивные соединения будут отбрасываться по достижении предела TCP-соединений. В течение коротких интервалов, в период перекрытия отбрасывания неактивного соединения и установления нового соединения, предел TCP-соединений может быть превышен.

Когда strict, предел TCP-соединений соблюдается без исключений. Это означает, что неактивные соединения будут препятствовать установлению новых TCP-соединений до истечения их срока действия, даже если они могли бы быть повторно использованы.

strict не рекомендуется использовать за исключением очень специфических случаев с короткими таймаутами истечения срока действия.

При создании нового профиля, если этот параметр не указан, значение по умолчанию предоставляется родительским профилем.

Варианты:

  • "none"
  • "idle"
  • "strict"

maximum_age

integer

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

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

При создании нового профиля, если этот параметр не указан, значение по умолчанию предоставляется родительским профилем.

maximum_reuse

integer

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

При создании нового профиля, если этот параметр не указан, значение по умолчанию предоставляется родительским профилем.

maximum_size

integer

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

Если пул уже заполнен, соединение на стороне сервера закрывается после завершения ответа.

При создании нового профиля, если этот параметр не указан, значение по умолчанию предоставляется родительским профилем.

name

string / required

Указывает имя профиля OneConnect.

parent

string

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

При создании нового профиля, если этот параметр не указан, значением по умолчанию является предоставленный системой профиль oneconnect.

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 / required

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

Можно пропустить этот параметр, установив переменную среды F5_PASSWORD.

server

string / required

Хост BIG-IP или хост BIG-IQ.

Можно пропустить этот параметр, установив переменную среды F5_SERVER.

server_port

integer

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

Можно пропустить этот параметр, установив переменную среды F5_SERVER_PORT.

Значение по умолчанию: 443

timeout

integer

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

transport

string

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

Варианты:

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

user

строка / обязательно

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

Вы можете опустить этот параметр, установив переменную среды F5_USER.

validate_certs

логическое

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

Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Варианты:

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

share_pools

логическое

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

Когда true, все виртуальные серверы, использующие тот же OneConnect и другие внутренние сетевые профили, могут совместно использовать соединения.

При создании нового профиля, если этот параметр не указан, по умолчанию используется параметр родительского профиля.

Варианты:

  • false
  • true

source_mask

строка

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

При создании нового профиля, если этот параметр не указан, по умолчанию используется параметр родительского профиля.

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

Маска 0 заставляет систему совместно использовать повторно используемые соединения для всех исходных адресов. Маска хоста 32 заставляет систему совместно использовать только те повторно используемые соединения, которые исходят от одного и того же исходного адреса.

При использовании SNAT или SNAT-пула, исходный адрес на стороне сервера сначала переводится, а затем маска OneConnect применяется к переведённому адресу.

state

строка

Когда present, гарантирует, что профиль существует.

Когда absent, гарантирует удаление профиля.

Варианты:

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

Примечания

Примечание

  • Дополнительную информацию об использовании 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 OneConnect profile
  bigip_profile_oneconnect:
    name: foo
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Значения возврата

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

Ключ

Описание

description

строка

Описание профиля.

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

Пример: "My profile"

idle_timeout_override

строка

Новое значение таймаута бездействия.

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

Пример: "disabled"

limit_type

строка

Новый тип ограничения профиля.

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

Пример: "idle"

maximum_age

целое число

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

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

Пример: 2000

maximum_reuse

целое число

Максимальное количество раз, которое соединение на стороне сервера может быть повторно использовано.

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

Пример: 1000

maximum_size

целое число

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

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

Пример: 3000

share_pools

логическое значение

Делится соединениями между похожими виртуальными серверами.

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

Пример: true

source_mask

строка

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

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

Пример: "255.255.255.255"

Авторы

  • Tim Rupp (@caphrim007)

Ссылки на сборки

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

© 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_oneconnect_module.html

Spec-Zone.ru

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