Spec-Zone.ru › Ansible

f5networks.f5_modules.bigiq_application_https_offload модуль — Управляет приложениями HTTPS-выгрузки BIG-IQ

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать его в книге задач, укажите: f5networks.f5_modules.bigiq_application_https_offload.

Добавлен в f5networks.f5_modules 1.0.0

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Управляет приложениями BIG-IQ, используемыми для балансировки нагрузки веб-приложений HTTPS по порту 443 с выгрузкой SSL на BIG-IP.

Параметры

Параметр

Комментарии

add_analytics

boolean

Сбор статистики BIG-IP, на котором развернуто приложение.

Этот параметр актуален только при указании service_environment, являющегося BIG-IP, а не SSG.

Выбираемые значения:

  • false ← (по умолчанию)
  • true

client_ssl_profile

dictionary

Указывает профиль SSL для управления трафиком SSL на стороне клиента.

cert_key_chain

any

Один или несколько сертификатов и ключей для ассоциации с профилем SSL.

Этот параметр всегда является списком. Ключи в списке определяют подробности сочетания клиент/ключ/цепь/пароль.

BIG-IP может иметь только один из каждого типа сертификата/ключа. Это означает, что вы можете иметь только один RSA, один DSA и один ECDSA на профиль.

Если вы попытаетесь назначить два RSA, DSA или ECDSA сочетание сертификата/ключа, устройство отклонит его.

Этот список — сложный список, определяющий ряд ключей.

При создании нового профиля, если этот параметр не указан, значение по умолчанию — inherit.

cert

string

Указывает имя сертификата для использования.

chain

string

Указывает цепочку сертификатов, относящуюся к указанному сертификату и ключу.

Этот ключ необязателен.

key

string

Указывает имя ключа.

passphrase

string

Содержит пароль файла ключа, если он необходим.

Пароли шифруются на удалённом устройстве BIG-IP.

name

string

Имя создаваемого и используемого профиля SSL клиента.

При создании нового приложения, если это значение не указано, значение по умолчанию — clientssl.

По умолчанию: "clientssl"

description

string

Описание приложения.

inbound_virtual

dictionary

Настройки для конфигурации виртуального сервера, принимающего входящие подключения.

Этот виртуальный сервер используется для размещения HTTPS-точки входа приложения.

Трафик, предназначенный для redirect_virtual, перенаправляется на этот параметр, чтобы обеспечить правильное перенаправление от небезопасного к безопасному.

address

string / обязательно

Указывает информацию об IP-адресе назначения, куда виртуальный сервер отправляет трафик.

Этот параметр необходим при создании нового приложения.

netmask

string / обязательно

Указывает маску подсети для ассоциации с данным address.

Этот параметр необходим при создании нового приложения.

port

integer

Порт, на котором виртуальный сервер прослушивает подключения.

При создании нового приложения, если этот параметр не указан, значение по умолчанию — 443.

По умолчанию: 443

name

string / обязательно

Имя нового приложения.

provider

dictionary

добавлено в f5networks.f5_modules 1.0.0

Объект словаря, содержащий детали подключения.

auth_provider

string

Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства.

Этот параметр используется при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если yes, данные телеметрии TEEM не отправляются в F5.

Вы можете опустить этот параметр, установив переменную среды F5_TELEMETRY_OFF.

Предыдущая переменная F5_TEEM устарела, так как её имя вызывало путаницу.

Выбираемые значения:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

string / обязательно

Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

server

строка / обязательно

Хост BIG-IP или хост BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER.

server_port

целое число

Порт сервера BIG-IP.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

целое число

Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.

transport

строка

Настраивает транспортное соединение для подключения к удалённому устройству.

Варианты:

  • "rest" ← (по умолчанию)

user

строка / обязательно

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве.

Вы можете опустить этот параметр, установив переменную среды F5_USER.

validate_certs

булево

Если no, сертификаты SSL не проверяются. Используйте только на сайтах под вашим контролем, использующих самозаверяющие сертификаты.

Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

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, удаляет ресурс из системы.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

wait

булево

Указывает, должен ли модуль ждать создания, удаления или обновления приложения.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Этот модуль не будет работать с BIGIQ версии 6.1.x или выше.
  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется версия ПО BIG-IP >= 12.
  • Модули F5 манипулируют только активной конфигурацией продукта F5. Чтобы гарантировать, что конфигурация, специфичная для BIG-IP, сохранится на диске, убедитесь, что включен хотя бы один task, использующий модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования, чтобы сохранить вашу текущую конфигурацию.

Примеры

- name: BIG-IQ CM 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: cm.mydomain.com
      user: admin
    state: present
  delegate_to: localhost

Значения возврата

Общие значения возврата задокументированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ

Описание

description

строка

Новое описание приложения ресурса.

Возвращено: изменено

Пример: "My application"

inbound_virtual_destination

строка

Назначение виртуального объекта, который был создан.

Возвращено: изменено

Пример: "6.7.8.9"

inbound_virtual_netmask

строка

Маска подсети предоставленного входного назначения.

Возвращено: изменено

Пример: "255.255.255.0"

inbound_virtual_port

целое число

Порт, на котором прослушивает входной виртуальный адрес.

Возвращено: изменено

Пример: 80

servers

сложный

Список серверов и их портов, составляющих приложение.

Возвращено: изменено

Пример: "hash/dictionary of values"

address

строка

IP-адрес сервера.

Возвращено: изменено

Пример: "2.3.4.5"

port

целое число

Порт, на котором прослушивает сервер.

Возвращено: изменено

Пример: 8080

service_environment

строка

Среда, в которую было развернуто приложение.

Возвращено: изменено

Пример: "my-ssg1"

Авторы

  • Tim Rupp (@caphrim007)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (исходники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigiq_application_https_offload_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API