管理コマンド

3 管理コマンド

管理コマンドは、クライアント・ウォレットとエンドポイントの管理に使用できます。

クライアント・ウォレットの管理コマンド
クライアント・ウォレットの管理コマンドを使用すると、ユーザー資格証明を格納するクライアント・ウォレットを管理できます。
エンドポイントの管理コマンド
エンドポイントの管理コマンドを使用すると、エンドポイントの作成やプロビジョニングなどのエンドポイント関連タスクを実行できます。

3.1 クライアント・ウォレットの管理コマンド

クライアント・ウォレットの管理コマンドを使用すると、ユーザー資格証明を格納するクライアント・ウォレットを管理できます。

okv admin client-wallet addコマンド
okv admin client-wallet addコマンドでは、クライアント・ウォレットのewallet.p12およびcwallet.ssoが存在しないときに該当するウォレット作成し、ユーザーの資格証明をクライアント・ウォレットに追加します。
okv admin client-wallet deleteコマンド
okv admin client-wallet deleteコマンドでは、クライアント・ウォレットからユーザーの資格証明を削除します。
okv admin client-wallet listコマンド
okv admin client-wallet listコマンドでは、クライアント・ウォレットに格納されている資格証明を保持しているユーザーをリストします。
okv admin client-wallet updateコマンド
okv admin client-wallet updateコマンドでは、クライアント・ウォレット内のユーザーのパスワードを更新します。

3.1.1 okv admin client-wallet addコマンド

okv admin client-wallet addコマンドでは、クライアント・ウォレットのewallet.p12およびcwallet.ssoが存在しないときに該当するウォレット作成し、ユーザーの資格証明をクライアント・ウォレットに追加します。

必要な権限

なし

構文

okv admin client-wallet add --client-wallet client_wallet_location --wallet-user user_name

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

{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "add",
    "options" : {
      "clientWallet" : "#VALUE",
      "walletUser" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ	必須かどうか	説明
`--client-wallet` / `clientWallet`	必須	クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ)
`--wallet-user` / `walletUser`	必須	ユーザー名

JSONの例

okv admin client-wallet addコマンド用にJSON入力を生成します。

okv admin client-wallet add --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "add",
    "options" : {
      "clientWallet" : "#VALUE",
      "walletUser" : "#VALUE"
    }
  }
}

生成された入力をファイル(たとえば、client_wallet_add.json)に保存して、ウォレットに追加しようとしているパスワードを保持するユーザーとクライアント・ウォレットの場所を指定できるように編集します。
```
{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "add",
    "options" : {
      "clientWallet" : "/home/oracle/okv_client_wallet",
      "walletUser" : "pfitch"
    }
  }
}
```
生成されたJSONファイルを使用して、okv admin client-wallet addコマンドを実行します。
```
okv admin client-wallet add --from-json client_wallet_add.json
```
プロンプトが表示されたら、ユーザーのパスワードを入力します。パスワードを入力すると、次のような出力が表示されます。
```
Password: password
{
  "result" : "Success"
}
```

親トピック: クライアント・ウォレットの管理コマンド

3.1.2 okv admin client-wallet deleteコマンド

okv admin client-wallet deleteコマンドでは、クライアント・ウォレットからユーザーの資格証明を削除します。

必要な権限

クライアント・ウォレットに対する読取り/書込み権限

構文

okv admin client-wallet delete client-wallet client_wallet_location --wallet-user wallet_user_name

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

{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "delete",
    "options" : {
      "clientWallet" : "#VALUE",
      "walletUser" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ	必須かどうか	説明
`--client-wallet` / `clientWallet`	必須	クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ)
`--wallet-user` / `walletUser`	必須	ユーザー名

JSONの例

okv admin client-wallet deleteコマンド用にJSON入力を生成します。

okv admin client-wallet delete --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "delete",
    "options" : {
      "clientWallet" : "#VALUE",
      "walletUser" : "#VALUE"
    }
  }
}

生成された入力をファイル(たとえば、client_wallet_delete.json)に保存して、ウォレットから削除するユーザーの名前とクライアント・ウォレットの場所を指定できるように編集します。
```
{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "delete",
    "options" : {
      "clientWallet" : "/home/oracle/okv_client_wallet",
      "walletUser" : "pfitch"
    }
  }
}
```
生成されたJSONファイルを使用して、okv admin client-wallet deleteコマンドを実行します。
```
okv admin client-wallet delete --from-json client_wallet_delete.json
```
出力は、次のようになります。
```
{
  "result" : "Success"
}
```

