Spec-Zone.ru › Ansible 2.6

bigip_monitor_udp - Управление мониторами udp F5 BIG-IP LTM

Новое в версии 2.5.

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

Описание

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

Требования

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

  • f5-sdk >= 3.0.9

Параметры

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

Псевдонимы: pass, pwd
port
Адрес порта в определении 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 установлена.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Можно опустить этот параметр, если переменная среды F5_USER установлена.
validate_certs
bool
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. Можно опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.
timeout По умолчанию:
10
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт, прежде чем операция будет завершена, модуль выдаст ошибку.
ssh_keyfile
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для перевозок cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
transport
обязательно
    Варианты:
  • rest
  • cli ←
Настраивает транспортное соединение для использования при подключении к удалённому устройству.
receive
Строка приёма для вызова монитора.
receive_disable
Эта настройка работает как receive, за исключением того, что система помечает узел или член пула как отключённый, когда его ответ соответствует строке receive_disable, но не строке receive. Чтобы использовать эту настройку, необходимо указать receive_disable и receive.
send
Строка отправки для вызова монитора. При создании нового монитора, если это значение не задано, используется значение по умолчанию default send string.
server
обязательно
Хост BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER установлена.
server_port
(добавлено в 2.2)
 По умолчанию:
443
Порт сервера BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER_PORT установлена.
state
(добавлено в 2.5)
    Варианты:
  • наличие ←
  • отсутствует
При present, гарантируется, что монитор существует.
При absent, гарантируется удаление монитора.
time_until_up
Указывает количество секунд после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения действительного ответа от узла. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет 0.
timeout
Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Можно изменить это число на любое нужное значение, однако оно должно быть в 3 раза больше числа секунд интервала плюс 1 секунда. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет 16.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Можно опустить этот параметр, если переменная среды F5_USER установлена.
validate_certs
bool

(добавлено в 2.0)
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. Можно опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.

Примечания

Примечание

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

Примеры

- name: Create UDP Monitor
  bigip_monitor_udp:
    state: present
    ip: 10.10.10.10
    server: lb.mydomain.com
    user: admin
    password: secret
    name: my_udp_monitor
  delegate_to: localhost

- name: Remove UDP Monitor
  bigip_monitor_udp:
    state: absent
    server: lb.mydomain.com
    user: admin
    password: secret
    name: my_udp_monitor
  delegate_to: localhost

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

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

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

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

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

Пример:
http
time_until_up
int
 изменённое
Новое время, в течение которого система будет помечена как активная после первого успешного ответа.

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

Пример:
10


Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

  • 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.6/modules/bigip_monitor_udp_module.html

Spec-Zone.ru

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