Spec-Zone.ru › Ansible 2.6

bigiq_application_http - Управляет приложениями BIG-IQ HTTP

Новая версия с 2.6.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • f5-sdk >= 3.0.9

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
add_analytics
bool
    Варианты:
  • нет ←
  • да
Сбор статистики BIG-IP, на котором развернуто приложение.
Этот параметр актуален только при указании service_environment, что является BIG-IP; не SSG.
description
Описание приложения.
inbound_virtual
Настройки для конфигурации виртуального сервера, который будет получать входящие подключения.
Этот виртуальный сервер будет использоваться для размещения HTTP-точки входа приложения.
address
обязательно
Указывает информацию об IP-адресе назначения, в который виртуальный сервер отправляет трафик.
Этот параметр обязателен при создании нового приложения.
netmask
обязательно
Указывает маску подсети, которая будет связана с данным destination.
Этот параметр обязателен при создании нового приложения.
port По умолчанию:
80
Порт, на котором виртуальный сервер прослушивает подключения.
При создании нового приложения, если этот параметр не указан, используется значение по умолчанию 80.
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
обязательно
    Варианты:
  • rest
  • cli ←
Настраивает транспортное соединение для использования при подключении к удалённому устройству.
server
обязательно
Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена.
server_port
(добавлен в 2.2)
По умолчанию:
443
Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена.
servers
Список серверов, на которых размещено приложение.
Если вы знакомы с другими настройками BIG-IP, вы также можете сослаться на этот список как на список членов пула.
При создании нового приложения требуется хотя бы один сервер.
address
обязательно
IP-адрес сервера.
port По умолчанию:
80
Порт сервера.
При создании нового приложения и указании сервера, если этот параметр не указан, используется значение по умолчанию 80.
service_environment
Указывает имя среды службы, в которой будет развернуто приложение.
При создании нового приложения этот параметр обязателен.
Тип среды службы будет обнаружен этим модулем автоматически. Поэтому крайне важно поддерживать уникальные имена элементов в различных типах сред службы (на данный момент SSG и BIGIP).
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.
  • Требуется пакет Python f5-sdk на хосте. Это так же просто, как pip install f5-sdk.

Примеры

- name: Load balance an HTTP application on port 80 on BIG-IP
  bigiq_application_http:
    name: my-app
    description: Redirect HTTP to HTTPS
    service_environment: my-ssg
    servers:
      - address: 1.2.3.4
        port: 8080
      - address: 5.6.7.8
        port: 8080
    inbound_virtual:
      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_http_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API