Monitoring Commands

You can use the monitoring commands to check the Oracle Key Vault configuration, health, and deployment modes.

okv cluster info get

The okv cluster info get command retrieves status information about a cluster or a cluster node.
okv cluster status get

The okv cluster status get command retrieves dynamic information about the cluster or the specified cluster node.
okv metrics application get

The okv metrics application get command retrieves the Oracle Key Vault server application metrics information.
okv metrics server get

The okv metrics server get command retrieves System Metrics information of an Oracle Key Vault server.
okv primary-standby info get

The okv primary-standby info get command displays static information about the Oracle Key Vault primary-standby configuration.
okv primary-standby status get

The okv primary-standby status get command retrieves dynamic information about the Oracle Key Vault primary-standby configuration.
okv server info get

The okv server info get command retrieves static information about an Oracle Key Vault server.
okv server status get

The okv server status get command retrieves status information about an Oracle Key Vault server.

okv cluster info get

The okv cluster info get command retrieves status information about a cluster or a cluster node.

okv cluster info get retrieves the following information:

Cluster name
Cluster version
Maximum Disable Node Duration setting
List of cluster subgroups
Information of cluster nodes including their configuration mode, status, subgroup, version information, and so on.

Required Authorization

System Administrator role or Monitor privilege. A regular Oracle Key Vault user can also run the command to check the Oracle Key Vault version.

Note: For regular Oracle Key Vault user the command displays the version number only.

Syntax

okv cluster info get --node node_name

JSON Input File Template

{
  "service" : {
    "category" : "cluster",
    "resource" : "info",
    "action" : "get",
    "options" : {
      "node" : "#VALUE"
    }
  }
}

Parameters

Parameter/Template Parameter	Required?	Description
`--node` / `node`	Optional	Name of the node within the current cluster. If you omit this setting, then information for the entire cluster is retrieved.

JSON Example

Generate JSON input for the okv cluster info get command:
```
okv cluster info get --generate-json-input
```
The generated JSON input is displayed as shown in the earlier section JSON Input File Template.
Save the generated input to a file (for example, get_cluster_info.json).

Depending on the kind of information that you want to find, do one of the following:
- Get cluster information for a specific node: Edit the file to specify the node value. For example:
```
{
  "service" : {
    "category" : "cluster",
    "resource" : "info",
    "action" : "get",
    "options" : {
      "node" : "node_1"
    }
  }
}
```
- Get cluster information for all nodes in the cluster: Edit the file to remove the node entry:
```
{
  "service" : {
    "category" : "cluster",
    "resource" : "info",
    "action" : "get"
  }
}
```

Run the okv cluster info get command using the generated JSON file:

okv cluster info get --from-json get_cluster_info.json

Depending on how you handled the file in Step 2, output similar to the following appears.

Get cluster information for a specific node:

{
  "result" : "Success",
  "value" : {
    "clusterSubgroup" : "okvslgrp1",
    "disableDate" : "",
    "installDate" : "2024-10-03 04:05:14",
    "ipAddress" : "100.70.126.1",
    "joinDate" : "2024-10-09 13:20:01",
    "mode" : "Read-Write",
    "nodeID" : "2",
    "nodeName" : "okvnode143",
    "readWritePeer" : "okv020017040e3c",
    "status" : "ACTIVE",
    "version" : "21.10.0.0.0"
  }
}

Get cluster information for all nodes in the cluster:

