12 RESTfulサービスを使用したOracle Key Vaultの管理およびキー管理
Oracle Key Vault RESTfulサービス・ユーティリティを使用すると、大規模な分散デプロイメントのOracle Key Vault管理タスクを自動化できます。
- RESTfulサービスについて
RESTfulサービスを使用して自動化できるOracle Key Vaultのタスクには、エンドポイントのエンロール、仮想ウォレット管理およびキー管理が含まれます。 - RESTfulサービスの使用に必要な権限
必要なRESTfulサービス権限は、Oracle Key Vault管理コンソールで同じタスクを実行するために必要な権限と一致しています。 - RESTfulサービスの有効化
エンドポイント要件を確認し、ネットワーク・サービスを有効化した後、RESTfulサービスを有効にしてRESTfulソフトウェア・ユーティリティをダウンロードできます。 - RESTfulサービス構成ファイルの管理
構成ファイルを使用して、RESTfulサービス・コマンドを個別にまたはグループ単位で実行できます。 - RESTfulサービスの無効化
RESTfulサービスは、エンドポイントの登録およびエンロール中の短期間のみ有効にする必要があります。 - Oracle Key Vaultの管理RESTクライアント・ツール・コマンド
RESTfulサービスの管理コマンドは、エンドポイントとエンドポイント・グループを管理する管理者向けに設計されています。 - Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンド
RESTfulサービス・キー管理コマンドは、Oracle Key Vaultにアップロードされるキーの管理を担当する管理者向けに設計されています。
12.1 RESTfulサービスについて
RESTfulサービスを使用して自動化できるOracle Key Vaultのタスクには、エンドポイントのエンロール、仮想ウォレット管理およびキー管理が含まれます。
Oracle Key Vault管理コンソールのユーザー・インタフェースでは複数のエンドポイントを効率的に管理できる一方、エンドポイントと仮想ウォレットの間のアクセス制御マッピングを定義するプロセスは手動となり、管理者がユーザー・インタフェースをクリックして処理する必要があります。
多くの場合、大規模な分散型エンタープライズ・デプロイメントにおいては、一括デプロイメントを可能にするために、スクリプティングによる自動化が必要となります。Oracle Key VaultのRESTfulサービス機能を使用すると、人による操作を削減してより高速にデプロイメントするために、何百ものエンドポイントをエンロールおよびプロビジョニングしたり、エンドポイントとその仮想ウォレットの間のアクセス制御マッピングを定義することができます。また、この機能を使用して、ユーザー、ユーザー・グループおよびエンドポイント・グループの管理を自動化することもできます。
RESTfulサービスを使用すると、エンドポイントのエンロールおよびプロビジョニング、エンドポイント・グループの作成およびエンドポイント、エンドポイント・グループ、仮想ウォレットの間のアクセス制御マッピングの定義を行うことができます。コマンドラインから単一のサービス・コマンドを実行したり、1つのスクリプトから複数のサービス・コマンドを実行することができます。コマンドラインまたはスクリプトからサービス・コマンドを実行するには、特定のプロパティ・セットを含む構成ファイルが必要です。RESTfulサービス・ユーティリティを実行するには、エンドポイントに、少なくともJava Runtime Environmentバージョン1.7.0.21がインストールされている必要があります。
RESTfulサービスは、Oracle Real Application Clusters (Oracle RAC)とマルチテナント環境の両方で使用できます。これらの環境での構成プロセスは、単一インスタンス環境と同じです。Oracle RAC環境では、Oracle Key Vault仮想ウォレットをOracle RACインスタンス間で共有する必要があります。つまり、Oracle Key Vaultでは、各Oracle RAC対応データベースに1つの仮想ウォレットがあります。そのデータベースに属するすべてのエンドポイントは、その仮想ウォレットをデフォルト・ウォレットとして使用します。
RESTfulサービスを使用してエンドポイントをエンロールおよびプロビジョニングした後は、RESTfulサービスを無効にしてOracle Key Vaultへのエントリ・ポイントの数を減らす必要があります。
RESTfulサービス実行処理を使用するには、次の一般的なステップに従います。
-
Oracle Key Vault管理コンソールからRESTfulサービスを有効にします。
-
RESTfulサービス・ユーティリティ
okvrestservices.jar
をダウンロードします。 -
構成ファイルを作成して、実行するサービスのプロパティを設定します。
-
RESTfulサービス・ユーティリティ
okvrestservices.jar
、構成ファイル、サービス・コマンドおよびオプションを使用してサービスを実行します。 -
複数のRESTfulサービス・コマンドを実行するには、次のことを行う必要があります。
-
スクリプトを作成して、このスクリプトにRESTfulコマンドを記述します。
-
RESTfulサービス・ユーティリティ
okvrestservices.jar
、構成ファイルおよびスクリプト・ファイルを使用してサービスを実行します。
-
-
エンドポイントのエンロールおよびプロビジョニングが完了したら、RESTfulサービスを無効にします。
12.2 RESTfulサービスの使用に必要な権限
必要なRESTfulサービス権限は、Oracle Key Vault管理コンソールで同じタスクを実行するために必要な権限と一致しています。
たとえば、エンドポイントを追加および管理する場合は、システム管理者ロールが必要です。ウォレットおよびキーを使用する場合は、キー管理者ロールが必要です。Oracle DatabaseをOracle Key Vaultに接続するには、システム管理者およびキー管理者権限が必要です。MySQLデータベースの場合、MySQLではウォレットが使用されないため、キー管理権限のみが必要となります。RESTfulサービスの使用時に、エンドポイント管理者権限は必要ありません。
RESTfulコマンドを実行するには、システム管理者ロールまたはキー管理者ロールのいずれかが必要です。RESTfulサービスの使用を簡略化するために、これらのロールの両方を持つユーザーを作成できます。通常は、これらの権限の両方が必要な処理を実行する必要があるスクリプトを使用して、Oracle Key Vaultでデータベースを自己登録する必要がある管理者がこのユーザーを使用します。
12.3 RESTfulサービスの有効化
エンドポイント要件を確認し、ネットワーク・サービスを有効化した後、RESTfulサービスを有効にしてRESTfulソフトウェア・ユーティリティをダウンロードできます。
- ステップ1: エンドポイント・システム要件の確認
REST APIでエンドポイントをプロビジョニングするには、ネットワーク上にデータを安全に転送するためのツールが必要です。 - ステップ2: ネットワーク・サービスの有効化
Oracle Key Vaultサーバーにアクセスするには、IPアドレスによってRESTfulクライアント用のWebアクセスを構成する必要があります。 - ステップ3: RESTfulサービスの有効化
ネットワーク・サービスを有効にした後、RESTfulサービスを有効にできます。 - ステップ3: RESTfulソフトウェア・ユーティリティのダウンロード
RESTfulソフトウェア・ユーティリティは、okvrestservices.jar file
にあります。
12.3.1 ステップ1: エンドポイントのシステム要件の確認
REST APIでエンドポイントをプロビジョニングするには、ネットワーク上にデータを安全に転送するためのツールが必要です。
親トピック: RESTfulサービスの有効化
12.3.2 ステップ2: ネットワーク・サービスの有効化
Oracle Key Vaultサーバーにアクセスするには、RESTfulクライアントのWebアクセスをそのIPアドレスごとに構成する必要があります。
親トピック: RESTfulサービスの有効化
12.3.4 ステップ3: RESTfulソフトウェア・ユーティリティのダウンロード
RESTfulソフトウェア・ユーティリティはokvrestservices.jar
ファイルにあります。
注意:
-
サード・パーティの証明書をインストールする場合は、新しい証明書を使用するために、RESTfulソフトウェア・ユーティリティ
okvrestservices.jar
を再度ダウンロードする必要があります。 -
証明書を変更する場合や、新しいソフトウェアまたはバックアップを使用してOracle Key Vaultアプライアンスを再インストールする場合は、常に、RESTfulソフトウェア・ユーティリティを再ダウンロードする必要があります。
-
マルチマスター・クラスタ環境では、読取り/書込みノードから
okvrestservice.jar
をダウンロードする必要があります。読取り専用ノードからダウンロードする場合、Oracle Key Vaultに接続できません。
親トピック: RESTfulサービスの有効化
12.4 RESTfulサービス構成ファイルの管理
構成ファイルを使用すると、RESTfulサービス・コマンドを個別に実行したり、グループ内で実行したりできます。
- RESTfulサービス構成ファイルの管理について
RESTfulサービス・キー管理コマンドは、Oracle Key Vaultにアップロードされるキーの管理を担当する管理者向けに設計されています。 - 構成ファイルの作成のガイドライン
スクリプト実行エラーを回避するには、推奨されるガイドラインに従う必要があります。 - RESTfulサービス構成ファイルの作成
RESTfulサービス・ユーティリティがコマンドの実行に使用するプロパティを構成ファイルに設定する必要があります。 - 構成ファイルの例
IPアドレスおよびホスト名を使用する構成ファイルを作成できます。 - 単一のRESTfulコマンドの実行
数個のコマンドのみを実行する場合は、-r
または--service
オプションを使用して、コマンドラインから個別にコマンドを実行します。 - スクリプトを使用した複数のRESTful管理コマンドの実行
時間と労力を節約し、正確性を確保するには、スクリプトを使用して一連のコマンドを実行します。
12.4.1 RESTfulサービス構成ファイルの管理について
RESTfulサービス・キー管理コマンドは、Oracle Key Vaultにアップロードされるキーの管理を担当する管理者向けに設計されています。
ユーティリティをコマンドラインから実行するか、スクリプトから実行するかにかかわらず、構成ファイルを使用してRESTfulサービス・ユーティリティokvrestservices.jar
を実行する必要があります。Oracle Key Vaultクライアント・ソフトウェアをデプロイしたときに作成されたokvclient.ora
ファイルを使用するか、新しい構成ファイルを作成できます。マルチマスター・クラスタ環境では、独自の構成ファイルを持つ読取り/書込みノードのいずれかを使用できます。ただし、okvclient.ora
を構成ファイルとして使用して、Oracle Key Vaultマルチマスター・クラスタ機能を利用することをお薦めします。
注意:
スクリプト・モードはKMIP RESTfulサービスでは使用できません。関連項目
親トピック: RESTfulサービス構成ファイルの管理
12.4.2 構成ファイル作成のガイドライン
スクリプト実行エラーを回避するには、推奨ガイドラインに従ってください。
-
スクリプトのコマンドおよび構文は、コマンドラインで使用されているものと同じです。
-
スクリプトの各行は、コマンドか、先頭が文字#の行である必要があります。
-
各コマンドを個別の行に記述します。
-
コマンドのない各行は#文字で開始します。
-
コメントおよび空白行には#文字を使用します。
-
コマンド・オプションが出現する順序は関係ありません。
-
すべての必須オプションに有効な値があることを確認します。
-
スクリプトを実行するときに、
-i
または--script
オプションを指定します。 -
-d
または--desc
オプションに使用する説明に空白が含まれる場合は、二重引用符で囲みます。
親トピック: RESTfulサービス構成ファイルの管理
12.4.3 RESTfulサービス構成ファイルの作成
RESTfulサービス・ユーティリティがコマンドの実行に使用するプロパティを構成ファイルに設定する必要があります。
親トピック: RESTfulサービス構成ファイルの管理
12.4.4 構成ファイルの例
IPアドレスおよびホスト名を使用する構成ファイルを作成できます。
例12-1 IPアドレスを使用する構成ファイル
server=192.0.2.254 usr=okvadmin log=/absolute_path_to_log_file/log_file_name log_level=warning client_wallet=/path_to_wallet_that_contains_credentials_for_RESTadmin
例12-2 ホスト名を使用する構成ファイル
server=Prod-OKV-07.example.com usr=okvadmin log=/absolute_path_to_log_file/log_file_name log_level=warning client_wallet=/path_to_wallet_that_contains_credentials_for_RESTadmin
親トピック: RESTfulサービス構成ファイルの管理
12.4.5 単一のRESTfulコマンドの実行
数個のコマンドのみを実行する場合は、-r
または--service
オプションを使用して、コマンドラインから個別にコマンドを実行します。
マルチマスター・クラスタ環境でマルチマスター・クラスタ機能を利用するには、デフォルトの場所のokvclient.ora
構成ファイルを使用する必要があります。okvclient.ora
を使用するかわりに、独自の構成ファイルを使用できます。ただし、スタンドアロン・モードで接続されるため、マルチマスター・クラスタ環境は利用できません。
注意:
コマンドライン・オプションは、構成ファイルまたはスクリプトで指定されたオプションよりも優先されます。たとえば、プロパティusr
が構成ファイルおよびコマンドラインで指定されている場合は、コマンドラインのオプションによって構成ファイルのオプションがオーバーライドされます。
親トピック: RESTfulサービス構成ファイルの管理
12.4.6 1つのスクリプトを使用した複数のRESTful管理コマンドの実行
時間と労力を節約し、正確性を確保するには、スクリプトを使用して一連のコマンドを実行します。
-i
オプションまたは--script
オプションを含むスクリプトを起動して、スクリプト・ファイルのパスを指定する必要があります。これは、KM REST APIを使用したキー管理コマンドの実行には適用されません。構成ファイルでscript
プロパティを定義すると、コマンドラインにこれを入力する必要がなくなります。script
パラメータは、構成ファイルまたはコマンドラインのいずれかで1回のみ入力します。
RESTfulサービス・ユーティリティでは、一度に1つのコマンドが実行されます。コマンドが失敗すると、スクリプトは終了します。実行されたすべてのコマンドの結果は、行番号および実行時にレポートされたメッセージとともにログ・ファイルに表示されます。この情報はすべてのログ・レベルで出現します。
関連項目
親トピック: RESTfulサービス構成ファイルの管理
12.5 RESTfulサービスの無効化
RESTfulサービスは、エンドポイントを登録およびエンロールする間の短期間のみ有効にする必要があります。
12.6 Oracle Key Vaultの管理RESTクライアント・ツール・コマンド
RESTfulサービスの管理コマンドは、エンドポイントとエンドポイント・グループを管理する管理者向けに設計されています。
- RESTfulサービス・コマンド構文
RESTfulサービス・コマンド構文では、ロング形式とショート形式の両方が提供されています。 - RESTfulサービスのウォレット・コマンド構文
RESTfulサービスのウォレット・コマンド構文では、ロング形式とショート形式の両方が提供されています。 - エンドポイントを追加およびエンロールするコマンド
システム管理者ロールで、エンドポイントを追加およびエンロールするRESTfulコマンドを使用する必要があります。 - エンドポイントの詳細を変更するコマンド
エンドポイントの詳細を変更するには、システム管理者ロールが必要です。 - エンドポイント・グループ・コマンド
RESTfulコマンドを使用してエンドポイント・グループを作成および管理するには、システム管理者ロールが必要です。 - 仮想ウォレット・コマンド
仮想ウォレット・コマンドは、仮想ウォレットのライフサイクルを管理し、仮想ウォレットとエンドポイントまたはエンドポイント・グループ間のアクセス制御マッピングを定義します。 - エラー・レポート
RESTfulサービス・ユーティリティには、RESTfulサービス・コマンドをすばやく正常に実行するためにデバッグする強力なエラー・レポートがあります。 - ヘルプ情報
RESTfulサービス・ユーティリティokvrestservices.jar
が提供する有効なオプションおよび使用可能なコマンドに関する情報を参照できます。
12.6.1 RESTfulサービス・コマンド構文
RESTfulサービス・コマンド構文では、ロング形式とショート形式の両方が提供されています。
これらのコマンドを使用するには、エンドポイント管理者である必要があります。
java -jar
コマンドを使用してRESTfulサービス・ユーティリティokvrestservices
を実行し、構成ファイルのパスを指定する必要があります。
次の表に、すべてのRESTfulサービス・コマンドで使用される共通のオプションを示します。
表12-2 RESTful管理サービス・コマンドのリスト
コマンド名 | 説明 |
---|---|
|
エンドポイント・グループにエンドポイントを追加します。エンドポイントがすでに存在する必要があります。 |
|
仮想ウォレットに対するエンドポイントのアクセス権のマッピングを設定します |
|
仮想ウォレットに対するエンドポイント・グループのアクセス権のマッピングを設定します |
|
エンドポイント、エンドポイント・グループまたはウォレットのステータスをチェックします |
|
Oracle Key Vaultにエンドポイントを追加します。追加されると、エンドポイントは登録済状態になります。 |
|
新しいエンドポイント・グループを追加します |
|
一意のエンドポイントをOracle Key Vaultに追加します。 |
|
Oracle Key Vaultに一意の仮想ウォレットを追加します |
|
Oracle Key Vaultに仮想ウォレットを追加します |
|
Oracle Key Vaultからエンドポイントを削除します |
|
エンドポイント・グループを削除します |
|
Oracle Key Vaultから仮想ウォレットを削除します |
|
エンドポイントにエンドポイント・ソフトウェア |
|
エンドポイント・グループからエンドポイントを削除します |
|
仮想ウォレットに対するエンドポイントのアクセス権のマッピングを削除します |
|
仮想ウォレットに対するエンドポイント・グループのアクセス権のマッピングを削除します |
get_default_wallet |
エンドポイントのデフォルト・ウォレットを取得します |
|
エンロール・トークンを取得して、登録されたエンドポイントのエンドポイント・ソフトウェアをダウンロードします |
get_wallets |
エンドポイントのすべての仮想ウォレットを取得します |
|
エンドポイントの説明を変更します |
|
エンドポイントの電子メールを変更します |
|
エンドポイント名を変更します |
|
エンドポイント・プラットフォームを変更します |
|
エンドポイント・タイプを変更します |
|
仮想ウォレットに対するエンドポイントのアクセス権のマッピングを変更します |
|
仮想ウォレットに対するエンドポイント・グループのアクセス権のマッピングを変更します |
|
仮想ウォレットの説明を変更します |
|
エンドポイント・ソフトウェア |
|
エンドポイントを再エンロールします |
|
エンドポイントのデフォルト・ウォレットを設定します |
例12-3 ショート形式のオプションの指定
オプションの前に1つのハイフンを使用してショート形式のオプションを指定します。
java -jar okvrestservices.jar -c path [-r RESTful_service | -i path]
例12-4 ロング形式のオプションの指定
オプションの前に二重ハイフンを使用してロング形式のオプションを指定します。
java -jar okvrestservices.jar --config path [--service RESTful_service | --script path]
12.6.2 RESTfulサービスのウォレット・コマンド構文
RESTfulサービス・ウォレット・コマンド構文では、ロング形式とショート形式の両方が提供されています。
次の例に、--client_wallet
オプションで指定されるOracleウォレットに関連するRESTfulサービス・コマンドを示します。このウォレットは、人による操作なしで自動的にエンドポイントをプロビジョニングできるようにするために、自動モードでのユーザー名およびパスワードを格納します。
これは、仮想ウォレット・コマンドの一部である--wallet
オプションで指定される仮想ウォレットとは異なります。
表12-3 ウォレット・コマンドのオプション
オプション | 必須かどうか | 説明 |
---|---|---|
|
オプション |
ウォレットにユーザーを追加します |
|
オプション |
ウォレットからユーザーを削除します |
|
オプション |
確認を求めることなく、操作を実行します |
|
必須 |
ウォレットの場所の絶対パスを表します |
|
オプション |
ウォレットに対するアクセス権を持つユーザーをリストします |
|
オプション |
ユーザーのパスワードを変更します |
|
必須 |
ウォレット名を表します |
例12-5 ウォレット・コマンド構文
ユーザーのパスワードをclient_wallet
に追加して、RESTfulスクリプトを実行するエンドポイント・データベース管理者がパスワードを見ることができないようにします。
java -jar okvrestservices.jar -c path_to_configuration file/rest.init --client_wallet absolute_path_to_wallet_location --add user
Oracle Key Vault管理コンソールの「Users」タブでこのパスワードがそのユーザー用に作成されたパスワードと一致していることを確認した後に、client_wallet
の資格証明とパスワードを変更します。
java -jar okvrestservices.jar -c path_to_configuration file/rest.init --client_wallet absolute_path_to_wallet_location --modify user
client_walletに資格証明が格納されているすべてのOracle Key Vaultユーザーをリストします。
java -jar okvrestservices.jar --config path_to_configuration file/rest.init --client_wallet absolute_path_to_wallet_location --listuser user
ユーザーの資格証明をclient_wallet
から削除します。
java -jar okvrestservices.jar --config path_to_configuration file/rest.init --client_wallet absolute_path_to_wallet_location --delete user
12.6.3 エンドポイントを追加およびエンロールするコマンド
RESTfulコマンドを使用してエンドポイントを追加およびエンロールするには、システム管理者ロールを持っている必要があります。
- create_endpointコマンド
create_endpoint
コマンドは、Oracle Key Vaultに新しいエンドポイントを追加します。 - create_unique_endpointコマンド
create_unique_endpoint
コマンドは、Oracle Key Vaultに新しい一意のエントポイントを追加します。 - delete_endpointコマンド
delete_endpoint
コマンドは、Oracle Key Vaultからエンドポイントを削除します。 - downloadコマンド
download
コマンドは、指定したディレクトリにエンドポイント・ソフトウェア(okvclient.jar
)をダウンロードします。 - get_enrollment_tokenコマンド
get_enrollment_token
コマンドは、登録済エンドポイントのエンロール・トークンを取得します。 - provisionコマンド
provision
コマンドは、指定されたディレクトリにエンドポイント・ソフトウェアをダウンロードしてインストールします。このディレクトリは存在している必要があります。 - re_enrollコマンド
re_enroll
コマンドは、エンドポイント・ソフトウェアをアップグレードするために、以前にエンロールしたエンドポイントを再エンロールします。
12.6.3.1 create_endpointコマンド
create_endpoint
コマンドは、Oracle Key Vaultに新しいエンドポイントを追加します。
エンドポイントを追加すると、このエンドポイントは登録済状態になります。
構文
ショート形式:
create_endpoint -e endpoint_name -d "description" -q platform -m email_address -t type
ロング形式:
create_endpoint --ep_name endpoint_name --desc "description" --ep_platform platform --ep_email email_address --ep_type type
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
追加するエンドポイントの名前 |
|
オプション |
わかりやすいエンドポイントの説明。空白が含まれる説明は、二重引用符で囲む必要があります。 |
|
必須 |
エンドポイント・プラットフォーム。使用可能な値は次のとおりです。
|
|
必須 |
エンドポイントのタイプ。使用可能な値は次のとおりです。
|
|
オプション |
エンドポイント管理者の電子メール・アドレス |
|
必須 |
|
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、hr_db_ep
というエンドポイントが追加され、これにはオプションの識別説明'HR database endpoint'
、タイプoracle_db
、プラットフォームsolaris64
およびエンドポイント管理者の電子メールpsmith@example.com
が指定されています。
java -jar okvrestservices.jar -c conf_file
-r create_endpoint -e hr_db -d "HR database endpoint" -q solaris64 -t oracle_db -m psmith@example.com -
ロング形式の例
java -jar okvrestservices.jar --config conf_file
--service create_endpoint --ep_name hr_db --desc "HR database endpoint" --ep_platform solaris64 --ep_type oracle_db --ep_email psmith@example.com
親トピック: エンドポイントを追加およびエンロールするコマンド
12.6.3.2 create_unique_endpointコマンド
create_unique_endpoint
コマンドは、Oracle Key Vaultに新しい一意のエンドポイントを追加します。
このコマンドは、マルチマスター・クラスタ環境でのみ使用します。
エンドポイントを作成すると、一意のIDが返されます。このIDを使用して、エンドポイント作成のステータス(進行中(PENDING
)または完了(ACTIVE
))を確認します。ステータスがPENDING
の場合は、まだ使用できないため、エンドポイントに対して実行されたアクションは失敗します。ステータスがACTIVE
の場合、エンドポイントは使用可能です。ステータスを確認するには、-x
または--uid
パラメータにこの一意のIDを指定して、check_object_status
コマンドを実行します。次に、ステータスがACTIVE
の場合、Oracle Key Vaultがこの名前の名前解決を実行した後に、get_object_name
コマンドを実行してエンドポイントの名前を確認します。指定した名前が別のノードですでに使用されている場合、このエンドポイントの名前には_OKVxx
が付加されます。たとえば、エンドポイントにep12
という名前を付けてネーミングの競合があった場合、名前はEP12_OKV01
になります。
構文
ショート形式:
create_unique_endpoint -e endpoint_name -d "description" -q platform -m email_address -t type
ロング形式:
create_unique_endpoint --ep_name endpoint_name --desc "description" --ep_platform platform --ep_email email_address --ep_type type
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
追加するエンドポイントの名前 |
|
オプション |
わかりやすいエンドポイントの説明。空白が含まれる説明は、二重引用符で囲む必要があります。 |
|
必須 |
エンドポイント・プラットフォーム。使用可能な値は次のとおりです。
|
|
必須 |
エンドポイントのタイプ。使用可能な値は次のとおりです。
|
|
必須 |
エンドポイント管理者の電子メール・アドレス |
|
必須 |
|
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、my_db_ep
というエンドポイントが追加され、これにはオプションの識別説明'My database endpoint'
、タイプoracle_db
、プラットフォームsolaris64
およびエンドポイント管理者の電子メールpsmith@example.com
が指定されています。
java -jar okvrestservices.jar -c path_to_okvclient.ora -r create_unique_endpoint -e my_db -d "My database endpoint" -q solaris64 -t oracle_db -m psmith@example.com
ロング形式の例
java -jar okvrestservices.jar --config path_to_okvclient.ora --service create_unique_endpoint --ep_name my_db --desc "My database endpoint" --platform solaris64 --ep_type oracle_db --ep_email psmith@example.com
親トピック: エンドポイントを追加およびエンロールするコマンド
12.6.3.3 delete_endpointコマンド
delete_endpoint
コマンドは、Oracle Key Vaultからエンドポイントを削除します。
エンドポイントを削除するかどうかを尋ねる確認メッセージが表示されます。-f
オプションまたは--force
オプションを使用すると、確認メッセージなしでエンドポイントを削除できます。確認メッセージが抑止されるため、-f
オプションまたは--force
オプションは慎重に使用します。
構文
ショート形式:
delete_endpoint -f -e endpoint_name
ロング形式:
delete_endpoint --force --ep_name endpoint_name
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須。 |
エンドポイントの名前 |
|
オプションです。 |
強制的に削除し、確認メッセージを抑止します |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、確認なしでOracle Key Vaultからsales_db_ep
エンドポイントを削除します。
java -jar okvrestservices.jar -c conf_file -r delete_endpoint -f -e sales_db_ep
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service delete_endpoint --force --ep_name sales_db_ep
親トピック: エンドポイントを追加およびエンロールするコマンド
12.6.3.4 downloadコマンド
download
コマンドは、ユーザーが指定したディレクトリにエンドポイント・ソフトウェア(okvclient.jar
)をダウンロードします。
ディレクトリ・パスは、-o
オプションで指定されます。絶対パスまたは相対パスを指定でき、さらにそのパスを指す環境変数も設定できます。
エンドポイントをエンロールするには、download
コマンドまたはprovision
コマンドのいずれかを使用できます。特定のエンドポイントに対して両方のコマンドを使用することはできません。
構文
ショート形式:
download -e endpoint_name -o directory
ロング形式:
download --ep_name endpoint_name -dir directory
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
エンドポイント・ソフトウェアのダウンロード・ディレクトリの絶対パス。たとえば、 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、エンドポイント・ソフトウェアokvclient.jar
は、エンドポイントhr_db_ep
の/home/oracle/downloads/hr_db_ep/okvclient.jar
にダウンロードされます。
java -jar okvrestservices.jar -c conf_file -r download -e hr_db_ep -o /home/oracle/downloads/
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service download --ep_name hr_db_ep --dir /home/oracle/downloads/
親トピック: エンドポイントを追加およびエンロールするコマンド
12.6.3.5 get_enrollment_tokenコマンド
get_enrollment_token
コマンドは、登録済エンドポイントのエンロール・トークンを取得します。
このコマンドは、登録済状態のエンドポイントに対してのみ機能します。
構文
ショート形式:
get_enrollment_token -e endpoint_name
ロング形式:
get_enrollment_token --ep_name endpoint_name
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前。 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、登録済エンドポイントhr_db_ep
がエンロール・トークンを取得します。これは、エンドポイントにエンドポイント・ソフトウェアをダウンロードしてインストールするために使用されます。
java -jar okvrestservices.jar -c conf_file -r get_enrollment_token -e hr_db_ep
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service get_enrollment_token --ep_name hr_db_ep
親トピック: エンドポイントを追加およびエンロールするコマンド
12.6.3.6 provisionコマンド
provision
コマンドは、指定されたディレクトリ(存在する必要があります)にエンドポイント・ソフトウェアをダウンロードしてインストールします。
このディレクトリには、所有者とそのグループに対する読取り権限、書込み権限および実行権限が必要です。たとえば、Oracle Key Vaultエンドポイント・ソフトウェアがOracle Databaseサーバーにインストールされる場合、このエンドポイントのインストール・ディレクトリには、ユーザーoracle
およびoinstall
グループによる読取り権限、書込み権限および実行権限がある必要があります。これにより、プロセスは実行時に適切にディレクトリにアクセスできるようになります。
このコマンドを実行するには、次の前提条件を満たす必要があります。
-
システム管理権限を持つユーザーである必要があります。
-
ソフト・リンク
/usr/bin/java
が$ORACLE_HOME/jdk/jre/bin/java
を指していることを確認する必要があります。 -
インストール・プロセスが
okvclient.ora
ファイルの場所を決定する方法を理解しておく必要があります。
エンドポイントをエンロールするには、download
コマンドまたはprovision
コマンドのいずれかを使用できます。特定のエンドポイントに対して両方のコマンドを使用することはできません。
構文
ショート形式:
provision [-a|-v account_pwd ] -e endpoint_name -o directory_path
ロング形式:
認証にパスワードが使用される場合:
provision --endpoint_password account_pwd -ep_name endpoint_name --dir directory_path
パスワードが使用されない場合(自動ログイン):
provision --autologin -ep_name endpoint_name --dir directory_path
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前。 |
|
必須 |
エンドポイント・ソフトウェアをダウンロードしてインストールする既存のディレクトリ |
|
オプション |
エンドポイントのパスワード。このオプションを省略すると(セキュリティ強化のためにお薦めします)、 |
|
必須 |
Oracle Key Vaultサーバーに接続するためのエンドポイントの資格証明が、自動ログイン・ウォレットに格納されます。 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
自動ログイン・モード:
この例では、エンドポイントhr_db_ep
のエンドポイント・ソフトウェアは、パスワードなし(自動ログイン・モード)でディレクトリ/home/oracle/okvutil
にインストールされます。
java -jar okvrestservices.jar -c conf_file -r provision -e hr_db_ep -o /home/oracle/okvutil/ -a
パスワード保護モード:
この例では、エンドポイントhr_db_ep
のエンドポイント・ソフトウェアは、パスワード付きでディレクトリ/home/oracle/okvutil
にインストールされます。パスワード・オプション(-v --client_password
)が省略されているため、要求に応じてパスワードをコマンドラインで入力する必要があります。
java -jar okvrestservices.jar -c conf_file -r provision -e hr_db_ep -o /home/oracle/okvutil/
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service provision --autologin --ep_name hr_db_ep --dir /home/oracle/okvutil/ -a
java -jar okvrestservices.jar --config conf_file --service provision --autologin --ep_name hr_db_ep --dir /home/oracle/okvutil/ -a
java -jar okvrestservices.jar --config conf_file --service provision --ep_name hr_db_ep --dir /home/oracle/okvutil/
親トピック: エンドポイントを追加およびエンロールするコマンド
12.6.3.7 re_enrollコマンド
re_enroll
コマンドは、エンドポイント・ソフトウェアをアップグレードするために、すでにエンロール済のエンドポイントを再エンロールします。
構文
ショート形式:
re_enroll -e endpoint_name
ロング形式:
re_enroll --ep_name endpoint_name
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、エンドポイントhr_db_ep
が再エンロールされます。
java -jar okvrestservices.jar -c conf_file -r re_enroll -e hr_db_ep
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service re_enroll --ep_name hr_db_ep
親トピック: エンドポイントを追加およびエンロールするコマンド
12.6.4 エンドポイントの詳細を変更するコマンド
エンドポイントの詳細を変更するには、システム管理者ロールが必要です。
- modify_endpoint_emailコマンド
modify_endpoint_email
コマンドは、エンドポイントの電子メール・アドレスを変更します。 - modify_endpoint_descコマンド
modify_endpoint_desc
コマンドは、エンドポイントの説明を変更します。 - modify_endpoint_nameコマンド
modify_endpoint_name
コマンドは、エンドポイントの名前を変更します。 - modify_endpoint_platformコマンド
modify_endpoint_platform
コマンドは、エンドポイントのプラットフォームを変更します。 - modify_endpoint_typeコマンド
modify_endpoint_type
コマンドは、エンドポイント・タイプを変更します。
12.6.4.1 modify_endpoint_emailコマンド
modify_endpoint_email
コマンドは、エンドポイントの電子メール・アドレスを変更します。
構文
ショート形式:
modify_endpoint_email -e endpoint_name -m endpoint_email_address
ロング形式:
modify_endpoint_email --ep_name endpoint_name --ep_email endpoint_email_address
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
このエンドポイントの新しい電子メール・アドレス |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例は、エンドポイントhr_db
の電子メールをtjones@example.com
に変更します。
java -jar okvrestservices.jar -c conf_file -r modify_endpoint_email -e hr_db -m tjones@example.com
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service modify_endpoint_email --ep_name hr_db --ep_email tjones@example.com
親トピック: エンドポイントの詳細を変更するコマンド
12.6.4.2 modify_endpoint_descコマンド
modify_endpoint_desc
コマンドは、エンドポイントの説明を変更します。
構文
ショート形式:
modify_endpoint_desc -e endpoint_name -d "new_desc"
ロング形式:
modify_endpoint_desc --ep_name endpoint_name --desc "new_desc"
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
二重引用符で囲まれたこのエンドポイントの新しい説明文字列 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例は、エンドポイントhr_db
の説明をHR database endpoint group
に変更します。
java -jar okvrestservices.jar -c conf_file -r modify_endpoint_desc -e hr_db -d "HR database endpoint group"
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service modify_endpoint_desc --ep_name hr_db --desc "HR database endpoint group"
親トピック: エンドポイントの詳細を変更するコマンド
12.6.4.3 modify_endpoint_nameコマンド
modify_endpoint_name
コマンドは、エンドポイントの名前を変更します。
構文
ショート形式:
modify_endpoint_name -e endpoint_name -n new_endpoint_name
ロング形式:
modify_endpoint_name --ep_name endpoint_name --ep_new_name new_endpoint_name
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
このエンドポイントの新しい名前 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例は、エンドポイントhr_db
の名前をhr_db_ep
の名前に変更します。
java -jar okvrestservices.jar -c conf_file -r modify_endpoint_name -e hr_db -k hr_db_ep
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service modify_endpoint_name --ep_name hr_db --ep_new_name hr_db_ep
親トピック: エンドポイントの詳細を変更するコマンド
12.6.4.4 modify_endpoint_platformコマンド
modify_endpoint_platform
コマンドは、エンドポイントのプラットフォームを変更します。
構文
ショート形式:
modify_endpoint_platform -e endpoint_name -q endpoint_platform
ロング形式:
modify_endpoint_platform --ep_name endpoint_name --ep_platform endpoint_platform
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
このエンドポイントのサーバーのプラットフォーム。値は次のとおりです。
|
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例は、エンドポイントhr_db
のプラットフォームをaix
に変更します。
java -jar okvrestservices.jar -c conf_file -r modify_endpoint_platform -e hr_db -q aix
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service modify_endpoint_platform --ep_name hr_db --ep_platform aix
親トピック: エンドポイントの詳細を変更するコマンド
12.6.4.5 modify_endpoint_typeコマンド
modify_endpoint_type
コマンドは、エンドポイント・タイプを変更します。
構文
ショート形式:
modify_endpoint_type -e endpoint_name -t endpoint_type
ロング形式:
modify_endpoint_type --ep_name endpoint_name --ep_type endpoint_type
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
エンドポイントのタイプ。値は次のとおりです。
|
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例は、エンドポイントhr_db
のエンドポイント・タイプをoracle_db
に変更します。
java -jar okvrestservices.jar -c conf_file -r modify_endpoint_type -e hr_db -t oracle_db
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service modify_endpoint_type --ep_name hr_db --ep_type oracle_db
親トピック: エンドポイントの詳細を変更するコマンド
12.6.5 エンドポイント・グループ・コマンド
RESTfulコマンドを使用してエンドポイント・グループを作成および管理するには、システム管理者ロールが必要です。
- add_epg_memberコマンド
add_epg_member
コマンドは、既存のエンドポイントをエンドポイント・グループに追加します。 - create_endpoint_groupコマンド
create_endpoint_group
コマンドは、新しいエンドポイント・グループを作成します。 - create_unique_endpoint_groupコマンド
create_unique_endpoint_group
コマンドは、新しいエンドポイント・グループを作成します。 - delete_endpoint_groupコマンド
delete_endpoint_group
コマンドは、エンドポイント・グループをOracle Key Vaultから削除します。 - drop_epg_memberコマンド
drop_epg_member
コマンドは、エンドポイントをエンドポイント・グループから削除します。 - modify_endpoint_group_descコマンド
modify_endpoint_group_desc
コマンドは、エンドポイント・グループの説明を変更します。
12.6.5.1 add_epg_memberコマンド
add_epg_member
コマンドは、エンドポイント・グループに既存のエンドポイントを追加します。
構文
ショート形式:
add_epg_member -g endpoint_group_name -e endpoint_member
ロング形式:
add_epg_member --epg_name endpoint_group_name --ep_name endpoint_member
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
エンドポイント・グループの名前 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、hr_db_ep
というエンドポイントがエンドポイント・グループepg_hr
に追加されることを示しています。
java -jar okvrestservices.jar -c conf_file -r add_epg_member -g epg_hr -e hr_db_ep
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service add_epg_member --epg_name epg_hr --ep_name hr_db_ep
親トピック: エンドポイント・グループ・コマンド
12.6.5.2 create_endpoint_groupコマンド
create_endpoint_group
コマンドは、新しいエンドポイント・グループを作成します。
構文
ショート形式:
create_endpoint_group -g endpoint_group_name -d "endpoint group description"
ロング形式:
create_unique_endpoint_group --epg_name endpoint_group_name --desc "endpoint grouop description"
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイント・グループの名前 |
|
オプション |
二重引用符で囲まれたエンドポイント・グループのわかりやすい説明 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、説明HR endpoint group
が付加されたepg_hr
というエンドポイント・グループが作成されることを示しています。
java -jar okvrestservices.jar -c conf_file -r create_unique_endpoint_group --epg_name EPG3 --desc "EPG test"
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service create_endpoint_group --epg_name epg_hr --desc "HR endpoint group"
親トピック: エンドポイント・グループ・コマンド
12.6.5.3 create_unique_endpoint_groupコマンド
create_unique_endpoint_group
コマンドは、新しい一意のエンドポイント・グループを作成します。
このコマンドは、マルチマスター・クラスタ環境でのみ使用します。
エンドポイント・グループを作成すると、一意のIDが返されます。このIDを使用して、エンドポイント・グループ作成のステータス(進行中(PENDING
)または完了(ACTIVE
))を確認します。ステータスがPENDING
の場合は、まだ使用できないため、エンドポイント・グループに対して実行されたアクションは失敗します。ステータスがACTIVE
の場合、エンドポイント・グループを使用できます。ステータスを確認するには、-x
または--uid
パラメータにこの一意のIDを指定して、check_object_status
コマンドを実行します。次に、ステータスがACTIVE
の場合、Oracle Key Vaultがこの名前の名前解決を実行した後に、get_object_name
コマンドを実行してエンドポイント・グループの名前を確認します。指定した名前が別のノードですでに使用されている場合は、このエンドポイント・グループの名前に_OKVxx
が付加されます。たとえば、エンドポイント・グループにepg12
という名前を付けてネーミングの競合があった場合、名前はEPG12_OKV01
になります。
構文
ショート形式:
create_unique_endpoint_group -g unique_endpoint_group_name -d "unique_endpoint group description"
ロング形式:
create_unique_endpoint_group --epg_name endpoint_group_name --desc "endpoint group description"
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイント・グループの名前 |
|
オプション |
二重引用符で囲まれたエンドポイント・グループのわかりやすい説明 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、説明HR endpoint group
が付加されたepg_hr
というエンドポイント・グループが作成されることを示しています。
java -jar okvrestservices.jar -c path_to_okvclient.ora -r create_unique_endpoint_group --epg_name EPG3 --desc "EPG test"
ロング形式の例
java -jar okvrestservices.jar --config path_to_okvclient.ora --service create_unique_endpoint_group --epg_name epg_hr --desc "HR endpoint group"
親トピック: エンドポイント・グループ・コマンド
12.6.5.4 delete_endpoint_groupコマンド
delete_endpoint_group
コマンドは、Oracle Key Vaultからエンドポイント・グループを削除します。
構文
ショート形式:
delete_endpoint_group -f -g endpoint_group
ロング形式:
delete_endpoint_group --force --endpoint_group
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイント・グループの名前 |
|
オプション |
強制的に削除し、確認メッセージを抑止します |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、エンドポイント・グループepg_hr
を削除します。
java -jar okvrestservices.jar -c conf_file -r delete_endpoint_group -f -g epg_hr
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service delete_endpoint_group --force --epg_name epg_hr
親トピック: エンドポイント・グループ・コマンド
12.6.5.5 drop_epg_memberコマンド
drop_epg_member
コマンドは、エンドポイント・グループからエンドポイントを削除します。
構文
ショート形式:
drop_epg_member -g endpoint_group -e endpoint_name
ロング形式:
drop_epg_member --epg_name endpoint_name --ep_name endpoint_group
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
エンドポイント・グループの名前 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、エンドポイントhr_db_ep
がエンドポイント・グループepg_hr
から削除されることを示しています。
java -jar okvrestservices.jar -c conf_file -r drop_epg_member -e hr_db_ep -g epg_hr
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service drop_epg_member --ep_name hr_db_ep --epg_name epg_hr
親トピック: エンドポイント・グループ・コマンド
12.6.5.6 modify_endpoint_group_descコマンド
modify_endpoint_group_desc
コマンドは、エンドポイント・グループの説明を変更します。
構文
ショート形式:
modify_endpoint_group_desc -g endpoint_group_name -d "endpoint_group_description"
ロング形式:
modify_endpoint_group_desc --epg_name endpoint_group_name --desc "endpoint_group_description"
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイント・グループの名前 |
|
必須 |
二重引用符で囲まれたエンドポイント・グループの新しい説明文字列 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、エンドポイント・グループepg_hr
が説明"HR DB endpoint group
"を取得することを示しています。
java -jar okvrestservices.jar -c conf_file -r modify_endpoint_group_desc -g epg_hr -d "HR DB endpoint group"
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service modify_endpoint_group_desc --epg_name epg_hr --desc "HR DB endpoint group"
親トピック: エンドポイント・グループ・コマンド
12.6.6 仮想ウォレット・コマンド
仮想ウォレット・コマンドは、仮想ウォレットのライフサイクルを管理し、仮想ウォレットとエンドポイントまたはエンドポイント・グループ間のアクセス制御マッピングを定義します。
ウォレット・コマンドを実行するには、キー管理者ロールが必要です。
- add_wallet_access_epコマンド
add_wallet_access_ep
コマンドは、エンドポイントに仮想ウォレットへのアクセス・レベルを付与します。 - add_wallet_access_epgコマンド
add_wallet_access_epg
コマンドは、エンドポイント・グループに仮想ウォレットへのアクセス・レベルを付与します。 - check_object_statusコマンド
check_object_status
コマンドは、エンドポイント、エンドポイント・グループまたはウォレットのステータスをチェックします。 - create_unique_walletコマンド
create_unique_wallet
コマンドは、一意の仮想ウォレットを作成します。 - create_walletコマンド
create_wallet
コマンドは、仮想ウォレットを作成します。 - delete_walletコマンド
delete_wallet
コマンドは、Oracle Key Vaultからウォレットを削除します。 - drop_wallet_access_epコマンド
drop_wallet_access_ep
コマンドは、ウォレットへのエンドポイントのアクセス権を削除します。 - drop_wallet_access_epgコマンド
drop_wallet_access_epg
コマンドは、ウォレットへのエンドポイント・グループのアクセス権を削除します。 - get_default_walletコマンド
get_default_wallet
コマンドは、エンドポイントに関連付けられているデフォルト・ウォレットを取得します。 - get_object_nameコマンド
get_object_name
コマンドは、オブジェクトのステータスがACTIVE
の場合に管理対象オブジェクトの名前を取得します。 - get_walletsコマンド
get_wallets
コマンドは、エンドポイントに関連付けられているすべての仮想ウォレットを取得します。 - modify_wallet_access_epコマンド
modify_wallet_access_ep
コマンドは、エンドポイントへの仮想ウォレットのアクセス・レベルを変更します。 - modify_wallet_access_epgコマンド
modify_wallet_access_epg
コマンドは、エンドポイント・グループへの仮想ウォレットのアクセス・レベルを変更します。 - modify_wallet_descコマンド
modify_wallet_desc
コマンドは、既存の仮想ウォレットの説明を変更します。 - set_default_walletコマンド
set_default_wallet
コマンドは、エンドポイントのデフォルト・ウォレットを設定します。
12.6.6.1 add_wallet_access_epコマンド
add_wallet_access_ep
コマンドは、エンドポイントに仮想ウォレットに対するアクセス・レベルを付与します。
構文
ショート形式:
add_wallet_access_ep -e endpoint_name -w virtual_wallet_name -l wallet_access_level
ロング形式:
add_wallet_access_ep --ep_name endpoint_name --wallet_name virtual_wallet_name --access_level wallet_access_level
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
仮想ウォレットの名前 |
|
必須 |
仮想ウォレットに対するアクセス・レベル。値は次のとおりです。
|
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、エンドポイントhr_db_ep
に、ウォレットhr_wallet
に対する読取り専用アクセス権限を追加します。
java -jar okvrestservices.jar -c conf_file -r add_wallet_access_ep -e hr_db_ep -w hr_wallet -l ro
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service add_wallet_access_ep --ep_name hr_db_ep --wallet_name hr_wallet --access_level ro
親トピック: 仮想ウォレット・コマンド
12.6.6.2 add_wallet_access_epgコマンド
add_wallet_access_epg
コマンドは、エンドポイント・グループに仮想ウォレットに対するアクセス・レベルを付与します。
構文
ショート形式:
add_wallet_access_epg -g endpoint_group_name -w virtual_wallet_name -l virtual_wallet_access_level
ロング形式:
add_wallet_access_epg --epg_name endpoint_group_name --wallet_name virtual_wallet_name --access_level wallet_access_level
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイント・グループの名前 |
|
必須 |
仮想ウォレットの名前 |
|
必須 |
仮想ウォレットに対するアクセス・レベル。値は次のとおりです。
|
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、エンドポイント・グループepg_hr
に読取り専用アクセス権が付与されることを示しています。
java -jar okvrestservices.jar -c conf_file -r add_wallet_access_epg -g epg_hr -w hr_wallet -l ro
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service add_wallet_access_epg -epg_name epg_hr --wallet_name hr_wallet --access_level ro
親トピック: 仮想ウォレット・コマンド
12.6.6.3 check_object_statusコマンド
check_object_status
コマンドを使用して、エンドポイント、エンドポイント・グループまたはウォレットのステータスをチェックします。
このコマンドは、マルチマスター・クラスタ環境でのみ使用します。
構文
ショート形式:
check_object_status -b EP|EPG|WALLET -x uuid
ロング形式:
check_object_status --type EP|EPG|WALLET --uuid uuid
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
チェックするオブジェクト・タイプ |
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
|
必須 |
チェックするオブジェクト・タイプを指定します。有効な値は次のとおりです。
|
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、指定したUUIDのウォレットのステータスを表示します。
java -jar okvrestservices.jar -c path_to_okvclient.ora -r check_object_status -b WALLET -x 7C3DC1FF-213A-4FBE-BF4A-98A04F8D05DF
ロング形式の例
java -jar okvrestservices.jar --config path_to_okvclient.ora --service check_object_status --type WALLET --uid 7C3DC1FF-213A-4FBE-BF4A-98A04F8D05DF
親トピック: 仮想ウォレット・コマンド
12.6.6.4 create_unique_walletコマンド
create_unique_wallet
コマンドは一意の仮想ウォレットを作成します。
このコマンドは、マルチマスター・クラスタ環境でのみ使用します。
このコマンドを使用するには、okvclient.ora
ファイルを構成ファイルとして参照する必要があります。ウォレットを作成すると、一意のIDが返されます。このIDを使用して、ウォレット作成のステータス(進行中(PENDING
)または完了(ACTIVE
))を確認します。ステータスがPENDING
の場合、まだ使用できないため、ウォレットに対して実行されたアクションは失敗します。ステータスがACTIVE
の場合、ウォレットは使用可能です。ステータスを確認するには、-x
または--uid
パラメータにこの一意のIDを指定して、check_object_status
コマンドを実行します。次に、ステータスがACTIVE
の場合、Oracle Key Vaultがこの名前の名前解決を実行した後に、get_object_name
コマンドを実行してウォレットの名前を確認します。指定した名前が別のノードですでに使用されている場合は、このウォレットの名前に_OKVxx
が付加されます。たとえば、ウォレットにWALLET12
という名前を付けてネーミングの競合があった場合、名前はwallet12_OKV01
になります。
構文
ショート形式:
create_unique_wallet -w wallet_name -d "wallet_description"
ロング形式:
create_unique_wallet --wallet_name wallet_name --desc "wallet_description"
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
作成する一意のウォレットの名前 |
|
オプション |
二重引用符で囲まれた一意のウォレットのわかりやすい名前。 |
|
必須 |
|
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、my_wallet
という名前の一意の仮想ウォレットをMy unique wallet
という説明を付けて作成します。
java -jar okvrestservices.jar -c path_to_okvclient.ora
-r create_unique_wallet -w my_wallet -d "My unique wallet"
ロング形式の例
java -jar okvrestservices.jar --config path_to_okvclient.ora
--service create_unique_wallet --wallet my_wallet --desc "My unique wallet"
親トピック: 仮想ウォレット・コマンド
12.6.6.5 create_walletコマンド
create_wallet
コマンドは仮想ウォレットを作成します。
構文
ショート形式:
create_wallet -w virtual_wallet_name -d "wallet_description"
ロング形式:
create_wallet --wallet_name wallet_name --desc "wallet_description"
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
仮想ウォレットの名前 |
|
オプション |
二重引用符で囲まれた仮想ウォレットのわかりやすい名前 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、hr_wallet
という名前のウォレットをVirtual wallet for HR endpoint
という説明を付けて作成します。
java -jar okvrestservices.jar -c conf_file -r create_wallet -w hr_wallet -d "Virtual wallet for HR endpoint"
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service create_wallet --wallet hr_wallet --desc "Virtual wallet for HR endpoint"
親トピック: 仮想ウォレット・コマンド
12.6.6.6 delete_walletコマンド
delete_wallet
コマンドは、Oracle Key Vaultからウォレットを削除します。
構文
ショート形式:
delete_wallet -f -w virtual_wallet_name
ロング形式:
delete_wallet --force --wallet_name virtual_wallet_name
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
仮想ウォレットの名前 |
|
オプション |
確認を求めることなく、強制的に削除します |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、確認なしでウォレットhr_wallet
を削除します。
java -jar okvrestservices.jar -c conf_file -r delete_wallet -f -w hr_wallet
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service delete_wallet --force --wallet_name hr_wallet
親トピック: 仮想ウォレット・コマンド
12.6.6.7 drop_wallet_access_epコマンド
drop_wallet_access_ep
コマンドは、ウォレットに対するエンドポイントのアクセス権を削除します。
構文
ショート形式:
drop_wallet_access_ep -e endpoint_name -w virtual_wallet_name
ロング形式:
drop_wallet_access_ep --ep_name endpoint_name --wallet_name virtual_wallet_name
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
仮想ウォレットの名前 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、エンドポイントhr_db_ep
のウォレットhr_wallet
に対するアクセス権を削除します。
java -jar okvrestservices.jar -c conf_file -r drop_wallet_access_ep -e hr_db_ep -w hr_wallet
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service drop_wallet_access_ep --ep_name hr_db_ep --wallet_name hr_wallet
親トピック: 仮想ウォレット・コマンド
12.6.6.8 drop_wallet_access_epgコマンド
drop_wallet_access_epg
コマンドは、仮想ウォレットに対するエンドポイント・グループのアクセス権を削除します。
構文
ショート形式:
drop_wallet_access_epg -g endpoint_group_name -w virtual_wallet_name
ロング形式:
drop_wallet_access_epg --epg_name endpoint_group_name --wallet_name virtual_wallet_name
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイント・グループの名前 |
|
必須 |
仮想ウォレットの名前 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、エンドポイント・グループepg_hr
に、ウォレットhr_wallet
に対する読取り、変更および管理アクセス権が付与されます。
java -jar okvrestservices.jar -c conf_file -r modify_wallet_access_epg -g epg_hr -w hr_wallet -l rm_mw
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service modify_wallet_access_epg --epg_name epg_hr --wallet_name hr_wallet -l rm_mw
親トピック: 仮想ウォレット・コマンド
12.6.6.9 get_default_walletコマンド
get_default_wallet
コマンドは、エンドポイントに関連付けられたデフォルト・ウォレットを取得します。
構文
get_default_wallet -e endpoint_name
get_default_wallet --ep_name endpoint_name
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
-e、 |
必須 | デフォルト・ウォレットを取得するエンドポイントの名前 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
hr_db
に関連付けられたデフォルト・ウォレットを取得するには、次のようにコマンドでエンドポイント名を指定する必要があります。java -jar okvrestservvices.jar -c conf_file -r get_default_wallet -e hr_db
ロング形式の例
java -jar okvrestservvices.jar -c conf_file -service get_default_wallet --ep_name hr_db
親トピック: 仮想ウォレット・コマンド
12.6.6.10 get_object_nameコマンド
オブジェクトのステータスがACTIVE
の場合は、get_object_name
コマンドで管理対象オブジェクトの名前を取得できます。
このコマンドは、マルチマスター・クラスタ環境でのみ使用します。
構文
ショート形式:
get_object_name -b EP|EPG|WALLET -x uid
ロング形式:
get_object_name --type EP|EPG|WALLET --uid uid
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
一意の識別子 |
|
必須 |
チェックするオブジェクト・タイプ。有効な値は次のとおりです。
|
|
必須 |
チェックするオブジェクト・タイプを指定します。有効な値は次のとおりです。
|
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
java -jar okvrestservices.jar -c path_to_okvclient.ora -r get_object_name -b WALLET -u 7C3DC1FF-213A-4FBE-BF4A-98A04F8D05DF
ロング形式の例
java -jar okvrestservices.jar --config path_to_okvclient.ora --service get_object_name --type WALLET --uid 7C3DC1FF-213A-4FBE-BF4A-98A04F8D05DF
親トピック: 仮想ウォレット・コマンド
12.6.6.11 get_walletsコマンド
get_wallets
コマンドは、エンドポイントに関連付けられたすべての仮想ウォレットを取得します。
構文
get_wallets -e endpoint_name
get_wallets --ep_name endpoint_name
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
-e、 |
必須 | 仮想ウォレットを取得するエンドポイントの名前 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
hr_db
,に関連付けられたすべての仮想ウォレットを取得するには、次のようにコマンドでエンドポイント名を指定する必要があります。java -jar okvrestservvices.jar -c conf_file -r get_wallets -e hr_db
ロング形式の例
java -jar okvrestservvices.jar -c conf_file -service get_wallets --ep_name hr_db
親トピック: 仮想ウォレット・コマンド
12.6.6.12 modify_wallet_access_epコマンド
modify_wallet_access_ep
コマンドは、エンドポイントに対する仮想ウォレットのアクセス・レベルを変更します。
構文
ショート形式:
modify_wallet_access_ep -e endpoint_name -w virtual_wallet_name -l virtual_wallet_access_level
ロング形式:
modify_wallet_access_ep --ep_name endpoint_name --wallet_name virtual_wallet_name --access_level wallet_access_level
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前 |
|
必須 |
仮想ウォレットの名前 |
|
必須 |
仮想ウォレットに対するアクセス・レベル。値は次のとおりです。
|
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、ウォレットhr_db
に対するアクセス・レベルを読取り専用およびウォレット管理に変更します。
java -jar okvrestservices.jar -c conf_file -r modify_wallet_access_ep -e hr_db_ep -w hr_wallet -l ro_mw
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service modify_wallet_access_ep --ep_name hr_db_ep --wallet_name hr_wallet --access_level ro_mw
親トピック: 仮想ウォレット・コマンド
12.6.6.13 modify_wallet_access_epgコマンド
modify_wallet_access_epg
コマンドは、エンドポイント・グループに対する仮想ウォレットのアクセス・レベルを変更します。
構文
ショート形式:
modify_wallet_access_epg -g endpoint_group_name -w virtual_wallet_name -l virtual_wallet_access_level
ロング形式:
modify_wallet_access_epg --epg_name endpoint_group_name --wallet_name virtual_wallet_name --access_level wallet_access_level
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイント・グループの名前 |
|
必須 |
仮想ウォレットの名前 |
|
必須 |
仮想ウォレットに対するアクセス・レベル。値は次のとおりです。
|
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、エンドポイント・グループepg_hr
にウォレットhr_wallet
に対する読取り、変更および管理の権限を付与します。
java -jar okvrestservices.jar -c conf_file -r modify_wallet_access_epg -g epg_hr -w hr_wallet -l rm_mw
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service modify_wallet_access_epg --epg_name epg_hr --wallet_name hr_wallet --access_level rm_mw
親トピック: 仮想ウォレット・コマンド
12.6.6.14 modify_wallet_descコマンド
modify_wallet_desc
コマンドは、既存の仮想ウォレットの説明を変更します。
構文
ショート形式:
modify_wallet_desc -w virtual_wallet_name -d "wallet_desc"
ロング形式:
modify_wallet_desc --wallet_name virtual_wallet_name --desc "wallet_desc"
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
仮想ウォレットの名前 |
|
必須 |
二重引用符で囲まれた仮想ウォレットの新しい説明文字列 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、ウォレットhr_wallet
に新しい説明HR endpoint virtual wallet
を付加します。
java -jar okvrestservices.jar -c conf_file -r modify_wallet_desc -w hr_wallet -d "HR endpoint virtual wallet"
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service modify_wallet_desc --wallet_name hr_wallet --desc "HR endpoint virtual wallet"
親トピック: 仮想ウォレット・コマンド
12.6.6.15 set_default_walletコマンド
set_default_wallet
コマンドは、エンドポイントのデフォルト・ウォレットを設定します。
構文
ショート形式:
set_default_wallet -e endpoint_name -w virtual_wallet_name
ロング形式:
set_default_wallet --ep_name --wallet_name virtual_wallet_name
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
仮想ウォレットの名前 |
|
必須 |
デフォルト・ウォレットが設定されるエンドポイント名 |
|
必須 |
構成ファイルの絶対パスを指定します |
|
複数のRESTfulサービス・コマンドの場合は必須 |
スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。 |
|
オプション |
|
|
必須 |
RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します |
|
オプション |
システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます |
ショート形式の例
この例では、エンドポイントhr_db
のデフォルト・ウォレットhr_wallet
を設定します。
java -jar okvrestservices.jar -c conf_file -r set_default_wallet -e hr_db -w hr_wallet
ロング形式の例
java -jar okvrestservices.jar --config conf_file --service set_default_wallet --ep_name hr_db --wallet_name hr_wallet
親トピック: 仮想ウォレット・コマンド
12.6.7 エラー・レポート
RESTfulサービス・ユーティリティには、RESTfulサービス・コマンドをすばやく正常に実行するためにデバッグする強力なエラー・レポートがあります。
- エラー・レポートについて
コマンド実行のステータス(成功および失敗)は、コマンドラインで即座にレポートされ、ログ・ファイルに書き込まれます。 - コマンドラインのエラー・レポート
エラー・レポートでは、不正なパスワードなどの問題があったアクションおよび正常なコマンド実行の両方が取得されます。 - スクリプトからのコマンド実行時のエラー・レポート
スクリプトから複数のサービス・コマンドを実行すると、コマンドラインおよびログ・ファイルに結果が表示されます。
12.6.7.1 エラー・レポートについて
コマンド実行のステータス(成功および失敗)は、コマンドラインですぐにレポートされ、ログ・ファイルに書き込まれます。
特定のエラーはレポートされ、必要に応じて修正処理が示されます。
コマンドが失敗したときには、まず、ログ・ファイルを確認します。選択した場所にカスタム・ログ・ファイルを作成していない場合は、現在のディレクトリのデフォルトのログ・ファイルokvrestservices.log
を確認すると、ここにコマンドの結果が書き込まれています。
コマンド実行中のOracle Key Vaultサーバーからのすべてのメッセージを表示するには、構成ファイルで適切なロギング・レベル、ログ・ファイル名およびログ・ファイルの場所を設定できます。
RESTfulサービス・ユーティリティは、ファイルやJAVA_HOME
などの環境変数が見つからない、不正なコマンド構文、不正なパスワードなどのエラーを報告します。
親トピック: エラー・レポート
12.6.7.2 コマンドラインのエラー・レポート
エラー・レポートでは、不正なパスワードなどの問題があったアクションおよび正常なコマンド実行の両方が取得されます。
例12-6 エラー: -rオプションを使用しないサービス・コマンドの実行
java -jar okvrestservices.jar -c rest.ini modify_endpoint_desc -e ORDERS -b ORDERS_HR Script or service option is required.
例12-7 エラー: 不正なパスワード
java -jar okvrestservices.jar -c rest.ini -r modify_endpoint_desc -e ORDERS -b ORDERS_HR Password: Invalid username or password. Try again after 5 seconds
例12-8 サービス・コマンドの正常な実行
java -jar okvrestservices.jar -c rest.ini -r modify_endpoint_desc -e ORDERS -b ORDERS_HR Password: [Line 0 OK] [MODIFY ENDPOINT DESC] [ORDERS:ORDERS_HR]
例12-9 ログ・ファイルのエントリ
有用なエラー・メッセージおよび使用に関するメッセージに加え、ログ・ファイルには、アクションのエントリが日付とともに記録されます。
Mar 02, 2019 7:23:55 PM com.oracle.okv.cloud.client.OKVAutomation checkpoint INFO: [Line 0 OK] [MODIFY ENDPOINT DESC] [ORDERS:ORDERS_HR]
親トピック: エラー・レポート
12.6.7.3 スクリプトからのコマンド実行時のエラー・レポート
1つのスクリプトから複数のサービス・コマンドを実行すると、コマンドラインに加えてログ・ファイルにも結果が表示されます。
次の出力は、スクリプトから実行された成功したコマンドの結果を示しています。
例12-10 スクリプトの実行結果
java -jar okvrestservices.jar --config rest.ini --script initial_setup.api Password: [Line 1 OK] [CREATE ENDPOINT] [APP_SERVER_1:ORACLE_NON_DB:LINUX64] [Line 2 OK] [CREATE ENDPOINT] [APP_SERVER_2:ORACLE_NON_DB:LINUX64] [Line 11 OK] [CREATE WALLET] [ApplicationWallet] [Line 12 OK] [CREATE WALLET] [FinanceWallet] [Line 15 OK] [CREATE ENDPOINT GROUP] [APP_SERVER] [Line 16 OK] [CREATE ENDPOINT GROUP] [FINANCE_RAC] [Line 20 OK] [ADD EPG MEMBER] [APP_SERVER:APP_SERVER_2] [Line 22 OK] [ADD EPG MEMBER] [FINANCE_RAC:FINANCE_RAC_NODE_1] [Line 29 OK] [ADD WALLET ACCESS EPG] [APP_SERVER:ApplicationWallet:RM] [Line 30 OK] [ADD WALLET ACCESS EPG] [FINANCE_RAC:FinanceWallet:RO] [Line 31 OK] [ADD WALLET ACCESS EP] [HR_DATABASE_PRIMARY:HRWallet:RM_MW]
親トピック: エラー・レポート
12.6.8 ヘルプ情報
有効なオプションに関する情報、およびRESTfulサービス・ユーティリティokvrestservices.jar
で使用できるコマンドに関する情報を確認できます。
有効なオプションのリストを表示する場合は、RESTfulサービス・ユーティリティokvrestservices.jar
とともに-h
オプションまたは--help
オプションを使用できます。
-bash-4.1$ java -jar okvrestservices.jar -help usage: java -jar okvrestservices.jar --config <arg> [--service <arg> |--script <arg> -A,--add <arg> User to add to wallet -c,--config <arg> System configuration file for OKV REST Services Utility -D,--delete <arg> User to delete from wallet -f,--force Confirm to delete -h,--help Display all available options -L,--listuser List all user from wallet -M,--modify <arg> User to modify from wallet -p,--pwd <arg> OKV user password -t,--twallet <arg> Wallet location -u,--usr <arg> OKV username -x,--script <arg> Script file -r,--service <arg> Service name -z,--list Display all service commands
RESTfulサービス・コマンドのリストを表示するには、コマンドラインで-H
または--list
を含めます。次に例を示します。
-bash-4.1$ java -jar okvrestservices.jar -H
12.7 Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンド
RESTfulサービス・キー管理コマンドは、Oracle Key Vaultにアップロードされるキーの管理を担当する管理者向けに設計されています。
- Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンドについて
Oracle Key Vaultのキー管理RESTクライアント・ツールは、okvrestservice.jar
コマンドを使用したKey Management Interoperability Protocol (KMIP)操作への簡略化されたインタフェースを提供します。 - OKVRESTSERVICEを使用するOracle Key Vaultのキー管理RESTクライアントAPI
OKVRESTSERVICE
(okvrestservice.jar
)を使用してKM RESTクライアントAPIをコールするには、kmip
オプションを含める必要があります。 - キー管理RESTクライアント・ツール・コマンドのリスト
RESTfulキー管理クライアント・ツールは、キーの作成やアクティブ化などのタスクを実行します。 - キー作成およびキー登録のコマンド
キー作成およびキー登録コマンドは、様々なタイプのセキュリティ・オブジェクトの登録などのタスクを実行します。 - キー属性管理コマンド
キー属性管理コマンドは、標準属性およびカスタム属性の追加、変更、削除などのタスクを実行します。 - キーのライフサイクル管理コマンド
キーのライフ管理コマンドは、管理対象の暗号化オブジェクトのアクティブ化や取消しなどのタスクを実行します。 - ウォレット・コマンド
ウォレット・コマンドは、ウォレットのメンバーシップを制御します。
関連項目
12.7.1 Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンドについて
Oracle Key Vaultのキー管理RESTクライアント・ツールは、okvrestservice.jar
コマンドを使用したKey Management Interoperability Protocol (KMIP)操作への簡略化されたインタフェースを提供します。
このツールは、クライアント・シェル・スクリプトまたは任意のプログラミング言語に埋め込むことができます。KM RESTクライアントを使用する前に、エンドポイント・ソフトウェアokvclient.jar
をダウンロードしてデプロイする必要があります。Oracle Key Vaultキー管理RESTサーバーは、デプロイされなかったエンドポイントからの接続を拒否します。Oracle Key Vaultキー管理REST APIには、JRE 1.8以降が必要です。このインタフェースが提供するコマンドを実行するには、キー管理者ロールが必要です。
マルチマスター・クラスタ環境を使用している場合は、読取り/書込みノードで接続中にokvrestservices.jar
ファイルをダウンロードする必要があります。Oracle Key Vaultでは、読取り専用モードでokvrestservices.jar
をダウンロードできません。読取り/書込みモードでダウンロードすると、クライアント・ツールは読取り/書込みモードまたは読取り専用モードで接続できます。
12.7.2 OKVRESTSERVICEを使用するOracle Key Vaultのキー管理RESTクライアントAPI
OKVRESTSERVICE
(okvrestservice.jar
)を使用してKM RESTクライアントAPIをコールするには、kmip
オプションを含める必要があります。
drop_wallet_access_epg
コマンドは、仮想ウォレットに対するエンドポイント・グループのアクセス権を削除します。
構文
java -jar okvrestservices.jar kmip --config path_to_okvclient.ora --service options_for_the_KMIP_API
KMIP RESTサービスのオプション
オプション | 説明 |
---|---|
|
使用する暗号化アルゴリズム。次の値を指定できます。
|
|
構成ファイルの絶対パスを指定します |
|
ユーザー名 |
|
属性リスト・ファイル。ファイル形式は次のとおりです。
|
|
グループ・メンバー |
|
属性の索引 |
|
サポートされているキーの長さは次のとおりです。
|
|
暗号化使用方法マスク。有効な値には、次の設定が含まれます。これは、Key Management Interoperability Protocol (KMIP)仕様バージョン1.1で説明されています。
|
|
属性名 |
|
登録するオブジェクト・ファイルへのパス |
|
次の値などの取消しコード値。
|
|
取消し理由メッセージ |
|
登録するオブジェクト・タイプ |
|
管理対象オブジェクトのUUID (Universally Unique ID) |
|
属性値 |
|
ウォレット名 |
|
表示するUIDの最大数 |
12.7.3 キー管理RESTクライアント・ツール・コマンドのリスト
RESTfulキー管理クライアント・ツールは、キーの作成、アクティブ化などのタスクを実行します。
表12-4 RESTfulキー管理コマンド
コマンド名 | 説明 |
---|---|
|
管理対象暗号オブジェクトをアクティブ化します |
|
オブジェクトに新しい属性を追加し、値を設定します |
|
カスタム属性を追加して、名前、タイプおよび値を指定します |
|
ウォレットにユーザーを追加します |
|
すべての属性名および値を取得します |
|
新しいキーを作成します |
|
管理対象オブジェクトの属性を削除します |
|
カスタム属性を削除します |
|
ウォレットからユーザーを削除します |
|
管理対象オブジェクトのキー・データを破棄するようにサーバーにリクエストします |
|
オブジェクトの1つ以上の属性値を取得します |
|
サーバーにデジタル証明書をリクエストします |
|
サーバーから暗号化キーを取得します |
|
使用可能な属性名および値をすべて取得します |
|
使用可能なすべての属性名のみをリストします |
|
仮想ウォレットをリストします |
|
1つ以上の管理対象オブジェクトを検索します |
|
管理対象オブジェクトの属性値を変更します |
|
カスタム属性を変更します |
|
サポートされている機能についてサーバーに問い合せます |
|
デジタル証明書を登録します |
|
キーを登録します |
|
サーバーが解釈できない可能性があるデータを含むオブジェクトを登録します |
|
シークレット・データを含むオブジェクトを登録します |
|
管理対象暗号化オブジェクトを取り消します。 |
12.7.4 キー作成およびキー登録のコマンド
キー作成およびキー登録コマンドは、様々なタイプのセキュリティ・オブジェクトの登録などのタスクを実行します。
これらのコマンドを使用するには、キー管理者ロールが必要です。
- create_keyコマンド
create_key
コマンドは、新しいキーを作成します。 - reg_keyコマンド
reg_key
コマンドは、キーを登録します。 - get_certコマンド
get_cert
コマンドは、デジタル証明書を取得します。 - get_keyコマンド
get_key
コマンドは、暗号化キーを取得します。 - get_opaqueコマンド
get_opaque
コマンドは、シークレット・データを含むオブジェクトを取得します。 - get_secretコマンド
get_secret
コマンドは、機密データを含むオブジェクトを取得します。 - reg_certコマンド
reg_cert
コマンドは、証明書を登録します。 - reg_opaqueコマンド
reg_cert
コマンドは、不透明オブジェクトを登録します。 - reg_secretコマンド
reg_cert
コマンドは、パスワードやランダム・シードなどのシークレット・データを登録します。
12.7.4.1 create_keyコマンド
create_key
コマンドは新しいキーを作成します。
暗号化アルゴリズム、キーの長さおよび使用方法マスクを指定する必要があります。
構文
ショート形式:
-s create_key -a cryptographic_algorithm -l key_length -m cryptographic_usage_mask
ロング形式:
--service create_key --algorithm cryptographic_algorithm --length key_length --mask crypographic_usage_mask
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
暗号化アルゴリズム |
|
必須 |
キーの長さ |
|
必須 |
二重引用符で囲まれた暗号化使用方法マスク |
ショート形式の例
この例では、AES (Advanced Encryption Standard)キーを作成します。
java -jar okvrestservices.jar kmip -c conf_file -s create_key -a AES -l 128 -m "ENCRYPT,DECRYPT,EXPORT"
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service create_key --algorithm AES --length 128 --mask "ENCRYPT,DECRYPT,EXPORT"
親トピック: キー作成およびキー登録のコマンド
12.7.4.2 reg_keyコマンド
reg_key
コマンドはキーを登録します。
構文
ショート形式:
-s reg_key -a algorithm -l key_length -m crypto_usage_mask -o path_to_object_file [-f path_to_object_attr_file>]
ロング形式:
--service reg_key --algorithm algorithm --length key_length --mask crypto_usage_mask --object path_to_object_file [-attr path_to_object_attr_file]
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
キーの長さ |
|
必須 |
アルゴリズム |
|
必須 |
暗号化使用方法マスク |
|
必須 |
キー・ファイルへのパス |
|
オプション |
属性リスト・ファイル |
ショート形式の例
この例では、指定した検索基準に基づいてオブジェクトを検索します。
java -jar okvrestservices.jar kmip -c conf_file -s reg_key -a AES -l 128 -m "EXPORT" -o ./object.key -f ./obj_key_attr_file.txt
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --reg_key --algorithm AES --length 128 --mask "EXPORT" --object ./object.key --attr ./obj_key_attr_file.txt
親トピック: キー作成およびキー登録のコマンド
12.7.4.3 get_certコマンド
get_cert
コマンドはデジタル証明書を取得します。
構文
ショート形式:
-s get_cert -u UUID
ロング形式:
--service get_cert --uid UUID
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
ショート形式の例
java -jar okvrestservices.jar kmip -c conf_file -s get_cert -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service get_cert --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC
親トピック: キー作成およびキー登録のコマンド
12.7.4.4 get_keyコマンド
get_key
コマンドは暗号化キーを取得します。
構文
ショート形式:
-s get_key -u UUID
ロング形式:
--service get_key --uid UUID
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
ショート形式の例
java -jar okvrestservices.jar kmip -c conf_file -s get_key -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service get_key --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC
親トピック: キー作成およびキー登録のコマンド
12.7.4.5 get_opaqueコマンド
get_opaque
コマンドは、シークレット・データを含むオブジェクトを取得します。
構文
ショート形式:
-s get_opaque -u UUID
ロング形式:
--service get_opaque --uid UUID
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
ショート形式の例
java -jar okvrestservices.jar kmip -c conf_file -s get_opaque -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service get_opaque --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC
親トピック: キー作成およびキー登録のコマンド
12.7.4.6 get_secretコマンド
get_secret
コマンドは、シークレット・データを含むオブジェクトを取得します。
構文
ショート形式:
-s get_secret -u UUID
ロング形式:
--service get_secret --uid UUID
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
ショート形式の例
java -jar okvrestservices.jar kmip -c conf_file -s get_secret -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service get_secret --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC
親トピック: キー作成およびキー登録のコマンド
12.7.4.7 reg_certコマンド
reg_cert
コマンドは証明書を登録します。
構文
ショート形式:
-s reg_cert -t object_type -a algorithm -l key_length -m crypto_usage_mask -o path_to_cert file [-f path_to_object_attr_file]
ロング形式:
--service reg_cert --type object_type --algorithm algorithm --length key_length --mask crypto_usage_mask --object path_to_cert_file [-attr path_to_cert_attr_file]
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
オブジェクト型 |
|
必須 |
キーの長さ |
|
必須 |
アルゴリズム |
|
必須 |
暗号化使用方法マスク |
|
必須 |
オブジェクト属性ファイルへのパス |
|
オプション |
属性リスト・ファイル |
ショート形式の例
java -jar okvrestservices.jar kmip -c conf_file -s reg_cert -t X_509 -a AES -l 128 -m ENCRYPT -o ./my_cert -f ./cert_attr_file.txt
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service reg_cert -t X_509 --algorithm AES --length 128 --mask ENCRYPT --object ./my_cert --attr ./cert_attr_file.txt
親トピック: キー作成およびキー登録のコマンド
12.7.4.8 reg_opaqueコマンド
reg_cert
コマンドは不透明なオブジェクトを登録します。
不透明なデータを含むオブジェクトは、サーバーによって解釈されるとはかぎりません。
構文
ショート形式:
-s reg_opaque -m crypto_usage_mask -o path_to_object_file [-f path_to_object_attr_file]
ロング形式:
--service reg_opaque --mask crypto_usage_mask --object path_to_object_file [--attr path_to_object_attr_file]
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
暗号化使用方法マスク |
|
必須 |
オブジェクト・ファイルへのパス |
|
オプション |
属性リスト・ファイル |
ショート形式の例
java -jar okvrestservices.jar kmip -c conf_file -s reg_opaque -m ENCRYPT -o ./my.opaque -f ./obj_attr_file.txt
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service reg_opaque --mask ENCRYPT --object ./my.opaque --attr ./obj_attr_file.txt
親トピック: キー作成およびキー登録のコマンド
12.7.4.9 reg_secretコマンド
reg_cert
コマンドは、パスワード、ランダム・シードなどのシークレット・データを登録します。
構文
ショート形式:
-s reg_secret -t object_type -m crypto_usage_mask -o path_to_object_file [-f path_to_object_attr_file]
ロング形式:
--service reg_secret --type object_type --mask crypto_usage_mask --object path_to_object_file [--attr path_to_object_attr_file]
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
オブジェクト型 |
|
必須 |
暗号化使用方法マスク |
|
必須 |
オブジェクト属性ファイルへのパス |
|
オプション |
属性リスト・ファイル |
ショート形式の例
obj_attr_file.txt
の内容の例
java -jar okvrestservices.jar kmip -c conf_file -s reg_secret -t PASSWORD -m ENCRYPT -o ./secret.password -f ./obj_attr_file.txt
CONTACT_INFO=admin@example.com NAME=John
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service reg_secret --type PASSWORD --mask ENCRYPT --object ./secret.password --attr ./obj_attr_file.txt
親トピック: キー作成およびキー登録のコマンド
12.7.5 キー属性管理コマンド
キー属性管理コマンドは、標準属性およびカスタム属性の追加、変更、削除などのタスクを実行します。
これらのコマンドを使用するには、キー管理者ロールが必要です。
- add_attrコマンド
add_attr
コマンドは、管理対象オブジェクトに属性を追加します。 - add_custom_attrコマンド
add_custom_attr
コマンドは、オブジェクトにカスタム属性を追加します。 - all_attrコマンド
all_attr
コマンドは、オブジェクトのすべての属性を取得します。 - del_attrコマンド
del_attr
コマンドは、管理対象オブジェクトから属性を削除します。 - del_custom_attrコマンド
del_custom_attr
コマンドは、カスタム属性を削除します。 - get_attrコマンド
get_attr
コマンドは、オブジェクトの属性または属性のリストを取得します。 - list_attrコマンド
list_attr
コマンドは、オブジェクトの属性のリストを取得します。 - mod_attrコマンド
mod_attr
コマンドは、オブジェクトの属性を変更します。 - mod_custom_attrコマンド
mod_custom_attr
コマンドは、カスタム属性を変更します。
12.7.5.1 add_attrコマンド
add_attr
コマンドは、管理対象オブジェクトに属性を追加します。
構文
ショート形式:
-s add_attr -u UUID -n attribute_name -v attribute_value
ロング形式:
--service add_attr --uid UUID --attribute attribute_name --value attribute_value
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
|
必須 |
属性名。変更可能な属性は次のとおりです。
|
|
必須 |
属性値 |
ショート形式の例
この例では、UUIDで指定されたオブジェクトの属性CONTACT_INFO
に値okv@example.com
を割り当てます。
java -jar okvrestservices.jar kmip -c conf_file -s add_attr -u 7D767505-2FBE-4F5E-BF81-F95A4FE88E03 -n CONTACT_INFO -v "okv@example.com"
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service add_attr --uid 7D767505-2FBE-4F5E-BF81-F95A4FE88E03 --attribute CONTACT_INFO --value "okv@example.com"
親トピック: キー属性管理コマンド
12.7.5.2 add_custom_attrコマンド
add_custom_attr
コマンドは、カスタム属性をオブジェクトに追加します。
構文
ショート形式:
-s add_custom_attr -u UUID -n {X-|Y-}attribute_name -t attribute_type -v attribute_value
ロング形式:
--service add_custom_attr --uid UUID --attribute {X-|Y-}attribute_name --type attribute_type --value attribute_value
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
|
必須 |
カスタム属性名。接頭辞 |
|
必須 |
オブジェクト型。 |
|
必須 |
カスタム属性値 |
ショート形式の例
この例では、UUIDで指定されたオブジェクトのx-OGG_MK_NAME
というカスタム属性にTEXT
値OGG_MASTER_KEY_NAME
を割り当てます。
java -jar okvrestservices.jar kmip -c conf_file -s add_custom_attr -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC -n x-OGG_MK_NAME -t TEXT -v OGG_MASTER_KEY_NAME
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service add_custom_attr --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC --attribute x-OGG_MK_NAME --type TEXT --value OGG_MASTER_KEY_NAME
親トピック: キー属性管理コマンド
12.7.5.3 all_attrコマンド
all_attr
コマンドは、オブジェクトのすべての属性を取得します。
構文
ショート形式:
-s all_attr -u UUID
ロング形式:
--service all_attr --uid UUID
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
ショート形式の例
この例では、UUIDで指定されたオブジェクトのすべての属性値をリストします。
java -jar okvrestservices.jar kmip -c conf_file -s all_attr -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service all_attr --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC
親トピック: キー属性管理コマンド
12.7.5.4 del_attrコマンド
del_attr
コマンドは、管理対象オブジェクトから属性を削除します。
構文
ショート形式:
-s del_attr -u UUID -n attribute_name
ロング形式:
--service del_attr --uid UUID --attribute attribute_name
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
|
必須 |
属性名。変更可能な属性は次のとおりです。
|
ショート形式の例
この例では、UUIDで指定されたオブジェクトのCONTACT_INFO
属性を削除します。
java -jar okvrestservices.jar kmip -c conf_file -s del_attr -u 7D767505-2FBE-4F5E-BF81-F95A4FE88E03 -n CONTACT_INFO
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service del_attr --uid 7D767505-2FBE-4F5E-BF81-F95A4FE88E03 --attribute CONTACT_INFO
親トピック: キー属性管理コマンド
12.7.5.5 del_custom_attrコマンド
del_custom_attr
コマンドはカスタム属性を削除します。
構文
ショート形式:
-s del_custom_attr -u UUID -n attribute_name -i attribute_index
ロング形式:
--service del_custom_attr --uid UUID --attribute attribute_name --index attribute_index
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
|
必須 |
属性名 |
|
必須 |
属性の索引 |
ショート形式の例
この例では、UUIDで指定されたオブジェクトの索引1
で識別されるx-OGG_MK_NAME
という名前の属性の値を削除します。
java -jar okvrestservices.jar kmip -c conf_file -s del_custom_attr -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC -n x-OGG_MK_NAME -i 1
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service del_custom_attr --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC --attribute x-OGG_MK_NAME --index 1
親トピック: キー属性管理コマンド
12.7.5.6 get_attrコマンド
get_attr
コマンドは、オブジェクトの属性または属性のリストを取得します。
使用可能な属性を検索するには、list_attr
コマンドを使用します。
構文
ショート形式:
-s get_attr -u UUID -n attribute name or list
ロング形式:
--service get_attr --uid UUID --attribute attribute name or list
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
|
必須 |
属性名、または引用符で囲んでカンマで区切られた属性のリスト |
ショート形式の例
この例では、UUIDで指定されたオブジェクトのCRYPTO_USAGE_MASK
、CONTACT_INFO
およびNAME
の属性値をリストします。
java -jar okvrestservices.jar kmip -c conf_file -s get_attr -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC -n "CRYPTO_USAGE_MASK,CONTACT_INFO,NAME"
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service get_attr --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC --attribute "CRYPTO_USAGE_MASK,CONTACT_INFO,NAME"
親トピック: キー属性管理コマンド
12.7.5.7 list_attrコマンド
list_attr
コマンドは、オブジェクトの属性のリストを取得します。
構文
ショート形式:
-s list_attr -u UUID
ロング形式:
--service list_attr --uid UUID
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
ショート形式の例
この例では、UUIDで指定されたオブジェクトのすべての属性値をリストします。
java -jar okvrestservices.jar kmip -c conf_file -s list_attr -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service list_attr --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC
親トピック: キー属性管理コマンド
12.7.5.8 mod_attrコマンド
mod_attr
コマンドはオブジェクトの属性を変更します。
構文
ショート形式:
-s mod_attr -u UUID -n attribute_name -v attribute_value
ロング形式:
--service mod_attr --uid UUID --attribute attribute_name --value attribute_value
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
|
必須 |
属性名。変更可能な属性は次のとおりです。
|
|
必須 |
属性値 |
ショート形式の例
この例では、UUIDで指定されたオブジェクトの属性PROCESS_START_DATE
の値を変更します。
java -jar okvrestservices.jar kmip -c conf_file -s mod_attr -u 7D767505-2FBE-4F5E-BF81-F95A4FE88E03 -n PROCESS_START_DATE -v "2030/10/1010:10:10"
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service mod_attr --uid 7D767505-2FBE-4F5E-BF81-F95A4FE88E03 --attribute PROCESS_START_DATE -value "2030/10/1010:10:10"
親トピック: キー属性管理コマンド
12.7.5.9 mod_custom_attrコマンド
mod_custom_attr
コマンドはカスタム属性を変更します。
構文
ショート形式:
-s mod_custom_attr -u UUID -n attribute_name -i attribute_index -v attribute_value
ロング形式:
--service mod_custom_attr --uid UUID --attribute attribute_name --index attribute_index --value attribute_value
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
|
必須 |
属性名 |
|
必須 |
属性の索引。属性の索引は各属性の一意の位置です。これにより、同じ名前を持つ属性を索引で区別できます。 |
|
必須 |
属性値 |
ショート形式の例
この例では、UUIDで指定されたオブジェクトのx_OGG_MK_NAME
というカスタム属性の値をOGG_MASTER_KEY_NAME2
に変更します。
java -jar okvrestservices.jar kmip -c conf_file -s mod_custom_attr -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC -n x-OGG_MK_NAME -i 1 -v OGG_MASTER_KEY_NAME2
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service mod_custom_attr --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC --attribute x-OGG_MK_NAME --index 1 --value OGG_MASTER_KEY_NAME2
親トピック: キー属性管理コマンド
12.7.6 キーのライフサイクル管理コマンド
キーのライフサイクル管理コマンドは、管理対象の暗号化オブジェクトのアクティブ化、取消しなどのタスクを実行します。
これらのコマンドを使用するには、キー管理者ロールが必要です。
- activateコマンド
activate
コマンドは、管理対象の暗号化オブジェクトをアクティブ化します。 - destroyコマンド
destroy
コマンドは、管理対象オブジェクトを破棄します。 - locateコマンド
locate
コマンドは、管理対象オブジェクトを検索します。 - revokeコマンド
revoke
コマンドは、キーや証明書などの管理対象オブジェクトを取り消します。 - queryコマンド
query
コマンドは、サポートされている操作およびオブジェクトを識別します。
12.7.6.1 activateコマンド
activate
コマンドは、管理対象の暗号化オブジェクトをアクティブ化します。
構文
ショート形式:
-s activate -u unique_identifier
ロング形式:
--service activate --uid unique_identifier
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
一意の識別子 |
ショート形式の例
この例では、管理対象オブジェクトをアクティブ化します。
java -jar okvrestservices.jar kmip -c conf_file -s activate --uid 7D767505-2FBE-4F5E-BF81-F95A4FE88E03
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service activate --uid 7D767505-2FBE-4F5E-BF81-F95A4FE88E03
親トピック: キーのライフサイクル管理コマンド
12.7.6.2 destroyコマンド
destroy
コマンドは管理対象オブジェクトを破棄します。
構文
ショート形式:
-s destroy -u unique_identifier
ロング形式:
--service destroy --uid unique_identifier
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
一意の識別子 |
ショート形式の例
この例では、管理対象オブジェクトを破棄します。
java -jar okvrestservices.jar kmip -c conf_file -s destroy -u D0ABC5A5-BB30-4F20-BFE2-54E3044F5296
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service destroy --uid D0ABC5A5-BB30-4F20-BFE2-54E3044F5296
親トピック: キーのライフサイクル管理コマンド
12.7.6.3 locateコマンド
locate
コマンドは管理対象オブジェクトを検出します。
構文
ショート形式:
-s locate [-x max_uid_# -g group_member –y object_state]
ロング形式:
--service locate [--max max_uid_# --group value –-state object_state]
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
オプション |
一意の識別子 |
|
オプション |
グループ・メンバー |
|
オプション |
オブジェクトの状態。オブジェクトの有効な状態値のリストについては、 |
ショート形式の例
この例では、指定した検索基準に基づいてオブジェクトを検索します。
java -jar okvrestservices.jar kmip -c conf_file -s locate
java -jar okvrestservices.jar kmip -c conf_file -s locate -x 50
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service locate --state ACTIVE --group FRESH
java -jar okvrestservices.jar kmip --config conf_file --service locate --state ACTIVE --group DEFAULT --max 1
12.7.6.4 revokeコマンド
revoke
コマンドは、キー、証明書などの管理対象オブジェクトを取り消します。
構文
ショート形式:
-s revoke -u unique_identifier -r revoke_code [-s revoke_reason]
ロング形式:
--service revoke --uid unique_identifier --code revoke_code [--reason revoke_reason]
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
一意の識別子 |
|
必須 |
取消しコード |
|
オプション |
取り消す理由。取消しコードが |
ショート形式の例
この例では、管理対象オブジェクトを取り消します。
java -jar okvrestservices.jar kmip -c conf_file -s revoke -u 7D767505-2FBE-4F5E-BF81-F95A4FE88E03 -r CA_COMPROMISE -s "security problem"
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service revoke --uid 7D767505-2FBE-4F5E-BF81-F95A4FE88E03 --code CA_COMPROMISE --reason "security problem"
12.7.6.5 queryコマンド
query
コマンドは、サポートされている操作およびオブジェクトを識別します。
構文
ショート形式:
-s query
ロング形式:
--service query
ショート形式の例
この例では、サポートされている操作およびオブジェクトをサーバーに問い合せます。
java -jar okvrestservices.jar kmip -c conf_file -s query
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service query
親トピック: キーのライフサイクル管理コマンド
12.7.7 ウォレット・コマンド
ウォレット・コマンドは、ウォレットのメンバーシップを制御します。
- add_memberコマンド
add_member
コマンドは、ウォレット・メンバーシップを追加します。 - del_memberコマンド
del_member
コマンドは、ウォレット・メンバーシップを削除します。 - list_walletコマンド
list_wallet
コマンドは、管理対象ウォレットをリストします。
12.7.7.1 add_memberコマンド
add_member
コマンドは、ウォレット・メンバーシップを追加します。
構文
ショート形式:
-s add_member -w wallet -u UUID
ロング形式:
--service add_member --wallet wallet --uid UUID
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
|
必須 |
ウォレット名 |
ショート形式の例
java -jar okvrestservices.jar kmip -c conf_file -s add_member -w WALLET -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service add_member --wallet WALLET --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC
親トピック: ウォレット・コマンド
12.7.7.2 del_memberコマンド
del_member
コマンドは、ウォレット・メンバーシップを削除します。
構文
ショート形式:
-s del_member -w wallet -u UUID
ロング形式:
--service del_member --wallet wallet --uid UUID
パラメータ
パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
管理対象オブジェクトのUUID (Universally Unique ID) |
|
必須 |
ウォレット名 |
ショート形式の例
java -jar okvrestservices.jar kmip -c conf_file -s del_member -w WALLET -u D69D2F32-2DBB-4FF3-BF52-95487526E6EC
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service del_member --wallet WALLET --uid D69D2F32-2DBB-4FF3-BF52-95487526E6EC
親トピック: ウォレット・コマンド
12.7.7.3 list_walletコマンド
list_wallet
コマンドは管理対象ウォレットをリストします。
構文
ショート形式:
-s list_wallet
ロング形式:
--service list_wallet
ショート形式の例
java -jar okvrestservices.jar kmip -c conf_file -s list_wallet
ロング形式の例
java -jar okvrestservices.jar kmip --config conf_file --service list_wallet
親トピック: ウォレット・コマンド