1. RESTfulサービス管理者ガイド
  2. クラスタ管理コマンド

9 クラスタ管理コマンド

クラスタ管理コマンドを使用して、クラスタの作成、クラスタ内のノードの管理、およびクラスタ内のノードのステータスのモニターを実行できます。

9.1 okv cluster node createコマンド

okv cluster node createコマンドは、クラスタの最初のノードを作成します。

用途

okv cluster node createコマンドは、クラスタでの最初のノードです。次の情報が必要です:

  • クラスタ名
  • クラスタ・ノード名
  • クラスタ内のサブグループ名

構文

okv cluster node create --generate-json-input

JSON入力ファイル・テンプレート 

{
  "service" : {
   "category" : "cluster,
   "resource" : "node",
   "action" : "create",
   "options" : {
     "nodeName" : "#VALUE",
     "clusterName" : "#VALUE",
     "clusterSubgroup" : "#VALUE"
     } 
   }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明
--cluster-name 必須

クラスタの名前。
--cluster-subgroup

必須

クラスタ・サブグループの名前。
--node-name 必須 クラスタ・ノードの名前。

CLIコマンド

okv cluster node create --cluster-name --cluster-subgroup --node-name

CLIの例

使用上のノート

okv cluster node create --cluster-name "NorthAmerica" --cluster-subgroup "NewYork" --node-name "node1"

出力は、次のようになります。 

{
  "result" : "Success",
  "value" : {
    "requestId" : "1630"
  }
}
addまたはcreateコマンドを発行してステータスを表示したら、次のステップを実行します。
  1. requestIDを取得できます。次のrequestIDを使用して、リクエスト・ステータスを確認できます。
    okv cluster node status --pairing-request-id
  2. この後に、次のコマンドを使用して現在のノードのステータスを確認できます:
    okv cluster node status

JSONの例

  1. okv cluster node createコマンド用にJSON入力を生成します。 
    okv cluster node create --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
   "category" : "cluster,
   "resource" : "node",
   "action" : "create",
   "options" : {
     "nodeName" : "node1",
      "clusterName" : "NorthAmerica",
      "clusterSubgroup" : "NewYork"
     }
   }
}
  2. 生成された入力内容をファイルに保存します(例: okv cluster node create --from-json node-create.json)。
    出力は、次のようになります。 
     
{
  "result" : "Success",
  "value" : {
    "requestId" : "1926"
  }
}

関連トピック

親トピック: クラスタ管理コマンド

9.2 okv cluster node statusコマンド

okv cluster node statusコマンドでは、クラスタ・ノードのペアリング・プロセスまたはクラスタ・ノードのステータスに関する情報が提供されます。

必要な権限

システム管理者ロール

構文

okv cluster node status

JSON入力ファイル・テンプレート

