Spec-Zone.ru › Ansible 2.8

bigip_monitor_external – Управляет внешними мониторами LTM на BIG-IP

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

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
arguments
строка
Указывает любые аргументы командной строки, необходимые для скрипта.
description
строка
добавлено в 2.7
Описание монитора.
external_program
строка
Указывает имя файла, используемого монитором. Для ссылки на файл необходимо сначала импортировать его, используя параметры на экране «Система» > «Управление файлами» > «Список внешних программ мониторинга» > «Импорт». Система BIG-IP автоматически помещает файл в соответствующее место на файловой системе.
interval
целое число
Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения timeout.
ip
строка
Часть IP-адреса определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'.
name
строка / обязательно
Указывает имя монитора.
parent
строка
По умолчанию:
"/Common/external"
Родительский шаблон этого шаблона монитора. После установки это значение изменить нельзя. По умолчанию это значение http родительский шаблон в разделе Common.
partition
строка
По умолчанию:
"Common"
Раздел устройства для управления ресурсами.
password
строка / обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Этот параметр можно опустить, установив переменную среды F5_PASSWORD.

Псевдонимы: pass, pwd
port
строка
Адрес порта части определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если вы указываете IP-адрес, значение должно быть от 1 до 65535.
provider
словарь
добавлено в 2.5
Объект словаря, содержащий сведения о подключении.
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
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное соединение для подключения к удаленному устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве.
Этот параметр можно опустить, установив переменную среды F5_USER.
validate_certs
булево
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, которыми вы контролируете, с самозаверяющими сертификатами.
Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS.
server
строка / обязательно
Хост BIG-IP.
Этот параметр можно опустить, установив переменную среды F5_SERVER.
server_port
целое число
добавлено в 2.2
По умолчанию:
443
Порт сервера BIG-IP.
Этот параметр можно опустить, установив переменную среды F5_SERVER_PORT.
state
строка
    Варианты:
  • present ←
  • absent
Когда present, гарантирует, что монитор существует.
Когда absent, гарантирует удаление монитора.
timeout
целое число
Количество секунд, в течение которого узел или служба должны ответить на запрос монитора.
Если целевой объект отвечает в течение заданного периода времени, он считается активным.
Если целевой объект не отвечает в течение заданного периода времени, он считается неактивным.
Вы можете изменить это число на любое нужное вам число, однако оно должно быть в 3 раза больше числа интервалов в секундах плюс 1 секунда.
Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве.
Этот параметр можно опустить, установив переменную среды F5_USER.
validate_certs
булево
добавлено в 2.0
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, которыми вы контролируете, с самозаверяющими сертификатами.
Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS.
variables
словарь
Указывает любые переменные, необходимые для скрипта.
Обратите внимание, что двойные кавычки в значениях будут подавлены.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется версия программного обеспечения BIG-IP >= 12.
  • Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохранится на диске, обязательно включите по крайней мере одну задачу, использующую модуль 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
строка
changed
Описание монитора.

Пример:
Важный монитор
interval
целое число
changed
Новый интервал, в котором будет выполняться проверка монитора.

Пример:
2
ip
строка
changed
Новый IP-адрес определения IP/порта.

Пример:
10.12.13.14
parent
строка
changed
Новая родительская шаблон монитора.

Пример:
external
timeout
целое число
changed
Новый таймаут, в течение которого удаленная система должна ответить на запрос монитора.

Пример:
10


Статус

  • Данный модуль не гарантирует обратной совместимости. [превью]
  • Данный модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

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

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_monitor_external_module.html

Spec-Zone.ru

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