f5networks.f5_modules.bigip_gtm_monitor_external модуль — Управляет внешними мониторами GTM на BIG-IP

Примечание

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

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

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_gtm_monitor_external.

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

Описание
Параметры
Примечания
Примеры
Значения возврата

Описание

Управляет внешними мониторами GTM (теперь BIG-IP DNS) на BIG-IP.

Параметры

Параметр	Комментарии
arguments строка	Указывает любые аргументы командной строки, необходимые скрипту.
external_program строка	Указывает имя файла, который будет использовать монитор. Для ссылки на файл необходимо сначала импортировать его, используя опции на экране «Система» > «Управление файлами» > «Список внешних файлов монитора» > «Импорт». Система BIG-IP автоматически помещает файл в соответствующее место на файловой системе.
interval целое число	Интервал, определяющий частоту запуска экземпляра монитора данного шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения `timeout`.
ip строка	Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет ‘*’.
name строка / обязательно	Указывает имя монитора.
parent строка	Родительский шаблон для данного шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — `http` родительский шаблон на `Common` разбиении. По умолчанию: `"/Common/external"`
partition строка	Разделение устройства для управления ресурсами. По умолчанию: `"Common"`
port строка	Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет ‘*’. Обратите внимание, что при указании IP-адреса необходимо использовать значение от 1 до 65535.
provider словарь добавлен в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
auth_provider строка	Настраивает провайдера аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную окружения `F5_TELEMETRY_OFF`. Предыдущая используемая переменная `F5_TEEM` устарела, так как ее название было запутанным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательно	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server строка / обязательно	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль вернет ошибку.
transport строка	Настраивает транспортное соединение для подключения к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь права администратора на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs логическое значение	Если `no`, сертификаты SSL не будут проверены. Используйте это только на управляемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

state string	Когда `present`, гарантирует существование монитора. Когда `absent`, гарантирует удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это значение на любое число, однако оно должно быть в 3 раза больше числа интервалов в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120.
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_gtm_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_gtm_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_gtm_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

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

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

Ключ	Описание
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_gtm_monitor_external_module.html