Discovering and Adding Oracle Key Vault

Starting with Enterprise Manager 24ai, two new target types have been added to enable the monitoring of Oracle Key Vault (OKV):

  • Oracle Key Vault Cluster (oracle_kv_cluster) - assists in the monitoring of OKV clusters.
  • Oracle Key Vault Server (oracle_kv_server) - assists in the monitoring of individual OKV nodes (or a standalone server for non-cluster deployments).

Prerequisites:

Note:

Since OKV Server does not allow EM agent running on it, in this document, "EM Agent Host" refers to any other host where EM agent is installed and running.

  • OKV Server to be monitored via EM must be at least version 21.10
  • Ensure that Network Services and RESTful Services options are enabled in the OKV server console. For more information, see Getting Started with Oracle Key Vault RESTful Services.
  • The OS specific "expect" package has to be installed on the host where the EM agent is installed.
  • Monitoring User account to be used in OEM need to be created in OKV console first. And it must have monitoring privilege selected
  • SNMP username and password need to be setup in OKV console.
  • SNMP access allowed from must have OEM Agent Hosts ip address specified or All option selected.

Note:

If there is any firewall on the agent host, for the EM Agent to communicate with the OKV server being monitored, open the REST port and SNMP port.

To add a OKV Cluster or Server target, follow these steps:

  1. From the Setup menu, select Add Target, then click Add Targets Manually.

  2. On the Add Targets Manually dialog, select the Agent Host

    Note:

    The agent needs to have HTTP/SNMP connectivity to the OKV server.

  3. From the Target Type list, select Oracle Key Vault Server or Oracle Key Vault Cluster.

  4. Click Add.

  5. Specify all the properties of the target, as described in the OKV UI discovery input table, click Next and wait for the validation.

After validation completes, on the Review page displayed, select Submit to complete the target creation.

Input Field Description
Target Name Any name your OKV server or cluster as a target.
OKV Server IP Address

The IP address of the OKV console.

OKV server must be version 21.10 onwards.
OKV Server Port

Port of the OKV console

By default: 5695
Monitoring Credentials:
  • Monitoring Username
  • Monitoring Password
 Username and password created in OKV Console with a monitoring privilege
SNMP Credentials
  • SNMP Username
  • SNMP Password

SNMP User Name and Password created in the OKV console

To create it, from the left navigation bar select the System tab, then Settings . In the Monitoring and Alerts area, click SNMP.

SNMP Port and SNMP Timeout

SNMP Port and Timeout found in the OKV console

SNMP Port: 161

SNMP Timeout: 5 seconds
OKV RESTful Services Utility Installation Location /

OKV REST CLI Installation Location

 Directory path accessible on the EM Agent host where OKV REST CLI / OKV REST Services Utilisation will be downloaded and configured automatically at the end of the discovery process.

For more information regarding the OKV Console, see Monitoring and Auditing Oracle Key Vault.