Spec-Zone.ru › Ansible

f5networks.f5_modules.bigip_monitor_mysql module – Управляет мониторами MySQL BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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

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

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

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

Параметры

Параметр

Описание

app_service

string

Служба iApp, с которой будет связан этот профиль. Если служба не указана, по умолчанию используется None.

count

integer

Задает количество проверок монитора, после которого соединение с базой данных завершается.

database

string

Задает имя базы данных, к которой пытается получить доступ монитор.

debug

boolean

Задает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный специально для этого монитора и помеченный соответствующим образом.

Варианты:

  • false
  • true

description

string

Задает описание монитора.

interval

integer

Задает частоту выполнения проверки монитора системой.

ip

string

IP-адрес в определении IP/порт. Если этот параметр не указан при создании нового монитора, по умолчанию используется значение «*».

manual_resume

boolean

Задает, будет ли система автоматически менять состояние ресурса на включено при следующей успешной проверке монитора.

Если для этого параметра задано значение true, необходимо вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки соединений.

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

Если задано значение false, система автоматически меняет состояние ресурса на включено при следующей успешной проверке монитора.

Варианты:

  • false
  • true

name

string / обязательный

Имя монитора.

parent

string

Родительский шаблон этого шаблона монитора. После задания этого значения его нельзя изменить.

По умолчанию используется родительский шаблон mysql в разделе Common.

partition

string

Раздел устройства, в котором будут управляться ресурсы.

По умолчанию: "Common"

port

string

Порт в определении IP/порт. Если этот параметр не указан при создании нового монитора, по умолчанию используется значение «*».

Если указан IP-адрес, необходимо задать значение от 1 до 65535.

provider

dictionary

добавлено в f5networks.f5_modules 1.0.0

Объект dict с данными для подключения.

auth_provider

string

Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства.

Этот параметр используется преимущественно при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если задано значение yes, телеметрические данные TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную среды F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM объявлена устаревшей из-за неоднозначного имени.

Варианты:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

string / обязательный

Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_PASSWORD.

server

string / обязательный

Узел BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_SERVER.

server_port

integer

Порт сервера BIG-IP.

Этот параметр можно не указывать, задав переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

Задает время ожидания в секундах при подключении к сетевому устройству или отправке команд. Если время ожидания истекает до завершения операции, модуль выдает ошибку.

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, связанная с этим монитором.

Возвращается: при изменении

Пример: "/Common/good_service.app/good_service"

database

string

Имя базы данных, к которой пытается получить доступ монитор.

Возвращается: при изменении

Пример: "primary1"

debug

boolean

Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора.

Возвращается: при изменении

Пример: false

description

string

Описание монитора.

Возвращается: при изменении

Пример: "Important Monitor"

interval

integer

Новый интервал выполнения проверки монитора.

Возвращается: при изменении

Пример: 2

ip

string

Новый IP-адрес в определении IP/порта.

Возвращается: при изменении

Пример: "10.12.13.14"

manual_resume

boolean

Указывает, меняет ли система автоматически статус ресурса на «доступен» после следующей успешной проверки монитора.

Возвращается: при изменении

Пример: true

parent

string

Родительский монитор.

Возвращается: при изменении

Пример: "/Common/foo_mysql"

port

string

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

Возвращается: при изменении

Пример: "80"

recv

string

Текстовая строка, которую монитор ищет в ответе ресурса.

Возвращается: при изменении

Пример: "OPEN"

recv_column

string

Столбец базы данных, в котором должна находиться указанная строка.

Возвращается: при изменении

Пример: "2"

recv_row

string

Строка базы данных, в которой должна находиться указанная строка.

Возвращается: при изменении

Пример: "1"

send

string

SQL-запрос, который монитор отправляет целевому объекту.

Возвращается: при изменении

Пример: "SELECT status FROM v$instance"

target_username

string

Имя пользователя для контролируемого целевого объекта.

Возвращается: при изменении

Пример: "bigip"

time_until_up

integer

Новое время, по истечении которого система будет считаться доступной после первого успешного ответа.

Возвращается: при изменении

Пример: 2

timeout

integer

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

Возвращается: при изменении

Пример: 10

up_interval

integer

Интервал, используемый системой для проверки работоспособности ресурса, когда он доступен.

Возвращается: при изменении

Пример: 0

Авторы

  • Andrey Kashcheev (@andreykashcheev)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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