Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию 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_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

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

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

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

Имя узла BIG-IP или BIG-IQ.

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

server_port

integer

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

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

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

timeout

integer

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

transport

string

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

Варианты:

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

user

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

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

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

validate_certs

boolean

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

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

Варианты:

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

redirect_virtual

dictionary

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

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

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

address

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

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

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

netmask

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

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

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

port

integer

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

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

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

servers

list / элементы=dictionary

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

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

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

address

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

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

port

integer

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

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

service_environment

string

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

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

state

string

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

При значении present гарантирует, что ресурс существует с указанными атрибутами.

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

Варианты:

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

wait

boolean

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

Варианты:

  • 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 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

string

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

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

Пример: "My application"

inbound_virtual_destination

string

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

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

Пример: "6.7.8.9"

inbound_virtual_netmask

string

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

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

Пример: "255.255.255.0"

inbound_virtual_port

integer

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

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

Пример: 80

servers

complex

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

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

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

address

string

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

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

Пример: "2.3.4.5"

port

integer

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

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

Пример: 8080

service_environment

string

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

Возвращается: 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_offload_module.html

Spec-Zone.ru

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