Модуль f5networks.f5_modules.bigip_monitor_mysql – Управление мониторами BIG-IP MySQL

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в книге задач, укажите: f5networks.f5_modules.bigip_monitor_mysql.

Новая функция в f5networks.f5_modules 1.3.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управляет мониторами BIG-IP MySQL.

Параметры

Параметр	Комментарии
app_service строка	Сервис iApp, который необходимо связать с этим профилем. Если сервис не указан, по умолчанию используется None.
count целое число	Указывает количество зондирований монитора, после которых соединение с базой данных прерывается.
database строка	Указывает имя базы данных, к которой пытается получить доступ монитор.
debug логическое значение	Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. Варианты: `false` `true`
description строка	Указывает описательный текст, который идентифицирует монитор.
interval целое число	Указывает частоту проверки состояния монитора системой.
ip строка	Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, по умолчанию используется ‘*’.
manual_resume логическое значение	Указывает, автоматически ли система изменяет состояние ресурса на enabled при следующей успешной проверке монитора. Если вы установите это значение в `true`, вы должны вручную повторно включить ресурс, прежде чем система сможет использовать его для подключения балансировки нагрузки. Когда `true`, указывает, что вы должны вручную повторно включить ресурс после неудачной проверки монитора. Когда `false`, указывает, что система автоматически изменяет состояние ресурса на enabled при следующей успешной проверке монитора. Варианты: `false` `true`
name строка / обязательно	Имя монитора.
parent строка	Родительская шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — родитель `mysql` на раздели `Common`.
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
port строка	Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, по умолчанию используется ‘*’. Если вы указываете IP-адрес, вам необходимо указать значение от 1 до 65535.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект словаря, содержащий сведения о подключении.
auth_provider строка	Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется в основном при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Ранее используемая переменная `F5_TEEM` устарела, так как ее имя было неясным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательно	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server строка / обязательно	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истекает до завершения операции, модуль выдаст ошибку.

transport string	Настраивает транспортное соединение, используемое при подключении к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен обладать административными привилегиями на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
recv string	Указывает текстовую строку, которую монитор ищет в возвращаемом ресурсе. Наиболее распространённые выражения получения содержат текстовую строку, которая включена в поле в вашей базе данных. Если вы не укажете как строку отправки, так и строку получения, монитор выполняет простой проверку службы и только подключается.
recv_column string	Указывает столбец в базе данных, где система ожидает указанной строки получения. Это необязательная настройка, которая применима только при конфигурировании параметров `send` и `recv`.
recv_row string	Указывает строку в базе данных, где система ожидает указанной строки получения. Это необязательная настройка, которая применима только при конфигурировании параметров `send` и `recv`.
send string	Указывает SQL-запрос, который монитор отправляет целевому объекту. Поскольку строка может содержать специальные символы, системе может потребоваться заключить её в одинарные кавычки. Если это значение равно `none`, то достаточного валидного соединения для определения активности службы. В этом случае системе не нужны параметры recv, recv-row и recv-column, и она игнорирует их, даже если они не `none`.
state string	При значении `present`, гарантирует существование монитора. При значении `absent`, гарантирует удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
target_password string	Указывает пароль, если для мониторируемого целевого объекта требуется аутентификация.
target_username string	Указывает имя пользователя, если для мониторируемого целевого объекта требуется аутентификация.
time_until_up integer	Указывает количество секунд, которые необходимо подождать после того, как ресурс впервые правильно ответит на запрос монитора, прежде чем установить для ресурса статус «включен». В течение этого интервала все ответы от ресурса должны быть правильными. По истечении интервала ресурс помечается как «включен». Значение 0 означает, что ресурс сразу же помечается как «включен» после получения первого правильного ответа.
timeout integer	Указывает количество секунд, в течение которых целевой объект должен ответить на запрос монитора. Если целевой объект отвечает в течение заданного периода времени, он считается «включенным». Если целевой объект не отвечает в течение заданного периода времени, он считается «выключенным». При значении 0 (ноль) система использует интервал из родительского монитора. Обратите внимание, что `timeout` и `time_until_up` объединяются для управления моментом, когда ресурс устанавливается в состояние «включен».
up_interval integer	Указывает интервал, который система использует для проверки работоспособности, когда ресурс «включен». При значении `0`, система использует интервал, указанный в `interval`, для проверки состояния ресурса. При любом другом числе вы можете указать другой интервал для проверки состояния ресурса, который находится в состоянии «включен».
update_password string	Значение `always` будет обновлять пароли, если указан параметр `target_password`. Значение `on_create` будет устанавливать пароль только для вновь созданных мониторов. Варианты: `"always"` ← (по умолчанию) `"on_create"`

Примечания

Примечание

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

Примеры

- name: Create an mysql monitor
  bigip_monitor_mysql:
    ip: 10.10.10.10
    port: 10923
    name: my_mysql_monitor
    send: "SELECT status FROM v$instance"
    recv: OPEN
    recv_column: 2
    recv_row: 1
    database: primary1
    target_username: bigip
    target_password: secret
    update_password: on_create
    state: present
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Modify an mysql monitor
  bigip_monitor_mysql:
    name: my_mysql_monitor
    recv_column: 4
    recv_row: 3
    database: primary2
    state: present
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove mysql monitor
  bigip_monitor_mysql:
    state: absent
    name: my_mysql_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ	Описание
app_service string	Сервис iApp, связанный с этим монитором. Возвращается: changed Пример: `"/Common/good_service.app/good_service"`
database string	Имя базы данных, к которой пытается получить доступ монитор. Возвращается: changed Пример: `"primary1"`
debug boolean	Отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. Возвращается: changed Пример: `false`
description string	Описание монитора. Возвращается: changed Пример: `"Important Monitor"`
interval integer	Новый интервал для запуска проверки монитора. Возвращается: changed Пример: `2`
ip string	Новый IP-адрес определения IP/порт. Возвращается: changed Пример: `"10.12.13.14"`
manual_resume boolean	Указывает, автоматически ли система изменяет состояние ресурса на «вверх» при следующей успешной проверке монитора. Возвращается: changed Пример: `true`
parent string	Родительский монитор. Возвращается: changed Пример: `"/Common/foo_mysql"`
port string	Псевдоним порта или сервиса, который должен проверить монитор от имени пулов или узлов пула, с которыми связан монитор. Возвращается: changed Пример: `"80"`
recv string	Текстовая строка, которую монитор ищет в возвращаемом ресурсе. Возвращается: changed Пример: `"OPEN"`
recv_column string	Столбец в базе данных, где должна находиться указанная строка. Возвращается: changed Пример: `"2"`
recv_row string	Строка в базе данных, где должна находиться указанная строка. Возвращается: changed Пример: `"1"`
send string	SQL-запрос, который монитор отправляет целевому объекту. Возвращается: changed Пример: `"SELECT status FROM v$instance"`
target_username string	Имя пользователя для отслеживаемого целевого объекта. Возвращается: changed Пример: `"bigip"`
time_until_up integer	Новое время, в течение которого нужно отметить систему как работающую после первого успешного ответа. Возвращается: changed Пример: `2`
timeout integer	Новый тайм-аут, в течение которого удалённая система должна ответить монитору. Возвращается: changed Пример: `10`
up_interval integer	Интервал, который система использует для проверки работоспособности, когда ресурс работает. Возвращается: changed Пример: `0`

Авторы

Andrey Kashcheev (@andreykashcheev)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_monitor_mysql_module.html