bigiq_application_https_offload – Управляет приложениями BIG-IQ HTTPS offload
Новая версия с 2.6.
Обзор
- Управляет приложениями BIG-IQ, используемыми для балансировки нагрузки HTTPS-приложения на порту 443 с SSL-offloading на BIG-IP.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| add_analytics boolean |
| Сбор статистики BIG-IP, на котором развернуто приложение. Этот параметр имеет значение только при указании service_environment, который представляет BIG-IP; не SSG. | ||
| client_ssl_profile - | Указывает профиль SSL для управления трафиком SSL на стороне клиента. | |||
| cert_key_chain - | Один или несколько сертификатов и ключей для ассоциации с профилем SSL. Этот параметр всегда является списком. Ключи в списке определяют детали комбинации клиент/ключ/цепь/пароль. Обратите внимание, что BIG-IP может иметь только по одному экземпляру каждого типа сертификата/ключа. Это означает, что вы можете иметь только один RSA, один DSA и один ECDSA на профиль. Если вы попытаетесь назначить две комбинации сертификатов/ключей RSA, DSA или ECDSA, устройство отклонит это. Этот список является сложным списком, который определяет ряд ключей. При создании нового профиля, если этот параметр не указан, будет использовано значение по умолчанию inherit. | |||
| cert - / обязательно | Указывает имя сертификата для использования. | |||
| chain - | Указывает цепочку сертификатов, относящуюся к сертификату и ключу, упомянутым ранее. Этот ключ необязателен. | |||
| key - / обязательно | Указывает имя ключа. | |||
| passphrase - | Содержит пароль к файлу ключа, если он требуется. Пароли шифруются на удалённом устройстве BIG-IP. | |||
| name - | Имя создаваемого и используемого профиля SSL клиента. При создании нового приложения, если это значение не указано, будет использовано значение по умолчанию clientssl. | |||
| description - | Описание приложения. | |||
| inbound_virtual - | Настройки для конфигурации виртуального сервера, который будет принимать входящее соединение. Этот виртуальный сервер будет использоваться для размещения HTTPS-точки входа приложения. Трафик, предназначенный для redirect_virtual, будет перенаправлен на этот параметр, чтобы обеспечить надлежащее перенаправление из небезопасного соединения в безопасное. | |||
| address - | Указывает информацию об IP-адресе назначения, куда виртуальный сервер отправляет трафик. Этот параметр необходим при создании нового приложения. | |||
| netmask - | Указывает маску подсети для ассоциации с заданным address. Этот параметр необходим при создании нового приложения. | |||
| port - | По умолчанию: 443 | Порт, на котором виртуальный сервер прослушивает соединения. При создании нового приложения, если этот параметр не указан, будет использовано значение по умолчанию 443. | ||
| name - / обязательно | Название нового приложения. | |||
| password - / обязательно | Пароль для учётной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | |||
| provider - добавлен в 2.5 | По умолчанию: null | Объект dict, содержащий сведения о подключении. | ||
| 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 boolean |
| Если no, сертификаты SSL не будут проверены. Используйте это только на контролируемых вами сайтах, использующих самозаверяющие сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | ||
| redirect_virtual - | Настройки для конфигурации виртуального сервера, который будет получать перенаправленное соединение. Этот виртуальный сервер будет использоваться для размещения HTTP-точки входа приложения. Трафик, предназначенный для этого параметра, будет перенаправлен на параметр inbound_virtual, чтобы обеспечить надлежащее перенаправление из небезопасного соединения в безопасное. | |||
| address - | Указывает информацию об IP-адресе назначения, куда виртуальный сервер отправляет трафик. Этот параметр необходим при создании нового приложения. | |||
| netmask - | Указывает маску подсети для ассоциации с заданным address. Этот параметр необходим при создании нового приложения. | |||
| port - | По умолчанию: 80 | Порт, на котором виртуальный сервер прослушивает соединения. При создании нового приложения, если этот параметр не указан, будет использовано значение по умолчанию 80. | ||
| server - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | |||
| server_port - added in 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_SERVER_PORT. | ||
| servers - | Список серверов, на которых размещено приложение. Если вы знакомы с другими настройками BIG-IP, вы можете также рассматривать этот список как список членов пула. При создании нового приложения требуется как минимум один сервер. | |||
| address - | IP-адрес сервера. | |||
| port - | Значение по умолчанию: 80 | Порт сервера. | ||
| service_environment - | Указывает имя среды службы или имя хоста BIG-IP, на котором будет развернуто приложение. При создании нового приложения этот параметр обязателен. | |||
| state - |
| Состояние ресурса в системе. Когда present, гарантирует, что ресурс существует с предоставленными атрибутами.Когда absent, удаляет ресурс из системы. | ||
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения F5_USER. | |||
| validate_certs boolean added in 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, находящихся под вашим контролем, которые используют самозаверяемые сертификаты.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | ||
| wait boolean |
| Если модуль должен ожидать создания, удаления или обновления приложения. | ||
Примечания
Примечание
- Для получения дополнительной информации об использовании Ansible для управления устройствами F5 Networks см. https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk. - Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохраняется на диске, обязательно включите хотя бы одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Load balance an HTTPS application on port 443 with SSL offloading on BIG-IP
bigiq_application_https_offload:
name: my-app
description: Redirect HTTP to HTTPS
service_environment: my-ssg
servers:
- address: 1.2.3.4
port: 8080
- address: 5.6.7.8
port: 8080
inbound_virtual:
address: 2.2.2.2
netmask: 255.255.255.255
port: 443
redirect_virtual:
address: 2.2.2.2
netmask: 255.255.255.255
port: 80
provider:
password: secret
server: lb.mydomain.com
user: admin
state: present
delegate_to: localhost
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| description строка | changed | Новое описание приложения ресурса. Пример: Моё приложение | |
| inbound_virtual_destination строка | changed | Назначение виртуального ресурса, который был создан. Пример: 6.7.8.9 | |
| inbound_virtual_netmask строка | changed | Маска сети предоставленного входного назначения. Пример: 255.255.255.0 | |
| inbound_virtual_port целое число | changed | Порт, на котором прослушивает входной виртуальный адрес. Пример: 80 | |
| servers сложное значение | changed | Список серверов и их портов, из которых состоит приложение. Пример: хеш/словарь значений | |
| address строка | changed | IP-адрес сервера. Пример: 2.3.4.5 | |
| port целое число | changed | Порт, на котором прослушивает сервер. Пример: 8080 | |
| service_environment строка | changed | Среда, в которую была развернута служба. Пример: my-ssg1 | |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- Tim Rupp (@caphrim007)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigiq_application_https_offload_module.html
