bigiq_application_https_offload - Управляет приложениями BIG-IQ HTTPS offload
Новая версия с 2.6.
Обзор
- Управляет приложениями BIG-IQ, используемыми для балансировки нагрузки HTTPS-приложения на порту 443 с offload SSL на BIG-IP.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| add_analytics bool |
| Собирает статистику BIG-IP, на котором развернуто приложение. Этот параметр актуален только при указании service_environment, являющегося BIG-IP; не SSG. | ||
| client_ssl_profile | Указывает профиль SSL для управления трафиком SSL на стороне клиента. | |||
| name | Имя профиля SSL клиента, который будет создан и использован. При создании нового приложения, если это значение не указано, будет использовано значение по умолчанию clientssl. | |||
| cert_key_chain | Один или несколько сертификатов и ключей для привязки к профилю SSL. Этот параметр всегда представляет собой список. Ключи в списке определяют детали сочетания клиент/ключ/цепочка/пароль. Обратите внимание, что BIG-IP может содержать только по одному экземпляру каждого типа сертификата/ключа. Это означает, что на один профиль можно назначить только один RSA, один DSA и один ECDSA. Если вы попытаетесь назначить два сочетания сертификат/ключ RSA, DSA или ECDSA, устройство отклонит это. Этот список представляет собой сложный список, определяющий ряд ключей. Поддерживается несколько типов ключей. При создании нового профиля, если этот параметр не указан, будет использовано значение по умолчанию inherit. | |||
| cert обязательно | Указывает имя сертификата для использования. | |||
| key обязательно | Указывает имя ключа. | |||
| chain | Указывает цепочку сертификатов, которая относится к сертификату и ключу, упомянутым ранее. Этот ключ необязателен. | |||
| passphrase | Содержит пароль к файлу ключа, если он требуется. Пароли шифруются на удалённом устройстве BIG-IP. | |||
| description | Описание приложения. | |||
| inbound_virtual | Настройки для конфигурации виртуального сервера, который будет получать входящее соединение. Этот виртуальный сервер будет использоваться для размещения HTTPS-точки входа приложения. Трафик, предназначенный для redirect_virtual, будет перенаправлен на этот параметр для обеспечения правильного перенаправления из незащищённого в защищённое соединение. | |||
| destination | Указывает информацию об IP-адресе назначения, куда виртуальный сервер отправляет трафик. Этот параметр требуется при создании нового приложения. | |||
| netmask | Указывает маску сети для привязки к заданному destination. Этот параметр требуется при создании нового приложения. | |||
| port | По умолчанию: 443 | Порт, на котором виртуальный сервер ожидает подключения. При создании нового приложения, если этот параметр не указан, будет использовано значение по умолчанию 443. | ||
| name обязательно | Имя нового приложения. | |||
| 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 установлена. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | |||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. | ||
| ssh_keyfile | Указывает файл SSH-ключа для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспортов cli. Если значение не указано в задании, будет использоваться значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | |||
| transport обязательно |
| Конфигурирует транспортное соединение для подключения к удалённому устройству. | ||
| redirect_virtual | Настройки для конфигурации виртуального сервера, который будет получать перенаправляемое соединение. Этот виртуальный сервер будет использоваться для размещения HTTP-точки входа приложения. Трафик, предназначенный для этого параметра, будет перенаправлен на параметр inbound_virtual для обеспечения правильного перенаправления из незащищённого в защищённое соединение. | |||
| destination | Указывает информацию об IP-адресе назначения, куда виртуальный сервер отправляет трафик. Этот параметр требуется при создании нового приложения. | |||
| netmask | Указывает маску сети для привязки к заданному destination. Этот параметр требуется при создании нового приложения. | |||
| port | По умолчанию: 80 | Порт, на котором виртуальный сервер ожидает подключения. При создании нового приложения, если этот параметр не указан, будет использовано значение по умолчанию 80. | ||
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | |||
| server_port (добавлено в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | ||
| servers | Список серверов, на которых размещено приложение. Если вы знакомы с другими настройками BIG-IP, вы можете также рассматривать этот список как список членов пула. При создании нового приложения требуется как минимум один сервер. | |||
| address | IP-адрес сервера. | |||
| port | По умолчанию: 80 | Порт сервера. | ||
| service_environment | Указывает имя среды сервиса, в которую будет развернуто приложение. При создании нового приложения этот параметр обязателен. | |||
| state |
| Состояние ресурса в системе. Когда present, гарантирует, что ресурс существует с предоставленными атрибутами.Когда absent, удаляет ресурс из системы. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | |||
| validate_certs bool (added in 2.0) |
| If no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. | ||
| wait bool |
| If the module should wait for the application to be created, deleted or updated. | ||
Примечания
Примечание
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk.
Примеры
- 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:
destination: 2.2.2.2
netmask: 255.255.255.255
port: 443
redirect_virtual:
destination: 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 string | changed | New description of the application resource. Пример: My application | |
| inbound_virtual_destination string | changed | Destination of the created virtual address. Пример: 6.7.8.9 | |
| inbound_virtual_netmask string | changed | Network mask of the provided inbound destination. Пример: 255.255.255.0 | |
| inbound_virtual_port int | changed | Порт, на котором прослушивает виртуальный входной адрес. Пример: 80 | |
| servers complex | changed | Список серверов и их портов, составляющих приложение. Пример: Список значений | |
| address string | changed | IP-адрес сервера. Пример: 2.3.4.5 | |
| port int | changed | Порт, на котором сервер прослушивает соединения. Пример: 8080 | |
| service_environment string | changed | Среда, в которой было развернуто приложение. Пример: my-ssg1 | |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом 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.6/modules/bigiq_application_https_offload_module.html
