Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigiq_application_https_waf — управление приложениями BIG-IQ HTTPS WAF

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigiq_application_https_waf.

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

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

Краткое описание

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

Параметры

Параметр

Комментарии

add_analytics

логическое значение

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

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

Варианты:

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

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.

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

description

строка

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

domain_names

список / элементы=строка

Задает имена узлов, используемые для доступа к веб-приложению, защищаемому этой политикой безопасности.

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

inbound_virtual

словарь

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

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

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

address

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

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

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

netmask

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

Задает маску подсети для указанного destination.

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

port

целое число

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

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

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

name

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

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

provider

словарь

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

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

auth_provider

строка

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

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

no_f5_teem

логическое значение

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

Этот параметр можно не указывать, задав переменную среды F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM объявлена устаревшей, поскольку ее имя было неоднозначным.

Варианты:

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

password

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

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

Пароль учетной записи пользователя, используемой для подключения к 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

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

Задает маску подсети для указанного destination.

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

port

целое число

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

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

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

servers

список / элементы=словарь

Список серверов, на которых размещено приложение.

Если вы знакомы с другими настройками BIG-IP, этот список также может называться списком участников пула.

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

address

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

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

port

целое число

Порт сервера.

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

service_environment

строка

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

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

state

строка

Состояние ресурса в системе.

При значении present гарантируется наличие ресурса с указанными атрибутами.

При значении absent ресурс удаляется из системы.

Варианты:

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

wait

логическое значение

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

Варианты:

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

Примечания

Примечание

  • Этот модуль не работает с BIG-IQ версии 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: BIG-IQ CM 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:
      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

строка

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

Возвращается: changed

Пример: "My application"

inbound_virtual_destination

строка

Адрес назначения созданного виртуального сервера.

Возвращается: changed

Пример: "6.7.8.9"

inbound_virtual_netmask

строка

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

Возвращается: changed

Пример: "255.255.255.0"

inbound_virtual_port

целое число

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

Возвращается: changed

Пример: 80

servers

сложный тип

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

Возвращается: changed

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

address

строка

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

Возвращается: changed

Пример: "2.3.4.5"

port

целое число

Порт, на котором ожидает соединения сервер.

Возвращается: changed

Пример: 8080

service_environment

строка

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

Возвращается: changed

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

Авторы

  • Tim Rupp (@caphrim007)

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

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

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

Spec-Zone.ru

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