{   
  "service" : {
   "category" : "cluster,
   "resource" : "node",
   "action" : "status",
   "options" : {
     "node-name" : "#VALUE",
     "pairingRequestId" : "#VALUE",
     "pairingSteps" : "#TRUE|FALSE",
     "candidateNodeIpAddress" : "#VALUE",
     "candidateNodeUser : "#VALUE",
     "candidateNodePassword : "#VALUE",     "candidateNodePrivateIpAddress" :"#VALUE",
     "controllerNodePrivateIpAddress" :"#VALUE"
    }    
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須 説明
--candidate-node-ip-address

オプション

候補ノードのIPアドレス。
--candidate-node-password

オプション

候補ノードのユーザーのパスワード。
--candidate-node-user

オプション

候補者ノードのユーザーの名前。
--candidate-node-private-ip-address

オプション

候補ノードのプライベートIPアドレス。

ノート: プライベートIPアドレスを使用している場合は、コントローラ・ノードと候補ノードの両方にIPアドレスを指定します。

--controller-node-private-ip-address

オプション

コントローラ・ノードのプライベートIPアドレス。

ノート: プライベートIPアドレスを使用している場合は、コントローラ・ノードと候補ノードの両方にIPアドレスを指定します。

--node-name

オプション

クラスタ・ノードの名前。
--pairing-request-id

オプション

長時間実行されるコマンドのリクエストID。
--pairing-steps

オプション

詳細なペアリング手順を表示します - TRUEまたはFALSE。

CLIコマンド

1. $ okv cluster node status
2. $ okv cluster node status --node-name
3. $ okv cluster node status --pairing-request-id
4. $ okv cluster node status --pairing-steps TRUE
5. $ okv cluster node status --pairing-steps --candidate-node-ip-address --candidate-node-user --candidate-node-password

ノート:

次の順序で複数ノードに従う必要があります:
  1. クラスタ・コマンドの管理に属する候補ノードまたはコントローラ・ノードに、okv cluster node statusコマンドを使用できます。コントローラ・ノードのステータスがチェックされます。
  2. requestIdを返すコマンドに、okv cluster node status --pairing-request-idを使用できます。指定されたノードのステータスがチェックされます。
  3. "add"コマンドのコントローラ・ノードでのペアリング・ステップの確認に、okv cluster node status --pairing-stepsを使用できます。リクエストIDによってジョブのステータスがチェックされます。リクエストIDは、create、addおよびabort-paringコマンドで使用できます。コントローラ・ノードでのペアリング・ステップのステータスがチェックされます。
  4. addコマンドの候補ノードでのペアリング・ステップの確認に、okv cluster node status --pairing-steps --candidate-node-ip-address --candidate-node-user --candidate-node-passwordを使用できます。コントローラ・ノードでのペアリング・ステップのステータスがチェックされます。

使用上のノート

addまたはcreateコマンドを発行してステータスを表示したら、次のステップを実行します。
  1. requestIDを取得できます。次のrequestIDを使用して、リクエスト・ステータスを確認できます。
    okv cluster node status --pairing-request-id
  2. 次に、コマンドを使用してノードの現在のステータスを確認できます。
    okv cluster node status

JSONの例

  1. okv cluster node statusコマンド用にJSON入力を生成します。 
    okv cluster node status --generate-json-input

    次のような入力が生成されます。 

    {   
  "service" : {
   "category" : "cluster,
   "resource" : "node",
   "action" : "status",
   "options" : {
     "node-name" : "#VALUE",
     "pairingRequestId" : "#VALUE",
     "pairingSteps" : "#TRUE|FALSE",
     "candidateNodeIpAddress" : "#VALUE",
     "candidateNodeUser : "#VALUE",
     "candidateNodePassword : "#VALUE"     "candidateNodePrivateIpAddress" :"#VALUE",
     "controllerNodePrivateIpAddress" :"#VALUE"
    }    
  }
}
  2. 生成された入力をファイル(node_status.jsonなど)に保存します。
  3. 生成されたJSONファイルを使用して、okv cluster node statusコマンドを実行します。たとえば:

    出力は、次のようになります。 

    okv cluster node status:

{
  "result" : "Success",
  "value" : {
   "status" : "CONFIGURED"
}

okv cluster node status --node-name node1

{
  "result" : "Success",
  "value" : {
   "status" : "ENABLING"
   }
  } 
okv cluster node status --pairing-request-id 18374: 
 {
   "result" : "Failure",
   "message" : "Server is already a node or is already configured as node."
  }
 {
   "result" : "Success" 
 }
okv cluster node status  --pairing-steps TRUE
 {
  "result" : "Success",
  "value" : {
    "stages" : [ {
      "step1" : "Open transport channel with the candidate node",
      "status" : "COMPLETED"
             }, {
      "step2" : "Verify the candidate node details",
      "status" : "COMPLETED"
    }, {
      "step3" : "Enable data replication to the candidate node",
      "status" : "COMPLETED"
    }, {
      "step4" : "Generate the controller node details",
      "status" : "COMPLETED"
    }, {
      "step5" : "Generate backup of the controller node for cloning",
      "status" : "COMPLETED"
    }, {
      "step6" : "Send clone bundle to the candidate node",
      "status" : "COMPLETED"
    }, {
      "step8" : "Enable data replication to other cluster nodes",
      "status" : ""
    }, {
      "step9" : "The candidate node successfully joins the cluster",
      "status" : ""
    } ]
  }
}
okv cluster node status --pairing-steps TRUE --candidate-node-ip-address100.70.126.53 --candidate-node-user okvadmin --candidate-node-password Welcome_1  
{
  "result" : "Success",
  "value" : {
    "stages" : [ {
      "step1" : "Generate the candidate node details",
      "status" : "COMPLETED"
    }, {
      "step2" : "Open transport channel with the controller node",
      "status" : "COMPLETED"
    }, {
      "step3" : "Send node details to the controller node",
      "status" : "COMPLETED"
    }, {
      "step4" : "Receive clone bundle from the controller node",
      "status" : "COMPLETED"
    }, {
      "step5" : "Restore backup on the candidate node",
      "status" : "COMPLETED"
    }, {
      "step6" : "Update credentials of the candidate node",
      "status" : "COMPLETED"
    }, {
      "step7" : "Tune the database on the candidate node",
      "status" : "COMPLETED"
    }, {
      "step8" : "Setup network configuration on the candidate node",
      "status" : "COMPLETED"
    }
  }
}

親トピック: クラスタ管理コマンド

9.3 okv cluster node addコマンド

okv cluster node addコマンドは、クラスタにノードを追加します。

構文

okv cluster node add

JSON入力ファイル・テンプレート

{
 "service" : {
  "category" : "cluster,
  "resource" : "node",
  "action" : "add",
  "options" : {
    "recoveryPassphrase" : "#VALUE",
    "candidateNodeIpAddress" : "#VALUE",
    "mode" : "#VALUE",
    "nodeId" : "#VALUE",
    "nodeName" : "#VALUE",
    "clusterSubgroup" : "#VALUE",
    "hsmCredential : "#VALUE",
    "candidateNodeUser : "#VALUE",
    "candidateNodePassword : "#VALUE",     "candidateNodePrivateIpAddress" :"#VALUE",
     "controllerNodePrivateIpAddress" :"#VALUE"
     }
   }
 }

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明
--candidate-node-ip-address

必須

候補ノードのIPアドレス。
--candidate-node-password

必須

 候補ノードのユーザーのパスワード。

ノート:

ユーザーは、コマンドラインまたはJSONでパスワードを指定する必要はありません。ユーザーは、実行時にパスワードを要求されます。
--candidate-node-user

必須

 候補者ノードのユーザーの名前。
--candidate-node-private-ip-address

オプション

候補ノードのプライベートIPアドレス。

ノート: プライベートIPアドレスを使用している場合は、コントローラ・ノードと候補ノードの両方にプライベートIPアドレスを指定します。

--controller-node-private-ip-address

オプション

コントローラ・ノードのプライベートIPアドレス。

ノート: プライベートIPアドレスを使用している場合は、コントローラ・ノードと候補ノードの両方にプライベートIPアドレスを指定します。

--cluster-subgroup

必須

 クラスタ・サブグループの名前。
--mode

必須

ペアリング・モード - READ-ONLYまたはREAD-WRITE。
--node-id

必須

クラスタ・ノードのID。IDは1から16の間です。IDは一意である必要があり、他のノードとの重複したIDにしないでください。

--node-name

必須

クラスタ・ノードの名前。

--recovery-passphrase

必須

クラスタのリカバリ・パス・フレーズ。

ノート:

ユーザーは、コマンドラインまたはJSONでパスワードを指定する必要はありません。ユーザーは、実行時にパスワードを要求されます。
--hsm-credential

オプション

 HSM資格証明。

CLIコマンド

okv cluster node add --options <argument>

JSONの例

  1. okv cluster node addコマンド用にJSON入力を生成します。 
    okv cluster node add --generate-json-input

    次のような入力が生成されます。 

    {
 "service" : {
  "category" : "cluster,
  "resource" : "node",
  "action" : "add",
  "options" : {
    "recoveryPassphrase" : "#VALUE",
    "candidateNodeIpAddress" : "#VALUE",     "candidateNodePrivateIpAddress" :"#VALUE",
     "controllerNodePrivateIpAddress" :"#VALUE"
    "mode" : "#VALUE",
    "nodeId" : "#VALUE",
    "nodeName" : "#VALUE",
    "clusterSubgroup" : "#VALUE",
    "hsmCredential : "#VALUE",
    "candidateNodeUser : "#VALUE",
    "candidateNodePassword : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(node-add.jsonなど)に保存します。
  3. 生成されたJSONファイルを使用して、okv cluster node addコマンドを実行します。たとえば:
    okv cluster node add --from-json-node-add.json
    出力は、次のようになります。 
    {
  "result" : "Success",
   "value" : {
    "requestId" : "78219"
    }
 }

ノート:

requestIdの出力については、「okv cluster node statusコマンド」の項を参照してください。

関連トピック

親トピック: クラスタ管理コマンド

9.4 okv cluster node abort-pairingコマンド

okv cluster node abort-pairingコマンドは、クラスタ内のノード・ペアリング・プロセスを中止します。

必要な権限

システム管理者ロール

構文

okv cluster node abort-pairing --generate-json-input

JSON入力ファイル・テンプレート

パラメータ

{
 "service" : {
  "category" : "cluster,
  "resource" : "node",
  "action" : "abort-pairing",
  "options" : {
    "candidateNodeIpAddress" : "#VALUE",
    "candidateNodeUser : "#VALUE",
    "candidateNodePassword : "#VALUE",     "candidateNodePrivateIpAddress" :"#VALUE",
     "controllerNodePrivateIpAddress" :"#VALUE"
    }     
  }
}
パラメータ/テンプレート・パラメータ 必須 説明
--candidate-node-ip-address

オプション

候補ノードのIPアドレス。
--candidate-node-password

オプション

候補ノードのユーザーのパスワード。--candidate-node-passwordが指定されていない場合、プロセスは入力を待機します。

--candidate-node-private-ip-address

オプション

候補ノードのプライベートIPアドレス。

ノート: プライベートIPアドレスを使用している場合は、コントローラ・ノードと候補ノードの両方にIPアドレスを指定します。

--controller-node-private-ip-address

オプション

コントローラ・ノードのプライベートIPアドレス。

ノート: プライベートIPアドレスを使用している場合は、コントローラ・ノードと候補ノードの両方にIPアドレスを指定します。

--candidate-node-user

オプション

候補者ノードのユーザーの名前。

ノート:

--candidate-node-ip-addressに情報を指定しない場合、コマンドはコントローラ・ノードで中止されます。--candidate-node-ip-addressを中止する場合は、3つのパラメータすべてに関する情報を指定する必要があります。

CLIコマンド

okv cluster node abort-pairing --options <argument>

使用上のノート

addまたはcreateコマンドを発行してステータスを表示したら、次のステップを実行します。
  1. requestIDを取得できます。次のrequestIDを使用して、リクエスト・ステータスを確認できます。
    okv cluster node status --pairing-request-id
  2. 次に、コマンドを使用してノードの現在のステータスを確認できます。
    okv cluster node status

JSONの例

  1. okv cluster node abort-pairingコマンド用にJSON入力を生成します。
    okv cluster node abort-pairing.
    次のような入力が生成されます。
    {
 "service" : {
  "category" : "cluster,
  "resource" : "node",
  "action" : "abort-pairing",
  "options" : {
    "candidateNodeIpAddress" : "#VALUE",
    "candidateNodeUser : "#VALUE",
    "candidateNodePassword : "#VALUE"     "candidateNodePrivateIpAddress" :"#VALUE",
     "controllerNodePrivateIpAddress" :"#VALUE"
    }     
  }
}
  2. 生成された入力をファイル(abort_pairing.jsonなど)に保存します。
  3. 生成されたJSONファイルを使用して、okv cluster node deleteコマンドを実行します。たとえば:
    okv cluster node abort-pairing --from-json abort_pairing.json
    出力は、次のようになります。 
    { 
 "result" : "Success",  
 "value" : {   
  "requestId" : "78223"  
  }
}

ノート:

requestIdの出力については、「okv cluster node statusコマンド」の項を参照してください。

関連トピック

親トピック: クラスタ管理コマンド

9.5 okv cluster node deleteコマンド

okv cluster node deleteコマンドは、クラスタ・ノードを削除します。

必要な権限

システム管理者ロール

okv cluster node deleteコマンドでは、次が表示されます。
  • 成功か失敗かに関係なく、コマンドの結果が表示されます。

構文

okv cluster node delete

JSON入力ファイル・テンプレート

パラメータ

{
 "service" : {
  "category" : "cluster,
  "resource" : "node",
  "action" : "delete",
  "options" : {
   "nodeName" : "#VALUE",
   "force" : "#TRUE|FALSE",
   "originNodeName" : "#VALUE"
   }
  }
 }
パラメータ 必須 説明
--node-name

必須

クラスタ・ノードの名前。
--origin-node-name

必須

 ノードの削除を開始するオリジン・ノードの名前。
--force

オプション

forceオプションを使用して、ノードを削除します(TRUEまたはFALSE)。

CLIコマンド

okv cluster node delete --options <argument>

JSONの例

  1. okv cluster node deleteコマンド用にJSON入力を生成します。 
    okv cluster node delete --generate-json-input

    次のような入力が生成されます。 

    {
 "service" : {
  "category" : "cluster,
  "resource" : "node",
  "action" : "delete",
  "options" : {
   "nodeName" : "#VALUE",
   "force" : "#TRUE|FALSE",
   "originNodeName" : "#VALUE"
   }
  }
 }
  2. 生成された入力をファイル(node_delete.jsonなど)に保存します。
  3. 生成されたJSONファイルを使用して、okv cluster node deleteコマンドを実行します。たとえば:
    okv cluster node delete --from-json node_delete.json

    出力は、次のようになります。 

    {
 "result" : "Success"
}

ノート:

requestIdの出力については、「okv cluster node statusコマンド」の項を参照してください。

親トピック: クラスタ管理コマンド

9.6 okv cluster node enableコマンド

okv cluster node enableコマンドは、クラスタ・ノードを有効にします。

必要な権限

システム管理者ロール

okv cluster node enable コマンドでは、次が表示されます。
  • 成功か失敗かに関係なく、コマンドの結果が表示されます。

構文

okv cluster node enable

JSON入力ファイル・テンプレート

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

パラメータ

パラメータ 必須 説明
--node-name

必須

クラスタ・ノードの名前。

JSONの例

  1. okv cluster node enableコマンド用にJSON入力を生成します。 
    okv cluster node enable --generate-json-input

    次のような入力が生成されます。 

    {
 "service" : {
  "category" : "cluster,
  "resource" : "node",
  "action" : "enable",
  "options" : {
   "nodeName" : "#VALUE"
   }
  }
}
  2. 生成された入力をファイル(node_enable.jsonなど)に保存します。
  3. 生成されたJSONファイルを使用して、okv cluster node enableコマンドを実行します。たとえば:
    okv cluster node enable --from-json node_enable.json

    出力は、次のようになります。 

    {  
 "result" : "Success"
}

親トピック: クラスタ管理コマンド

9.7 okv cluster node disableコマンド

okv cluster node disableコマンドは、クラスタ・ノードを無効にします。

必要な権限

システム管理者ロール

構文

okv cluster node disable

JSON入力ファイル・テンプレート

{
 "service" : {
  "category" : "cluster,
  "resource" : "node",
  "action" : "disable",
  "options" : {
   "nodeName" : "#VALUE",
   "originNodeName" : "#VALUE"
   }
  }
}

パラメータ

パラメータ 必須かどうか 説明
--node-name

必須

クラスタ・ノードの名前。
--origin-node-name オプション ノードの無効化を開始するオリジン・ノードの名前。

JSONの例

  1. okv cluster node disableコマンド用にJSON入力を生成します。 
    okv cluster node disable --generate-json-input

    次のような入力が生成されます。 

    {
 "service" : {
  "category" : "cluster,
  "resource" : "node",
  "action" : "disable",
  "options" : {
   "nodeName" : "#VALUE",
   "originNodeName" : "#VALUE"
   }
  }
}
  2. 生成された入力をファイル(node_disable.jsonなど)に保存します。
  3. 生成されたJSONファイルを使用して、okv cluster node disableコマンドを実行します。たとえば:
    okv cluster node disable --from-json node_disable.json

    出力は、次のようになります。 

    {
 "result" :"Success"
}

親トピック: クラスタ管理コマンド

9.8 okv cluster node cancel-disableコマンド

okv cluster node cancel-disableコマンドは、クラスタ・ノードの無効化を取り消します。

必要な権限

システム管理者ロール

okv cluster node cancel-disableコマンドでは、次が表示されます。
  • 成功か失敗かに関係なく、コマンドの結果が表示されます。

構文

okv cluster node cancel-disable

JSON入力ファイル・テンプレート

{
 "service" : {
 "category" : "cluster,
 "resource" : "node",
 "action" : "cancel-disable",
 "options" : {
  "nodeName" : "#VALUE"
  }    
 }
}

パラメータ

パラメータ 必須かどうか 説明
--node-name

必須

クラスタ・ノードの名前。

JSONの例

  1. okv cluster node cancel-disableコマンド用にJSON入力を生成します。 
    okv cluster node cancel-disable --generate-json-input

    次のような入力が生成されます。 

    {
 "service" : {
 "category" : "cluster,
 "resource" : "node",
 "action" : "cancel-disable",
 "options" : {
  "nodeName" : "#VALUE"
  }    
 }
}
  2. 生成された入力をファイル(cancel_disable.jsonなど)に保存します。
  3. 生成されたJSONファイルを使用して、okv cluster node cancel-disableコマンドを実行します。たとえば:
    okv cluster node cancel-disable --from-json cancel_disable.json

    出力は、次のようになります。 

    {
 "result" : "Success"
}

親トピック: クラスタ管理コマンド

9.9 okv cluster node updateコマンド

okv cluster node updateコマンドは、クラスタ・ノードのクラスタ・サブグループを変更します。

必要な権限

システム管理者ロール

構文

okv cluster node update --generate-json-input

JSON入力ファイル・テンプレート

{
 "service" : {
  "category" : "cluster,
  "resource" : "node",
  "action" : "update",
  "options" : {
   "nodeName" : "#VALUE",
   "clusterSubgroup" : "#VALUE"
  }
 }
}

パラメータ

パラメータ 必須 説明
--cluster-subgroup

必須

クラスタ・サブグループの名前。
--node-name

必須

クラスタ・ノードの名前。

JSONの例

  1. okv cluster node updateコマンド用にJSON入力を生成します。 
    okv cluster node update

    次のような入力が生成されます。 

    {
 "service" : {
  "category" : "cluster,
  "resource" : "node",
  "action" : "update",
  "options" : {
   "nodeName" : "#VALUE",
   "clusterSubgroup" : "#VALUE"
  }
 }
}
  2. 生成された入力をファイル(node_update.jsonなど)に保存します。
  3. 生成されたJSONファイルを使用して、okv cluster node deleteコマンドを実行します。たとえば:
    okv cluster node update --from-json node_update.json

    出力は、次のようになります。 

    {
 "result" : "Success"
}

親トピック: クラスタ管理コマンド