親トピック: クライアント・ウォレットの管理コマンド

3.1.3 okv admin client-wallet listコマンド

okv admin client-wallet listコマンドでは、クライアント・ウォレットに格納されている資格証明を保持しているユーザーをリストします。

必要な権限

クライアント・ウォレットに対するファイル読取り権限

構文

okv admin client-wallet list --client-wallet client_wallet_location

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

{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "list",
    "options" : {
      "clientWallet" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ	必須かどうか	説明
`--client-wallet` / `clientWallet`	必須	クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ)

JSONの例

okv admin client-wallet listコマンド用にJSON入力を生成します。

okv admin client-wallet list --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "list",
    "options" : {
      "clientWallet" : "#VALUE"
    }
  }
}

生成された入力をファイル(たとえば、client_wallet_list.json)に保存して、クライアント・ウォレットの場所を含めるようにファイルを変更します。
```
{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "list",
    "options" : {
      "clientWallet" : "/home/oracle/okv_client_wallet"
    }
  }
}
```

生成されたJSONファイルを使用して、okv admin client-wallet listコマンドを実行します。

okv admin client-wallet list --from-json client_wallet_list.json

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

{
  "result" : "Success",
  "value" : {
    "walletUsers" : [ "psmith", "pfitch" ]
  }
}

親トピック: クライアント・ウォレットの管理コマンド

3.1.4 okv admin client-wallet updateコマンド

okv admin client-wallet updateコマンドでは、クライアント・ウォレット内のユーザーのパスワードを更新します。

必要な権限

ウォレットに対する読取り/書込みファイル権限

構文

okv admin client-wallet update --client-wallet client_wallet_location --wallet-user user_name

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

{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "update",
    "options" : {
      "clientWallet" : "#VALUE",
      "walletUser" : "#VALUE"
    }
  }
}

パラメータ

パラメータ	必須かどうか	説明
`--client-wallet` / `clientWallet`	必須	クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ)
`--wallet-user` / `walletUser`	必須	ユーザー名

JSONの例

okv admin client-wallet updateコマンド用にJSON入力を生成します。

okv admin client-wallet update --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "update",
    "options" : {
      "clientWallet" : "#VALUE",
      "walletUser" : "#VALUE"
    }
  }
}

生成された入力をファイル(たとえば、client_wallet_update.json)に保存して、ウォレットで更新しようとしているパスワードを保持するユーザーとクライアント・ウォレットの場所を指定できるように編集します。
```
{
  "service" : {
    "category" : "admin",
    "resource" : "client-wallet",
    "action" : "update",
    "options" : {
      "clientWallet" : "/home/oracle/okv_client_wallet",
      "walletUser" : "pfitch"
    }
  }
}
```
生成されたJSONファイルを使用して、okv admin client-wallet updateコマンドを実行します。
```
okv admin client-wallet update --from-json client_wallet_update.json
```
プロンプトが表示されたら、ユーザーのパスワードを入力します。パスワードを入力すると、次のような出力が表示されます。
```
Password: password
{
  "result" : "Success"
}
```

関連項目

okv admin client-wallet listコマンド

親トピック: クライアント・ウォレットの管理コマンド

3.2 エンドポイントの管理コマンド

エンドポイントの管理コマンドを使用すると、エンドポイントの作成やプロビジョニングなどのエンドポイント関連タスクを実行できます。

okv admin endpoint check-statusコマンド
okv admin endpoint check-statusコマンドでは、エンドポイントの現在の状態を表示します。状態はACTIVEまたはPENDINGになります。
okv admin endpoint createコマンド
okv admin endpoint createコマンドでは、新しいエンドポイントをOracle Key Vaultに追加します。
okv admin endpoint deleteコマンド
okv admin endpoint deleteコマンドでは、エンドポイントをOracle Key Vaultから削除します。
okv admin endpoint downloadコマンド
okv admin endpoint downloadコマンドでは、エンドポイント・ソフトウェア(okvclient.jar)を指定したディレクトリにダウンロードします。
okv admin endpoint get-enrollment-tokenコマンド
okv admin endpoint get-enrollment-tokenコマンドでは、登録されたエンドポイントのエンロール・トークンを取得します。
okv admin endpoint provisionコマンド
okv admin endpoint provisionコマンドでは、エンドポイント・ソフトウェアをダウンロードして指定したディレクトリにインストールします。
okv admin endpoint re-enrollコマンド
okv admin endpoint re-enrollコマンドでは、以前にエンロールしたエンドポイントを再エンロールします。
okv admin endpoint re-enroll-allコマンド
okv admin endpoint re-enroll-allコマンドでは、以前にエンロールしたすべてのエンドポイントを再エンロールします。
okv admin endpoint updateコマンド
okv admin endpoint updateコマンドでは、エンドポイントの設定を更新します。

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

