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

Примечание

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

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

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

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

Управляет приложениями BIG-IQ, используемыми для балансировки нагрузки TCP-приложения с профилем FastL4.

Параметры

Параметр	Комментарии
add_analytics boolean	Собирает статистику BIG-IP, на котором развёрнуто приложение. Этот параметр имеет смысл только при указании `service_environment` типа BIG-IP, а не SSG. Варианты: `false` ← (по умолчанию) `true`
description string	Описание приложения.
inbound_virtual dictionary	Параметры настройки виртуального сервера, который будет принимать входящие подключения.
address string / обязательный	Задаёт сведения об IP-адресе назначения, на который виртуальный сервер направляет трафик. Этот параметр обязателен при создании нового приложения.
netmask string / обязательный	Задаёт маску сети, связанную с указанным `destination`. Этот параметр обязателен при создании нового приложения.
port integer	Порт, на котором виртуальный сервер ожидает подключения. При создании нового приложения, если этот параметр не указан, используется значение по умолчанию `8080`. По умолчанию: `8080`
name string / обязательный	Имя нового приложения.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Словарь с параметрами подключения.
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	Порт сервера. При создании нового приложения с указанием сервера, если этот параметр не задан, используется значение по умолчанию `8000`. По умолчанию: `8000`
service_environment string	Задаёт имя сервисной среды, в которой развёртывается приложение. Этот параметр обязателен при создании нового приложения. Тип сервисной среды определяется модулем автоматически. Поэтому крайне важно использовать уникальные имена для элементов разных типов сервисной среды. SSG не поддерживаются для приложений этого типа.
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 a TCP-based application with a FastL4 profile
  bigiq_application_fastl4_tcp:
    name: my-app
    description: My description
    service_environment: my-bigip-device
    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_fastl4_tcp_module.html