Модуль f5networks.f5_modules.bigip_monitor_external — управление внешними мониторами LTM на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в сценарии, укажите: f5networks.f5_modules.bigip_monitor_external.

Добавлено в f5networks.f5_modules 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управление внешними мониторами LTM на устройстве BIG-IP.

Параметры

Параметр	Комментарии
arguments string	Указывает аргументы командной строки, необходимые для работы скрипта.
description string	Описание монитора.
external_program string	Указывает имя файла, который будет использовать монитор. Чтобы сослаться на файл, сначала импортируйте его с помощью параметров на экране System > File Management > External Monitor Program File List > Import. Система BIG-IP автоматически помещает файл в соответствующее расположение в файловой системе.
interval integer	Интервал, задающий частоту запуска экземпляра монитора на основе этого шаблона. Если при создании монитора этот параметр не указан, по умолчанию используется значение 5. Это значение должно быть меньше значения `timeout`.
ip string	IP-адрес в определении IP/порта. Если при создании нового монитора этот параметр не указан, по умолчанию используется значение ‘*’.
name string / обязательный	Указывает имя монитора.
parent string	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию используется родительский шаблон `external` в разделе `Common`. По умолчанию: `"/Common/external"`
partition string	Раздел устройства, в котором будут управляться ресурсы. По умолчанию: `"Common"`
port string	Номер порта в определении IP/порта. Если при создании нового монитора этот параметр не указан, по умолчанию используется значение ‘*’. Если указан IP-адрес, необходимо использовать значение от 1 до 65535.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр фактически используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если задано значение `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Переменная `F5_TEEM`, использовавшаяся ранее, устарела, поскольку её название было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учётной записи, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истекает до завершения операции, модуль выдаёт ошибку.
transport string	Настраивает транспортное подключение для соединения с удалённым устройством. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs boolean	Если задано значение `no`, SSL-сертификаты не проверяются. Используйте этот параметр только на сайтах под вашим контролем, где применяются самозаверяющие сертификаты. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
state string	Если задано значение `present`, гарантирует существование монитора. Если задано значение `absent`, гарантирует удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение заданного времени, он считается доступным. Если целевой объект не отвечает в течение заданного времени, он считается недоступным. Это значение можно изменить на любое число, однако оно должно составлять три интервала в секундах плюс одну секунду. Если при создании нового монитора этот параметр не указан, по умолчанию используется значение `16`.
variables dictionary	Указывает переменные, необходимые для работы скрипта. Обратите внимание: двойные кавычки в значениях удаляются.

Примечания

Примечание

Подробнее об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить конфигурацию BIG-IP на диск, добавьте как минимум одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Инструкции по использованию модуля для сохранения текущей конфигурации см. в документации к модулю.

Примеры

- name: Create an external monitor
  bigip_monitor_external:
    name: foo
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Create an external monitor with variables
  bigip_monitor_external:
    name: foo
    timeout: 10
    variables:
      var1: foo
      var2: bar
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add a variable to an existing set
  bigip_monitor_external:
    name: foo
    timeout: 10
    variables:
      var1: foo
      var2: bar
      cat: dog
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
description string	Описание монитора. Возвращается: changed Пример: `"Important Monitor"`
interval integer	Новый интервал запуска проверки монитора. Возвращается: changed Пример: `2`
ip string	Новый IP-адрес в определении IP/порта. Возвращается: changed Пример: `"10.12.13.14"`
parent string	Новый родительский шаблон монитора. Возвращается: changed Пример: `"external"`
timeout integer	Новое время ожидания ответа удалённой системы на запрос монитора. Возвращается: changed Пример: `10`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_monitor_external_module.html