8 Cluster Monitoring Commands

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

• okv cluster service start Command
  The okv cluster service start command starts the cluster service of a node.
• okv cluster service stop Command
  The okv cluster service stop command stops the cluster service of a node.
• okv cluster service monitor Command
  The okv cluster service monitor command monitors the cluster service of a node.
• okv cluster link enable Command
  The okv cluster link enable command enables the replication link between the current node and the given node in a cluster.
• okv cluster link disable Command
  The okv cluster link disable command disables a cluster node.
• okv cluster link monitor Command
  The okv cluster link monitor command monitors the replication link.

8.1 okv cluster service start Command

The okv cluster service start command starts the cluster service of a node.

Required Authorization

System Administrator role

Syntax

okv cluster service start 

JSON Input File Template

{
 "service" : {
  "category":"cluster,
  "resource":"service",
  "action":"start,
  "options":{
  "nodeName":"#VALUE"
   } 
  }
}

Parameters

Parameter	Required	Description
--node-name	Required	Name of the cluster node.

JSON Examples

1. Generate JSON input for the okv cluster service start command.

   okv cluster service start --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "cluster",
       "resource" : "service",
       "action" : "start",
       "options" : {
         "nodeName" : "#VALUE"
       }
     }
   } 

2. Save the generated input to a file, for example, service_start.json.
3. Run the okv cluster service start command using the generated JSON file. For example:

   okv  cluster service start --from-json service_start.json

   Output similar to the following appears:

8.2 okv cluster service stop Command

The okv cluster service stop command stops the cluster service of a node.

Required Authorization

System Administrator role

Syntax

okv cluster service stop

JSON Input File Template

{
 "service" : {
  "category" : "cluster,
  "resource" : "service",
  "action" : "stop,
  "options" : {
   "nodeName" : "#VALUE"
   }
 }
}

Parameters

Parameter	Required	Description
--node-name	Required	Name of the cluster node

CLI Command

okv cluster service stop --node <argument>

JSON Examples

1. Generate JSON input for the okv cluster service stop command.

   okv cluster service stop --generate-json-input

   The generated input appears as follows:

   {
    "service" : {
     "category" : "cluster,
     "resource" : "service",
     "action" : "stop,
     "options" : {
      "nodeName" : "#VALUE"
      }
    }
   }

2. Save the generated input to a file, for example, service_stop.json.
3. Run the okv cluster service stop command using the generated JSON file. For example:

   okv cluster service stop --from-json service_stop.json

   Output similar to the following appears:

   {
    "result" : "Success"
   }

8.3 okv cluster service monitor Command

The okv cluster service monitor command monitors the cluster service of a node.

Required Authorization

System Administrator role

Syntax

okv cluster service monitor --generate-json-input

JSON Input File Template

{
 "service" : {
  "category" : "cluster,
  "resource" : "service",
  "action" : "monitor,
  "options" : {
   "nodeName" : "#VALUE"
   }   
  }
}

Parameters

Parameter	Required	Description
--node-name	Required	Name of the cluster node.

JSON Examples

1. Generate JSON input for the okv cluster service monitor command.

   okv cluster service monitor

   The generated input appears as follows:

   {
    "service" : {
     "category" : "cluster,
     "resource" : "service",
     "action" : "monitor,
     "options" : {
      "nodeName" : "#VALUE"
      }   
     }
   }

2. Save the generated input to a file, for example, service_monitor.json.
3. Run the okv cluster service monitor command using the generated JSON file. For example:

   okv cluster service monitor --from-json service_monitor.json

   Output similar to the following appears:

   {
    "result" : "Success",
    "value" : {
     "clusterServiceStatus":"Up",
     "mode":"Read-Write",
     "nodeID":"2",
     "nodeName":"node2"
     }
    }
   }

8.4 okv cluster link enable Command

The okv cluster link enable command enables the replication link between the current node and the given node in a cluster.

Required Authorization

System Administrator role

okv cluster link enable command displays the following:

• The command result, whether it is Success or failure.

Syntax

okv cluster link enable --generate-json-input

Parameters

Parameter	Required	Description
--node-name	Required	Name of the cluster target node to enable.
--target-node	Optional	Name of the node to initiate disabling of a node

JSON Examples

1. Generate JSON input for the okv cluster link enable command.

   okv cluster link enable

   The generated input appears as follows:

   {
    "service" : {
     "category" : "cluster,
     "resource" : "link",
     "action" : "enable,
     "options" : {
      "nodeName" : "#VALUE",
      "targetNode" : "#VALUE"
      }
     }
   }

2. Save the generated input to a file, for example, link_enable.json.
3. Run the okv cluster link enable command using the generated JSON file. For example:

   okv cluster link enable --from-json link_enable.json

   Output similar to the following appears:

   {
    "result" : "Success"
   }

8.5 okv cluster link disable Command

The okv cluster link disable command disables a cluster node.

Required Authorization

System Administrator role

okv cluster link disable command displays the following:

• The command result, whether it is Success or failure.

Syntax

okv cluster link disable

JSON Input File Template

{
 "service" : {
  "category" : "cluster,
  "resource" : "link",
  "action" : "enable,
  "options" : {
   "nodeName" : "#VALUE",
   "targetNode" : "#VALUE"
  }
 }
}

Parameters

Parameter	Required	Description
--node-name	Required	Name of the cluster node.
--target-node	Optional	Name of the node to initiate disabling of a node.

JSON Examples

1. Generate JSON input for the okv cluster link disable command.

   okv cluster link disable --generate-json-input

   The generated input appears as follows:

   {
    "service" : {
     "category" : "cluster,
     "resource" : "link",
     "action" : "enable,
     "options" : {
      "nodeName" : "#VALUE",
      "targetNode" : "#VALUE"
     }
    }
   }

2. Save the generated input to a file, for example, link_disable.json.
3. Run the okv cluster link disable command using the generated JSON file. For example:

   okv cluster link disable --from-json link_disable.json

   Output similar to the following appears:

   {
    "result" : "Success"
   }

8.6 okv cluster link monitor Command

The okv cluster link monitor command monitors the replication link.

Required Authorization

System Administrator role

Syntax

okv cluster link monitor

JSON Input File Template

{
 "service" : {
  "category" : "cluster,
  "resource" : "link",
  "action" : "monitor,
  "options" : {
   "nodeName" : "#VALUE"
  }  
 }
}

Parameters

Parameter	Required	Description
--node-name	Required	Name of the cluster node.

JSON Examples

1. Generate JSON input for the okv cluster link monitor command.

   okv cluster link monitor --generate-json-input

   The generated input appears as follows:

   {
    "service" : {
     "category" : "cluster,
     "resource" : "link",
     "action" : "monitor,
     "options" : {
      "nodeName" : "#VALUE"
     }  
    }
   }

2. Save the generated input to a file, for example, link_monitor.json.
3. Run the okv cluster link monitor command using the generated JSON file. For example:

   okv cluster link monitor --from-json

   Output similar to the following appears:

   {
    "result" : "Success",
    "value" : {
     "linkStatus":[ {
      "nodeID":"1",
      "nodeName:"okv080027ef30b1",
      "heartbeatLagInSeconds":"82.95",
      "linkState":"Up",
      "replicationLagInSeconds":"6"
       },
       {
        "nodeID":"2",
        "nodeName":"node2",
        "heartbeatLagInSeconds":"40.55",
        "linkState":"Up",
        "replicationLagInSeconds":"5"
         } ],
         "nodeID":"3",
         "nodeName":"node3"
         }
       }
    }