Spec-Zone.ru › Ansible 2.6

bigip_monitor_tcp - Управляет мониторами F5 BIG-IP LTM tcp

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

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

Обзор

  • Управляет мониторами F5 BIG-IP LTM tcp через iControl SOAP API.

Требования

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

  • f5-sdk >= 3.0.9

Параметры

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

псевдонимы: pass, pwd
port
Порт в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что при указании IP-адреса необходимо указать значение от 1 до 65535.
Этот аргумент не поддерживается для типов TCP Echo.
provider
(добавлено в 2.5)
Объект словаря, содержащий сведения о подключении.
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
Строка приёма для вызова монитора.
send
Строка отправки для вызова монитора.
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
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 TCP Monitor
  bigip_monitor_tcp:
    state: present
    server: lb.mydomain.com
    user: admin
    password: secret
    name: my_tcp_monitor
    type: tcp
    send: tcp string to send
    receive: tcp string to receive
  delegate_to: localhost

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

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

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

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

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

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

Пример:
tcp
port
string
 изменённое
Новый порт для определения IP/порт.

Пример:
admin@root.local
receive
string
 изменённое
Новая строка для приёма данных для данного монитора.

Пример:
tcp string to receive
send
string
 изменённое
Новая строка для отправки данных для данного монитора.

Пример:
tcp string to send
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_tcp_module.html

Spec-Zone.ru

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