bigiq_application_fastl4_tcp - Управляет приложениями BIG-IQ FastL4 TCP
Новое в версии 2.6.
Описание
- Управляет приложениями BIG-IQ, используемыми для балансировки нагрузки TCP-приложения с профилем FastL4.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| add_analytics bool |
| Сбор статистики BIG-IP, на котором развернуто приложение. Этот параметр актуален только при указании service_environment, что является BIG-IP; не SSG. | |
| description | Описание приложения. | ||
| inbound_virtual | Настройки для конфигурации виртуального сервера, который будет принимать входящее подключение. | ||
| address обязательно | Указывает информацию об IP-адресе назначения, куда виртуальный сервер отправляет трафик. Этот параметр необходим при создании нового приложения. | ||
| netmask обязательно | Указывает маску сети для ассоциации с заданным destination. Этот параметр необходим при создании нового приложения. | ||
| port | По умолчанию: 8080 | Порт, на котором виртуальный сервер прослушивает подключения. При создании нового приложения, если этот параметр не указан, будет использовано значение по умолчанию 8080. | |
| name обязательно | Имя нового приложения. | ||
| password обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, если переменная среды F5_PASSWORD задана.псевдонимы: pass, pwd | ||
| provider (добавлено в 2.5) | Объект словаря, содержащий данные подключения. | ||
| 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 обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER задана. | ||
| server_port (добавлено в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER_PORT задана. | |
| servers | Список серверов, на которых размещено приложение. Если вы знакомы с другими настройками BIG-IP, вы можете также рассматривать этот список как список членов пула. При создании нового приложения необходим хотя бы один сервер. | ||
| address обязательно | IP-адрес сервера. | ||
| port | По умолчанию: 8000 | Порт сервера. При создании нового приложения и указании сервера, если этот параметр не указан, будет использовано значение по умолчанию 8000. | |
| service_environment | Указывает имя среды обслуживания, в которую будет развернуто приложение. При создании нового приложения этот параметр необходим. Тип среды обслуживания будет обнаружен этим модулем автоматически. Поэтому крайне важно поддерживать уникальные имена элементов в различных типах сред обслуживания. SSG не поддерживаются для этого типа приложений. | ||
| state |
| Состояние ресурса в системе. Когда present, гарантирует, что ресурс существует с указанными атрибутами.Когда absent, удаляет ресурс из системы. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если переменная среды F5_USER задана. | ||
| validate_certs bool (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, управляемых лично, с самозаверенными сертификатами. Можно опустить этот параметр, если переменная среды F5_VALIDATE_CERTS задана. | |
| wait bool |
| Если модуль должен ожидать создания, удаления или обновления приложения. | |
Примечания
Примечание
- Этот модуль не поддерживает обновление приложения (развернутого или нет). Если вам нужно обновить приложение, рекомендуется удалить и повторно создать его.
- Требуется BIG-IQ версии 6.0 или выше.
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- name: Load balance 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
load_balancer:
name: foo
destination: 2.2.2.2
netmask: 255.255.255.255
port: 443
provider:
password: secret
server: lb.mydomain.com
user: admin
state: present
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| description строка | изменено | Новое описание применения ресурса. Пример: Моё приложение | |
| inbound_virtual_destination строка | изменено | Назначение созданного виртуального адреса. Пример: 6.7.8.9 | |
| inbound_virtual_netmask строка | изменено | Маска сети предоставленного входного назначения. Пример: 255.255.255.0 | |
| inbound_virtual_port целое число | изменено | Порт, на котором прослушивает входной виртуальный адрес. Пример: 80 | |
| servers сложное | изменено | Список серверов и их портов, составляющих приложение. Пример: хэш/словарь значений | |
| address строка | изменено | IP-адрес сервера. Пример: 2.3.4.5 | |
| port целое число | изменено | Порт, на котором прослушивает сервер. Пример: 8080 | |
| service_environment строка | изменено | Среда, в которую развернута служба. Пример: 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_fastl4_tcp_module.html