{
  "result" : "Success",
  "value" : {
    "clusterName" : "okvcluster1",
    "clusterSubgroups" : [ "okvslgrp1" ],
    "clusterVersion" : "21.10.0.0.0",
    "maximumDisableNodeDuration" : "24 hrs",
    "nodes" : [ {
      "nodeName" : "okv020017040e3c",
      "nodeID" : "1",
      "ipAddress" : "100.70.1.1",
      "mode" : "Read-Write",
      "status" : "ACTIVE",
      "readWritePeer" : "okvnode143",
      "clusterSubgroup" : "okvslgrp1",
      "joinDate" : "2024-10-09 13:13:23",
      "disableDate" : "",
      "version" : "21.10.0.0.0",
      "installDate" : "2024-10-03 10:31:33"
    }, {
      "nodeName" : "okvnode143",
      "nodeID" : "2",
      "ipAddress" : "100.70.1.2",
      "mode" : "Read-Write",
      "status" : "ACTIVE",
      "readWritePeer" : "okv020017040e3c",
      "clusterSubgroup" : "okvslgrp1",
      "joinDate" : "2024-10-09 13:20:01",
      "disableDate" : "",
      "version" : "21.10.0.0.0",
      "installDate" : "2024-10-03 04:05:14"
    } ]
  }
}

okv cluster status get

The okv cluster status get command retrieves dynamic information about the cluster or the specified cluster node.

okv cluster status get retrieves the following information:

Nodes that are read/write pairs
Nodes that are read-only pairs
The number and type of unresolved name conflicts
Alerts that are related to the cluster

Required Authorization

None. Information returned by the command varies depending upon the user’s authorization.

Syntax

okv cluster status get --node node_name

JSON Input File Template

{
  "service" : {
    "category" : "cluster",
    "resource" : "status",
    "action" : "get",
    "options" : {
      "node" : "#VALUE"
    }
  }
}

Parameters

Parameter/Template Parameter	Required?	Description
`--node` / `node`	Optional	Name of the node within the current cluster. If you omit this setting, then information for the entire cluster is retrieved.

JSON Example

Generate JSON input for the okv cluster status get command:
```
okv cluster status get --generate-json-input
```
The generated JSON input is displayed as shown in the earlier section JSON Input File Template.
Save the generated input to a file (for example, get_cluster_status.json).

Depending on the kind of information that you want to find, do one of the following:
- Get cluster status for a specific node: Edit the file to specify the node value. For example:
```
{
  "service" : {
    "category" : "cluster",
    "resource" : "status",
    "action" : "get",
    "options" : {
      "node" : "node_1"
    }
  }
}
```
- Get the status of the cluster: Edit the file to remove the node entry:
```
{
  "service" : {
    "category" : "cluster",
    "resource" : "status",
    "action" : "get"
  }
}
```

Run the okv cluster status get command using the generated JSON file:

okv cluster status get --from-json get_cluster_status.json

Depending on how you handled the file in Step 2, output similar to the following appears.

Get cluster status for a specific node:

{
  "result" : "Success",
  "value" : {
    "mode" : "Read-Write",
    "nameResolutionTime" : "62.79 seconds",
    "nodeID" : 1,
    "nodeName" : "node1",
    "status" : "ACTIVE"
  }
}

Get the status of the cluster:

{
  "result" : "Success",
  "value" : {
    "alertsCount" : "1",
    "clusterServiceStatus" : "Up",
    "nodes" : [ {
      "nodeID" : "1",
      "nodeName" : "node1",
      "mode" : "Read-Write",
      "status" : "ACTIVE",
      "nameResolutionTime" : "62.79 seconds"
    }, {
      "nodeID" : "2",
      "nodeName" : "node2",
      "mode" : "Read-Write",
      "status" : "ACTIVE",
      "nameResolutionTime" : "62.79 sec(s)"
    } ],
    "unresolvedConflicts" : {
      "endpointNameConflicts" : "0",
      "endpointGroupNameConflicts" : "0",
      "userNameConflicts" : "0",
      "userGroupNameConflicts" : "0",
      "walletNameConflicts" : "0",
      "kmipObjectNameConflicts" : "0"
    }
  }
}

okv metrics application get

The okv metrics application get command retrieves the Oracle Key Vault server application metrics information.

Application metrics details of Oracle Key Vault server:

Number of KMIP Connections
Number of RESTFul KMIP Connections

