Spec-Zone.ru › Ansible

f5networks.f5_modules.bigip_profile_persistence_cookie модуль – Управление профилями сохранения cookie на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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 сессии. Этот 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

Объект типа dict, содержащий данные подключения.

auth_provider

string

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

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

no_f5_teem

boolean

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

Вы можете опустить этот параметр, установив переменную среды F5_TELEMETRY_OFF.

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

Варианты:

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

password

aliases: 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.

Возвращено: changed

Пример: "preferred"

cookie_method

string

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

Возвращено: changed

Пример: "insert"

cookie_name

string

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

Возвращено: 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_profile_persistence_cookie_module.html

Spec-Zone.ru

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