Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_profile_persistence_cookie — управление профилями сохранения cookie на 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_persistence_cookie.

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

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

Краткое описание

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

Параметры

Параметр

Комментарии

always_send

boolean

Отправляет запись сохранения cookie в каждом ответе, даже если эта запись уже отправлялась клиенту.

Варианты:

  • false
  • true

cookie_encryption

string

Определяет способ использования формата шифрования cookie.

Если указано disabled, формат cookie создается без шифрования.

Если указано preferred, создается зашифрованная cookie, но принимаются как зашифрованный, так и незашифрованный форматы.

Если указано required, формат cookie должен быть зашифрован.

Варианты:

  • "disabled"
  • "preferred"
  • "required"

cookie_method

string

Определяет тип обработки cookie, используемый системой.

Если указано hash, cookie предоставляет сервер, а система затем постоянно сопоставляет ее с определенным узлом. Для этого типа сохранения требуется значение cookie_name.

Если указано insert, система вставляет сведения о сервере в виде cookie в заголовок ответа сервера.

Если указано passive, cookie предоставляет сервер, задавая правильные сведения о сервере и время ожидания. Для этого типа сохранения требуется значение cookie_name.

Если указано rewrite, система перехватывает заголовок BIGipCookie, отправленный сервером, и перезаписывает имя и значение этой cookie.

Варианты:

  • "hash"
  • "insert"
  • "passive"
  • "rewrite"

cookie_name

string

Задает уникальное имя cookie.

description

string

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

encrypt_cookie_pool_name

boolean

Определяет, следует ли шифровать имя пула во вставляемой cookie BIG-IP по умолчанию.

Варианты:

  • false
  • true

encryption_passphrase

string

Задает парольную фразу для шифрования cookie.

expiration

dictionary

Задает срок действия cookie. По умолчанию система создает и использует сеансовую cookie. Срок ее действия истекает по окончании сеанса пользователя (при закрытии браузера).

days

integer

Срок действия cookie в днях. Значение должно находиться в диапазоне от 0 до 24855 дней.

hours

integer

Срок действия cookie в часах. Значение должно находиться в диапазоне от 0 до 23 часов.

minutes

integer

Срок действия cookie в минутах. Значение должно находиться в диапазоне от 0 до 59 минут.

seconds

integer

Срок действия cookie в секундах. Значение должно находиться в диапазоне от 0 до 59 секунд.

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

http_only

boolean

Определяет, следует ли включить или отключить атрибут httponly для вставляемых cookie.

Варианты:

  • false
  • true

match_across_pools

boolean

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

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

Варианты:

  • false
  • true

match_across_services

boolean

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

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

Варианты:

  • false
  • true

match_across_virtuals

boolean

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

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

Варианты:

  • false
  • true

name

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

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

override_connection_limit

boolean

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

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

Варианты:

  • false
  • true

parent

string

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

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

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

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 ← (по умолчанию)

secure

boolean

Определяет, следует ли включить или отключить атрибут secure для вставляемых cookie.

Варианты:

  • false
  • true

state

string

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

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

Варианты:

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

update_password

string

Параметр always позволяет обновлять парольные фразы по запросу пользователя. Параметр on_create задает парольную фразу только для вновь создаваемых профилей.

Варианты:

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

Примечания

Примечание

  • Дополнительные сведения об использовании 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 persistence cookie profile
  bigip_profile_persistence_cookie:
    name: foo
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost
- name: Create a persistence cookie profile with expiration time
  bigip_profile_persistence_cookie:
    name: foo
    expiration:
      days: 7
      hours: 12
      minutes: 30
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ

Описание

always_send

boolean

Новое значение Always Send.

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

Пример: false

cookie_encryption

string

Новый тип Cookie Encryption.

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

Пример: "preferred"

cookie_method

string

Новый метод Cookie.

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

Пример: "insert"

cookie_name

string

Новое значение Cookie Name.

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

Пример: "cookie1"

description

string

Новое описание.

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

Пример: "My description"

encrypt_cookie_pool_name

boolean

Новое значение Encrypt Cookie Pool Name.

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

Пример: true

expiration

complex

Время истечения срока действия cookie.

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

Пример: "hash/dictionary of values"

days

integer

Срок действия cookie в днях.

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

Пример: 125

hours

integer

Срок действия cookie в часах.

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

Пример: 22

minutes

integer

Срок действия cookie в минутах.

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

Пример: 58

seconds

integer

Срок действия cookie в секундах.

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

Пример: 20

http_only

boolean

Новое значение HTTP Only.

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

Пример: true

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

override_connection_limit

boolean

Новое значение Override Connection Limit.

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

Пример: false

parent

string

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

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

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

secure

boolean

Новое значение Secure Cookie.

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

Пример: false

Авторы

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

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

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

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

Spec-Zone.ru

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