3.2.1 okv admin endpoint check-statusコマンド

okv admin endpoint check-statusコマンドでは、エンドポイントの現在の状態を表示します。状態はACTIVEまたはPENDINGになります。

このコマンドは、主にマルチマスター・クラスタ環境に向けられています。ただし、その他のデプロイメントにも有効であり、エンドポイントの存在を確認するために使用できます。

必要な権限

システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限

構文

okv admin endpoint check-status --endpoint endpoint_name|--locator-id UUID

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "check-status",
    "options" : {
      "endpoint" : "#VALUE",
      "locatorID" : "#VALUE"
    }
  }
}

パラメータ

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

パラメータ/テンプレート・パラメータ	必須かどうか	説明
`--endpoint` / `endpoint`または`--locator-id` / `locatorID`	オプション	確認するエンドポイントのエンドポイント名またはロケータID (UUID (universally unique ID))。`--locator-id` / `locatorID`は、マルチマスター・クラスタ環境を使用している場合にのみ必要になります。 `--endpoint` / `endpoint`値または`--locator-id` / `locatorID`値のどちらかを指定する必要があります。その両方は指定できません。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。ロケータIDを調べるには、Oracle Key Vault管理コンソールで、左側のナビゲーションバーにある「Cluster」タブを選択して、「Conflict Resolution」を選択します。「Keys, Secrets & Objects」表で、「Unique Identifier」列を確認します。

--endpoint / endpointまたは--locator-id / locatorID

オプション

確認するエンドポイントのエンドポイント名またはロケータID (UUID (universally unique ID))。--locator-id / locatorIDは、マルチマスター・クラスタ環境を使用している場合にのみ必要になります。

--endpoint / endpoint値または--locator-id / locatorID値のどちらかを指定する必要があります。その両方は指定できません。

既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。

ロケータIDを調べるには、Oracle Key Vault管理コンソールで、左側のナビゲーションバーにある「Cluster」タブを選択して、「Conflict Resolution」を選択します。「Keys, Secrets & Objects」表で、「Unique Identifier」列を確認します。

JSONの例

okv admin endpoint check-statusコマンド用にJSON入力テンプレートを生成します。

okv admin endpoint check-status --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "check-status",
    "options" : {
      "endpoint" : "#VALUE",
      "locatorID" : "#VALUE"
    }
  }
}

生成された入力をファイル(たとえば、check-status_ep.json)に保存して、エンドポイントを確認できるように編集します。endpoint値またはlocatorID値のどちらかを指定します(両方は指定できません)。
```
{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "check-status",
    "options" : {
      "locatorID" : "1AC9B321-6540-4F2B-809B-95FD7416999E"
    }
  }
}
```
生成されたJSONファイルを使用して、okv admin endpoint check-statusコマンドを実行します。
```
okv admin endpoint check-status --from-json check-status_ep.json
```
出力は、次のようになります。
```
{
  "result" : "Success",
  "value" : {
    "status" : "ACTIVE",
    "endpoint" : "HR_DB_EP"
  }
}
```
エンドポイント・オブジェクトがACTIVE状態の場合は、出力にエンドポイントの名前が含まれます。ここに示されるエンドポイント名は、エンドポイントの作成時に指定したものとは異なることがあります。複数のクラスタ・ノードで同じ名前のエンドポイントが作成された場合、Oracle Key Vaultはネーミング競合の解決を実行して、エンドポイント名に_OKVnode-idを追加することで、1つのエンドポイントを除くすべてのエンドポイントの名前を変更します。たとえば、エンドポイントにHR_DB_EPという名前を付けたときにネーミング競合があった場合、その名前はHR_DB_EP_OKV01になります。

マルチマスター・クラスタ以外のデプロイメントでは、このコマンドはエンドポイントが存在している場合にSuccessを返し、出力にはエンドポイント名とその状態を示すエントリは含まれません。

