Spec-Zone.ru › Ansible 2.9

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

Новая в версии 2.7.

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
description
строка
Описание профиля.
idle_timeout_override
строка
Устанавливает количество секунд бездействия соединения, после которого поток соединения может быть удален.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
Можно указать число секунд для переопределения таймаута.
Когда disabled, указывает, что для соединения нет переопределения таймаута.
Когда indefinite, указывает, что соединение может быть бездействующим без переопределения таймаута.
limit_type
строка
    Варианты:
  • none
  • idle
  • strict
Когда none, одновременные запросы и ответы в процессе обработки над TCP-соединениями с узлом пула учитываются при достижении лимита. Это историческое поведение.
Когда idle, бездействующие соединения будут удалены при достижении лимита TCP-соединений. В короткие промежутки времени, во время перекрытия удаления бездействующего соединения и установления нового, лимит TCP-соединений может быть превышен.
Когда strict, лимит TCP-соединений соблюдается без исключений. Это означает, что бездействующие соединения будут препятствовать созданию новых TCP-соединений до их истечения, даже если они могли бы быть повторно использованы.
strict не рекомендуется использовать, кроме очень специфических случаев с короткими таймаутами истечения.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
maximum_age
целое число
Устанавливает максимальное количество секунд, разрешенное для соединения в пуле повторного использования соединений.
Для любого соединения, чей возраст превышает это значение, система удаляет его из пула повторного использования.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
maximum_reuse
целое число
Устанавливает максимальное количество раз, которое серверное соединение может быть повторно использовано.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
maximum_size
целое число
Устанавливает максимальное количество соединений, которые система хранит в пуле повторного использования соединений.
Если пул уже заполнен, серверное соединение закрывается после завершения ответа.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
name
строка / обязательно
Указывает имя профиля OneConnect.
parent
строка
Указывает профиль, от которого этот профиль наследует настройки.
При создании нового профиля, если этот параметр не указан, используется системный профиль oneconnect по умолчанию.
partition
строка
По умолчанию:
"Common"
Раздел устройства для управления ресурсами.
provider
словарь
добавлено в 2.5
Объект словаря, содержащий данные о подключении.
auth_provider
строка
Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства.
Этот параметр используется при работе с устройствами BIG-IQ.
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
целое число
Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль вернёт ошибку.
transport
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное подключение для соединения с удалённым устройством.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве.
Можно опустить этот параметр, установив переменную среды F5_USER.
validate_certs
логическое значение
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах с личным контролем, использующих самозаверяющие сертификаты.
Можно опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.
share_pools
логическое значение
    Варианты:
  • no
  • yes
Указывает, что соединения могут быть объединены не только внутри виртуального сервера, но и между похожими виртуальными серверами.
Если yes, все виртуальные серверы, использующие один и тот же OneConnect и другие внутренние сетевые профили, могут совместно использовать соединения.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
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 сохранится на диске, необходимо включить хотя бы одну задачу, использующую модуль 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
строка
changed
Описание профиля.

Пример:
Мой профиль
idle_timeout_override
строка
changed
Новое значение переопределения тайм-аута бездействия.

Пример:
disabled
limit_type
строка
changed
Новый тип ограничения профиля.

Пример:
idle
maximum_age
целое число
changed
Максимальное количество секунд, разрешенных для подключения в пуле повторного использования соединений.

Пример:
2000
maximum_reuse
целое число
changed
Максимальное количество раз, которое серверное подключение может быть повторно использовано.

Пример:
1000
maximum_size
целое число
changed
Максимальное количество подключений, которые система хранит в пуле повторного использования соединений.

Пример:
3000
share_pools
логическое значение
changed
Обмен подключениями между похожими виртуальными серверами.

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

Пример:
255.255.255.255


Статус

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

Авторы

  • Tim Rupp (@caphrim007)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_profile_oneconnect_module.html

Spec-Zone.ru

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