6 Monitoring Commands
You can use the monitoring commands to check the Oracle Key Vault configuration, health, and deployment modes.
- okv cluster info get Command
Theokv cluster info get
command retrieves status information about a cluster or a cluster node. - okv cluster status get Command
Theokv cluster status get
command retrieves dynamic information about the cluster or the specified cluster node. - okv primary-standby info get Command
Theokv primary-standby info get
command displays static information about the Oracle Key Vault primary-standby configuration. - okv primary-standby status get Command
Theokv primary-standby status get
command retrieves dynamic information about the Oracle Key Vault primary-standby configuration. - okv server info get Command
Theokv server info get
command retrieves static information about an Oracle Key Vault server. - okv server status get Command
Theokv server status get
command retrieves status information about an Oracle Key Vault server.
6.1 okv cluster info get Command
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
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 |
---|---|---|
|
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 input appears as follows:
{ "service" : { "category" : "cluster", "resource" : "info", "action" : "get", "options" : { "node" : "#VALUE" } } }
- 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" } }
- Get cluster information for a specific node: Edit the file to specify the
- Execute 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" : "subgrp1", "disableDate" : "", "ipAddress" : "192.0.2.114", "joinDate" : "2021-06-16 06:57:45", "mode" : "Read-Write", "nodeID" : "1", "nodeName" : "node1", "readWritePeer" : "node2", "status" : "ACTIVE", "version" : "21.2.0.0.0" } }
- Get cluster information for all nodes in the cluster:
{ "result" : "Success", "value" : { "clusterName" : "cluster1", "clusterSubgroups" : [ "subgrp1", "subgrp2" ], "clusterVersion" : "21.2.0.0.0", "maximumDisableNodeDuration" : "24 hrs", "nodes" : [ { "nodeName" : "node1", "nodeID" : "1", "ipAddress" : "192.0.2.114", "mode" : "Read-Write", "status" : "ACTIVE", "readWritePeer" : "node2", "clusterSubgroup" : "subgrp1", "joinDate" : "2021-06-16 06:57:45", "disableDate" : "", "version" : "21.2.0.0.0" }, { "nodeName" : "node2", "nodeID" : "2", "ipAddress" : "192.0.2.115", "mode" : "Read-Write", "status" : "ACTIVE", "readWritePeer" : "node1", "clusterSubgroup" : "subgrp2", "joinDate" : "2021-06-16 07:05:34", "disableDate" : "", "version" : "21.2.0.0.0" } ] } }
- Get cluster information for a specific node:
Parent topic: Monitoring Commands
6.2 okv cluster status get Command
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
System Administrator role
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 |
---|---|---|
|
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 input appears as follows:
{ "service" : { "category" : "cluster", "resource" : "status", "action" : "get", "options" : { "node" : "#VALUE" } } }
- 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" } }
- Get cluster status for a specific node: Edit the file to specify the
- Execute 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" : "Could not determine", "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" : "Could not determine" }, { "nodeID" : "2", "nodeName" : "node2", "mode" : "Read-Write", "status" : "ACTIVE", "nameResolutionTime" : "119.98 sec(s)" } ], "unresolvedConflicts" : { "endpointNameConflicts" : "0", "endpointGroupNameConflicts" : "0", "userNameConflicts" : "0", "userGroupNameConflicts" : "0", "walletNameConflicts" : "0", "kmipObjectNameConflicts" : "0" } } }
- Get cluster status for a specific node:
Parent topic: Monitoring Commands
6.3 okv primary-standby info get Command
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
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 input appears as follows:
{ "service" : { "category" : "primary-standby", "resource" : "info", "action" : "get" } }
- Save the output to a file (for example,
primary-standby-info.json
). - Execute 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" } }
Parent topic: Monitoring Commands
6.4 okv primary-standby status get Command
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
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 input appears as follows:
"service" : { "category" : "primary-standby", "resource" : "status", "action" : "get" } }
- Save the generated input to a file (for example,
primary-standby-status.json
). - Execute 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" } }
Parent topic: Monitoring Commands
6.5 okv server info get Command
The okv server info get
command retrieves static information about an Oracle Key Vault server.
Required Authorization
System Administrator role
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
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 input appears as follows:
{ "service" : { "category" : "server", "resource" : "info", "action" : "get" } }
- 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. - Execute 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:
{ "result" : "Success", "value" : { "deploymentType" : "Cluster", "serverCertificateExpirationDate" : "2023-04-17 07:20:54", "serverTime" : "2021-04-22 05:59:38", "version" : "21.2.0.0.0" } }
All dates are shown in UTC.
Parent topic: Monitoring Commands
6.6 okv server status get Command
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
Required Authorization
System Administrator role
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 input appears as follows:
{ "service" : { "category" : "server", "resource" : "status", "action" : "get" } }
- Save the generated input to a file (for example,
server-status.json
). - Execute 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" : "No successful backup done", "freeSpace" : "88%", "uptime" : "00:55 HH:MM" } }
Parent topic: Monitoring Commands