親トピック: エンドポイントの管理コマンド

3.2.2 okv admin endpoint createコマンド

okv admin endpoint createコマンドでは、新しいエンドポイントをOracle Key Vaultに追加します。

必要な権限

システム管理者ロールまたはエンドポイント作成システム権限

エンドポイントを追加すると、このエンドポイントは登録済状態になります。

構文

okv admin endpoint create --endpoint endpoint_name --description "description" --email email_address --platform platform --type type --subgroup "subgroup_value" --unique TRUE|FALSE

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "create",
    "options" : {
      "endpoint" : "#VALUE",
      "description" : "#VALUE",
      "email" : "#VALUE",
      "platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS",
      "type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|OTHER",
      "subgroup" : "#VALUE|NO SUBGROUP|USE CREATOR SUBGROUP",
      "unique" : "#TRUE|FALSE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ	必須かどうか	説明
`--endpoint` / `endpoint`	必須	追加するエンドポイントの名前。「オブジェクトのネーミング・ガイドライン」を参照してください。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。
`--description` / `description`	オプション	わかりやすいエンドポイントの説明。空白が含まれる説明は、二重引用符で囲む必要があります。
`--email` / `email`	オプション	エンドポイント管理者の電子メール・アドレス。この値は二重引用符で囲みます。
`--platform` / `platform`	必須	エンドポイント・プラットフォーム。使用可能な値は次のとおりです。 `LINUX64` `SOLARIS64` `SOLARIS_SPARC` `AIX` `HP-UX` `WINDOWS`
`--type`	必須	エンドポイントのタイプ。使用可能な値は次のとおりです。 `ORACLE_DB` `ORACLE_NON_DB` `ORACLE_ACFS` `MYSQL_DB` `OTHER`
`--subgroup`	オプション	マルチマスター・クラスタ環境の場合は、特定のOracle Key Vaultクラスタ・サブグループに対するエンドポイントのアフィニティを定義します。値は次のとおりです。マルチマスター・クラスタ・サブグループの名前を入力します。サブグループを調べるには、Oracle Key Vault管理コンソールで、「Cluster」タブを選択し、左側のナビゲーションバーにある「Management」を選択します。クラスタのサブグループは、「Cluster Information」の下にリストされています。 `NO SUBGROUP`では、Oracle Key Vaultクラスタ・サブグループのアフィニティを持たないエンドポイントを作成します。 `USE CREATOR SUBGROUP`では、エンドポイントが作成されたノードが属するOracle Key Vaultクラスタ・サブグループへのアフィニティを持つエンドポイントを作成します。
`--unique`	オプション	マルチマスター・クラスタ環境では、一意のエンドポイントとしてエンドポイントを作成します。マルチマスター・クラスタでは、2つの異なるノードから同じ名前のエンドポイントを作成することが可能です。その場合は、エンドポイント名が競合することがあります。Oracle Key Vaultの競合解決スキームでは、1つのエンドポイントに所定の名前が維持され、それ以外の競合する名前を持つエンドポイントは`given_ep_name_OKVnode_id`という形式を使用して名前が付けられます。有効な設定は次のとおりです。 `TRUE`は、所定の名前に`_OKVnode_id`を追加して、このエンドポイント名が競合しないようにします。そのエンドポイントは、すぐに使用可能になります。 `FALSE` (デフォルト)にすると、Oracle Key Vaultによってエンドポイント名が一意であるかどうかを調べるチェック・プロセスが開始されます。一意のIDが返されます。このIDを使用して、エンドポイント作成のステータスが進行中(`PENDING`)であるか、完了している(`ACTIVE`)かを確認できます。ステータスが`PENDING`の場合は、まだ使用できないため、エンドポイントに対して実行されたアクションは失敗します。ステータスが`ACTIVE`の場合、エンドポイントは使用可能です。ステータスを確認するには、`okv admin endpoint check_status`コマンドを実行します。指定した名前が別のノードですでに使用されている場合、このエンドポイントの名前には`_OKVxx`が付加されます。たとえば、エンドポイントに`ep12`という名前を付けてネーミングの競合があった場合、名前は`EP12_OKV01`になります。

JSONの例

okv admin endpoint createコマンド用にJSON入力を生成します。

okv admin endpoint create --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "create",
    "options" : {
      "endpoint" : "#VALUE",
      "description" : "#VALUE",
      "email" : "#VALUE",
      "platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS",
      "type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|OTHER",
      "subgroup" : "#VALUE|NO SUBGROUP|USE CREATOR SUBGROUP",
      "unique" : "#TRUE|FALSE"
    }
  }
}