Required Authorization

System Administrator role or Monitor privilege

Syntax

okv metrics application get --start-time start_time --end-time end_time --include include --interval interval --statistic statistic

JSON Input File Template

{
  "service" : {
    "category" : "metrics",
    "resource" : "application",
    "action" : "get",
    "options" : {
      "startTime" : "#YYYY-MM-DD hh:mm:ss",
      "endTime" : "#NOW|YYYY-MM-DD hh:mm:ss",
      "interval" : "#VALUE",
      "statistic" : "#MEAN|MAX|MIN|COUNT",
      "include" : [ "ALL" ],
      "limit" : "#VALUE"
    }
  }
}

Parameters

Parameter / Template Parameter	Required?	Description
`--start-time` / `startTime`	Required	Specifies the start time for which results should be returned. Enter the timestamp in `YYYY-MM-DD HH:mm:ss` format. Example: `2023-04-20 20:05:00`
`--end-time` / `endTime`	Required	Specifies the end time for which results should be returned. Supported values: - Timestamp in `YYYY-MM-DD HH:mm:ss` format - `NOW`
`--interval` / `interval`	Required	Specifies the time window used to convert given set of raw data points. Enter the value using the ISO 8601 duration format. For example, `PT10M` specifies an interval of 10 minutes. Note: The timestamp of the aggregated data point corresponds to the start of the time window during which raw data points are assessed. For example, for a 10 minutes interval, the timestamp `09:00` corresponds to the 10 minutes time window from `09:00` to `09:10`. Example: ISO 8601 Duration
`--statistic` / `statistic`	Required	Specifies the aggregation function applied to the given set of raw data points in an interval. Supported functions are: - `MEAN` - `MIN` - `MAX` - `COUNT`
`--include` / `include`	Required	Specifies the list of system resources that requires data. The supported resources are KMIP. Specify `KMIP` to include KMIP metrics. Specify `ALL` to include all supported resources.
`--limit` / `limit`	Optional	The maximum number of data should be returned.

JSON Example

Generate JSON input for the okv metrics application get command:
```
okv metrics application get --generate-json-input
```
The generated JSON input is displayed as shown in the earlier section JSON Input File Template.

Save the generated output to a file (for example, metric_application_get.json):

{
  "service" : {
    "category" : "metrics",
    "resource" : "application",
    "action" : "get",
    "options" : {
      "startTime" : "2023-04-20 20:05:00",
      "endTime" : "NOW",
      "interval" : "PT10M",
      "statistic" : "COUNT",
      "include" : [ "ALL" ],
      "limit" : "3"
    }
  }
}

Run the okv metrics application get command using the generated JSON file:

okv metrics application get --from-json metric_application_get.json

Output similar to the following appears:

{
  "result" : "Success",
  "value" : {
    "metrics" : [ {
      "sampleTime" : "2023-04-20 20:05:03",
      "kmipConnections" : "15",
      "RESTfulKmipConnections" : "5"
    }, {
      "sampleTime" : "2023-04-20 20:15:04",
      "kmipConnections" : "10",
      "RESTfulKmipConnections" : "7"
    }, {
      "sampleTime" : "2023-04-20 20:25:05",
      "kmipConnections" : "3",
      "RESTfulKmipConnections" : "1"
    } ]
  }
}

okv metrics server get

The okv metrics server get command retrieves System Metrics information of an Oracle Key Vault server.

Installed resources on an Oracle Key Vault server shown under reserved resources, including:

Number of CPU Cores
Total amount of memory installed in KB

Note: There can be multiple entries for reserved resources in case there’s a change in resources installed or an Oracle Key Vault server reboot.

Server metrics details of Oracle Key Vault server are divided into four categories with each containing metrics related to the category:

