Spec-Zone.ru › Ansible 2.7

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

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

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

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

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • f5-sdk >= 3.0.16

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ignore_down_response
логический
    Варианты:
  • нет
  • да
Указывает, что монитор позволяет более одной попытки зондирования за интервал.
Когда yes, указывает, что монитор игнорирует ответы о недоступности в течение таймаута монитора. После достижения таймаута монитора без получения ответа о доступности системы, система помечает объект как недоступный.
Когда no, указывает, что монитор сразу помечает объект как недоступный при получении ответа о недоступности.
При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no.
interval
-
Указывает частоту проверки монитора системой в секундах, когда ресурс недоступен или статус ресурса неизвестен.
При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 30. Это значение должно быть меньше значения timeout.
ip
-
Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'.
name
- / обязательно
Имя монитора.
parent
-
Значение по умолчанию:
"/Common/tcp_half_open"
Шаблон-родитель для данного шаблона монитора. После установки этого значения, его нельзя изменить. По умолчанию, это значение - родитель tcp_half_open на раздела Common.
partition
-
Значение по умолчанию:
"Common"
Раздел устройства для управления ресурсами.
password
- / обязательно
Пароль учетной записи пользователя для подключения к BIG-IP.
Можно опустить этот параметр, установив переменную окружения F5_PASSWORD.

Псевдонимы: pass, pwd
port
-
Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что при указании IP-адреса необходимо указать значение от 1 до 65535.
probe_attempts
-
Указывает количество попыток зондирования хост-сервера, после которого система считает хост-сервер недоступным.
При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 3.
probe_interval
-
Указывает количество секунд, которое процесс big3d ожидает перед отправкой последующей попытки зондирования, когда зондирование неудачно и запрошено несколько попыток зондирования.
При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 1.
probe_timeout
-
Указывает количество секунд, после которых система отменяет запрос зондирования к системе.
При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 5.
provider
-
добавлен в 2.5
Значение по умолчанию:
null
Объект 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
- / обязательно
    Варианты:
  • rest
  • cli ←
Настраивает транспортное соединение для подключения к удаленному устройству.
user
- / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Можно опустить этот параметр, установив переменную окружения F5_USER.
validate_certs
логический
    Варианты:
  • нет
  • да ←
Если 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
-
Указывает количество секунд, в течение которых целевой объект должен ответить на запрос монитора.
Если целевой объект отвечает в установленный период, он считается доступным.
Если целевой объект не отвечает в установленный период, он считается недоступным.
Если это значение установлено в 0 (ноль), система использует интервал из родительского монитора.
При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 120.
transparent
логический
    Варианты:
  • нет
  • да
Указывает, работает ли монитор в прозрачном режиме.
Монитор в прозрачном режиме направляет трафик через соответствующих членов пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному назначению (т.е. зондирует ip-port комбинацию, указанную в мониторе).
Если монитор не может успешно достичь алиасного назначения, член пула или узел, через который был отправлен трафик монитора, помечается как недоступный.
При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no.
user
- / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Можно опустить этот параметр, установив переменную окружения F5_USER.
validate_certs
boolean
added in 2.0
    Choices:
  • no
  • yes ←
If no, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.
You may omit this option by setting the environment variable F5_VALIDATE_CERTS.

Примечания

Примечание

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

Примеры

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

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

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

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

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

Ключ Возвращенное значение Описание
interval
integer
changed
Новый интервал, в котором будет выполняться проверка монитора.

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

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

Пример:
tcp_half_open
probe_attempts
integer
changed
Новое количество попыток, которые система предпримет при проверке зонда монитора.

Пример:
10
probe_interval
integer
changed
Новый интервал, в котором система будет проверять зонд монитора.

Пример:
10
probe_timeout
integer
changed
Новый таймаут, в котором система будет ожидать ответа зонда монитора.

Пример:
10
timeout
integer
changed
Новый таймаут, в котором удаленная система должна ответить на монитор.

Пример:
10


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
  • Этот модуль поддерживается партнером Ansible. [certified]

Авторы

  • Tim Rupp (@caphrim007)

Подсказка

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

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

Spec-Zone.ru

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