生成された入力をファイル(たとえば、create_ep.json)に保存して、エンドポイントを作成できるように編集します。

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "create",
    "options" : {
      "endpoint" : "hr_db_ep",
      "description" : "HR database endpoint",
      "email" : "pfitch@example.com",
      "platform" : "LINUX64",
      "type" : "ORACLE_DB",
      "subgroup" : "USE CREATOR SUBGROUP",
      "unique" : "FALSE"
    }
  }
}

生成されたJSONファイルを使用して、okv admin endpoint createコマンドを実行します。
```
okv admin endpoint create --from-json create_ep.json
```
出力は、次のようになります。
```
{
  "result" : "Success",
  "value" : {
    "status" : "PENDING",
    "locatorID" : "1AC9B321-6540-4F2B-809B-95FD7416999E"
  }
}
```
okv admin endpoint check-statusコマンドに前述の出力から得られたlocatorIDを使用すると、エンドポイント・オブジェクトの現在の状態を表示できます。オブジェクト・ステータスがACTIVEの場合、このコマンドは競合名の解決後のオブジェクト名も表示します。

親トピック: エンドポイントの管理コマンド

3.2.3 okv admin endpoint deleteコマンド

okv admin endpoint deleteコマンドでは、エンドポイントをOracle Key Vaultから削除します。

必要な権限

システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限

構文

okv admin endpoint delete --endpoint endpoint_name

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "delete",
    "options" : {
      "endpoint" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ	必須かどうか	説明
`--endpoint` / `endpoint`	必須	エンドポイントの名前。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。

JSONの例

okv admin endpoint deleteコマンド用にJSON入力を生成します。

okv admin endpoint delete --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "delete",
    "options" : {
      "endpoint" : "#VALUE"
    }
  }
}

生成された入力をファイル(たとえば、delete_ep.json)に保存して、エンドポイントを削除できるように編集します。

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "delete",
    "options" : {
      "endpoint" : "sales_db_ep"
    }
  }
}

生成されたJSONファイルを使用して、okv admin endpoint deleteコマンドを実行します。
```
okv admin endpoint delete --from-json delete_ep.json
```
出力は、次のようになります。
```
{
  "result" : "Success"
}
```

親トピック: エンドポイントの管理コマンド

3.2.4 okv admin endpoint downloadコマンド

okv admin endpoint downloadコマンドでは、エンドポイント・ソフトウェア(okvclient.jar)を指定したディレクトリにダウンロードします。

エンドポイント・ソフトウェアのダウンロードとインストールの両方を実行する場合は、okv admin endpoint provisionコマンドを使用します。

必要な権限

システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限

構文

okv admin endpoint download --endpoint endpoint_name --location download_location

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "download",
    "options" : {
      "endpoint" : "#VALUE",
      "location" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ	必須かどうか	説明
`--endpoint` / `endpoint`	必須	エンドポイントの名前。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。
`--location` `location`	必須	エンドポイント・ソフトウェアのダウンロード・ディレクトリの絶対パス。たとえば、`/tmp`を指定すると、エンドポイント・ソフトウェアは`/tmp/endpoint_name/okvclient.jar`にダウンロードされます。

JSONの例

okv admin endpoint downloadコマンド用にJSON入力を生成します。

okv admin endpoint download --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "download",
    "options" : {
      "endpoint" : "#VALUE",
      "location" : "#VALUE"
    }
  }
}

生成された入力をファイル(たとえば、download_ep.json)に保存して、エンドポイントを作成できるように編集します。

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "download",
    "options" : {
      "endpoint" : "hr_db_ep",
      "location": "/opt/downloads/okv"
    }
  }
}

生成されたJSONファイルを使用して、okv admin endpoint downloadコマンドを実行します。
```
okv admin endpoint download --from-json download_ep.json
```
okvclient.jarファイルのダウンロードが成功すると、次の出力が表示されます。
```
{
  "result" : "Success"
}
```

関連項目

okv admin endpoint provisionコマンド

親トピック: エンドポイントの管理コマンド

