bigiq_application_fastl4_udp - Управляет приложениями BIG-IQ FastL4 UDP
Новое в версии 2.6.
Обзор
- Управляет приложениями BIG-IQ, используемыми для балансировки нагрузки UDP-приложения с профилем FastL4.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| add_analytics bool |
| Сбор статистики BIG-IP, на который развернуто приложение. Этот параметр актуален только при указании service_environment, являющегося BIG-IP, а не SSG. | |
| description | Описание приложения. | ||
| inbound_virtual | Настройки для настройки виртуального сервера, который будет принимать входящее подключение. | ||
| address обязательно | Указывает информацию об IP-адресе назначения, которому виртуальный сервер отправляет трафик. Этот параметр обязателен при создании нового приложения. | ||
| netmask обязательно | Указывает маску сети для ассоциации с заданным destination. Этот параметр обязателен при создании нового приложения. | ||
| port | Значение по умолчанию: 53 | Порт, на котором виртуальный сервер прослушивает подключения. При создании нового приложения, если этот параметр не указан, будет использовано значение по умолчанию 53. | |
| name обязательно | Имя нового приложения. | ||
| password обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| provider (добавлено в 2.5) | Объект типа dict, содержащий данные подключения. | ||
| 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 UDP-based application with a FastL4 profile
bigiq_application_fastl4_udp:
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: 53
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_udp_module.html
