f5networks.f5_modules.bigiq_application_https_offload – Управляет приложениями BIG-IQ HTTPS offload
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Чтобы использовать его в плейбуке, укажите: f5networks.f5_modules.bigiq_application_https_offload.
Добавлена в версии 1.0.0: модуля f5networks.f5_modules
Обзор
- Управляет приложениями BIG-IQ, используемыми для балансировки нагрузки HTTPS-приложения на порту 443 с SSL-offloading на BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| 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 строка | По умолчанию: "clientssl" | Имя профиля SSL клиента, который будет создан и использован. При создании нового приложения, если это значение не указано, используется значение по умолчанию clientssl. | ||
| description строка | Описание приложения. | |||
| inbound_virtual словарь | Настройки для конфигурации виртуального сервера, принимающего входящие соединения. Этот виртуальный сервер используется для размещения HTTPS-точки входа приложения. Трафик, предназначенный для redirect_virtual, перенаправляется на этот параметр для обеспечения правильного перенаправления из небезопасного соединения в безопасное. | |||
| address строка / обязательно | Указывает информацию об IP-адресе назначения, которому виртуальный сервер отправляет трафик. Этот параметр необходим при создании нового приложения. | |||
| netmask строка / обязательно | Указывает маску подсети, которую нужно связать с заданным address.Этот параметр необходим при создании нового приложения. | |||
| port строка | По умолчанию: 443 | Порт, на котором виртуальный сервер слушает подключения. При создании нового приложения, если этот параметр не указан, значение по умолчанию — 443. | ||
| name строка / обязательно | Имя нового приложения. | |||
| provider словарь добавлен в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий данные подключения. | |||
| auth_provider строка | Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | |||
| no_f5_teem boolean |
| Если yes, данные телеметрии TEEM не отправляются в F5.Вы можете пропустить этот параметр, установив переменную среды F5_TEEM. | ||
| password строка / обязательно | Пароль для учётной записи пользователя, используемой для подключения к BIG-IP. Вы можете пропустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | |||
| server строка / обязательно | Хост BIG-IP. Вы можете пропустить этот параметр, установив переменную среды F5_SERVER. | |||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете пропустить этот параметр, установив переменную среды F5_SERVER_PORT. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |||
| 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. | ||
| servers список / элементы=словарь | Список серверов, на которых размещено приложение. Если вы знакомы с другими настройками BIG-IP, вы можете также отнести этот список к списку членов пула. При создании нового приложения требуется как минимум один сервер. | |||
| address строка / обязательно | IP-адрес сервера. | |||
| port строка | По умолчанию: 80 | Порт сервера. | ||
| service_environment строка | Указывает имя среды обслуживания или имя хоста BIG-IP, на котором будет развернуто приложение. Этот параметр необходим при создании нового приложения. | |||
| state строка |
| Состояние ресурса в системе. Когда present, гарантирует, что ресурс существует с указанными атрибутами.Когда absent, удаляет ресурс из системы. | ||
| wait boolean |
| Если модуль должен подождать, пока приложение будет создано, удалено или обновлено. | ||
Примечания
Примечание
- Этот модуль не будет работать на версии BIGIQ 6.1.x и выше.
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, обязательно включите по крайней мере одну задачу, которая использует модуль f5networks.f5_modules.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 | |
Авторы
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigiq_application_https_offload_module.html