3.2.5 okv admin endpoint get-enrollment-tokenコマンド

okv admin endpoint get-enrollment-tokenコマンドでは、登録されたエンドポイントのエンロール・トークンを取得します。

エンロール・トークンは、エンドポイントの作成(登録)時に生成されるワンタイム・トークンです。このトークンは、ソフトウェアのダウンロード時およびエンドポイントのインストール時に使用します。okv admin endpoint get-enrollment-tokenは、Oracle Key Vault管理者ではなくエンドポイント管理者がエンドポイントをダウンロードしてプロビジョニングする必要がある場合に役立ちます。こうしたエンドポイント管理者は、一般にOracle Key Vaultユーザーではなく、Oracle Key Vault管理コンソールを使用して、トークンを指定することでエンドポイント・ソフトウェアをダウンロードします。okv admin endpoint get-enrollment-tokenコマンドを使用すると、Oracle Key Vault管理者はRESTfulサービス・ユーティリティを使用してトークンを取得し、アウトオブバンド・チャネル(電子メールなど)を通じてトークンを安全にエンドポイント管理者に渡すことができます。

このコマンドは、登録済状態のエンドポイントに対してのみ機能します。

必要な権限

システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限

構文

okv admin endpoint get-enrollment-token --endpoint endpoint_name

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "get-enrollment-token",
    "options" : {
      "endpoint" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ	必須かどうか	説明
`--endpoint` / `endpoint`	必須	登録されたエンドポイントの名前。登録されたエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。

JSONの例

okv admin endpoint get-enrollment-tokenコマンド用にJSON入力を生成します。

okv admin endpoint get-enrollment-token --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "get-enrollment-token",
    "options" : {
      "endpoint" : "#VALUE"
    }
  }
}

生成された入力をファイル(たとえば、get_token.json)に保存して、エンロール・トークンを取得できるように編集します。

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "get-enrollment-token",
    "options" : {
      "endpoint" : "hr_db_ep"
    }
  }
}

生成されたJSONファイルを使用して、okv admin endpoint get-enrollment-tokenコマンドを実行します。
```
okv admin endpoint get-enrollment-token --from-json get_token.json
```
エンロール・トークンを示す出力は、次のようになります。
```
{
  "result" : "Success",
  "value" : {
    "token" : "Si71duR2mGQ8naSZ"
  }
}
```

親トピック: エンドポイントの管理コマンド

3.2.6 okv admin endpoint provisionコマンド

okv admin endpoint provisionコマンドでは、エンドポイント・ソフトウェアをダウンロードして指定したディレクトリにインストールします。

このディレクトリには、所有者とそのグループに対する読取り権限、書込み権限および実行権限が必要です。たとえば、Oracle Key Vaultエンドポイント・ソフトウェアがOracle Databaseサーバーにインストールされる場合、このエンドポイントのインストール・ディレクトリには、ユーザーoracleおよびoinstallグループによる読取り権限、書込み権限および実行権限がある必要があります。これにより、プロセスは実行時に適切にディレクトリにアクセスできるようになります。

このコマンドを実行するには、次の前提条件を満たす必要があります。

ユーザーには、システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限が必要です。
ソフト・リンク/usr/bin/javaが$ORACLE_HOME/jdk/jre/bin/javaを指していることを確認する必要があります。
インストール・プロセスがokvclient.oraファイルの場所を決定する方法を理解しておく必要があります。

エンドポイント・ソフトウェアをダウンロードするのみでインストールしない場合は、okv admin endpoint downloadコマンドを使用します。

必要な権限

システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限

構文

okv admin endpoint provision --endpoint endpoint_name --location software_location --auto-login TRUE|FALSE

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "provision",
    "options" : {
      "endpoint" : "#VALUE",
      "location" : "#VALUE",
      "autoLogin" : "#TRUE|FALSE"
    }
  }
}

パラメータ

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

--endpoint / endpoint

必須

エンドポイントの名前。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。

--location / location

必須

エンドポイント・ソフトウェアのインストール場所へのパス。透過的データ暗号化(TDE)環境の場合は、インストール・ディレクトリとしてWALLET_ROOT/okvを指定します。

--auto-login / autoLogin

オプション

次のいずれかの値を入力します。

TRUE: 自動ログイン認証を有効にします。
FALSE (デフォルト): Oracle Key Vaultサーバーへの接続に使用するエンドポイント資格証明をパスワードで保護されたウォレットに格納します。--auto-loginがFALSEに設定されていると、対話形式でパスワードの入力が求められます。