CPU Usage
- CPU Utilization Percentage
- CPU load averages from last one, five and fifteen minutes
Memory Usage
- Amount of free memory available to start new processes in KB.
- High Swap Daemon Activity Percentage: When an Oracle Key Vault instance runs low on memory, the kernel memory swap daemon activates to swap the memory pages out, freeing up the memory. If the swap daemon exhibits high activity (indicated by significant CPU usage and ranking among the top three CPU-consuming processes) Oracle Key Vault considers this a high swap daemon activity which is an indication of high-memory pressure.
Disk I/O
- Number of disk read and write operations
Network I/O
- Amount of network data sent and received in KB
- Rate of network data sent and received in KB/s
- Number of incoming TCP connections

Required Authorization

System Administrator role or Monitor privilege

Syntax

okv metrics server get --start-time start_time --end-time end_time --include include --interval interval --statistic statistic

JSON Input File Template

{
  "service" : {
    "category" : "metrics",
    "resource" : "server",
    "action" : "get",
    "options" : {
      "startTime" : "#YYYY-MM-DD hh:mm:ss",
      "endTime" : "#NOW|YYYY-MM-DD hh:mm:ss",
      "interval" : "#VALUE",
      "statistic" : "#MEAN|MAX|MIN|COUNT",
      "include" : [ "ALL" ],
      "limit" : "#VALUE"
    }
  }
}

Parameters

Parameter / Template Parameter	Required?	Description
`--start-time`	Required	Specifies the start time for which results should be returned. Enter the timestamp in `YYYY-MM-DD HH:mm:ss` format. Example: `2023-04-20 20:05:00`
`--end-time`	Required	Specifies the end time for which results should be returned. Supported values: - Timestamp in `YYYY-MM-DD HH:mm:ss` format - `NOW`
`--interval`	Required	Specifies the time window used to convert given set of raw data points. Enter the value using the ISO 8601 duration format. For example, `PT10M` specifies an interval of 10 minutes. Note: The timestamp of the aggregated data point corresponds to the start of the time window during which raw data points are assessed. For example, for a 10 minutes interval, the timestamp `09:00` corresponds to the 10 minutes time window from `09:00` to `09:10`. Example: ISO 8601 Duration
`--statistic`	Required	Specifies the aggregation function applied to the given set of raw data points in an interval. Supported functions are: - `MEAN` - `MIN` - `MAX` - `COUNT`
`--include`	Required	Specifies the list of system resources that requires data. The supported resources are CPU, Memory, Disk, and network. Example: Specify “CPU” to include CPU, “CPU, MEMORY” to include CPU and Memory, “DISK” to include Disk, “NETWORK” to include Network, “ALL” to include all resources.
`--limit`	Optional	The maximum number of data should be returned.

JSON Example

Generate JSON input for the okv metrics server get command:
```
okv metrics server get --generate-json-input
```
The generated JSON input is displayed as shown in the earlier section JSON Input File Template.

Save the generated output to a file (for example, metric_server_get.json).

{
  "service" : {
    "category" : "metrics",
    "resource" : "server",
    "action" : "get",
    "options" : {
      "startTime" : "2023-04-20 20:05:00",
      "endTime" : "NOW",
      "interval" : "PT10M",
      "statistic" : "MEAN",
      "include" : [ "ALL" ],
      "limit" : "3"
    }
  }
}

Run the okv metrics server get command using the generated JSON file:

okv metrics server get --from-json metric_server_get.json

Output similar to the following appears:

