bigip_profile_http – Управление профилями HTTP на BIG-IP
Новая в версии 2.7.
Описание
- Управление профилями HTTP на BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка | Описание профиля. | ||
| dns_resolver строка | Указывает имя настроенного DNS-резолвера. Этот параметр обязателен, когда proxy_type установлено в explicit. Формат имени может быть с префиксом раздела ( /Common/foo) или указан как просто имя объекта (foo).Чтобы удалить запись, можно установить значение none или '', но при этом профиль proxy_type не должен быть установлен как explicit. | ||
| encrypt_cookie_secret строка | Пароль для шифрования куки. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. | ||
| encrypt_cookies список | Имена куки, которые система должна шифровать. Чтобы полностью удалить запись, необходимо установить значение none или ''. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. | ||
| header_erase строка добавлено в 2.8 | Имя заголовка в HTTP-запросе, который система удаляет из запроса. Чтобы полностью удалить запись, необходимо установить значение none или ''. Формат заголовка должен быть в формате KEY:VALUE, в противном случае произойдет ошибка.При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. | ||
| header_insert строка добавлено в 2.8 | Строка, которую система вставляет в качестве заголовка в HTTP-запрос. Чтобы полностью удалить запись, необходимо установить значение none или ''. Формат заголовка должен быть в формате KEY:VALUE, в противном случае произойдет ошибка.При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. | ||
| hsts_mode логическое добавлено в 2.8 |
| При установке в yes, включаются настройки HSTS.При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. | |
| include_subdomains логическое добавлено в 2.8 |
| При установке в yes, политика HSTS применяется к хосту HSTS и его дочерним доменам.При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. | |
| insert_xforwarded_for логическое |
| При указании система вставляет заголовок X-Forwarded-For в HTTP-запрос с IP-адресом клиента для использования с пулом подключений. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. | |
| maximum_age строка добавлено в 2.8 | Указывает максимальную длительность в секундах, в течение которой функция HSTS запрашивает от клиентов использовать только HTTPS для подключения к текущему хосту и любым дочерним доменам текущего доменного имени. Принимаемый диапазон значений — 0 - 4294967295 секунд. Значение 0 секунд позволяет повторно включить доступ через обычный HTTP, в то время как indefinite установит максимальное значение.При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. | ||
| name строка / обязательно | Указывает имя профиля. | ||
| parent строка | По умолчанию: "/Common/http" | Указывает профиль, из которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, используется профиль по умолчанию http, предоставляемый системой. | |
| 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 строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs логическое |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
| proxy_type строка |
| Указывает режим прокси для профиля. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. | |
| redirect_rewrite строка |
| Указывает, переписывает ли система URI, которые являются частью ответов HTTP-перенаправления (3XX). При установке значения none, система не будет переписывать URI в ответах HTTP-перенаправления.При установке значения all, система переписывает URI во всех ответах HTTP-перенаправления.При установке значения matching, система переписывает URI в ответах HTTP-перенаправления, которые соответствуют запросу URI.При установке значения nodes, если URI содержит IP-адрес узла вместо имени хоста, система изменяет его на адрес виртуального сервера.При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. | |
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_agent_name строка добавлен в 2.8 | Указывает строку, используемую в качестве имени сервера в трафике, генерируемом LTM. Чтобы полностью удалить запись, следует установить значение none или ''. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. | ||
| server_port целое число добавлен в 2.2 | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| state строка |
| При установке значения present, гарантируется, что профиль существует.При установке значения absent, гарантируется удаление профиля. | |
| update_password строка |
| always будет обновлять пароли, если параметр encrypt_cookie_secret указан.on_create будет устанавливать пароль только для вновь созданных профилей. | |
| user строка / обязательно | Имя пользователя для подключения к 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 HTTP profile
bigip_profile_http:
name: my_profile
insert_xforwarded_for: yes
redirect_rewrite: all
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Remove HTTP profile
bigip_profile_http:
name: my_profile
state: absent
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add HTTP profile for transparent proxy
bigip_profile_http:
name: my_profile
proxy_type: transparent
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка | changed | Описание профиля. Пример: Мой профиль |
| dns_resolver строка | changed | Настроенный DNS-резолвер. Пример: /Common/FooBar |
| encrypt_cookies список | changed | Имена cookie для шифрования. Пример: ['MyCookie1', 'MyCookie2'] |
| insert_xforwarded_for булево | changed | Вставить заголовок X-Forwarded-For. Пример: True |
| proxy_type строка | changed | Указать режим прокси-сервера профиля. Пример: explicit |
| redirect_rewrite строка | changed | Переписать URI, которые являются частью ответов 3xx. Пример: all |
Статус
- Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- 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_http_module.html
