bigip_profile_persistence_cookie – Управление профилями сохранения cookie на BIG-IP
Новая в версии 2.8.
Описание
- Управление профилями сохранения cookie на BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| always_send boolean |
| Отправлять запись сохранения cookie при каждом ответе, даже если запись уже была предоставлена клиенту. | |
| cookie_encryption строка |
| Указывает способ использования формата шифрования cookie. Когда disabled, генерирует формат cookie без шифрования.Когда preferred, генерирует зашифрованный cookie, но принимает как зашифрованные, так и незашифрованные форматы.Когда required, формат cookie должен быть зашифрованным. | |
| cookie_method строка |
| Указывает тип обработки cookie, используемый системой. Когда hash, указывает, что сервер предоставляет cookie, которое система затем согласованно сопоставляет с определенным узлом. Этот тип сохранения требует значение cookie_name. Когда insert, указывает, что система вставляет информацию сервера в виде cookie в заголовок ответа сервера.Когда passive, указывает, что сервер предоставляет cookie с правильной информацией сервера и таймаутом. Этот тип сохранения требует значение cookie_name. Когда rewrite, указывает, что система перехватывает заголовок BIGipCookie, отправленный сервером, и перезаписывает имя и значение этого cookie. | |
| cookie_name строка | Указывает уникальное имя для cookie. | ||
| description строка | Описание профиля. | ||
| encrypt_cookie_pool_name boolean |
| Указывает, следует ли шифровать имя пула в вставленном стандартном cookie BIG-IP. | |
| encryption_passphrase строка | Указывает пароль, используемый для шифрования cookie. | ||
| expiration словарь добавлен в 2.8 | Указывает время истечения срока действия cookie. По умолчанию система генерирует и использует сессионный cookie. Этот cookie истекает при истечении сессии пользователя, то есть при закрытии браузера. | ||
| days целое число | Время истечения срока действия cookie в днях, значение должно быть в диапазоне от 0 до 24855 дней. | ||
| hours целое число | Время истечения срока действия cookie в часах, значение должно быть в диапазоне от 0 до 23 часов. | ||
| minutes целое число | Время истечения срока действия cookie в минутах, значение должно быть в диапазоне от 0 до 59 минут. | ||
| seconds целое число | По умолчанию: 0 | Время истечения срока действия cookie в секундах, значение должно быть в диапазоне от 0 до 59 секунд. | |
| http_only boolean |
| Указывает, следует ли включить или отключить атрибут httponly для вставляемых cookie. | |
| match_across_pools boolean |
| Когда yes, указывает, что система может использовать любой пул, содержащий эту запись сохранения.При создании нового профиля, если этот параметр не указан, значение по умолчанию предоставляется родительским профилем. | |
| match_across_services boolean |
| Когда yes, указывает, что все постоянные подключения с адреса клиента, которые обращаются к одному виртуальному IP-адресу, также обращаются к одному узлу.При создании нового профиля, если этот параметр не указан, значение по умолчанию предоставляется родительским профилем. | |
| match_across_virtuals boolean |
| Когда yes, указывает, что все постоянные подключения с одного адреса клиента обращаются к одному узлу.При создании нового профиля, если этот параметр не указан, значение по умолчанию предоставляется родительским профилем. | |
| name строка / обязательно | Указывает имя профиля. | ||
| override_connection_limit boolean |
| Когда yes, указывает, что система позволяет указать, что пределы подключений членов пула будут переопределены для постоянных клиентов.Пределы подключений на виртуальном уровне остаются жёсткими ограничениями и не переопределяются. | |
| parent строка | По умолчанию: "cookie" | Указывает профиль, из которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, значение по умолчанию — системный профиль cookie. | |
| partition строка | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| provider словарь добавлен в 2.5 | Объект словаря, содержащий сведения о подключении. | ||
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. | |
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| пользователь строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs логическое |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами лично, с самоподписанными сертификатами.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
| secure логическое |
| Указывает, должен ли быть включён или выключен атрибут secure для вставляемых файлов cookie. | |
| сервер строка / обязательно | Хост BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER. | ||
| server_port целое число добавлен в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER_PORT. | |
| состояние строка |
| При present, гарантирует, что профиль существует.При absent, гарантирует удаление профиля. | |
| update_password строка |
| always позволит обновить пароли, если пользователь этого пожелает. on_create будет устанавливать пароль только для вновь созданных профилей. | |
| пользователь строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs логическое добавлен в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами лично, с самоподписанными сертификатами.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании 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 логическое | изменилось | Новое значение Always Send. | |
| cookie_encryption строка | изменилось | Новый тип шифрования файлов cookie. Пример: предпочтительный | |
| cookie_method строка | изменилось | Новый метод файлов cookie. Пример: вставка | |
| cookie_name строка | изменилось | Новое значение Cookie Name. Пример: 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. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается партнёром 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.8/modules/bigip_profile_persistence_cookie_module.html