{
  "result" : "Success",
  "value" : {
    "availableResources" : [ {
      "sampleTime" : "2024-12-12 02:28:26",
      "cpuCores" : "2",
      "totalMemoryInKB" : "8112788"
    }, {
      "sampleTime" : "2024-12-12 03:53:08",
      "cpuCores" : "4",
      "totalMemoryInKB" : "32855068"
    } ],
    "metrics" : [ {
      "sampleTime" : "2024-12-12 02:28:26",
      "cpuUtilizationPercentage" : "99",
      "loadAverage1Minute" : "3.01",
      "loadAverage5Minutes" : "1.38",
      "loadAverage15Minutes" : "1.21",
      "freeMemoryInKB" : "1433548",
      "highSwapDaemonActivityPercentage" : "2",
      "diskReads" : "16763",
      "diskWrites" : "48480",
      "networkDataReceivedInKB" : "0",
      "networkDataSentInKB" : "0",
      "networkDataReceivedRateInKBps" : "0",
      "networkDataSentRateInKBps" : "0",
      "incomingTCPConnections" : "127"
    }, {
      "sampleTime" : "2024-12-12 03:53:08",
      "cpuUtilizationPercentage" : "73",
      "loadAverage1Minute" : "1.67",
      "loadAverage5Minutes" : "0.75",
      "loadAverage15Minutes" : "0.44",
      "freeMemoryInKB" : "26494624",
      "highSwapDaemonActivityPercentage" : "0",
      "diskReads" : "36189",
      "diskWrites" : "23666",
      "networkDataReceivedInKB" : "104245.51",
      "networkDataSentInKB" : "821488.99",
      "networkDataReceivedRateInKBps" : "17.05",
      "networkDataSentRateInKBps" : "84.13",
      "incomingTCPConnections" : "101"
    } ]
  }
}

okv primary-standby info get

The okv primary-standby info get command displays static information about the Oracle Key Vault primary-standby configuration.

okv primary-standby info retrieves the following information:

The primary-standby status
The primary server IP address
The standby server IP address
The fast-start failover threshold value

Required Authorization

System Administrator role or Monitor privilege

Syntax

okv primary-standby info get

JSON Input File Template

{
  "service" : {
    "category" : "primary-standby",
    "resource" : "info",
    "action" : "get"
  }
}

Parameters

None

JSON Example

Generate JSON input for the okv primary-standby info get command:
```
okv primary-standby info get --generate-json-input
```
The generated JSON input is displayed as shown in the earlier section JSON Input File Template.
Save the output to a file (for example, primary_standby_info.json).

Run the okv primary-standby info get command using the generated JSON file:

okv primary-standby info get --from-json primary_standby_info.json

Output similar to the following appears:

{
  "result" : "Success",
  "value" : {
    "fsfo" : "60",
    "primaryIPAddress" : "192.0.2.114",
    "primaryStandbyStatus" : "Primary",
    "standbyIPAddress" : "192.0.2.115"
  }
}

okv primary-standby status get

The okv primary-standby status get command retrieves dynamic information about the Oracle Key Vault primary-standby configuration.

okv primary-standby status get get retrieves the following information:

The switchover status
The failover status
Whether the primary is in read-only restricted mode

Required Authorization

System Administrator role or Monitor privilege

Syntax

okv primary-standby status get

JSON Input File Template

{
  "service" : {
    "category" : "primary-standby",
    "resource" : "status",
    "action" : "get"
  }
}

Parameters

None

JSON Example

Generate JSON input for the okv primary-standby status get command:
```
okv primary-standby status get --generate-json-input
```
The generated JSON input is displayed as shown in the earlier section JSON Input File Template.
Save the generated input to a file (for example, primary_standby_status.json).

Run the okv primary-standby status get command using the generated JSON file:

okv primary-standby status get --from-json primary_standby_status.json

Output similar to the following appears:

{
  "result" : "Success",
  "value" : {
    "failoverStatus" : "SYNCHRONIZED",
    "rormMode" : "No",
    "switchoverStatus" : "TO STANDBY"
  }
}

okv server info get

The okv server info get command retrieves static information about an Oracle Key Vault server.

okv server info get displays the following:

The current version of the Oracle Key Vault server
The Oracle Key Vault server certification expiration date
The deployment type of the Oracle Key Vault server, such as standalone, cluster, or primary-standby

Required Authorization

None. Information returned varies based on the user’s authorization.

Syntax

okv server info get

JSON Input File Template

