Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_profile_oneconnect — управление профилями OneConnect на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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 / обязательный

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

parent

string

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

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

partition

string

Раздел устройства для управления ресурсами.

По умолчанию: "Common"

provider

dictionary

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

Словарь с параметрами подключения.

auth_provider

string

Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства.

Этот параметр используется преимущественно при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если указано yes, телеметрические данные TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную окружения F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM устарела, поскольку её название было неоднозначным.

Варианты:

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

password

псевдонимы: pass, pwd

string / обязательный

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

Этот параметр можно не указывать, задав переменную окружения F5_PASSWORD.

server

string / обязательный

Имя хоста BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную окружения F5_SERVER.

server_port

integer

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

Этот параметр можно не указывать, задав переменную окружения F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

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

transport

string

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

Варианты:

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

user

string / обязательный

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

Этот параметр можно не указывать, задав переменную окружения F5_USER.

validate_certs

boolean

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

Этот параметр можно не указывать, задав переменную окружения F5_VALIDATE_CERTS.

Варианты:

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

share_pools

boolean

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

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

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

Варианты:

  • false
  • true

source_mask

string

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

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

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

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

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

state

string

Если указано 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

string

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

Возвращается: changed

Пример: "My profile"

idle_timeout_override

string

Новое значение переопределения тайм-аута простоя.

Возвращается: changed

Пример: "disabled"

limit_type

string

Новый тип лимита профиля.

Возвращается: changed

Пример: "idle"

maximum_age

integer

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

Возвращается: changed

Пример: 2000

maximum_reuse

integer

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

Возвращается: changed

Пример: 1000

maximum_size

integer

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

Возвращается: changed

Пример: 3000

share_pools

boolean

Совместное использование соединений между похожими виртуальными серверами.

Возвращается: changed

Пример: true

source_mask

string

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

Возвращается: changed

Пример: "255.255.255.255"

Авторы

  • Tim Rupp (@caphrim007)

Ссылки на коллекцию

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_profile_oneconnect_module.html

Spec-Zone.ru

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