JSONの例

okv admin endpoint provisionコマンド用にJSON入力を生成します。

okv admin endpoint provision --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "provision",
    "options" : {
      "endpoint" : "#VALUE",
      "location" : "#VALUE",
      "autoLogin" : "#TRUE|FALSE"
    }
  }
}

生成された入力をファイル(たとえば、provision_ep.json)に保存して、エンドポイント・ソフトウェアをダウンロードしてインストールできるように編集します。

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "provision",
    "options" : {
      "endpoint" : "hr_db_ep",
      "location" : "/u01/opt/oracle/product/okv",
      "autoLogin" : "TRUE"
    }
  }
}

生成されたJSONファイルを使用して、okv admin endpoint provisionコマンドを実行します。
```
okv admin endpoint provision --from-json provision_ep.json
```
出力は、次のようになります。
```
{
  "result" : "Success"
}
```

関連項目

親トピック: エンドポイントの管理コマンド

3.2.7 okv admin endpoint re-enrollコマンド

okv admin endpoint re-enrollコマンドでは、以前にエンロールしたエンドポイントを再エンロールします。

必要な権限

システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限

構文

okv admin endpoint re-enroll --endpoint endpoint_name

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "re-enroll",
    "options" : {
      "endpoint" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ	必須かどうか	説明
`--endpoint` / `endpoint`	必須	エンドポイントの名前。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。

JSONの例

okv admin endpoint re-enrollコマンド用にJSON入力を生成します。

okv admin endpoint re-enroll --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "re-enroll",
    "options" : {
      "endpoint" : "#VALUE"
    }
  }
}

生成された入力をファイル(たとえば、re-enroll_ep.json)に保存して、エンドポイントを再エンロールできるように編集します。
```
{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "re-enroll",
    "options" : {
      "endpoint" : "hr_db_ep"
    }
  }
}
```
生成されたJSONファイルを使用して、okv admin endpoint re-enrollコマンドを実行します。
```
okv admin endpoint re-enroll --from-json re-enroll_ep.json
```
出力は、次のようになります。
```
{
  "result" : "Success"
}
```

親トピック: エンドポイントの管理コマンド

3.2.8 okv admin endpoint re-enroll-allコマンド

okv admin endpoint re-enroll-allコマンドでは、以前にエンロールしたすべてのエンドポイントを再エンロールします。

必要な権限

システム管理者ロール

構文

okv admin endpoint re-enroll-all

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "re-enroll-all"
  }
}

パラメータ

なし

JSONの例

okv admin endpoint re-enroll-allコマンド用にJSON入力を生成します。

okv admin endpoint re-enroll-all --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "re-enroll-all"
  }
}

生成された入力をファイル(たとえば、re-enroll-all_ep.json)に保存します。
生成されたJSONファイルを使用して、okv admin endpoint re-enroll-allコマンドを実行します。
```
okv admin endpoint re-enroll-all --from-json re-enroll-all_ep.json
```
出力は、次のようになります。
```
{
  "result" : "Success"
}
```

親トピック: エンドポイントの管理コマンド

3.2.9 okv admin endpoint updateコマンド

okv admin endpoint updateコマンドでは、エンドポイントの設定を更新します。

必要な権限

システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限

構文

