Spec-Zone.ru › Ansible 2.7

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

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

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

Обзор

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

Требования

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

  • f5-sdk >= 3.0.16

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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"
Раздел устройства для управления ресурсами.
password
- / обязательно
Пароль учетной записи пользователя, используемой для подключения к BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_PASSWORD.

псевдонимы: pass, pwd
provider
-
добавлен в 2.5
Значение по умолчанию:
null
Объект словаря, содержащий сведения о подключении.
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.
share_pools
boolean
    Варианты:
  • no
  • yes
Указывает, что соединения могут быть объединены не только внутри виртуального сервера, но и между похожими виртуальными серверами.
Когда yes, все виртуальные серверы, использующие один и тот же OneConnect и другие внутренние сетевые профили, могут совместно использовать соединения.
При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
source_mask
-
Указывает значение, которое система применяет к исходному адресу, чтобы определить его пригодность для повторного использования.
При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
Система применяет значение этого параметра к исходному адресу на стороне сервера, чтобы определить его пригодность для повторного использования.
Маска 0 заставляет систему совместно использовать повторно используемые соединения по всем исходным адресам. Маска хоста 32 заставляет систему совместно использовать только те повторно используемые соединения, которые исходят с того же исходного адреса.
Если вы используете SNAT или SNAT-пул, исходный адрес на стороне сервера сначала преобразуется, а затем к преобразованному адресу применяется маска OneConnect.
state
-
    Варианты:
  • present ←
  • absent
Когда present, гарантирует, что профиль существует.
Когда absent, гарантирует удаление профиля.
user
- / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве.
Можно опустить этот параметр, установив переменную среды F5_USER.
validate_certs
boolean
добавлено в 2.0
    Варианты:
  • нет
  • да ←
Если 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 OneConnect profile
  bigip_profile_oneconnect:
    name: foo
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

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

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

Ключ Возвращаемое значение Описание
description
строка
changed
Описание профиля.

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

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

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

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

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

Пример:
3000
share_pools
boolean
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.7/modules/bigip_profile_oneconnect_module.html

Spec-Zone.ru

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