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