Модуль f5networks.f5_modules.bigip_monitor_external — Управляет внешними мониторами LTM на 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_monitor_external.

Новое в f5networks.f5_modules 1.0.0

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

Описание

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

Параметры

Параметр	Комментарии
arguments строка	Указывает любые аргументы командной строки, необходимые скрипту.
description строка	Описание монитора.
external_program строка	Указывает имя файла, используемого монитором. Чтобы сделать ссылку на файл, необходимо сначала импортировать его, используя опции на экране Система > Управление файлами > Список файлов внешней программы монитора > Импорт. Система BIG-IP автоматически помещает файл в нужное место на файловой системе.
interval целое число	Интервал, определяющий частоту запуска экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения `timeout`.
ip строка	Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет ‘*’.
name строка / обязательно	Указывает имя монитора.
parent строка	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — родительский шаблон `external` на разбиении `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 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет `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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_monitor_external_module.html