okv admin endpoint update --endpoint endpoint_name --description "description" --email email_address --platform platform --type type  --subgroup "subgroup_value" --unique TRUE|FALSE --name new_endpoint_name

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "update",
    "options" : {
      "endpoint" : "#VALUE",
      "name" : "#VALUE",
      "description" : "#VALUE",
      "email" : "#VALUE",
      "platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS",
      "type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|OTHER",
      "subgroup" : "#VALUE|NO SUBGROUP|USE CREATOR SUBGROUP",
      "unique" : "#TRUE|FALSE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ	必須かどうか	説明
`--endpoint` / `endpoint`	必須	更新するエンドポイントの名前。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。
`--description` / `description`	オプション	エンドポイントについてのわかりやすい説明。空白が含まれる説明は、二重引用符で囲む必要があります。
`--email` / `email`	オプション	エンドポイント管理者の電子メール・アドレス。この値は二重引用符で囲みます。
`--platform` / `platform`	オプション	エンドポイント・プラットフォーム。使用可能な値は次のとおりです。 `LINUX64` `SOLARIS64` `SOLARIS_SPARC` `AIX` `HP-UX` `WINDOWS`
`--type` / `type`	オプション	エンドポイントのタイプ。使用可能な値は次のとおりです。 `ORACLE_DB` `ORACLE_NON_DB` `ORACLE_ACFS` `MYSQL_DB` `OTHER`
`--subgroup` / `subgroup`	オプション	マルチマスター・クラスタ環境の場合は、特定のOracle Key Vaultクラスタ・サブグループに対するエンドポイントのアフィニティを定義します。値は次のとおりです。マルチマスター・クラスタ・サブグループの名前を入力します。サブグループを調べるには、Oracle Key Vault管理コンソールで、「Cluster」タブを選択し、左側のナビゲーションバーにある「Management」を選択します。クラスタのサブグループは、「Cluster Information」の下にリストされています。 `NO SUBGROUP`では、Oracle Key Vaultクラスタ・サブグループのアフィニティを持たないエンドポイントを作成します。 `USE CREATOR SUBGROUP`では、エンドポイントが作成されたノードが属するOracle Key Vaultクラスタ・サブグループへのアフィニティがあるエンドポイントを作成します。
`--unique` / `unique`	オプション	マルチマスター・クラスタ環境では、一意のエンドポイントとしてエンドポイントを作成します。マルチマスター・クラスタでは、2つの異なるノードから同じ名前のエンドポイントを作成することが可能です。その場合は、エンドポイント名が競合することがあります。Oracle Key Vaultの競合解決スキームでは、1つのエンドポイントに所定の名前が維持され、それ以外の競合する名前を持つエンドポイントは`given_ep_name_OKVnode_id`という形式を使用して名前が付けられます。有効な設定は次のとおりです。 `TRUE`は、所定の名前に`_OKVnode_id`を追加して、このエンドポイント名が競合しないようにします。 `FALSE` (デフォルト)にすると、Oracle Key Vaultによってエンドポイント名が一意であるかどうかを調べるチェック・プロセスが開始されます。一意のIDが返されます。このIDを使用して、エンドポイント作成のステータスが進行中(`PENDING`)であるか、完了している(`ACTIVE`)かを確認できます。ステータスが`PENDING`の場合は、まだ使用できないため、エンドポイントに対して実行されたアクションは失敗します。ステータスが`ACTIVE`の場合、エンドポイントは使用可能です。ステータスを確認するには、`okv admin endpoint check_status`コマンドを実行します。指定した名前が別のノードですでに使用されている場合、このエンドポイントの名前には`_OKVxx`が付加されます。たとえば、エンドポイントに`ep12`という名前を付けてネーミングの競合があった場合、名前は`EP12_OKV01`になります。
`--name` / `name`	オプション	エンドポイントの新しい名前。「オブジェクトのネーミング・ガイドライン」を参照してください。

JSONの例

okv admin endpoint updateコマンド用にJSON入力を生成します。

okv admin endpoint update --generate-json-input

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "update",
    "options" : {
      "endpoint" : "#VALUE",
      "name" : "#VALUE",
      "description" : "#VALUE",
      "email" : "#VALUE",
      "platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS",
      "type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|OTHER",
      "subgroup" : "#VALUE|NO SUBGROUP|USE CREATOR SUBGROUP",
      "unique" : "#TRUE|FALSE"
    }
  }
}

生成された入力をファイル(たとえば、update_ep.json)に保存して、エンドポイントを更新できるように編集します。

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "update",
    "options" : {
      "endpoint" : "hr_db_ep",
      "name" : "HR_DB"
    }
  }
}

生成されたJSONファイルを使用して、okv admin endpoint updateコマンドを実行します。
```
okv admin endpoint update --from-json update_ep.json
```
出力は、次のようになります。
```
{
  "result" : "Success",
  "value" : {
    "status" : "PENDING",
    "locatorID" : "C27E950A-0DF3-402E-BB40-4903FC936C85"
  }
}
```
この例は、マルチマスター・クラスタのエンドポイントの名前を変更した場合の出力を示しています。名前の変更時、エンドポイントはネーミング競合解決の間PENDING状態になります。

マルチマスター・クラスタではエンドポイントの名前を変更しないかぎり、statusとlocatorIDのエントリは出力に含まれません。

親トピック: エンドポイントの管理コマンド