bigiq_application_fastl4_tcp – Управляет приложениями BIG-IQ FastL4 TCP
Новая версия с 2.6.
Описание
- Управляет приложениями BIG-IQ, используемыми для балансировки нагрузки TCP-приложения с профилем FastL4.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| add_analytics boolean |
| Собирает статистику 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 | Значение по умолчанию: null | Объект типа dict, содержащий данные подключения. | |
| 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 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: 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. [сертифицировано]
Авторы
- 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_tcp_module.html