Spec-Zone.ru › Ansible 2.6

bigiq_application_https_waf - Управляет приложениями BIG-IQ HTTPS WAF

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

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

  • Управляет приложениями BIG-IQ, используемыми для балансировки нагрузки HTTPS-приложения на порту 443 с межсетевым экраном веб-приложений (WAF) с использованием политики развертывания ASM Rapid Deployment.

Требования

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

  • 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
Описание приложения.
domain_names
Указывает имена хостов, используемые для доступа к веб-приложению, которое защищает эта политика безопасности.
При создании нового приложения этот параметр обязателен.
inbound_virtual
Настройки для конфигурации виртуального сервера, который будет принимать входящие подключения.
Этот виртуальный сервер будет использоваться для размещения HTTPS-точки входа приложения.
Трафик, предназначенный для redirect_virtual, будет перенаправлен на этот параметр, чтобы обеспечить правильное перенаправление с не защищённого на защищённый протокол.
destination
Указывает информацию об IP-адресе назначения, куда виртуальный сервер отправляет трафик.
Этот параметр обязателен при создании нового приложения.
netmask
Указывает маску сети для ассоциации с данным destination.
Этот параметр обязателен при создании нового приложения.
port По умолчанию:
443
Порт, на котором виртуальный сервер ожидает подключения.
При создании нового приложения, если этот параметр не указан, будет использовано значение по умолчанию 443.
name
обязательно
Имя нового приложения.
password
обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD задана.

Псевдонимы: pass, pwd
provider
(добавлено в 2.5)
Объект типа dict, содержащий данные подключения.
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
обязательно
    Варианты:
  • rest
  • cli ←
Конфигурирует транспортное соединение для использования при подключении к удалённому устройству.
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)
    Choices:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены. Используйте этот параметр только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.
wait
bool
    Choices:
  • no
  • yes ←
Если модуль должен ждать создания, удаления или обновления приложения.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.

Примеры

- name: Load balance an HTTPS application on port 443 with a WAF using ASM
  bigiq_application_https_waf:
    name: my-app
    description: Redirect HTTP to HTTPS via WAF
    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
Новое описание приложения ресурса.

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

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

Пример:
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_waf_module.html

Spec-Zone.ru

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