Spec-Zone.ru › Ansible 2.6

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

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

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

Описание

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

Требования

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

  • f5-sdk >= 3.0.9

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
interval
Интервал, определяющий частоту запуска экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения timeout.
ip
Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'.
name
обязательно
Имя монитора.
parent Значение по умолчанию:
"/Common/https"
Родительский шаблон этого шаблона монитора. После установки этого значения его изменить нельзя. По умолчанию это значение является родительским значением https в разделе 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 установлена.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, если переменная среды F5_USER установлена.
validate_certs
bool
    Варианты:
  • no
  • yes ←
Если 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
Строка отправки для вызова монитора. При создании нового монитора, если это значение не указано, будет использовано значение по умолчанию GET /\\r\\n.
server
обязательно
Хост BIG-IP. Этот параметр можно опустить, если переменная среды F5_SERVER установлена.
server_port
(добавлено в 2.2)
 Значение по умолчанию:
443
Порт сервера BIG-IP. Этот параметр можно опустить, если переменная среды F5_SERVER_PORT установлена.
state
(добавлено в 2.5)
    Варианты:
  • present ←
  • absent
В случае present, гарантирует, что монитор существует.
В случае absent, гарантирует удаление монитора.
target_password
Указывает пароль, если контролируемый целевой объект требует аутентификации.
target_username
Указывает имя пользователя, если контролируемый целевой объект требует аутентификации.
time_until_up
Указывает количество времени в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения правильного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0.
timeout
Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это число на любое другое, однако оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, если переменная среды F5_USER установлена.
validate_certs
bool

(добавлено в 2.0)
    Варианты:
  • no
  • yes ←
Если 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 HTTPS Monitor
  bigip_monitor_https:
    state: present
    ip: 10.10.10.10
    server: lb.mydomain.com
    user: admin
    password: secret
    name: my_http_monitor
  delegate_to: localhost

- name: Remove HTTPS Monitor
  bigip_monitor_https:
    state: absent
    server: lb.mydomain.com
    user: admin
    password: secret
    name: my_http_monitor
  delegate_to: localhost

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

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

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

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

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

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

Spec-Zone.ru

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