bigiq_application_fastl4_udp – Управляет приложениями BIG-IQ FastL4 UDP
Новая в версии 2.6.
Описание
- Управляет приложениями BIG-IQ, используемыми для балансировки нагрузки UDP-приложения с профилем FastL4.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| add_analytics boolean |
| Сбор статистики 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 | Значение по умолчанию: null | Объект словаря, содержащий сведения о подключении. | |
| password - / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. Псевдонимы: pass, pwd | ||
| server - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port - | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile - | Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернет ошибку. | |
| transport - / обязательно |
| Настройка транспортного подключения для подключения к удаленному устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах под вашим контролем, использующих самозаверяющие сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| 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 boolean добавлен в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах под вашим контролем, использующих самозаверяющие сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| wait boolean |
| Если модуль должен дождаться создания, удаления или обновления приложения. | |
Примечания
Примечание
- Этот модуль не поддерживает обновление вашего приложения (развернутого или нет). Если вам нужно обновить приложение, рекомендуется удалить и создать его заново.
- Требуется версия BIG-IQ 6.0 или выше.
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- На хосте требуется пакет f5-sdk Python. Это так же просто, как
pip install f5-sdk. - Требуется версия ПО BIG-IP >= 12.
- Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохраняется на диске, обязательно включите хотя бы одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- 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
inbound_virtual:
name: foo
address: 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 строка | changed | Новое описание приложения ресурса. Пример: Моё приложение | |
| inbound_virtual_destination строка | changed | Назначение виртуального ресурса, который был создан. Пример: 6.7.8.9 | |
| inbound_virtual_netmask строка | changed | Маска сети предоставленного входящего назначения. Пример: 255.255.255.0 | |
| inbound_virtual_port целое число | changed | Порт, на котором прослушивает входящий виртуальный адрес. Пример: 80 | |
| servers сложный тип | changed | Список серверов и их портов, составляющих приложение. Пример: хэш/словарь значений | |
| address строка | changed | IP-адрес сервера. Пример: 2.3.4.5 | |
| port целое число | changed | Порт, на котором прослушивает сервер. Пример: 8080 | |
| service_environment строка | changed | Среда, в которой было развернуто приложение. Пример: my-ssg1 | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается партнёром 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.7/modules/bigiq_application_fastl4_udp_module.html