Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_profile_persistence_universal — управление профилями универсальной персистентности

Примечание

Этот модуль входит в коллекцию 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_persistence_universal.

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

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

Обзор

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

Параметры

Параметр

Описание

app_service

string

Служба iApp, связываемая с этим профилем. Если служба не указана, по умолчанию используется None.

match_across_pools

boolean

Если true, указывает, что система может использовать любой пул, содержащий эту запись персистентности.

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

Варианты:

  • false
  • true

match_across_services

boolean

Если true, указывает, что все постоянные соединения с IP-адреса клиента, направляемые на один и тот же виртуальный IP-адрес, также направляются на один и тот же узел.

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

Варианты:

  • false
  • true

match_across_virtuals

boolean

Если true, указывает, что все постоянные соединения с одного и того же IP-адреса клиента направляются на один и тот же узел.

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

Варианты:

  • false
  • true

mirror

boolean

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

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

Варианты:

  • false
  • true

name

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

Задаёт имя профиля.

override_connection_limit

boolean

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

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

Варианты:

  • false
  • true

parent

string

Задаёт профиль, от которого этот профиль наследует настройки.

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

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 / обязательный

Пароль учётной записи пользователя, используемой для подключения к 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 ← (по умолчанию)

rule

string

Задаёт iRule, используемое для выбора записи персистентности.

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

state

string

Если present, обеспечивает наличие профиля.

Если absent, обеспечивает удаление профиля.

Варианты:

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

timeout

string

Задаёт длительность действия записей персистентности.

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

Чтобы задать бесконечный период ожидания, используйте значение indefinite.

При указании числового периода ожидания значение должно находиться в диапазоне от 1 до 4294967295.

Примечания

Примечание

  • Дополнительные сведения об использовании 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 profile
  bigip_profile_persistence_universal:
    name: foo
    state: present
    match_across_services: true
    match_across_virtuals: true
    mirror: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ

Описание

app_service

string

Служба iApp, связанная с этим профилем

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

Пример: "/Common/good_service.app/good_service"

match_across_pools

boolean

Новое значение параметра Match Across Pools.

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

Пример: true

match_across_services

boolean

Новое значение параметра Match Across Services.

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

Пример: false

match_across_virtuals

boolean

Новое значение параметра Match Across Virtuals.

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

Пример: true

mirror

boolean

Новое значение параметра Mirror.

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

Пример: true

override_connection_limit

boolean

Новое значение параметра Override Connection Limit.

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

Пример: false

parent

string

Родительский профиль.

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

Пример: "/Common/cookie"

rule

string

iRule, используемое для выбора записи персистентности.

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

Пример: "/Common/_sys_https_redirect"

timeout

string

Длительность действия записей персистентности.

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

Пример: "180"

Авторы

  • Nitin Khanna (@nitinthewiz)

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

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

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

Spec-Zone.ru

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