Spec-Zone.ru › Ansible 2.8

bigip_monitor_tcp_half_open – Управляет мониторами F5 BIG-IP LTM tcp half-open

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

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

Описание

  • Управляет мониторами F5 BIG-IP LTM tcp half-open.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
description
строка
добавлен в 2.7
Описание монитора.
interval
целое число
Интервал, определяющий частоту запуска экземпляра монитора данной шаблона. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения timeout.
ip
строка
Часть IP-адреса в определении IP/порт. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет '*'.
Если это значение — IP-адрес, и type равно tcp (значение по умолчанию), то необходимо указать числовой port.
name
строка / обязательно
Имя монитора.
parent
строка
Значение по умолчанию:
"/Common/tcp_half_open"
Родительский шаблон данного шаблона монитора. После установки этого значения его изменить нельзя. По умолчанию, это значение — родительский tcp_half_open на Common разделе.
partition
строка
добавлен в 2.5
Значение по умолчанию:
"Common"
Раздел устройства для управления ресурсами.
password
строка / обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Можно опустить этот параметр, установив переменную окружения F5_PASSWORD.

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

Примечания

Примечание

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

Примеры

- name: Create TCP half-open Monitor
  bigip_monitor_tcp_half_open:
    state: present
    ip: 10.10.10.10
    name: my_tcp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove TCP half-open Monitor
  bigip_monitor_tcp_half_open:
    state: absent
    name: my_tcp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add half-open monitor for all addresses, port 514
  bigip_monitor_tcp_half_open:
    port: 514
    name: my_tcp_monitor
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Значения возврата

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

Ключ Возвращаемое значение Описание
description
строка
changed
Описание монитора.

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

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

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

Пример:
tcp
time_until_up
целое число
changed
Новое время, в течение которого система будет считаться активной после первого успешного ответа.

Пример:
2
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_tcp_half_open_module.html

Spec-Zone.ru

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