Модуль f5networks.f5_modules.bigip_monitor_oracle — Управляет мониторами BIG-IP Oracle

Примечание

Этот модуль входит в коллекцию 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_oracle.

Впервые в f5networks.f5_modules 1.3.0

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

Обзор

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

Параметры

Параметр	Комментарии
app_service строка	Сервис iApp, который будет связан с этим профилем. Если сервис не указан, используется значение по умолчанию — None.
count целое число	Указывает количество зондов мониторинга после которых соединение с базой данных будет разорвано. Значение «0» указывает, что соединение никогда не будет разорвано.
database строка	Указывает имя базы данных, к которой пытается подключиться монитор.
debug логическое	Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. Варианты: `false` `true`
description строка	Указывает описательный текст, идентифицирующий монитор.
interval целое число	Указывает частоту, в секундах, с которой система выполняет проверку монитора, когда ресурс недоступен или его статус неизвестен.
ip строка	Часть IP/порт определения. Если этот параметр не указан при создании нового монитора, значение по умолчанию — ‘*’.
manual_resume логическое	Указывает, автоматически ли система изменяет статус ресурса на активирован при следующей успешной проверке монитора. Если вы установите это значение в `true`, вы должны вручную снова активировать ресурс, прежде чем система сможет его использовать для балансировки нагрузки. Если `true`, указывает, что вы должны вручную снова активировать ресурс после неудачной проверки монитора. Если `false`, указывает, что система автоматически изменяет статус ресурса на активирован при следующей успешной проверке монитора. Варианты: `false` `true`
name строка / обязательно	Имя монитора.
parent строка	Родительская шаблон этого шаблона монитора. После установки этого значения, его нельзя изменить. По умолчанию, это значение — `oracle` родительский шаблон на `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 целое число	Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечет, прежде чем операция будет завершена, модуль выдаст ошибку.

END_OF_DOCUMENT_MARKER

transport string	Настраивает соединение транспорта для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, задав переменную окружения `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Этот параметр можно опустить, задав переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
recv string	Указывает текстовую строку, которую монитор ищет в возвращаемом ресурсе. Наиболее распространённые выражения приёма содержат текстовую строку, которая включена в поле в вашей базе данных. Если вы не укажите оба `send` и `recv` параметра, монитор выполняет простой тест службы и только подключение.
recv_column string	Указывает столбец в базе данных, где должна находиться указанная `recv` строка. Это необязательное значение, и оно применимо только если вы настроите параметры `send` и `recv`.
recv_row string	Указывает строку в базе данных, где должна находиться указанная `recv` строка. Это необязательное значение, и оно применимо только если вы настроите параметры `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 oracle monitor
  bigip_monitor_oracle:
    ip: 10.10.10.10
    port: 10923
    name: my_oracle_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 oracle monitor
  bigip_monitor_oracle:
    name: my_oracle_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 oracle monitor
  bigip_monitor_oracle:
    state: absent
    name: my_oracle_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_oracle"`
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`

Авторы

Wojciech Wypior (@wojtek0806)

Справочные ссылки

© 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_oracle_module.html