Spec-Zone.ru › Ansible 2.9

bigiq_application_https_offload – Управляет приложениями BIG-IQ HTTPS offload

Новая в версии 2.6.

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

Описание

  • Управляет приложениями 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
-
Имя создаваемого и используемого профиля SSL клиента.
При создании нового приложения, если это значение не указано, будет использовано значение по умолчанию clientssl.
description
строка
Описание приложения.
inbound_virtual
словарь
Настройки для конфигурации виртуального сервера, который будет принимать входящее соединение.
Этот виртуальный сервер будет использоваться для размещения HTTPS-точки входа приложения.
Трафик, предназначенный для redirect_virtual, будет перенаправлен на этот параметр, чтобы обеспечить правильное перенаправление из небезопасного соединения в безопасное.
address
строка
Указывает информацию об IP-адресе назначения, на который виртуальный сервер отправляет трафик.
Этот параметр необходим при создании нового приложения.
netmask
строка
Указывает маску сети для привязки к заданному address.
Этот параметр необходим при создании нового приложения.
port
строка
Значение по умолчанию:
443
Порт, на котором виртуальный сервер ожидает соединения.
При создании нового приложения, если этот параметр не указан, будет использовано значение по умолчанию 443.
name
строка / обязательно
Имя нового приложения.
provider
словарь
добавлено в 2.5
Объект словаря, содержащий сведения о подключении.
auth_provider
строка
Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства.
Этот параметр используется при работе с устройствами BIG-IQ.
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
целое число
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
transport
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное соединение для подключения к удаленному устройству.
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-адрес сервера.
END_OF_DOCUMENT_MARKER
порт
строка
По умолчанию:
80
Порт сервера.
service_environment
строка
Указывает имя среды сервиса или имя хоста BIG-IP, на который будет развернуто приложение.
При создании нового приложения этот параметр требуется.
состояние
строка
    Варианты:
  • absent
  • present ←
Состояние ресурса в системе.
Когда present, гарантирует, что ресурс существует с предоставленными атрибутами.
Когда absent, удаляет ресурс из системы.
wait
логический
    Варианты:
  • no
  • yes ←
Если модуль должен дождаться создания, удаления или обновления приложения.

Примечания

Примечание

  • Этот модуль не будет работать на BIGIQ версии 6.1.x или выше.
  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется программное обеспечение 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

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

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

Ключ Возвращенное значение Описание
описание
строка
changed
Новое описание приложения для ресурса.

Пример:
Моё приложение
inbound_virtual_destination
строка
changed
Назначение виртуального адреса, которое было создано.

Пример:
6.7.8.9
inbound_virtual_netmask
строка
changed
Маска подсети предоставленного входящего назначения.

Пример:
255.255.255.0
inbound_virtual_port
целое число
changed
Порт, на котором прослушивает входящий виртуальный адрес.

Пример:
80
servers
сложный
changed
Список серверов и их портов, составляющих приложение.

Пример:
хеш/словарь значений
адрес
строка
changed
IP-адрес сервера.

Пример:
2.3.4.5
порт
целое число
changed
Порт, на котором прослушивает сервер.

Пример:
8080
service_environment
строка
changed
Среда, в которой был развернут сервис.

Пример:
my-ssg1


Статус

  • Этот модуль не гарантирует обратную совместимость. [preview]
  • Этот модуль поддерживается партнёром Ansible. [certified]

Авторы

  • 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.9/modules/bigiq_application_https_offload_module.html

Spec-Zone.ru

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