3 管理コマンド
管理コマンドは、クライアント・ウォレットとエンドポイントの管理に使用できます。
- クライアント・ウォレットの管理コマンド
クライアント・ウォレットの管理コマンドを使用すると、ユーザー資格証明を格納するクライアント・ウォレットを管理できます。クライアント・ウォレット管理コマンドは、LDAPユーザーおよびデータベース・ユーザーのみをサポートします。 - エンドポイントの管理コマンド
エンドポイントの管理コマンドを使用すると、エンドポイントの作成やプロビジョニングなどのエンドポイント関連タスクを実行できます。
3.1 クライアント・ウォレットの管理コマンド
クライアント・ウォレットの管理コマンドを使用すると、ユーザー資格証明を格納するクライアント・ウォレットを管理できます。クライアント・ウォレット管理コマンドは、LDAPユーザーおよびデータベース・ユーザーのみをサポートします。
- okv admin client-wallet addコマンド
okv admin client-wallet add
コマンドでは、ユーザーの資格証明をクライアント・ウォレットに追加します。クライアント・ウォレットが存在しない場合は、Oracle Key Vaultによって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
コマンドでは、ユーザーの資格証明をクライアント・ウォレットに追加します。クライアント・ウォレットが存在しない場合は、Oracle Key Vaultによって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" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ) |
|
必須 |
ユーザー名 |
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" : "psmith" } } }
- 生成されたJSONファイルを使用して、
okv admin client-wallet add
コマンドを実行します。okv admin client-wallet add --from-json client_wallet_add.json
プロンプトが表示されたら、ユーザーのパスワードを入力します。パスワードを入力すると、次のような出力が表示されます。
Password: password { "result" : "Success" }
ノート:
Oracle Key Vaultリリース21.7より前は、クライアント・ウォレット・ファイルにユーザーへの書込み権限がない場合、ウォレット・クライアント・ファイルにユーザーを追加していなくても、'okv admin client-wallet add'によって成功メッセージが表示されます。Oracle Key Vaultリリース21.7以降、RESTfulサービス・ユーティリティ・コマンドのエラー・メッセージで権限の問題が報告されます
親トピック: クライアント・ウォレットの管理コマンド
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" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ) |
|
必須 |
ユーザー名 |
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" : "psmith" } } }
- 生成された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" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ) |
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", "psmith" ] } }
親トピック: クライアント・ウォレットの管理コマンド
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" } } }
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ) |
|
必須 |
ユーザー名 |
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" : "psmith" } } }
- 生成されたJSONファイルを使用して、
okv admin client-wallet update
コマンドを実行します。okv admin client-wallet update --from-json client_wallet_update.json
プロンプトが表示されたら、ユーザーのパスワードを入力します。パスワードを入力すると、次のような出力が表示されます。
Password: password { "result" : "Success" }
親トピック: クライアント・ウォレットの管理コマンド
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コマンド
okv admin endpoint get
コマンドでは、エンドポイント・グループや関連するウォレットなど、エンドポイントの詳細情報を取得します。 - okv admin endpoint get-enrollment-tokenコマンド
okv admin endpoint get-enrollment-token
コマンドでは、登録されたエンドポイントのエンロール・トークンを取得します。 - okv admin endpoint listコマンド
okv admin endpoint list
コマンドでは、エンドポイントとその関連情報(作成時間、証明書の有効期限、デフォルト・ウォレットなど)をリストします。 - okv admin endpoint list-objectsコマンド
okv admin endpoint list-objects
コマンドでは、指定されたエンドポイントに関連付けられたセキュリティ・オブジェクトをリストします。 - 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 resumeコマンド
okv admin endpoint resume
コマンドでは、一時停止されたエンドポイントを再開します。 - okv admin endpoint suspendコマンド
okv admin endpoint suspend
コマンドでは、エンドポイントを一時停止します。 - 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" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
オプション |
確認するエンドポイントのエンドポイント名またはロケータID (UUID (universally unique ID))。
既存のエンドポイントを調べるには、 ロケータIDを調べるには、このエンドポイントの作成に使用された |
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 [--description <description>] [--email <email>] --endpoint <endpoint> [--platform <platform>] [--ssh-server-host-name <ssh-server-host-name>] [--strict-ip-check <strict-ip-check>] [--subgroup <subgroup>] [--type <type>] [--unique <unique>]
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|SSH_SERVER|OTHER", "subgroup" : "#VALUE|NO SUBGROUP|USE CREATOR SUBGROUP", "strictIpCheck" : "#TRUE|FALSE", "unique" : "#TRUE|FALSE", "sshServerHostName" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
追加するエンドポイントの名前。「オブジェクトのネーミング・ガイドライン」を参照してください。 既存のエンドポイントを調べるには、 |
|
オプション |
エンドポイントについてのわかりやすい説明。空白が含まれる説明は、二重引用符で囲む必要があります。 |
|
オプション |
エンドポイント管理者の電子メール・アドレス。この値は二重引用符で囲みます。 |
|
オプション |
エンドポイント・プラットフォーム。使用可能な値は次のとおりです。
|
|
オプション |
エンドポイントのタイプ。使用可能な値は次のとおりです。
|
|
オプション |
|
|
オプション |
マルチマスター・クラスタ環境の場合は、特定のOracle Key Vaultクラスタ・サブグループに対するエンドポイントのアフィニティを定義します。値は次のとおりです。
|
|
オプション |
Oracle Key Vaultサーバーで特定のエンドポイントの着信IPアドレスをチェックするかどうかを制御します。
ノート: デフォルト値はTRUE です。
|
|
オプション |
マルチマスター・クラスタ環境では、一意のエンドポイントとしてエンドポイントを作成します。マルチマスター・クラスタでは、2つの異なるノードから同じ名前のエンドポイントを作成することが可能です。その場合は、エンドポイント名が競合することがあります。Oracle Key Vaultの競合解決スキームでは、1つのエンドポイントに所定の名前が維持され、それ以外の競合する名前を持つエンドポイントは 有効な設定は次のとおりです。
|
--ssh-server-host-name / sshServerHostName |
オプション |
|
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|SSH_SERVER|OTHER", "subgroup" : "#VALUE|NO SUBGROUP|USE CREATOR SUBGROUP", "strictIpCheck" : "#TRUE|FALSE", "unique" : "#TRUE|FALSE", "sshServerHostName" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
create_ep.json
)に保存して、エンドポイントを作成できるように編集します。{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "create", "options" : { "endpoint" : "hr_db_ep", "description" : "HR database endpoint", "email" : "psmith@example.com", "platform" : "LINUX64", "type" : "ORACLE_DB", "subgroup" : "USE CREATOR SUBGROUP", "strictIpCheck" : "TRUE", "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" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前。 既存のエンドポイントを調べるには、 |
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" : "hr_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 |
必須 |
エンドポイントの名前。 既存のエンドポイントを調べるには、 |
|
必須 |
エンドポイント・ソフトウェアのダウンロード・ディレクトリの絶対パス。たとえば、 |
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" }
親トピック: エンドポイントの管理コマンド
3.2.5 okv admin endpoint getコマンド
okv admin endpoint get
コマンドでは、エンドポイント・グループや関連するウォレットなど、エンドポイントの詳細情報を取得します。
必要な権限
システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限
構文
okv admin endpoint get --endpoint endpoint_name
JSON入力ファイル・テンプレート
{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "get", "options" : { "endpoint" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前。 既存のエンドポイントを調べるには、 |
JSONの例
okv admin endpoint get
コマンド用にJSON入力を生成します。okv admin endpoint get --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "get", "options" : { "endpoint" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
get_ep.json
)に保存し、それを編集してエンドポイントを指定します。{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "get", "options" : { "endpoint" : "hr_db_ep" } } }
- 生成されたJSONファイルを使用して、
okv admin endpoint get
コマンドを実行します。okv admin endpoint get --from-json get_ep.json
出力は、次のようになります。
{ "result" : "Success", "value" : { "administratorEmail" : "", "certificateExpirationTime" : "2023-10-29 14:48:46", "creationTime" : "2021-11-02 14:48:46", "defaultWallet" : "", "description" : "", "effectiveEndpointConfiguration" : { "expirePkcs11PersistentCacheOnDatabaseShutdown" : "FALSE", "serverPollTimeout" : "PT0.3S", "pkcs11ConfigurationParameterRefreshInterval" : "PT10M", "pkcs11InMemoryCacheTimeout" : "PT1H", "pkcs11PersistentCacheRefreshWindow"\" : "PT30M", "pkcs11PersistentCacheTimeout" : "PT24H", "pkcs11TraceDirectoryPath" : "/tmp" }, "effectiveEndpointSettingsForManagedObjects" : { "extractableAttribute" : { "symmetricKey" : "TRUE" } }, "endpoint" : "HR_DB_EP", "endpointConfiguration" : { "expirePkcs11PersistentCacheOnDatabaseShutdown" : "FALSE", "serverPollTimeout" : "", "pkcs11ConfigulationParameterRefreshInterval" : "", "pkcs11InMemoryCacheTimeout" : "", "pkcs11PersistentCacheRefreshWindow" : "", "pkcs11PersistentCacheTimeout" : "", "pkcs11TraceDirectoryPath" : "" }, "endpointGroupMembership" : [ { "endpointGroup" : "EPG_HR", "description" : "" } ], "endpointSettingsForManagedObjects" : { "extractableAttribute" : { "symmetricKey" : "" } }, "ipAddress" : "100.70.00.00", "platform" : "LINUX", "selfEnrolled" : "FALSE", "status" : "ENROLLED", "strictIpCheck" : "TRUE", "type" : "ORACLE DATABASE", "walletAccess" : [ { "access" : "RO", "type" : "VIA ENDPOINT GROUP", "wallet" : "HR_WALLET" } ] } }
effectiveEndpointConfiguration
およびeffectiveEndpointSettingsForManagedObjects
の下の出力は、エンドポイント構成に使用される設定を表します(そのために、名前にeffectiveEndpoint...
が使用されています)。これらは、エンドポイント固有の設定およびグローバル・エンドポイント固有の設定に基づいて決定されます。
親トピック: エンドポイントの管理コマンド
3.2.6 okv admin endpoint get-enrollment-tokenコマンド
okv admin endpoint get-enrollment-token
コマンドでは、登録されたエンドポイントのエンロール・トークンを取得します。
エンロール・トークンは、エンドポイントの作成(登録)時に生成されるワンタイム・トークンです。Oracle Key Vaultでは、このトークンを使用してソフトウェアをダウンロードし、エンドポイントをインストールします。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" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
登録されたエンドポイントの名前。 既存のエンドポイントを調べるには、 |
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.7 okv admin endpoint listコマンド
okv admin endpoint list
コマンドでは、エンドポイントとその関連情報(作成時間、証明書の有効期限、デフォルト・ウォレットなど)をリストします。
必要な権限
システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限
構文
okv admin endpoint list [--limit <limit>] [--platform <platform>] [--status <status>] [--type <type>]
JSON入力ファイル・テンプレート
{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "list", "options" : { "platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS", "type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|SSH_SERVER|OTHER", "status" : "#REGISTERED|ENROLLED|SUSPENDED", "limit" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
オプション |
リストするエンドポイント・オブジェクトの数。
|
--platform /platform |
オプション |
エンドポイント・プラットフォーム。使用可能な値は次のとおりです。
カンマ区切り値の組合せを指定することもできます。フィルタは各値に個別に適用され、OR演算が効果的にサポートされて、結合された結果が返されます。 |
--type / type |
オプション |
エンドポイント・プラットフォームのタイプ。使用可能な値は次のとおりです。
カンマ区切り値の組合せを指定することもできます。フィルタは各値に個別に適用され、OR演算が効果的にサポートされて、結合された結果が返されます。 |
--status / status |
オプション |
エンドポイント・プラットフォームのステータス。使用可能な値は次のとおりです。
カンマ区切り値の組合せを指定することもできます。フィルタは各値に個別に適用され、OR演算が効果的にサポートされて、結合された結果が返されます。 |
JSONの例
okv admin endpoint list
コマンド用にJSON入力テンプレートを生成します。okv admin endpoint list --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "list", "options" : { "platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS", "type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|SSH_SERVER|OTHER", "status" : "#REGISTERED|ENROLLED|SUSPENDED", "limit" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
list_ep.json
)に保存し、それを編集して、フェッチするオブジェクトの数を指定します。{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "list", "options" : { "limit" : "2" } } }
- 生成されたJSONファイルを使用して、
okv admin endpoint list
コマンドを実行します。okv admin endpoint list --from-json list_ep.json
出力は、次のようになります。
{ "result" : "Success", "value" : { "endpoints" : [ { "commonNameOfCertificateIssuer" : "CA", "createdBy" : "OKVADMIN", "creationTime" : "2021-07-13 15:26:47", "defaultWallet" : "HR_WALLET", "description" : " ", "endpoint" : "HR_DB_EP_1", "endpointCertificateExpiration" : "2023-07-13 15:26:47", "enrollmentToken" : "", "ipAddress" : "", "platform" : "LINUX", "status" : "ENROLLED", "type" : "ORACLE DATABASE" }, { "commonNameOfCertificateIssuer" : "CA", "createdBy" : "OKVADMIN", "creationTime" : "2021-06-25 19:22:36", "defaultWallet" : "", "description" : "", "endpoint" : "HR_DB_EP_2", "endpointCertificateExpiration" : "2023-06-25 19:22:36", "enrollmentToken" : "", "ipAddress" : "192.0.2.143", "platform" : "LINUX", "status" : "ENROLLED", "type" : "ORACLE DATABASE" } ], "fetchedObjectCount" : "2" } }
親トピック: エンドポイントの管理コマンド
3.2.8 okv admin endpoint list-objectsコマンド
okv admin endpoint list-objects
コマンドでは、指定されたエンドポイントに関連付けられたセキュリティ・オブジェクトをリストします。
必要な権限
システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限
構文
okv admin endpoint list-objects --endpoint <endpoint> [--exclude-wallet-membership <exclude-wallet-membership>] [--limit <limit>][--state <state>] [--type <type>]
JSON入力ファイル・テンプレート
{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "list-objects", "options" : { "endpoint" : "#VALUE", "state" : "#PRE-ACTIVE|ACTIVE|DEACTIVATED|COMPROMISED|DESTROYED|DESTROYED_COMPROMISED", "type" : "#CERTIFICATE|OPAQUE|PRIVATE_KEY|PUBLIC_KEY|SECRET|SYMMETRIC_KEY", "limit" : "#VALUE", "excludeWalletMembership" : "#TRUE|FALSE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前。 既存のエンドポイントを調べるには、 |
|
オプション |
リストするオブジェクトの数。
|
|
オプション |
各オブジェクトに対してウォレット・メンバーシップを表示するかどうかを制御します。
|
|
オプション |
セキュリティ・オブジェクトのタイプ。使用可能な値は次のとおりです。
カンマ区切り値の組合せを指定することもできます。フィルタは各値に個別に適用され、OR演算が効果的にサポートされて、結合された結果が返されます。 |
|
オプション |
セキュリティ・オブジェクトの状態。使用可能な値は次のとおりです。
カンマ区切り値の組合せを指定することもできます。フィルタは各値に個別に適用され、OR演算が効果的にサポートされて、結合された結果が返されます。 |
JSONの例
okv admin endpoint list-objects
コマンド用にJSON入力テンプレートを生成します。okv admin endpoint list-objects --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "list-objects", "options" : { "endpoint" : "#VALUE", "state" : "#PRE-ACTIVE|ACTIVE|DEACTIVATED|COMPROMISED|DESTROYED|DESTROYED_COMPROMISED", "type" : "#CERTIFICATE|OPAQUE|PRIVATE_KEY|PUBLIC_KEY|SECRET|SYMMETRIC_KEY", "limit" : "#VALUE", "excludeWalletMembership" : "#TRUE|FALSE" } } }
- 生成された入力をファイル(たとえば、
list-obj_ep.json
)に保存し、それを編集して、エンドポイントにレコード数を指定します。{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "list-objects", "options" : { "endpoint" : "sales-ep", "limit" : "8" } } }
- 生成されたJSONファイルを使用して、
okv admin endpoint list-objects
コマンドを実行します。okv admin endpoint list-objects --from-json list-obj_ep.json
出力は、次のようになります。
{ "result" : "Success", "value" : { "fetchedObjectCount" : "8", "managedObjects" : [ { "creatingEndpoint" : "SALES-EP", "creationDate" : "2021-08-04 18:34:52", "deactivationDate" : "2051-10-10 10:10:10", "displayName" : "X.509 Certificate: DN EMAILADDRESS=psmith@example.com, CN=vienna, OU=Security, O=Oracle, L=Reston, ST=VA, C=US", "name" : "ps30090", "protectStopDate" : "2053-10-10 10:10:10", "state" : "PRE-ACTIVE", "type" : "CERTIFICATE", "uuid" : "847D1538-915D-4FD7-BF14-829B1A11FAF9" }, { "creatingEndpoint" : "SALES-EP", "creationDate" : "2021-08-03 21:40:25", "deactivationDate" : "2029-12-25 15:11:11", "displayName" : "Symmetric Key: Name Sales Key 1", "name" : "sales_key_1", "protectStopDate" : "", "state" : "Pre-Active", "type" : "Symmetric Key", "uuid" : "670B600E-1667-4FD1-BF94-C35C4BC81E8B" }, { "creatingEndpoint" : "SALES-EP", "creationDate" : "2021-08-03 21:21:33", "deactivationDate" : "2029-12-25 15:11:11", "displayName" : "X.509 Certificate: DN EMAILADDRESS=psmith@example.com, CN=vienna, OU=Security, O=Oracle, L=Reston, ST=VA, C=US", "name" : "orders_key_1", "protectStopDate" : "2029-12-25 15:11:11", "state" : "Pre-Active", "type" : "Certificate", "uuid" : "0C11B125-B17A-4F90-BF16-F876E5E20A21" }, { "creatingEndpoint" : "SALES-EP", "creationDate" : "2021-08-03 13:36:01", "deactivationDate" : "", "displayName" : "rec_key_1", "protectStopDate" : "", "state" : "Pre-Active", "type" : "Symmetric Key", "uuid" : "780608F6-0CA6-4FC5-BF46-A7B8A36074F7" }, { "creatingEndpoint" : "SALES-EP", "creationDate" : "2021-08-02 15:41:38", "deactivationDate" : "2029-12-25 15:11:11", "displayName" : "X.509 Certificate: DN EMAILADDRESS=psmith@example.com, CN=vienna, OU=Security, O=Oracle, L=Reston, ST=VA, C=US", "name" : "cert_key_1", "protectStopDate" : "2029-12-25 15:11:11", "state" : "Pre-Active", "type" : "Certificate", "uuid" : "72EA8183-98BA-4F5A-BF31-CE7256E29496" }, { "creatingEndpoint" : "SALES-EP", "creationDate" : "2021-07-26 20:19:32", "deactivationDate" : "2029-12-25 15:11:11", "displayName" : "X.509 Certificate: DN EMAILADDRESS=psmith@example.com, CN=vienna, OU=Security, O=Oracle, L=Reston, ST=VA, C=US", "name" : "emp_key_1", "protectStopDate" : "2029-12-25 15:11:11", "state" : "Pre-Active", "type" : "Certificate", "uuid" : "975F17DF-11C1-4F16-BFBC-28E9C200C99F" }, { "creatingEndpoint" : "SALES-EP", "creationDate" : "2021-07-23 17:22:14", "deactivationDate" : "2041-10-10 10:10:10", "displayName" : "emp_key_2", "protectStopDate" : "", "state" : "Active", "type" : "Symmetric Key", "uuid" : "330F5527-0DB2-4FD1-BF54-1FA189C8A765" }, { "creatingEndpoint" : "SALES-EP", "creationDate" : "2021-06-30 21:01:48", "deactivationDate" : "", "displayName" : "Symmetric Key: Name psc7", "name" : "emp_key_2,emp_key_3,emp_key_5,emp_key_6,emp_key_7", "protectStopDate" : "", "state" : "Active", "type" : "Symmetric Key", "uuid" : "7432AED6-6628-4F43-BF7C-9D30023A4301" } ] } }
親トピック: エンドポイントの管理コマンド
3.2.9 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" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前。 既存のエンドポイントを調べるには、 |
|
必須 |
エンドポイント・ソフトウェアのインストール場所へのパス。透過的データ暗号化(TDE)環境の場合は、インストール・ディレクトリとして |
|
オプション |
次のいずれかの値を入力します。
|
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.10 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" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前。 既存のエンドポイントを調べるには、 |
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.11 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.12 okv admin endpoint resumeコマンド
okv admin endpoint resume
コマンドでは、一時停止されたエンドポイントを再開します。
必要な権限
システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限
構文
okv admin endpoint resume --endpoint endpoint_name
JSON入力ファイル・テンプレート
{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "resume", "options" : { "endpoint" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
一時停止されたエンドポイントの名前。 一時停止されているエンドポイントの名前を調べるには、 |
JSONの例
okv admin endpoint resume
コマンド用にJSON入力を生成します。okv admin endpoint resume --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "resume", "options" : { "endpoint" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
resume_ep.json
)に保存し、それを編集して、一時停止されたエンドポイントを指定します。{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "resume", "options" : { "endpoint" : "hr_db_ep" } } }
- 生成されたJSONファイルを使用して、
okv admin endpoint resume
コマンドを実行します。okv admin endpoint resume --from-json resume_ep.json
出力は、次のようになります。
{ "result" : "Success" }
親トピック: エンドポイントの管理コマンド
3.2.13 okv admin endpoint suspendコマンド
okv admin endpoint suspend
コマンドでは、エンドポイントを一時停止します。
必要な権限
システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限
構文
okv admin endpoint suspend --endpoint endpoint_name
JSON入力ファイル・テンプレート
{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "suspend", "options" : { "endpoint" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前。 既存のエンドポイントを調べるには、 |
JSONの例
okv admin endpoint suspend
コマンド用にJSON入力を生成します。okv admin endpoint suspend --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "suspend", "options" : { "endpoint" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
suspend_ep.json
)に保存し、それを編集して、一時停止するエンドポイントを指定します。{ "service" : { "category" : "admin", "resource" : "endpoint", "action" : "suspend", "options" : { "endpoint" : "hr_db_ep" } } }
- 生成されたJSONファイルを使用して、
okv admin endpoint suspend
コマンドを実行します。okv admin endpoint suspend --from-json suspend_ep.json
出力は、次のようになります。
{ "result" : "Success" }
親トピック: エンドポイントの管理コマンド
3.2.14 okv admin endpoint updateコマンド
okv admin endpoint update
コマンドでは、エンドポイントの設定を更新します。
必要な権限
ノート:
endpointSettingsForManagedObject
を更新するには、キー管理者ロールが必要です。また、endpointConfiguration
を更新するには、システム管理者ロールまたは管理対象エンドポイント権限が必要です。
構文
okv admin endpoint update --endpoint current_endpoint_name --name new_endpoint_name --description "description" --email email_address --platform platform --type type --subgroup "subgroup_value" --unique #TRUE|FALSE --strict-ip-check #TRUE|FALSE
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", "sshServerHostName" : "#VALUE", "strictIpCheck" : "#TRUE|FALSE", "endpointConfiguration" : { "expirePkcs11PersistentCacheOnDatabaseShutdown" : "#TRUE|FALSE", "serverPollTimeout" : "#VALUE", "pkcs11ConfigurationParameterRefreshInterval" : "#VALUE", "pkcs11InMemoryCacheTimeout" : "#VALUE", "pkcs11PersistentCacheRefreshWindow" : "#VALUE", "pkcs11PersistentCacheTimeout" : "#VALUE", "pkcs11TraceDirectoryPath" : "#VALUE" }, "endpointSettingsForManagedObjects" : { "extractableAttribute" : { "privateKey" : "#TRUE|FALSE", "symmetricKey" : "#TRUE|FALSE" } } } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
更新するエンドポイントの名前。 既存のエンドポイントを調べるには、 |
|
オプション |
エンドポイントの新しい名前。オブジェクトのネーミング・ガイドラインに従っていることを確認します。「オブジェクトのネーミング・ガイドライン」を参照してください。 |
|
オプション |
エンドポイントについてのわかりやすい説明。空白が含まれる説明は、二重引用符で囲む必要があります。 |
|
オプション |
エンドポイント管理者の電子メール・アドレス。この値は二重引用符で囲みます。 |
|
オプション |
エンドポイント・プラットフォーム。使用可能な値は次のとおりです。
|
|
オプション |
エンドポイントのタイプ。使用可能な値は次のとおりです。
|
|
オプション |
マルチマスター・クラスタ環境の場合は、特定のOracle Key Vaultクラスタ・サブグループに対するエンドポイントのアフィニティを定義します。値は次のとおりです。
|
|
オプション |
マルチマスター・クラスタ環境では、一意のエンドポイントとしてエンドポイントを作成します。マルチマスター・クラスタでは、2つの異なるノードから同じ名前のエンドポイントを作成することが可能です。その場合は、エンドポイント名が競合することがあります。Oracle Key Vaultの競合解決スキームでは、1つのエンドポイントに所定の名前が維持され、それ以外の競合する名前を持つエンドポイントは 有効な設定は次のとおりです。
|
|
オプション |
Oracle Key Vaultサーバーで特定のエンドポイントの着信IPアドレスをチェックするかどうかを制御します。
|
|
オプション |
各 入力できる値は次のとおりです。
|
/ |
オプション |
|
CLIの例
okv admin endpoint update [--description <description>] [--email <email>] --endpoint <endpoint> [--name <name>] [--platform <platform>]
[--ssh-server-host-name <ssh-server-host-name>] [--strict-ip-check <strict-ip-check>] [--subgroup <subgroup>] [--type <type>] [--unique
<unique>]
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", "strictIpCheck" : "#TRUE|FALSE", "endpointConfiguration" : { "expirePkcs11PersistentCacheOnDatabaseShutdown" : "#TRUE|FALSE", "serverPollTimeout" : "#VALUE", "pkcs11ConfigurationParameterRefreshInterval" : "#VALUE", "pkcs11InMemoryCacheTimeout" : "#VALUE", "pkcs11PersistentCacheRefreshWindow" : "#VALUE", "pkcs11PersistentCacheTimeout" : "#VALUE", "pkcs11TraceDirectoryPath" : "#VALUE" }, "endpointSettingsForManagedObjects" : { "extractableAttribute" : { "privateKey" : "#TRUE|FALSE", "symmetricKey" : "#TRUE|FALSE" } } } } }
- 生成された入力をファイル(たとえば、
update_ep.json
)に保存し、それを編集してエンドポイントを更新します。{ "service": { "category": "admin", "resource": "endpoint", "action": "update", "options": { "endpoint": "hr_db_ep", "description": "", "platform": "LINUX64", "email": "", "type": "ORACLE_DB", "strictIpCheck" : "TRUE", "endpointConfiguration" : { "expirePkcs11PersistentCacheOnDatabaseShutdown" : "TRUE", "serverPollTimeout" : "PT5M", "pkcs11ConfigurationParameterRefresh" : "PT11M", "pkcs11InMemoryCacheTimeout" : "PT20M", "pkcs11PersistentCacheRefreshWindow" : "PT30M", "pkcs11PersistentCacheTimeout" : "PT40M", "pkcs11TraceDirectoryPath" : "/users/psmith/work" }, "endpointSettingsForManagedObjects" : { "extractableAttribute" : { "symmetricKey" : "FALSE" } } } } }
- 生成されたJSONファイルを使用して、
okv admin endpoint update
コマンドを実行します。okv admin endpoint update --from-json update_ep.json
出力は、次のようになります。
{ "result" : "Success", }