Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_monitor_oracle — управление мониторами Oracle 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_oracle.

Добавлено в f5networks.f5_modules 1.3.0

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

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

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

Параметры

Параметр

Комментарии

app_service

string

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

count

integer

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

Значение count, равное нулю, означает, что соединение никогда не будет завершено.

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

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

По умолчанию используется родительский шаблон oracle в разделе 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

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

Чаще всего выражения receive содержат текстовую строку, включенную в поле базы данных.

Если не указать оба параметра 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, связанная с этим монитором.

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

Пример: "/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_oracle"

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

Авторы

  • Wojciech Wypior (@wojtek0806)

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

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

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

Spec-Zone.ru

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