{
  "service" : {
    "category" : "server",
    "resource" : "info",
    "action" : "get"
  }
}

Parameters

None

JSON Example

Generate JSON input for the okv server info get command:
```
okv server info get --generate-json-input
```
The generated JSON input is displayed as shown in the earlier section JSON Input File Template.
Save the generated input to a file (for example, server_info_get.json). You do not need to edit the file because it has no parameters to modify.

Run the okv server info get command using the generated JSON file:

okv server info get --from-json server_info_get.json

Output similar to the following appears:

As sysadmin:
{
  "result" : "Success",
  "value" : {
    "caCertificateExpirationDate" : "2027-10-03 10:34:57",
    "cpuCores" : "16",
    "deploymentType" : "Cluster",
    "diskInGB" : "335",
    "fraInGB" : "160",
    "installDate" : "2024-10-03 10:31:33",
    "memoryInKB" : "7837396",
    "platformCertificatesExpirationDate" : "2025-10-03 10:33:11",
    "serverCertificateExpirationDate" : "2025-10-03 10:35:35",
    "serverTime" : "2024-10-09 16:13:03",
    "version" : "21.10.0.0.0"
  }
}

As user with no privileges:

{
  "result" : "Success",
  "value" : {
    "cpuCores" : "16",
    "deploymentType" : "Cluster",
    "diskInGB" : "335",
    "serverTime" : "2025-05-11 15:14:05",
    "version" : "21.10.0.0.0"
  }
}

All dates are shown in UTC.

okv server status get

The okv server status get command retrieves status information about an Oracle Key Vault server.

okv server status get displays the following:

The amount of time (uptime) that the Oracle Key Vault has been running
How much current free space is left on the Oracle Key Vault server
The status of any backup jobs that have been started for Oracle Key Vault
Number of alerts that have been raised concerning the Oracle Key Vault system
Current CPU usage percentage and number of CPU cores installed on the Oracle Key Vault server
Current disk space usage percentage and amount in GB and total disk space in GB on the Oracle Key Vault server
Current Fast Recovery Area (FRA) space usage percentage, amount in GB, and total space in GB for FRA on the Oracle Key Vault server
Current memory usage percentage, amount in KB, and total memory amount in KB installed on the Oracle Key Vault server
Status of services running on the Oracle Key Vault server

Required Authorization

System Administrator role or Monitor privilege

Syntax

okv server status get

JSON Input File Template

{
  "service" : {
    "category" : "server",
    "resource" : "status",
    "action" : "get"
  }
}

Parameters

None

JSON Example

Generate JSON input for the okv server status get command:
```
okv server status get --generate-json-input
```
The generated JSON input is displayed as shown in the earlier section JSON Input File Template.
Save the generated input to a file (for example, server_status.json).

Run the okv server status get command using the generated JSON file:

okv server status get --from-json server_status.json

Output similar to the following appears:

{
  "result" : "Success",
  "value" : {
    "alertsRaised" : "1",
    "backupStatus" : "25 day(s) since successful backup",
    "cpu" : {
      "usagePercentage" : "2",
      "cpuCores" : "16"
    },
    "disk" : {
      "usagePercentage" : "14",
      "usedInGB" : "42",
      "totalInGB" : "293"
    },
    "fra" : {
      "usagePercentage" : "20",
      "usedInGB" : "4",
      "totalInGB" : "20"
    },
    "freeSpacePercentage" : "86",
    "memory" : {
      "usagePercentage" : "98",
      "usedInKB" : "7655964",
      "totalInKB" : "7847768"
    },
    "services" : {
      "RESTfulService" : "Up",
      "emailService" : "Up",
      "KMIPService" : "Up",
      "storageDB" : "Up",
      "auditVaultAgentMonitor" : "Not enabled"
    },
    "uptime" : "11:59 HH:MM"
  }
}

Note: The count of alertsRaised may be different for users with the System Administrator role and the Monitor privilege.