f5networks.f5_modules.bigip_profile_persistence_cookie – Управление профилями сохранения cookie на BIG-IP
Примечание
Этот плагин входит в состав коллекции f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в книге задач укажите: f5networks.f5_modules.bigip_profile_persistence_cookie.
Добавлена в версии 1.0.0: модуля f5networks.f5_modules
Описание
- Управление профилями сохранения cookie на системе BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| always_send boolean |
| Отправляет запись сохранения cookie при каждом ответе, даже если запись уже была предоставлена клиенту. | |
| cookie_encryption string |
| Указывает способ использования формата шифрования cookie. Когда disabled, генерирует формат cookie без шифрования.Когда preferred, генерирует зашифрованное cookie, но принимает как зашифрованные, так и незашифрованные форматы.Когда required, формат cookie должен быть зашифрованным. | |
| cookie_method string |
| Указывает тип обработки cookie, используемый системой. Когда hash, указывает, что сервер предоставляет cookie, которое система затем сопоставляет с определенным узлом. Этот тип сохранения требует cookie_name значения.Когда insert, указывает, что система вставляет информацию сервера в виде cookie в заголовок ответа сервера.Когда passive, указывает, что сервер предоставляет cookie с правильной информацией сервера и таймаутом. Этот тип сохранения требует cookie_name значения.Когда rewrite, указывает, что система перехватывает заголовок BIGipCookie, отправленный сервером, и перезаписывает имя и значение этого cookie. | |
| cookie_name string | Указывает уникальное имя для cookie. | ||
| description string | Описание профиля. | ||
| encrypt_cookie_pool_name boolean |
| Указывает, нужно ли шифровать имя пула в вставленном cookie по умолчанию BIG-IP. | |
| 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 | Значение по умолчанию: 0 | Время истечения срока действия cookie в секундах. Значение должно быть в диапазоне от 0 до 59 секунд. | |
| http_only boolean |
| Указывает, нужно ли включить или отключить атрибут httponly для вставляемых cookie. | |
| match_across_pools boolean |
| Когда yes, указывает, что система может использовать любой пул, содержащий эту запись сохранения.При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию. | |
| match_across_services boolean |
| Когда yes, указывает, что все постоянные подключения с адреса клиента, которые переходят к одному виртуальному адресу, также переходят к одному узлу.При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию. | |
| match_across_virtuals boolean |
| Когда yes, указывает, что все постоянные подключения с одного адреса клиента переходят к одному узлу.При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию. | |
| name string / required | Указывает имя профиля. | ||
| override_connection_limit boolean |
| Когда yes, указывает, что система позволяет указать, что пределы подключений членов пула будут переопределены для сохраненных клиентов.Пределы подключений на виртуальной основе остаются жесткими ограничениями и не переопределяются. | |
| parent string | Значение по умолчанию: "cookie" | Указывает профиль, из которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, значение по умолчанию - cookie профиль. | |
| partition string | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| provider dictionary добавлен в 1.0.0 f5networks.f5_modules | Объект типа dict, содержащий детали подключения. | ||
| auth_provider string | Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется, когда вы работаете с устройствами BIG-IQ. | ||
| no_f5_teem boolean |
| Если yes, данные телеметрии TEEM не отправляются в F5.Вы можете опустить этот параметр, установив переменную среды F5_TEEM. | |
| password string / required | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| server string / required | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port integer | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| timeout integer | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | ||
| transport string |
| Настраивает транспортное подключение для использования при подключении к удаленному устройству. | |
| user string / required | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самоподписанными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| secure boolean |
| Указывает, нужно ли включить или отключить атрибут secure для вставляемых cookie. | |
| state string |
| Когда present, гарантирует, что профиль существует.Когда absent, гарантирует, что профиль удален. | |
| update_password string |
| 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 | changed | Новое значение Always Send. | |
| cookie_encryption string | changed | Новый тип шифрования Cookie. Пример: preferred | |
| cookie_method string | changed | Новый метод Cookie. Пример: insert | |
| cookie_name string | changed | Новое значение имени Cookie. Пример: cookie1 | |
| description string | changed | Новое описание. Пример: Моё описание | |
| encrypt_cookie_pool_name boolean | changed | Новое значение Encrypt Cookie Pool Name. Пример: True | |
| expiration complex | changed | Срок действия cookie. Пример: хэш/словарь значений | |
| days integer | changed | Срок действия cookie в днях. Пример: 125 | |
| hours integer | changed | Срок действия cookie в часах. Пример: 22 | |
| minutes integer | changed | Срок действия cookie в минутах. Пример: 58 | |
| seconds integer | changed | Срок действия cookie в секундах. Пример: 20 | |
| http_only boolean | changed | Новое значение HTTP Only. Пример: True | |
| match_across_pools boolean | changed | Новое значение Match Across Pools. Пример: True | |
| match_across_services boolean | changed | Новое значение Match Across Services. | |
| match_across_virtuals boolean | changed | Новое значение Match Across Virtuals. Пример: True | |
| override_connection_limit boolean | changed | Новое значение Override Connection Limit. | |
| parent string | changed | Родительский профиль. Пример: /Common/cookie | |
| secure boolean | changed | Новое значение Secure Cookie. | |
Авторы
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_profile_persistence_cookie_module.html
