Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

Параметры

Параметр

Комментарии

add_analytics

boolean

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

Этот параметр применим только при указании service_environment типа BIG-IP, а не SSG.

Возможные значения:

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

description

string

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

inbound_virtual

dictionary

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

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

address

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

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

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

netmask

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

Указывает маску сети, связанную с указанным destination.

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

port

integer

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

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

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

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 ← (по умолчанию)

servers

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

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

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

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

address

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

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

port

integer

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

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

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

service_environment

string

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

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

Тип сервисной среды определяется этим модулем автоматически. Поэтому крайне важно использовать уникальные имена для элементов разных типов сервисной среды (в настоящее время — SSG и 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 HTTP application on port 80 on BIG-IP
  bigiq_application_http:
    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:
      name: foo
      address: 2.2.2.2
      netmask: 255.255.255.255
      port: 443
    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_http_module.html

Spec-Zone.ru

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