bigip_profile_persistence_cookie – Управление профилями сохранения cookie на BIG-IP
Новая в версии 2.8.
Описание
- Управление профилями сохранения 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 добавлено в 2.8 | Указывает время истечения срока действия 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, указывает, что все постоянные соединения с адреса IP клиента, которые идут на один и тот же виртуальный IP-адрес, также идут на один и тот же узел.При создании нового профиля, если этот параметр не указан, значение по умолчанию берётся из родительского профиля. | |
| match_across_virtuals boolean |
| При yes, указывает, что все постоянные соединения с одного и того же адреса IP клиента идут на один и тот же узел.При создании нового профиля, если этот параметр не указан, значение по умолчанию берётся из родительского профиля. | |
| name string / обязательно | Указывает имя профиля. | ||
| override_connection_limit boolean |
| При yes, указывает, что система позволяет указать, что лимиты подключений к членам пула будут переопределены для клиентов с сохранением.Лимиты подключений на виртуальный уровень остаются жёсткими ограничениями и не переопределяются. | |
| parent string | По умолчанию: "cookie" | Указывает профиль, из которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, значение по умолчанию — системный профиль cookie. | |
| partition string | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| provider dictionary добавлено в 2.5 | Объект словаря, содержащий данные подключения. | ||
| auth_provider string | Настраивает поставщика аутентификации для получения маркеров аутентификации от удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| password string / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| server string / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port integer | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| 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 конфигурация сохранится на диске, обязательно включите хотя бы одну задачу, использующую модуль 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. Пример: hash/словарь значений | |
| 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. | |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается партнёром Ansible. [сертифицированный]
Авторы
- 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.9/modules/bigip_profile_persistence_cookie_module.html
