1. 管理者ガイド
  2. RESTfulサービスを使用したOracle Key Vaultの管理およびキー管理

13 RESTfulサービスを使用したOracle Key Vaultの管理およびキー管理

Oracle Key Vault RESTfulサービス・ユーティリティを使用すると、大規模な分散デプロイメントのOracle Key Vault管理タスクを自動化できます。

13.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サービス実行処理を使用するには、次の一般的なステップに従います。

  1. Oracle Key Vault管理コンソールからRESTfulサービスを有効にします。

  2. RESTfulサービス・ユーティリティokvrestservices.jarをダウンロードします。

  3. 構成ファイルを作成して、実行するサービスのプロパティを設定します。

  4. RESTfulサービス・ユーティリティokvrestservices.jar、構成ファイル、サービス・コマンドおよびオプションを使用してサービスを実行します。

  5. 複数のRESTfulサービス・コマンドを実行するには、次のことを行う必要があります。

    1. スクリプトを作成して、このスクリプトにRESTfulコマンドを記述します。

    2. RESTfulサービス・ユーティリティokvrestservices.jar、構成ファイルおよびスクリプト・ファイルを使用してサービスを実行します。

  6. エンドポイントのエンロールおよびプロビジョニングが完了したら、RESTfulサービスを無効にします。

親トピック: RESTfulサービスを使用したOracle Key Vaultの管理およびキー管理

13.2 RESTfulサービスの使用に必要な権限

必要なRESTfulサービス権限は、Oracle Key Vault管理コンソールで同じタスクを実行するために必要な権限と一致しています。

たとえば、エンドポイントを追加して管理する場合は、システム管理者ロールまたはエンドポイント管理権限が必要です。エンドポイント・グループを管理する場合は、キー管理者ロールまたはエンドポイント・グループ管理権限が必要です。ウォレットおよびキーを使用する場合は、キー管理者ロールが必要です。こうしたロールと権限は、OracleデータベースをOracle Key Vaultに接続するために必要になります。MySQLデータベースの場合、MySQLではウォレットを使用しないため、キー管理ロールのみが必要です。RESTfulサービスの使用時に、エンドポイント管理者権限は必要ありません。

RESTfulコマンドには、システム管理者ロール、キー管理者ロール、エンドポイント管理権限またはエンドポイント・グループ管理権限が必要です。RESTfulサービスの使用を簡略化するために、これらのロールまたは権限の両方を持つユーザーを作成できます。通常は、これらの権限の両方が必要な処理を実行する必要があるスクリプトを使用して、Oracle Key Vaultでデータベースを自己登録する必要がある管理者がこのユーザーを使用します。

親トピック: RESTfulサービスを使用したOracle Key Vaultの管理およびキー管理

13.3 RESTfulサービスの有効化

エンドポイント要件を確認し、ネットワーク・サービスを有効化した後、RESTfulサービスを有効にしてRESTfulソフトウェア・ユーティリティをダウンロードできます。

親トピック: RESTfulサービスを使用したOracle Key Vaultの管理およびキー管理

13.3.1 ステップ1: エンドポイントのシステム要件の確認

REST APIでエンドポイントをプロビジョニングするには、ネットワーク上にデータを安全に転送するためのツールが必要です。

  1. エンドポイント管理者としてエンドポイントにログインします。
  2. 次のツールがあることを確認します。
    • TLS (Transport Layer Security) 1.2以降をサポートするcURLバージョン
    • OpenSSL 1.0.1p以降
    • Java 1.7.0.21以降(Java Runtime Environment (JRE)はOracle Databaseリリース12.2で提供されます。Oracle Databaseリリース12.2以上がすでにある場合は、JREをインストールする必要はありません)。Oracle Databaseリリース12.2.0.1以上のデータベース・サーバーにRESTfulサービスをデプロイする場合は、$ORACLE_HOME/jdk/jreの埋込みJava Runtime Environment (JRE)を使用できます。

      Oracleリリース12.2.0.1以降のデータベース・インストール環境の場合は、JAVA_HOMEに$ORACLE_HOME/jdk/jreを設定し、JAVA_HOME/binをPATHに追加します。以前のデータベース・リリースの場合は、JREバージョン1.7.0.21以降をダウンロードしてインストールし、JAVA_HOMEおよびPATHを適切に設定します。OpenJDKはサポートされていません。

    • provisionコマンドの場合、/usr/bin/javaから追加のJREインストール環境(Oracle Databaseリリース12.2.0.1より前の古いデータベースの場合)または$ORACLE_HOME/jdk/jre/bin/java (Oracle Databaseリリース12.2.0.1以上の場合)へのソフト・リンク。コマンドラインでnamei/usr/bin/javaを実行することで確認できます。

親トピック: RESTfulサービスの有効化

13.3.2 ステップ2: ネットワーク・サービスの有効化

Oracle Key Vaultサーバーにアクセスするには、RESTfulクライアントのWebアクセスをそのIPアドレスごとに構成する必要があります。

すべてのIPアドレスを許可するか、このステップで指定するIPアドレスのサブセットへのアクセスを制限できます。このオプションによって、Oracle Key Vault管理コンソールへのアクセスも制限されることに注意してください。
  1. システム管理者ロールを持っているユーザーとしてOracle Key Vault管理コンソールにログインします。
  2. 「System」を選択し、左側のサイドバーで「System Settings」を選択します。
    「Settings」ページが表示されます。「Network Services」セクションに移動します。
  3. 「Web Access」で、RESTfulクライアントに対して次のIPアドレス・オプションのいずれかを選択します。
    • すべてのIPアドレスを許可する場合は、「All」。
    • 一連のIPアドレスを指定する場合は、「IP address(es)」。このオプションを選択した場合は、隣のフィールドにIPアドレスを入力します(各IPアドレスは空白で区切ります)。
  4. 「Save」をクリックします。

親トピック: RESTfulサービスの有効化

13.3.3 ステップ3: RESTfulサービスの有効化

ネットワーク・サービスを有効にした後、RESTfulサービスを有効にできます。

  1. システム管理者ロールを持っているユーザーとしてOracle Key Vault管理コンソールにログインします。
  2. 「System」を選択し、左側のサイドバーで「System Settings」を選択します。

    「Settings」ページが表示されます。「RESTful Services」セクションに移動します。

  3. 「Enable」の右側のボックスを選択します。
  4. 「Save」をクリックします。

親トピック: RESTfulサービスの有効化

13.3.4 ステップ4: RESTfulソフトウェア・ユーティリティのダウンロード

RESTfulソフトウェア・ユーティリティはokvrestservices.jarファイルにあります。

  • 次のいずれかの方法を使用して、okvrestservices.jarファイルをダウンロードします。
    • Oracle Key Vault管理コンソールのホーム・ページから、次の操作を実行します。
      1. システム管理者ロールを持つユーザーとしてログインします。
      2. 左サイドバーの「Downloads」で、「RESTful Service Utility」をクリックします。

        「Download RESTful Utility」ページが表示されます。

      3. 右上の「Download」をクリックします。

        ユーティリティ・ファイルokvrestservices.jarをローカル・ディレクトリに保存することを求めるプロンプトとともに、ディレクトリ・ウィンドウが表示されます。

      4. セキュアな場所にファイルを保存します。
    • Oracle Key Vault管理コンソールの「Endpoint Enrollment」および「Software Download」から、次の操作を実行します。
      1. Oracle Key Vault管理コンソールに接続します。

        Oracle Key Vault管理コンソールへのログイン・ページが表示されます。ログインしないでください。

      2. ログイン・ページの右下隅にある「Login」で、「Endpoint Enrollment and Software Download」をクリックします。
      3. 「Download OKV Automation Utility」タブをクリックします。
      4. 「Download」ボタンをクリックします。
      5. 安全な場所にokvrestservices.jarをダウンロードします。
    • コマンドラインHTTPクライアント(wgetやcurlなど)を使用します。プライマリ/スタンバイ構成の場合は、プライマリ・データベースのIPアドレスを入力します。次に例を示します。
      wget --no-check-certificate https://ip_address:5695/okvrestservices.jar  
curl -k https://ip_address:5695/okvrestservices.jar -o okvrestservices.jar 
curl -O -k https://ip_address:5695/okvrestservices.jar

関連項目

親トピック: RESTfulサービスの有効化

13.4 RESTfulサービス構成ファイルの管理

構成ファイルを使用すると、RESTfulサービス・コマンドを個別に実行したり、グループ内で実行したりできます。

親トピック: RESTfulサービスを使用したOracle Key Vaultの管理およびキー管理

13.4.1 RESTfulサービス構成ファイルの管理について

RESTfulサービス・キー管理コマンドは、Oracle Key Vaultにアップロードされるキーの管理を担当する管理者向けに設計されています。

ユーティリティをコマンドラインから実行するか、スクリプトから実行するかにかかわらず、構成ファイルを使用してRESTfulサービス・ユーティリティokvrestservices.jarを実行する必要があります。Oracle Key Vaultクライアント・ソフトウェアをデプロイしたときに作成されたokvclient.oraファイルを使用するか、新しい構成ファイルを作成できます。マルチマスター・クラスタ環境では、独自の構成ファイルを持つ読取り/書込みノードのいずれかを使用できます。ただし、okvclient.oraを構成ファイルとして使用して、Oracle Key Vaultマルチマスター・クラスタ機能を利用することをお薦めします。

ノート:

スクリプト・モードはKMIP RESTfulサービスでは使用できません。

関連項目

親トピック: RESTfulサービス構成ファイルの管理

13.4.2 構成ファイル作成のガイドライン

スクリプト実行エラーを回避するには、推奨ガイドラインに従ってください。

  • スクリプトのコマンドおよび構文は、コマンドラインで使用されているものと同じです。

  • スクリプトの各行は、コマンドか、先頭が文字#の行である必要があります。

  • 各コマンドを個別の行に記述します。

  • コマンドのない各行は#文字で開始します。

  • コメントおよび空白行には#文字を使用します。

  • コマンド・オプションが出現する順序は関係ありません。

  • すべての必須オプションに有効な値があることを確認します。

  • スクリプトを実行するときに、-iまたは--scriptオプションを指定します。

  • -dまたは--descオプションに使用する説明に空白が含まれる場合は、二重引用符で囲みます。

親トピック: RESTfulサービス構成ファイルの管理

13.4.3 RESTfulサービス構成ファイルの作成

RESTfulサービス・ユーティリティがコマンドの実行に使用するプロパティを構成ファイルに設定する必要があります。

  1. デフォルトの場所のokvclient.oraファイルを使用するか、わかりやすい名前でファイルを作成します。
    デフォルトの場所は、okvclient.jarファイルをデプロイしたsslディレクトリです。
    たとえば、hr_dbという名前のエンドポイントの場合は、hr_db_endpoint.confという名前にします。
  2. ファイルを開き、次の表に示すプロパティを設定します。

    表13-1 構成ファイルに設定するプロパティ

    プロパティ 値 オプション 説明

    server

    文字列

    必須

    Oracle Key Vaultサーバーのホスト名またはIPアドレスを指定します。RESTfulサービス・ユーティリティ。標準のHTTPSポート443が使用されます(オプション)。IPアドレスまたはホスト名を指定するのみで十分です。

    script

    文字列

    オプション(複数のRESTfulサービス・コマンドの場合のみ必須)

    スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。KM REST APIでは使用されません。

    log_level

    文字列

    必須

    次のいずれかのログ・レベルを指定します。

    • allはすべてのメッセージを記録します

    • severeはクリティカルなエラーを記録します

    • warningログには、問題を引き起こす可能性のあるクリティカルではないエラーが記録されます

    • infoは一般的な情報を記録します

    • fineログには詳細が記録され、デバッグに役立ちます

    • finestログには、最も詳細なロギング情報が記録されます

    ssl_wallet_loc 文字列 オプション(構成ファイルがKMIP RESTのokvclient.oraではない場合にのみ必須) okvlient.oraのSSL (Secure Sockets Layer)デプロイメント・ディレクトリへのパスを指定します。これは、okvclient.jarファイルからデプロイされたewallet.p12およびcwallet.ssoの場所です。

    log

    文字列

    オプション

    ログ・ファイルの絶対パスを指定します。選択した場所にカスタム・ログ・ファイルを作成する場合は、このプロパティを設定します。この設定を省略すると、デフォルトのログ・ファイルokvrestservices.logに結果が記録され、デフォルトのログ・ファイルの場所として現在のディレクトリに配置されます。

    usr

    文字列

    オプション

    Oracle Key Vaultアカウントのユーザー名を指定します。このプロパティの設定を省略すると、ユーザー名の入力を求められます。通常、このユーザーは、コマンドの実行に必要な権限のあるシステム管理者ロールまたはキー管理者ロールを持ちます。キーへのアクセスはエンドポイント権限によって判断されるため、KM REST APIではusrプロパティは使用されません。

    pwd

    文字列

    オプション

    ユーザー・パスワードを指定します。このプロパティの設定を省略すると、パスワードを要求されます。セキュリティを強化するには、configurationファイルのパスワードを省略し、プロンプトが表示されたら対話的に入力します。KM REST APIでは使用されません。

    client_wallet

    文字列

    オプション

    自動モードでのウォレットへの絶対パスを指定します。自動モードでは人による操作がないため、Oracle Key Vaultサーバーにログインするためのユーザー資格証明はウォレットに配置されます。このオプションがusrオプションとともに使用されると、Key Vaultサーバーとの接続を確立するために、コマンドによってユーザーの資格証明がウォレットから取得されます。KM REST APIでは使用されません。

  3. セキュアな場所に構成ファイルを保存します。

親トピック: RESTfulサービス構成ファイルの管理

13.4.4 構成ファイルの例

IPアドレスおよびホスト名を使用する構成ファイルを作成できます。

例13-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

例13-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サービス構成ファイルの管理

13.4.5 単一のRESTfulコマンドの実行

数個のコマンドのみを実行する場合は、-rまたは--serviceオプションを使用して、コマンドラインから個別にコマンドを実行します。

  1. コマンドを実行するエンドポイントにログインします。
  2. 構成ファイルのscriptプロパティに値がないことを確認してください
  3. -cオプションで構成ファイル、-rオプションまたは--service オプションでサービスを指定し、さらにコマンド固有のオプションを指定して、RESTfulサービス・ユーティリティを実行します。
    次に例を示します。 
    java -jar okvrestservices.jar -c conf_file -r create_endpoint -e hr_db_ep -d "HR database endpoint" -q solaris64 -t oracle_db -m psmith@example.com
User: Key_Vault_user_name
Password: Key_Vault_user_password

    このように指定した場合:

    • -cは、構成ファイルconf_fileを示します。

    • -rは、RESTfulサービスcreate_endpointを示します。

    • -eは、エンドポイント名hr_db_epを示します。

    • -dは、エンドポイントの説明HR database endpointを示します。

    • -qは、エンドポイント・プラットフォームsolaris64を示します。

    • -tは、エンドポイント・タイプoracle_dbを示します。

    • -mは、エンドポイントの電子メールpsmith@example.comを示します。

マルチマスター・クラスタ環境でマルチマスター・クラスタ機能を利用するには、デフォルトの場所のokvclient.ora構成ファイルを使用する必要があります。okvclient.oraを使用するかわりに、独自の構成ファイルを使用できます。ただし、スタンドアロン・モードで接続されるため、マルチマスター・クラスタ環境は利用できません。

ノート:

コマンドライン・オプションは、構成ファイルまたはスクリプトで指定されたオプションよりも優先されます。たとえば、プロパティusrが構成ファイルおよびコマンドラインで指定されている場合は、コマンドラインのオプションによって構成ファイルのオプションがオーバーライドされます。

親トピック: RESTfulサービス構成ファイルの管理

13.4.6 1つのスクリプトを使用した複数のRESTful管理コマンドの実行

時間と労力を節約し、正確性を確保するには、スクリプトを使用して一連のコマンドを実行します。

コマンドラインから一度に1つずつ、一連のOracle Key Vault管理コマンドを実行できます。ただし、一連のコマンドを1つのスクリプトに記述すると、より効率的に実行できます。スクリプト・ファイルの各コマンドは、サービス・コマンドとして解釈されます。-iオプションまたは--scriptオプションを含むスクリプトを起動して、スクリプト・ファイルのパスを指定する必要があります。これは、KM REST APIを使用したキー管理コマンドの実行には適用されません。構成ファイルでscriptプロパティを定義すると、コマンドラインにこれを入力する必要がなくなります。scriptパラメータは、構成ファイルまたはコマンドラインのいずれかで1回のみ入力します。
  1. コマンドを実行するエンドポイントにログインします。
  2. スクリプト・ファイルを作成して、このスクリプト・ファイルに実行するサービス・コマンドを追加します。
    たとえば、次のコマンドをスクリプト・ファイルに記述して、エンドポイント、エンドポイント・グループを作成し、エンドポイントをエンドポイント・グループに追加します。
    create_endpoint -e hr_db_ep -d "HR database endpoint" -q solaris64 -t oracle_db -m psmith@example.com 
create_endpoint_group -g hr_db_epg -d "HR endpoint group"
add_epg_member -g hr_db_epg -e hr_db_ep
  3. スクリプト・ファイルは、create_hr_endpoint_group.txtのようなわかりやすい名前を付けて保存します。
  4. conf_fileという名前の構成ファイルを編集してscriptプロパティを追加し、そのプロパティにスクリプト・ファイルの名前およびそのフル・パスを設定します。
    構成ファイルは次のようになります。 
    server=192.0.2.254
usr=okvadmin
log=/logs/okvrestservices.log
log_level=warning
script=/scripts/create_hr_endpoint_group.txt
client_wallet=/path_to_wallet_that_contains_credentials_for_RESTuser
  5. 構成ファイルにスクリプト・プロパティを定義した場合は、構成ファイルのみを指定してRESTfulサービス・ユーティリティを実行します。
    java -jar okvrestservices.jar -c conf_file 
User: Oracle_Key_Vault_user
Password: Oracle_Key_Vault_user_password

    構成ファイルでscriptプロパティを設定しなかった場合(ステップ4)にRESTfulサービス・ユーティリティを実行するには、構成ファイルとスクリプト・ファイルの両方を指定する必要があります。 

    java -jar okvrestservices.jar -c conf_file -i /scripts/create_hr_endpoint_group.txt
User: Oracle_Key_Vault_user
Password: Oracle_Key_Vault_user_password

RESTfulサービス・ユーティリティでは、一度に1つのコマンドを実行します。コマンドが失敗すると、スクリプトは終了します。実行されたすべてのコマンドの結果は、行番号および実行時にレポートされたメッセージとともにログ・ファイルに表示されます。この情報はすべてのログ・レベルで出現します。デフォルトでは、このログ・ファイルはコマンドが実行されるディレクトリと同じディレクトリに作成されます。

関連項目

親トピック: RESTfulサービス構成ファイルの管理

13.4.7 エンドポイントとしてOracle Databasesを自動的にエンロールするスクリプトの作成

データベース管理者がOracle Key VaultにOracle Databaseエンドポイントを自動的にエンロールするために実行できるスクリプトを作成できます。

Oracle Key Vault管理者は、データベース管理者が後で共有の場所からダウンロードし、データベース・サーバー上で実行して、Oracle Key Vault管理者の介入なしにデータベースをOracle Key Vaultに自動的にオンボードできるスクリプトおよびファイルのセットを作成できます。Oracle Key Vault管理者は、次のものをパッケージ化します。
  • 構成ファイル(config.iniなど)
  • ewallet.p12およびcwallet.ssoウォレット・ファイル
  • run-me.shスクリプト

次の手順では、これらのコンポーネントを作成する方法を説明します。

  1. Oracle Key Vaultサーバーにログインします。
  2. RESTfulサービス・パッケージをダウンロードし、作業ディレクトリに格納します。ここでは、他のファイルも作成します。
    curl -O -k https://Oracle_Key_Vault_IP_address:5695/okvrestservices.jar
  3. ユーザーを作成してエンドポイント作成権限を付与します(この手順を実行していない場合)。
    Oracle Key Vault管理コンソールを使用して、このユーザーを作成します。このトピックの手順では、このユーザーにrestuser_ronという名前を付けて、エンドポイント作成権限を付与します。システム管理者ロールを持つユーザーがrestuser_ronアカウントを作成して、そのユーザーにエンドポイント作成権限を付与します。最後に、restuser_ronユーザーがログインして、ワンタイム・パスワードを永続パスワードに変更する必要があります。
  4. 構成ファイル(config.iniなど)を作成して、次のように設定します。
    • serverは、okvrestservices.jarファイルをダウンロードしたOracle Key VaultサーバーのIPアドレスです。
    • usrはエンドポイント作成権限を持つユーザーです。この例の場合、そのユーザーの名前はrestuser_ronです。
    • logは、ファイル名を含むログ・ファイルの場所です。
    • log_levelは、構成ファイルのログ・レベルです。設定のfinestは、ログに詳細なメッセージが記録され、デバッグに適したものになるためお薦めです。
    • client_walletは、restuser_ronユーザーの永続パスワードが含まれているウォレットの絶対パスです。usrオプションを含めているため、このコマンドはウォレットからユーザーの資格証明を取得して、Oracle Key Vaultサーバーとの接続を確立します。
    • scriptは、実行するスクリプト・ファイルへの絶対パスです。このスクリプトには、RESTfulサービスがOracle Key Vaultで実行する正しい構文のコマンドが含まれています。ただし、すべてのデータベース管理者が同じファイルのコレクションをダウンロードするため、スクリプトではOracle Key Vaultの仮想ウォレットとエンドポイントに同じ名前が使用されます。エンドポイントとして構成するデータベースごとに、仮想ウォレットの一意の名前およびOracle Key Vaultのこのデータベース・インスタンスのエンドポイントを含むスクリプトを作成する必要があります。そのため、このスクリプトはサーバー自体で作成する必要があります。仮想ウォレットおよびエンドポイントに一意の名前を作成する方法の1つは、そのデータベース・インスタンスのローカル環境変数から仮想ウォレットおよびエンドポイントを作成することです。環境に一致する別の方法または命名規則を見つける必要がある場合があります。この手順の後のステップで、このスクリプトの例を示します。

    たとえば、IPアドレスが192.0.2.181のOracle Key Vaultサーバーにconfig.iniファイルを作成するには、次のようにします。 

    server=192.0.2.181
usr=restuser_ron
log=/home/oracle/OKVrest.log
log_level=finest
client_wallet=/home/oracle
script=/home/oracle/script.txt

    このように指定した場合:

    • usr=restuser_ronは、エンドポイント作成権限を持つrestuser_ronというユーザーを表します。
    • client_walletは、RESTfulサービスがrestuser_ronユーザーのパスワードを見つけられる場所を指します。Oracle Key Vault管理者は、このウォレットを作成する必要があります。
  5. 次のコマンドを実行して、ウォレットを作成し、restuser_ronユーザーのパスワードを挿入します。
    java -jar okvrestservices.jar -c config.ini --client_wallet /home/oracle --add restuser_ron
Password: restuser_ron_password
    このコマンドでは、パスワード保護されたウォレットewallet.p12および自動ログイン・ウォレットcwallet.ssoが作成されます。
  6. config.iniファイルのscriptパラメータで参照されるスクリプトを作成します。
    サイトでウォレットおよびその他のコンポーネントの名前に通常使用される命名規則を使用します。

    run-me.shという次のシェル・スクリプトは、データベース管理者がダウンロードするためにOracle Key Vault管理者が作成するパッケージの一部です。config.iniファイルで参照されるファイルscript.txtが作成され、仮想ウォレットおよび関連付けられたエンドポイントの一意の名前が含まれます。 

    $ more run-me.sh

#!/bin/bash
export EP_NAME=${ORACLE_SID^^}_on_${HOSTNAME/.*}
curl -O -k https://Oracle_Key_Vault_IP_address:5695/okvrestservices.jar
cat > /home/oracle/script.txt << EOF
create_wallet -w ${DB_NAME^^}
create_endpoint -e $EP_NAME -t ORACLE_DB -q LINUX64 -d "$HOSTNAME, $(hostname -i)"
set_default_wallet -e $EP_NAME -w ${DB_NAME^^}
provision -v temporary_password -e $EP_NAME -y /u01/opt/oracle/product/okv
EOF
more script.txt

    このように指定した場合:

    1. export ...はuppercase(ORACLE_SID)_on_short_hostnameからエンドポイント名を作成し、大文字の(ORACLE_SID)からWALLET_NAMEを作成します。Oracle Real Application Clusters (Oracle RAC)環境で、ORACLE_SIDを大文字の(ORACLE_UNQNAME)に置き換えます。
    2. curlでは、データベース管理者がrun-meスクリプトを実行したときに、適切な現行バージョンのOracle Key Vault RESTfulサービス・パッケージをダウンロードします。
    3. create_wallet ...は、Oracle Key Vaultに(共有)仮想ウォレットを作成します。ここでは、uppercase(database name)があります。
    4. create_endpoint ...は、aの行のexportコマンドで作成されたエンドポイントに基づいて名前が付けられたエンドポイントを、type=ORACLE_DB, OS=LINUX64とフリー・テキストfully_qualified_hostname, IP addressで作成します。
    5. set_default_wallet ...はデフォルトのウォレットを設定し、作成されたエンドポイント(行d)を共有ウォレット(行c)に関連付けます。
    6. provision ...では、WALLET_ROOT/okv既存ディレクトリへの一時パスワードを使用したダウンロードとインストールを実行します。
  7. run-me.shスクリプトを複製して、様々な状況で使用するプライマリ・スクリプトとセカンダリ・スクリプトを作成します。
    プライマリ・スクリプトは、単一インスタンス・データベースおよび最初のOracle RACインスタンスに使用されます。セカンダリ・スクリプトは、プライマリ・データベースの残りのOracle RACノードおよび対応するスタンバイOracle RACデータベースのすべてのノードに使用されます。このセカンダリ・スクリプトは、最初のインスタンスで作成された共有ウォレットにエンドポイントを関連付けます。
    1. run-me.shスクリプトの名前をprimary-run-me.shに変更します。
    2. primary-run-me.shをsecondary-run-me.shという名前の新しいファイルにコピーします。
    3. secondary-run-me.shを開き、次の行を削除します。 
      
create_wallet -w ${DB_NAME^^}
  8. スクリプトを実行可能にします。 
    $ chmod +x primary-run-me.sh
$ chmod +x secondary-run-me.sh
  9. 各スクリプトをテストして、script.txtファイルを作成できることを確認します。 
    $ ./primary-run-me.sh
$ ./secondary-run-me.sh
  10. 次のコマンドを実行して、仮想ウォレットおよびエンドポイントの名前が命名規則に従っていることを確認します。
    $ more script.txt
  11. 各スクリプトに対して2つの.zipファイル・パッケージを作成します。
    各パッケージには次のコンテンツが必要です。
    • primary.zipには、primary-run-me.sh、ewallet.p12、cwallet.ssoおよびconfig.iniを含めます。
    • secondary.zipには、secondary-run-me.sh、ewallet.p12、cwallet.ssoおよびconfig.iniを含めます。
  12. これらの2つの.zipファイルを、データベース管理者が共有ファイル・サーバーからダウンロードできるようにします。
  13. スクリプトをダウンロードして実行する場所をデータベース管理者に指示します。
    • 単一インスタンス・データベースまたは最初のOracle RACインスタンスで、primary-run-me.shスクリプトを実行します。Oracle Data Guard環境の場合は、プライマリOracle RACデータベースのリード・ノードでスクリプトを実行します。
    • プライマリ・データベースの残りのすべてのOracle RACノードおよび対応するスタンバイOracle RACデータベースのすべてのノードで、secondary-run-me.shスクリプトを実行します。

関連項目

親トピック: RESTfulサービス構成ファイルの管理

13.5 RESTfulサービスの無効化

RESTfulサービスは、エンドポイントを登録およびエンロールする間の短期間のみ有効にする必要があります。

RESTfulサービスはデフォルトでは無効になっています。エンドポイントを登録したら、RESTfulサービスを無効にする必要があります。
  1. システム管理者ロールを持っているユーザーとしてOracle Key Vault管理コンソールにログインします。
  2. 左サイドバーで、「System」タブから「System Settings」を選択します。

    「System Settings」ページが表示されます。

  3. 「RESTful Services」セクションで、「Enable」の右側のボックスの選択を解除します。
  4. 「System Settings」ページで、「Save」をクリックします。

親トピック: RESTfulサービスを使用したOracle Key Vaultの管理およびキー管理

13.6 Oracle Key Vaultの管理RESTクライアント・ツール・コマンド

RESTfulサービスの管理コマンドは、エンドポイントとエンドポイント・グループを管理する管理者向けに設計されています。

  • RESTfulサービス・コマンド構文
    RESTfulサービス・コマンド構文では、ロング形式とショート形式の両方が提供されています。
  • RESTfulサービスのウォレット・コマンド構文
    RESTfulサービスのウォレット・コマンド構文では、ロング形式とショート形式の両方が提供されています。
  • エンドポイント・コマンド
    エンドポイントの管理にRESTfulコマンドを使用するには、システム管理者ロールまたはエンドポイント管理権限が必要です。
  • エンドポイント・グループのコマンド
    エンドポイント・グループの作成および管理にはキー管理者ロールまたはエンドポイント・グループ管理権限が必要です。
  • 仮想ウォレット・コマンド
    仮想ウォレット・コマンドは、仮想ウォレットのライフサイクルを管理し、仮想ウォレットとエンドポイントまたはエンドポイント・グループ間のアクセス制御マッピングを定義します。
  • エラー・レポート
    RESTfulサービス・ユーティリティには、RESTfulサービス・コマンドをすばやく正常に実行するためにデバッグする強力なエラー・レポートがあります。
  • ステータスとヘルプ情報のコマンド
    これらのコマンドにより、特定のOracle Key Vaultオブジェクトに関するステータス情報、Oracle Key Vaultシステム全体に関する情報、一般的なヘルプ情報が示されます。

親トピック: RESTfulサービスを使用したOracle Key Vaultの管理およびキー管理

13.6.1 RESTfulサービス・コマンド構文

RESTfulサービス・コマンド構文では、ロング形式とショート形式の両方が提供されています。

これらのコマンドを使用するには、エンドポイント管理者である必要があります。エンドポイント関連のコマンドの場合は、システム管理者ロールまたはエンドポイント管理権限を持っていることが必要です。エンドポイント・グループ関連のコマンドには、キー管理者ロールまたはエンドポイント・グループ管理権限が必要です。

java -jarコマンドを使用してRESTfulサービス・ユーティリティokvrestservicesを実行し、構成ファイルのパスを指定する必要があります。

サーバーにエンドポイント・ソフトウェアをインストールする場合は、手動で作成した構成ファイル(config.iniファイルなど)を使用します。Oracle Key Vaultクライアントをインストールしたら、Oracle Key Vaultのクラスタ機能を利用するために、Oracle_Key_Vault_installation_directory/conf内で自動的に作成されてメンテナンスされるokvclient.ora構成ファイルを使用することをお薦めします。okvclient.oraには、Oracle Key VaultでRESTfulコマンドを自動的に実行できるようにするためのusrおよびclient_walletパラメータのエントリがありません。この場合は、RESTfulコマンドに-u usernameおよび-j client_wallet_locationパラメータを追加します。

次の表に、すべてのRESTfulサービス・コマンドで使用される共通のオプションを示します。

表13-2 RESTful管理サービス・コマンドのリスト

コマンド名 説明

add_epg_member

エンドポイント・グループにエンドポイントを追加します。エンドポイントがすでに存在する必要があります。

add_wallet_access_ep

仮想ウォレットに対するエンドポイントのアクセス権のマッピングを設定します

add_wallet_access_epg

仮想ウォレットに対するエンドポイント・グループのアクセス権のマッピングを設定します

check_object_status

エンドポイント、エンドポイント・グループまたはウォレットのステータスをチェックします

create_endpoint

Oracle Key Vaultにエンドポイントを追加します。追加されると、エンドポイントは登録済状態になります。

create_endpoint_group

新しいエンドポイント・グループを追加します

create_unique_endpoint

一意のエンドポイントをOracle Key Vaultに追加します。

create_unique_endpoint_group

一意のエンドポイント・グループをOracle Key Vaultに追加します。

create_unique_wallet

Oracle Key Vaultに一意の仮想ウォレットを追加します

create_wallet

Oracle Key Vaultに仮想ウォレットを追加します

delete_endpoint

Oracle Key Vaultからエンドポイントを削除します

delete_endpoint_group

エンドポイント・グループを削除します

delete_wallet

Oracle Key Vaultから仮想ウォレットを削除します

download

エンドポイントにエンドポイント・ソフトウェアokvclient.jarを手動でインストールするために、これをダウンロードします。

drop_epg_member

エンドポイント・グループからエンドポイントを削除します

drop_wallet_access_ep

仮想ウォレットに対するエンドポイントのアクセス権のマッピングを削除します

drop_wallet_access_epg

仮想ウォレットに対するエンドポイント・グループのアクセス権のマッピングを削除します
get_cluster_info

クラスタに関するステータス情報を取得します
get_cluster_node_info

クラスタ内のノードに関するステータス情報を取得します

get_default_wallet エンドポイントのデフォルト・ウォレットを取得します

get_enrollment_token

エンロール・トークンを取得して、登録されたエンドポイントのエンドポイント・ソフトウェアをダウンロードします
get_system_info クライアント・ツール・バージョン、サーバー・バージョンおよびデプロイメント・モードを返します
get_wallets エンドポイントのすべての仮想ウォレットを取得します

modify_endpoint_desc

エンドポイントの説明を変更します

modify_endpoint_email

エンドポイントの電子メールを変更します

modify_endpoint_group

エンドポイント・グループを変更します

modify_endpoint_group_desc

エンドポイント・グループの説明を変更します

modify_endpoint_name

エンドポイント名を変更します

modify_endpoint_platform

エンドポイント・プラットフォームを変更します

modify_endpoint_type

エンドポイント・タイプを変更します

modify_wallet_access_ep

仮想ウォレットに対するエンドポイントのアクセス権のマッピングを変更します

modify_wallet_access_epg

仮想ウォレットに対するエンドポイント・グループのアクセス権のマッピングを変更します

modify_wallet_desc

仮想ウォレットの説明を変更します

modify_wallet_name

仮想ウォレットの名前を変更します

provision

エンドポイント・ソフトウェアokvclient.jarをダウンロードしてインストールします。この後、エンドポイントはエンロール済状態になります。

re_enroll

エンドポイントを再エンロールします

re_enroll_all

すべてのエンドポイントを再エンロールします

set_default_wallet

エンドポイントのデフォルト・ウォレットを設定します

例13-3 ショート形式のオプションの指定

オプションの前に1つのハイフンを使用してショート形式のオプションを指定します。

java -jar okvrestservices.jar -c path [-r RESTful_service | -i path]

例13-4 ロング形式のオプションの指定

オプションの前に二重ハイフンを使用してロング形式のオプションを指定します。

java -jar okvrestservices.jar --config path [--service RESTful_service | --script path]

親トピック: Oracle Key Vaultの管理RESTクライアント・ツール・コマンド

13.6.2 RESTfulサービスのウォレット・コマンド構文

RESTfulサービス・ウォレット・コマンド構文では、ロング形式とショート形式の両方が提供されています。

次の例に、--client_walletオプションで指定されるOracleウォレットに関連するRESTfulサービス・コマンドを示します。このウォレットは、人による操作なしで自動的にエンドポイントをプロビジョニングできるようにするために、自動モードでのユーザー名およびパスワードを格納します。

これは、仮想ウォレット・コマンドの一部である--walletオプションで指定される仮想ウォレットとは異なります。

表13-3 ウォレット・コマンドのオプション

オプション 必須かどうか 説明

-A、--add

オプション

ウォレットにユーザーを追加します

-D、--delete

オプション

ウォレットからユーザーを削除します

-f、--force

オプション

確認を求めることなく、操作を実行します

-j、--client_wallet arg

必須

ウォレットの場所の絶対パスを表します

-L、--listuser

オプション

ウォレットに対するアクセス権を持つユーザーをリストします

-M、--modify

オプション

ユーザーのパスワードを変更します

-w、--wallet_name arg

必須

ウォレット名を表します

例13-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

親トピック: Oracle Key Vaultの管理RESTクライアント・ツール・コマンド

13.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コマンドは、登録済エンドポイントのエンロール・トークンを取得します。
  • modify_endpoint_descコマンド
    modify_endpoint_descコマンドは、エンドポイントの説明を変更します。
  • modify_endpoint_emailコマンド
    modify_endpoint_emailコマンドは、エンドポイントの電子メール・アドレスを変更します。
  • modify_endpoint_nameコマンド
    modify_endpoint_nameコマンドは、エンドポイントの名前を変更します。
  • modify_endpoint_platformコマンド
    modify_endpoint_platformコマンドは、エンドポイントのプラットフォームを変更します。
  • modify_endpoint_typeコマンド
    modify_endpoint_typeコマンドは、エンドポイント・タイプを変更します。
  • provisionコマンド
    provisionコマンドは、指定されたディレクトリにエンドポイント・ソフトウェアをダウンロードしてインストールします。このディレクトリは存在している必要があります。
  • re_enrollコマンド
    re_enrollコマンドは、エンドポイント・ソフトウェアをアップグレードするために、以前にエンロールしたエンドポイントを再エンロールします。
  • re_enroll_allコマンド
    re_enroll_alコマンドは、エンドポイント・ソフトウェアをアップグレードするために、以前にエンロールされたすべてのエンドポイントを再エンロールします。

親トピック: Oracle Key Vaultの管理RESTクライアント・ツール・コマンド

13.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

パラメータ

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

-e、--ep_name

必須

追加するエンドポイントの名前。「オブジェクトのネーミング・ガイドライン」を参照してください。

-d、--desc

オプション

わかりやすいエンドポイントの説明。空白が含まれる説明は、二重引用符で囲む必要があります。

-q、--ep_platform

必須

エンドポイント・プラットフォーム。使用可能な値は次のとおりです。

  • linux64

  • solaris64

  • solaris_sparc

  • aix

  • hpux

  • hp-ux

  • windows

-t、--ep_type

必須

エンドポイントのタイプ。使用可能な値は次のとおりです。

  • oracle_db

  • oracle_non_db

  • other

-m、--ep_email

オプション

エンドポイント管理者の電子メール・アドレス。この値は二重引用符で囲みます。

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

-p, --pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-c, --config

必須

構成ファイルの絶対パスを指定します

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

ショート形式の例

この例では、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
13.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

パラメータ

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

-e、--ep_name

必須

追加するエンドポイントの名前。「オブジェクトのネーミング・ガイドライン」を参照してください。

-d、--desc

オプション

わかりやすいエンドポイントの説明。空白が含まれる説明は、二重引用符で囲む必要があります。

-q、--platform

必須

エンドポイント・プラットフォーム。使用可能な値は次のとおりです。

  • linux64

  • solaris64

  • solaris_sparc

  • aix

  • aix_53

  • hp-ux

  • windows

-t、--ep_type

必須

エンドポイントのタイプ。使用可能な値は次のとおりです。

  • oracle_db

  • oracle_non_db

  • oracle_acfs

  • mysql_db

  • other

-m、--ep_email

必須

エンドポイント管理者の電子メール・アドレス。この値は二重引用符で囲みます。

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-c、--config

必須

構成ファイルの絶対パスを指定します

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

ショート形式の例

この例では、my_db_epというエンドポイントが追加され、これにはオプションの識別説明'My database endpoint'、タイプoracle_db、プラットフォームsolaris64およびエンドポイント管理者の電子メールpsmith@example.comが指定されています。 

java -jar okvrestservices.jar -c conf_file -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 conf_file --service create_unique_endpoint --ep_name my_db --desc "My database endpoint" --platform solaris64 --ep_type oracle_db --ep_email psmith@example.com
13.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

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-f、--force

オプション

強制的に削除し、確認メッセージを抑止します

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.3.4 downloadコマンド

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

ディレクトリ・パスは、-oオプションで指定されます。絶対パスまたは相対パスを指定でき、さらにそのパスを指す環境変数も設定できます。

エンドポイントをエンロールするには、downloadコマンドまたはprovisionコマンドのいずれかを使用できます。特定のエンドポイントに対して両方のコマンドを使用することはできません。

構文

ショート形式:

download -e endpoint_name -o directory

ロング形式:

download --ep_name endpoint_name -dir directory

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-o、--dir

必須

エンドポイント・ソフトウェアのダウンロード・ディレクトリの絶対パス。たとえば、-o /tmpを指定すると、エンドポイント・ソフトウェアは/tmp/endpoint_name/okvclient.jarにダウンロードされます。

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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/
13.6.3.5 get_enrollment_tokenコマンド

get_enrollment_tokenコマンドは、登録済エンドポイントのエンロール・トークンを取得します。

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

構文

ショート形式:

get_enrollment_token -e endpoint_name

ロング形式:

get_enrollment_token --ep_name endpoint_name

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.3.6 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"

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-d、--desc

必須

二重引用符で囲まれたこのエンドポイントの新しい説明文字列

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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"
13.6.3.7 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

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-m、--ep_email

必須

このエンドポイントの新しい電子メール・アドレスこの値は二重引用符で囲みます。

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.3.8 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

パラメータ

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

-e、--ep_name

必須

エンドポイントの現在の名前。

-n、--ep_new_name

必須

このエンドポイントの新しい名前「オブジェクトのネーミング・ガイドライン」を参照してください。

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

ショート形式の例

この例は、エンドポイントhr_dbの名前をhr_db_epの名前に変更します。 

java -jar okvrestservices.jar -c conf_file -r modify_endpoint_name -e hr_db -n hr_db_ep

ロング形式の例

java -jar okvrestservices.jar --config conf_file --service modify_endpoint_name --ep_name hr_db --ep_new_name hr_db_ep
13.6.3.9 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

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-q、--ep_platform

必須

このエンドポイントのサーバーのプラットフォーム。値は次のとおりです。

  • linux64

  • solaris64

  • solaris_sparc

  • aix

  • hpux

  • hp-ux

  • windows

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.3.10 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

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-t、--ep_type

必須

エンドポイントのタイプ。値は次のとおりです。

  • oracle_db

  • oracle_non_db

  • other

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.3.11 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

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前。

-o、--dir

必須

エンドポイント・ソフトウェアをダウンロードしてインストールする既存のディレクトリ

-y、--okv_home

-o、--dirオプションを使用しない場合は必須

クライアント側のウォレット・ルートに使用されるOracle Key Vaultホーム・ディレクトリ。このパラメータと-o、--dirのいずれかを選択します。-o、--dirと-y、--okv_homeを使用した場合の違いは、-y、--okv_homeではエンドポイント・ディレクトリが作成されないことのみです。

-v、--endpoint_password

オプション

エンドポイントのパスワード。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると(セキュリティ強化のためにお薦めします)、provisionコマンドにより、対話式でパスワードの入力を求められます。相互認証TLS (Transport Layer Security)を介してOracle Key Vaultサーバーと通信するために、エンドポイント・ソフトウェアのインストール中にウォレットに対して使用されるパスワードを指定する必要があります。エンドポイント・ソフトウェアのインストール中にパスワードなしの自動ログイン・ウォレットを作成した場合、エンドポイントの資格証明はOracleウォレットに格納されます。

-a、--autologin

必須

Oracle Key Vaultサーバーに接続するためのエンドポイントの資格証明が、自動ログイン・ウォレットに格納されます。

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-c、--config

必須

構成ファイルの絶対パスを指定します

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

ショート形式の例

自動ログイン・モード:

この例では、エンドポイント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 --ep_name hr_db_ep --dir /home/oracle/okvutil/
13.6.3.12 re_enrollコマンド

re_enrollコマンドは、エンドポイント・ソフトウェアをアップグレードするために、すでにエンロール済のエンドポイントを再エンロールします。

構文

ショート形式:

re_enroll -e endpoint_name

ロング形式:

re_enroll --ep_name endpoint_name

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.3.13 re_enroll_allコマンド

re_enroll_alコマンドは、エンドポイント・ソフトウェアをアップグレードするために、すでにエンロール済のすべてのエンドポイントを再エンロールします。

構文

ショート形式とロング形式:

re_enroll_all

パラメータ

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

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

ショート形式の例

java -jar okvrestservices.jar -c conf_file -r re_enroll

ロング形式の例

java -jar okvrestservices.jar --config conf_file --service re_enroll

13.6.4 エンドポイント・グループ・コマンド

エンドポイント・グループの作成および管理にはキー管理者ロールまたはエンドポイント・グループ管理権限が必要です。

親トピック: Oracle Key Vaultの管理RESTクライアント・ツール・コマンド

13.6.4.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

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-g、--epg_name

必須

エンドポイント・グループの名前

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.4.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"

パラメータ

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

-g、--epg_name

必須

エンドポイント・グループの名前「オブジェクトのネーミング・ガイドライン」を参照してください。

-d、--desc

オプション

二重引用符で囲まれたエンドポイント・グループのわかりやすい説明

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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"
13.6.4.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"

パラメータ

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

-g、--epg_name

必須

エンドポイント・グループの名前「オブジェクトのネーミング・ガイドライン」を参照してください。

-d、--desc

オプション

二重引用符で囲まれたエンドポイント・グループのわかりやすい説明

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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_unique_endpoint_group --epg_name epg_hr --desc "HR endpoint group"
13.6.4.4 delete_endpoint_groupコマンド

delete_endpoint_groupコマンドは、Oracle Key Vaultからエンドポイント・グループを削除します。

構文

ショート形式:

delete_endpoint_group -f -g endpoint_group

ロング形式:

delete_endpoint_group --force --endpoint_group

パラメータ

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

-g、--epg_name

必須

エンドポイント・グループの名前

-f、--force

オプション

強制的に削除し、確認メッセージを抑止します

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.4.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

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-g、--epg_name

必須

エンドポイント・グループの名前

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.4.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"

パラメータ

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

-g、--epg_name

必須

エンドポイント・グループの名前

-d、--desc

必須

二重引用符で囲まれたエンドポイント・グループの新しい説明文字列

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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"
13.6.4.7 modify_endpoint_group_nameコマンド

modify_endpoint_group_nameコマンドは、エンドポイント・グループの名前を変更します。

構文

ショート形式: 

modify_endpoint_group_name -g endpoint_group_name -z new_endpoint_group_name

ロング形式:

modify_endpoint_group_name  --epg_name epg endpoint_group_name --new_name new_endpoint_group_name

パラメータ

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

-g、--epg_group_name

必須

エンドポイント・グループの現在の名前

-z、--new_name

必須

新しいエンドポイント・グループ名。「オブジェクトのネーミング・ガイドライン」を参照してください。

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

ショート形式の例

この例では、エンドポイント・グループ名hr_dbをhr_db_westに変更します。 

java -jar okvrestservices.jar modify_endpoint_name -g hr_db -z hr_db_west

ロング形式の例

java -jar okvrestservices.jar modify_endpoint_name --epg_name hr_db --new_name hr_db_west

13.6.5 仮想ウォレット・コマンド

仮想ウォレット・コマンドは、仮想ウォレットのライフサイクルを管理し、仮想ウォレットとエンドポイントまたはエンドポイント・グループ間のアクセス制御マッピングを定義します。

ウォレット・コマンドを実行するには、キー管理者ロールが必要です。

親トピック: Oracle Key Vaultの管理RESTクライアント・ツール・コマンド

13.6.5.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

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-w、--wallet_name

必須

仮想ウォレットの名前

-l、--access_level

必須

仮想ウォレットに対するアクセス・レベル。値は次のとおりです。

  • ro: 読取り専用

  • rm: 読取りおよび変更

  • ro_mw: 読取り専用および仮想ウォレット管理

  • rm_mw: 読取りおよび変更、および仮想ウォレット管理

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.5.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

パラメータ

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

-g、--epg_name

必須

エンドポイント・グループの名前

-w、--wallet_name

必須

仮想ウォレットの名前

-l、--access_level

必須

仮想ウォレットに対するアクセス・レベル。値は次のとおりです。

  • ro: 読取り専用

  • rm: 読取りおよび変更

  • ro_mw: 読取り専用および仮想ウォレット管理

  • rm_mw: 読取りおよび変更、および仮想ウォレット管理

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.5.3 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"

パラメータ

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

-w、--wallet_name

必須

作成する一意のウォレットの名前。「オブジェクトのネーミング・ガイドライン」を参照してください。

-d、--desc

オプション

二重引用符で囲まれた一意のウォレットのわかりやすい名前。

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

ショート形式の例

この例では、my_walletという名前の一意の仮想ウォレットをMy unique walletという説明を付けて作成します。 

java -jar okvrestservices.jar -c conf_file -r create_unique_wallet -w my_wallet -d "My unique wallet"

ロング形式の例

java -jar okvrestservices.jar --config conf_file --service create_unique_wallet --wallet  my_wallet --desc "My unique wallet"
13.6.5.4 create_walletコマンド

create_walletコマンドは仮想ウォレットを作成します。

構文

ショート形式:

create_wallet -w virtual_wallet_name -d "wallet_description"

ロング形式:

create_wallet --wallet_name wallet_name --desc "wallet_description"

パラメータ

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

-w、--wallet_name

必須

仮想ウォレットの名前「オブジェクトのネーミング・ガイドライン」を参照してください。

-d、--desc

オプション

二重引用符で囲まれた仮想ウォレットのわかりやすい名前

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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"
13.6.5.5 delete_walletコマンド

delete_walletコマンドは、Oracle Key Vaultからウォレットを削除します。

構文

ショート形式:

delete_wallet -f -w virtual_wallet_name

ロング形式:

delete_wallet --force --wallet_name virtual_wallet_name

パラメータ

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

-w、--wallet_name

必須

仮想ウォレットの名前

-f、--force

オプション

確認を求めることなく、強制的に削除します

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.5.6 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

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-w、--wallet_name

必須

仮想ウォレットの名前

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.5.7 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

パラメータ

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

-g、--epg_name

必須

エンドポイント・グループの名前

-w、--wallet_name

必須

仮想ウォレットの名前

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.5.8 get_default_walletコマンド

get_default_walletコマンドは、エンドポイントに関連付けられたデフォルト・ウォレットを取得します。

構文

ショート形式: 
get_default_wallet -e endpoint_name
ロング形式: 
get_default_wallet --ep_name endpoint_name

パラメータ

パラメータ 必須かどうか 説明
-e、-–ep_name 必須 デフォルト・ウォレットを取得するエンドポイントの名前

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.5.9 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

パラメータ

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

-x、--uid

必須

一意の識別子

-b、--type arg

必須

チェックするオブジェクト・タイプを指定します。有効な値は次のとおりです。

  • EP
  • EPG
  • WALLET

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

ショート形式の例

java -jar okvrestservices.jar -c conf_file -r get_object_name -b WALLET -u 7C3DC1FF-213A-4FBE-BF4A-98A04F8D05DF

ロング形式の例

java -jar okvrestservices.jar --config conf_file --service get_object_name --type WALLET --uid 7C3DC1FF-213A-4FBE-BF4A-98A04F8D05DF
13.6.5.10 get_walletsコマンド

get_walletsコマンドは、エンドポイントに関連付けられたすべての仮想ウォレットを取得します。

構文

ショート形式: 
get_wallets -e endpoint_name
ロング形式: 
get_wallets --ep_name endpoint_name

パラメータ

パラメータ 必須かどうか 説明
-e、-—ep_name 必須 仮想ウォレットを取得するエンドポイントの名前

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.5.11 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

パラメータ

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

-e、--ep_name

必須

エンドポイントの名前

-w、--wallet_name

必須

仮想ウォレットの名前

-l、--access_level

必須

仮想ウォレットに対するアクセス・レベル。値は次のとおりです。

  • ro: 読取り専用

  • rm: 読取りおよび変更

  • ro_mw: 読取り専用および仮想ウォレット管理

  • rm_mw: 読取り、変更、および仮想ウォレット管理

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.5.12 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

パラメータ

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

-g、--epg_name

必須

エンドポイント・グループの名前

-w、--wallet_name

必須

仮想ウォレットの名前

-l、--access_level

必須

仮想ウォレットに対するアクセス・レベル。値は次のとおりです。

  • ro: 読取り専用

  • rm: 読取りおよび変更

  • ro_mw: 読取り専用および仮想ウォレット管理

  • rm_mw: 読取りおよび変更、および仮想ウォレット管理

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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
13.6.5.13 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"

パラメータ

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

-w、--wallet_name

必須

仮想ウォレットの名前

-d、--desc

必須

二重引用符で囲まれた仮想ウォレットの新しい説明文字列

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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"
13.6.5.14 modify_wallet_nameコマンド

modify_wallet_nameコマンドは、仮想ウォレット名を変更します。

構文

ショート形式:

modify_wallet_name -w current_wallet_name -z new_wallet_name

ロング形式:

modify_wallet_name --wallet_name current_wallet_name --new_name new_wallet_name

パラメータ

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

-w、--wallet_name

必須

ウォレットの現在の名前

-z、--new_name

必須

新しい仮想ウォレットの名前。「オブジェクトのネーミング・ガイドライン」を参照してください。

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

ショート形式の例

この例では、仮想ウォレットhr_db_walletの名前をhr_db_west_walletに変更します。 

java -jar okvrestservices.jar -r modify_wallet_name -w hr_db_wallet -z hr_db_west_wallet

ロング形式の例

java -jar okvrestservices.jar --service modify_wallet_name --wallet_name hr_db_wallet --new_name hr_db_west_wallet
13.6.5.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

パラメータ

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

-w、--wallet_name

必須

仮想ウォレットの名前

-e、--ep_name

必須

デフォルト・ウォレットが設定されるエンドポイント名

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つ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

13.6.6 エラー・レポート

RESTfulサービス・ユーティリティには、RESTfulサービス・コマンドをすばやく正常に実行するためにデバッグする強力なエラー・レポートがあります。

親トピック: Oracle Key Vaultの管理RESTクライアント・ツール・コマンド

13.6.6.1 エラー・レポートについて

コマンド実行のステータス(成功および失敗)は、コマンドラインですぐにレポートされ、ログ・ファイルに書き込まれます。

特定のエラーはレポートされ、必要に応じて修正処理が示されます。エラー・レポートは、すべてのRESTコマンドに共通です。

コマンドが失敗したときには、まず、ログ・ファイルを確認します。選択した場所にカスタム・ログ・ファイルを作成していない場合は、現在のディレクトリのデフォルトのログ・ファイルokvrestservices.logを確認すると、ここにコマンドの結果が書き込まれています。

コマンド実行中のOracle Key Vaultサーバーからのすべてのメッセージを表示するには、構成ファイルで適切なロギング・レベル、ログ・ファイル名およびログ・ファイルの場所を設定できます。

RESTfulサービス・ユーティリティは、ファイルやJAVA_HOMEなどの環境変数が見つからない、不正なコマンド構文、不正なパスワードなどのエラーを報告します。

親トピック: エラー・レポート

13.6.6.2 コマンドラインのエラー・レポート

エラー・レポートでは、不正なパスワードなどの問題があったアクションおよび正常なコマンド実行の両方が取得されます。

例13-6 エラー: -rオプションを使用しないサービス・コマンドの実行

java -jar okvrestservices.jar -c rest.ini modify_endpoint_desc -e ORDERS -b ORDERS_HR
Script or service option is required.

例13-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

例13-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]

例13-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]

親トピック: エラー・レポート

13.6.6.3 スクリプトからのコマンド実行時のエラー・レポート

1つのスクリプトから複数のサービス・コマンドを実行すると、コマンドラインに加えてログ・ファイルにも結果が表示されます。

次の出力は、スクリプトから実行された成功したコマンドの結果を示しています。

例13-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]

親トピック: エラー・レポート

13.6.7ステータスとヘルプ情報のコマンド

これらのコマンドにより、特定のOracle Key Vaultオブジェクトに関するステータス情報、Oracle Key Vaultシステム全体に関する情報、一般的なヘルプ情報が示されます。

  • check_object_statusコマンド
    check_object_statusコマンドは、エンドポイント、エンドポイント・グループまたはウォレットのステータスをチェックします。
  • get_system_infoコマンド
    get_system_infoは、クライアント・ツール・バージョン、サーバー・バージョンおよびデプロイメント・モードを返します。
  • ヘルプ情報
    RESTfulサービス・ユーティリティokvrestservices.jarが提供する有効なオプションおよび使用可能なコマンドに関する情報を参照できます。

親トピック: Oracle Key Vaultの管理RESTクライアント・ツール・コマンド

13.6.7.1 check_object_statusコマンド

check_object_statusコマンドを使用して、エンドポイント、エンドポイント・グループまたはウォレットのステータスをチェックします。

返されるステータスは、object_type existsまたはobject_type does not existのどちらかです。このobject_typeは、Endpoint、Endpoint GroupまたはWalletです。オブジェクトが存在する場合は、出力にACTIVEまたはPENDINGステータスが含まれます。オブジェクトが存在しない場合は、追加のステータスは表示されません。

構文

ショート形式:

check_object_status -b EP|EPG|WALLET -x uid|-N object_name

ロング形式:

check_object_status --type EP|EPG|WALLET --uid uid|--name object_name

パラメータ

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

-x、--uid

-N、--nameが使用されていない場合は必須

管理対象オブジェクトのUID (Universally Unique ID)。マルチマスター・クラスタ環境でのみ、このパラメータとともにcheck_object_statusを使用できます。

-N、--name

-x、--uidが使用されていない場合は必須

チェックするオブジェクトの名前を指定します。スタンドアロン・クラスタ環境またはマルチマスター・クラスタ環境では、このパラメータとともにcheck_object_statusを使用できます。

-b、--type arg

必須

チェックするオブジェクト・タイプを指定します。有効な値は次のとおりです。

  • EP
  • EPG
  • WALLET

-c、--config

必須

構成ファイルの絶対パスを指定します

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

ショート形式の例

この例では、エンドポイント名で指定したエンドポイントのステータスを表示します。

java -jar okvrestservices.jar -c conf_file -r check_object_status -b EP -N EP-sales

ロング形式の例

この例では、UIDで指定したウォレットのステータスを表示します。
java -jar okvrestservices.jar --config conf_file --service check_object_status --type EP --uid 7C3DC1FF-213A-4FBE-BF4A-98A04F8D05DF
13.6.7.2 get_system_infoコマンド

get_system_infoは、クライアント・ツール・バージョン、サーバー・バージョンおよびデプロイメント・モードを返します。

構文

get_system_info

パラメータ

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

-i、--script arg

複数のRESTfulサービス・コマンドの場合は必須

スクリプト・ファイルの絶対パスを指定します。複数のRESTfulサービス・コマンドを実行するには、このプロパティを設定する必要があります。

-p、--pwd arg

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを指定します。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

このオプションを省略すると、対話式でパスワードの入力を求められます。セキュリティを強化するには、このオプションを省略します。

-r、--service arg

必須

RESTfulサービス・コマンド構文にリストされている実行するRESTfulサービスを指定します

-u、--usr arg

オプション

システム管理者ロールまたはキー管理者ロールを持つOracle Key Vaultアカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

例

デプロイメント・モードの値は、Standalone、Primary-StandbyまたはClusterです。

次に各例を示します。 

$ java -jar okvrestservices.jar --config rest.ini --service get_system_info
[Line 0 OK] [GET SYSTEM INFO] [REST Client Tool Version: 18.5.0.0.0]
[Line 0 OK] [GET SYSTEM INFO] [Server Version: 18.5.0.0.0]
[Line 0 OK] [GET SYSTEM INFO] [Deployment Mode: Standalone]
$ java -jar okvrestservices.jar -c rest.ini -r
get_system_info
[Line 0 OK] [GET SYSTEM INFO] [REST Client Tool Version: 18.5.0.0.0]
[Line 0 OK] [GET SYSTEM INFO] [Server Version: 18.5.0.0.0]
[Line 0 OK] [GET SYSTEM INFO] [Deployment Mode: Primary-Standby]
$ java -jar okvrestservices.jar -c rest.ini -r
get_system_info
[Line 0 OK] [GET SYSTEM INFO] [REST Client Tool Version: 18.5.0.0.0]
[Line 0 OK] [GET SYSTEM INFO] [Server Version: 18.5.0.0.0]
[Line 0 OK] [GET SYSTEM INFO] [Deployment Mode: Cluster]
13.6.7.3 ヘルプ情報

有効なオプションに関する情報、および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

13.7 Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンド

RESTfulサービス・キー管理コマンドは、Oracle Key Vaultにアップロードされたキーの管理を担当するユーザー向けに設計されています。

該当するユーザーには、キー管理ロールが必要です。

親トピック: RESTfulサービスを使用したOracle Key Vaultの管理およびキー管理

13.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をダウンロードできません。読取り/書込みモードでダウンロードすると、クライアント・ツールは読取り/書込みモードまたは読取り専用モードで接続できます。

親トピック: Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンド

13.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 conf_file --service options_for_the_KMIP_API

KMIP RESTサービスのオプション

オプション 説明

-a、--algorithm

使用する暗号化アルゴリズム。次の値を指定できます。

  • 3DES
  • AES

-c、--config

構成ファイルの絶対パスを指定します

-e、--user

ユーザー名

-f、--attr

属性リスト・ファイル。ファイル形式は次のとおりです。

name1:value1

name2:value2

name3:value3

-g、--group

グループ・メンバー

-i、--index

属性の索引

-l、--length
サポートされているキーの長さは次のとおりです。

  • 3DES: 112、168

  • AES : 128、192、256

-m、--mask
暗号化使用方法マスク。有効な値には、次の設定が含まれます。これは、Key Management Interoperability Protocol (KMIP)仕様バージョン1.1で説明されています。

  • ENCRYPT

  • DECRYPT

  • WRAP_KEY

  • UNWRAP_KEY

  • EXPORT

  • DERIVE_KEY

  • GENERATE_CRYPTOGRAM

  • VALIDATE_CRYPTOGRAM

  • TRANSLATE_ENCRYPT

  • TRANSLATE_DECRYPT

  • TRANSLATE_WRAP

  • TRANSLATE_UNWRAP

-n、--attribute

属性名

-o、--object

登録するオブジェクト・ファイルへのパス

-r、--code
次の値などの取消しコード値。

  • UNSPECIFIED

  • KEY_COMPROMISE

  • CA_COMPROMISE

  • AFFILIATION_CHANGED

  • SUPERSEDED

  • CESSATION_OF_OPERATION

  • PRIVILEGE_WITHDRAWN

-s、--reason

取消し理由メッセージ

-t、--type

登録するオブジェクト・タイプ

-u、--uid

管理対象オブジェクトのUUID (Universally Unique ID)

-v、--value

属性値

-w、--wallet

ウォレット名

-x、--max

表示するUIDの最大数

親トピック: Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンド

13.7.3 キー管理RESTクライアント・ツール・コマンドのリスト

RESTfulキー管理クライアント・ツールは、キーの作成、アクティブ化などのタスクを実行します。

表13-4 RESTfulキー管理コマンド

コマンド名 説明

activate

管理対象暗号オブジェクトをアクティブ化します

add_attr

オブジェクトに新しい属性を追加し、値を設定します

add_custom_attr

カスタム属性を追加して、名前、タイプおよび値を指定します

add_member

ウォレットにユーザーを追加します

all_attr

すべての属性名および値を取得します

create_key

新しいキーを作成します

del_attr

管理対象オブジェクトの属性を削除します

del_custom_attr

カスタム属性を削除します

del_member

ウォレットからユーザーを削除します

destroy

管理対象オブジェクトのキー・データを破棄するようにサーバーにリクエストします

get_attr

オブジェクトの1つ以上の属性値を取得します

get_cert

サーバーにデジタル証明書をリクエストします

get_key

サーバーから暗号化キーを取得します

get_opaque

シークレット・データを含むオブジェクトを取得します

get_secret

使用可能な属性名および値をすべて取得します

list_attr

使用可能なすべての属性名のみをリストします

list_wallet

仮想ウォレットをリストします

locate

1つ以上の管理対象オブジェクトを検索します

mod_attr

管理対象オブジェクトの属性値を変更します

mod_custom_attr

カスタム属性を変更します

query

サポートされている機能についてサーバーに問い合せます

reg_cert

デジタル証明書を登録します

reg_key

キーを登録します

reg_opaque

サーバーが解釈できない可能性があるデータを含むオブジェクトを登録します

reg_secret

シークレット・データを含むオブジェクトを登録します

revoke

管理対象暗号化オブジェクトを取り消します。

親トピック: Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンド

13.7.4 キー作成およびキー登録のコマンド

キー作成およびキー登録コマンドは、様々なタイプのセキュリティ・オブジェクトの登録などのタスクを実行します。

これらのコマンドを使用するには、キー管理者ロールが必要です。

親トピック: Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンド

13.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

パラメータ

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

-a、--algorithm

必須

暗号化アルゴリズム

-l、--length

必須

キーの長さ

-m、--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"
13.7.4.2 get_certコマンド

get_certコマンドはデジタル証明書を取得します。

構文

ショート形式:

-s get_cert -u UUID

ロング形式:

--service get_cert --uid UUID

パラメータ

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

-u、--uid

必須

管理対象オブジェクトの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
13.7.4.3 get_keyコマンド

get_keyコマンドは暗号化キーを取得します。

構文

ショート形式:

-s get_key -u UUID

ロング形式:

--service get_key --uid UUID

パラメータ

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

-u、--uid

必須

管理対象オブジェクトの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
13.7.4.4 get_opaqueコマンド

get_opaqueコマンドは、シークレット・データを含むオブジェクトを取得します。

構文

ショート形式:

-s get_opaque -u UUID

ロング形式:

--service get_opaque --uid UUID

パラメータ

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

-u、--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
13.7.4.5 get_secretコマンド

get_secretコマンドは、シークレット・データを含むオブジェクトを取得します。

構文

ショート形式:

-s get_secret -u UUID

ロング形式:

--service get_secret --uid UUID

パラメータ

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

-u、--uid

必須

管理対象オブジェクトの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
13.7.4.6 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]

パラメータ

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

-t、--type

必須

オブジェクト型

-l、--length

必須

キーの長さ

-a、--algorithm

必須

アルゴリズム

-m、--mask

必須

暗号化使用方法マスク

-o、--object

必須

オブジェクト属性ファイルへのパス

-f、--attr

オプション

属性リスト・ファイル

ショート形式の例

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
13.7.4.7 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]

パラメータ

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

-l、--length

必須

キーの長さ

-a、--algorithm

必須

アルゴリズム

-m、--mask

必須

暗号化使用方法マスク

-o、--object

必須

キー・ファイルへのパス

-f、--attr

オプション

属性リスト・ファイル

ショート形式の例

この例では、指定した検索基準に基づいてオブジェクトを検索します。

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 --service reg_key --algorithm AES --length 128 --mask "EXPORT" --object ./object.key  --attr ./obj_key_attr_file.txt
13.7.4.8 reg_opaqueコマンド

reg_opaqueコマンドは不透明なオブジェクトを登録します。

不透明なデータを含むオブジェクトは、サーバーによって解釈されるとはかぎりません。

構文

ショート形式:

-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]

パラメータ

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

-m、--mask

必須

暗号化使用方法マスク

-o、--object

必須

オブジェクト・ファイルへのパス

-f、--attr

オプション

属性リスト・ファイル

ショート形式の例

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
13.7.4.9 reg_secretコマンド

reg_secretコマンドは、パスワード、ランダム・シードなどのシークレット・データを登録します。

構文

ショート形式:

-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]

パラメータ

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

-t、--type

必須

オブジェクト型

-m、--mask

必須

暗号化使用方法マスク

-o、--object

必須

オブジェクト属性ファイルへのパス

-f、--attr

オプション

属性リスト・ファイル

ショート形式の例

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

13.7.5 キー属性管理コマンド

キー属性管理コマンドは、標準属性およびカスタム属性の追加、変更、削除などのタスクを実行します。

これらのコマンドを使用するには、キー管理者ロールが必要です。

親トピック: Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンド

13.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

パラメータ

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

-u、--uuid

必須

管理対象オブジェクトのUUID (Universally Unique ID)

-n、--attribute

必須

属性名。変更可能な属性は次のとおりです。

  • ACTIVATION_DATE

  • CONTACT_INFO

  • DEACTIVATION_DATE

  • NAME

  • PROCESS_START_DATE

  • PROTECT_STOP_DATE

-v、--value

必須

属性値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

ショート形式の例

この例では、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"
13.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

パラメータ

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

-u、--uid

必須

管理対象オブジェクトのUUID (Universally Unique ID)

-n、--attribute

必須

カスタム属性名。接頭辞X-またはY-を含める必要があります。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

-t、--type

必須

オブジェクト型。NUMBERまたはTEXTを指定できます。

-v、--value

必須

カスタム属性値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

ショート形式の例

この例では、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
13.7.5.3 all_attrコマンド

all_attrコマンドは、オブジェクトのすべての属性を取得します。

構文

ショート形式:

-s all_attr -u UUID

ロング形式:

--service all_attr --uid UUID

パラメータ

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

-u、--uid

必須

管理対象オブジェクトの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
13.7.5.4 del_attrコマンド

del_attrコマンドは、管理対象オブジェクトから属性を削除します。

構文

ショート形式:

-s del_attr -u UUID -n attribute_name

ロング形式:

--service del_attr --uid UUID --attribute attribute_name

パラメータ

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

-u、--uuid

必須

管理対象オブジェクトのUUID (Universally Unique ID)

-n、--attribute

必須

属性名。変更可能な属性は次のとおりです。

  • ACTIVATION_DATE

  • CONTACT_INFO

  • DEACTIVATION_DATE

  • NAME

  • PROTECT_STOP_DATE

ショート形式の例

この例では、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
13.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

パラメータ

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

-u、--uid

必須

管理対象オブジェクトのUUID (Universally Unique ID)

-n、--attribute

必須

属性名。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

-i、--index

必須

属性の索引

ショート形式の例

この例では、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
13.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

パラメータ

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

-u、--uid

必須

管理対象オブジェクトのUUID (Universally Unique ID)

-n、--attribute

必須

属性名、または引用符で囲んでカンマで区切られた属性のリスト

ショート形式の例

この例では、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"
13.7.5.7 list_attrコマンド

list_attrコマンドは、オブジェクトの属性のリストを取得します。

構文

ショート形式:

-s list_attr -u UUID

ロング形式:

--service list_attr --uid UUID

パラメータ

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

-u、--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
13.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

パラメータ

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

-u、--uid

必須

管理対象オブジェクトのUUID (Universally Unique ID)

-n、--attribute

必須

属性名。変更可能な属性は次のとおりです。

  • ACTIVATION_DATEは、管理対象オブジェクトを最初に使用できる日時です。

  • CONTACT_INFOは、連絡用にのみ使用され、ポリシー施行には使用されません。

  • DEACTIVATION_DATEは、管理対象オブジェクトをどの目的にも使用できなくなる日時です。

  • NAMEは、オブジェクトを識別および検索するために指定するわかりやすい名前です。

  • PROCESS_START_DATEは、暗号化で保護されたデータを処理するためにキー・オブジェクトを最初に使用できる日時です。

  • PROTECT_STOP_DATEは、暗号化保護を適用するためにキー・オブジェクトがそれ以降使用される日時です。

-v、--value

必須

属性値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

ショート形式の例

この例では、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"
13.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

パラメータ

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

-u、--uuid

必須

管理対象オブジェクトのUUID (Universally Unique ID)

-n、--attrubute

必須

属性名。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

-i、--index

必須

属性の索引。属性の索引は各属性の一意の位置です。これにより、同じ名前を持つ属性を索引で区別できます。

-v、--value

必須

属性値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。

ショート形式の例

この例では、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

13.7.6 キーのライフサイクル管理コマンド

キーのライフサイクル管理コマンドは、管理対象の暗号化オブジェクトのアクティブ化、取消しなどのタスクを実行します。

これらのコマンドを使用するには、キー管理者ロールが必要です。

  • activateコマンド
    activateコマンドは、管理対象の暗号化オブジェクトをアクティブ化します。
  • destroyコマンド
    destroyコマンドは、管理対象オブジェクトを破棄します。
  • locateコマンド
    locateコマンドは、管理対象オブジェクトを検索します。
  • revokeコマンド
    revokeコマンドは、キーや証明書などの管理対象オブジェクトを取り消します。
  • queryコマンド
    queryコマンドは、サポートされている操作およびオブジェクトを識別します。

親トピック: Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンド

13.7.6.1 activateコマンド

activateコマンドは、管理対象の暗号化オブジェクトをアクティブ化します。

構文

ショート形式:

-s activate -u unique_identifier

ロング形式:

--service activate --uid  unique_identifier

パラメータ

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

-u、--uid

必須

一意の識別子

ショート形式の例

この例では、管理対象オブジェクトをアクティブ化します。

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
13.7.6.2 destroyコマンド

destroyコマンドは管理対象オブジェクトを破棄します。

構文

ショート形式:

-s destroy -u unique_identifier 

ロング形式:

--service destroy --uid unique_identifier 

パラメータ

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

-u、--uid

必須

一意の識別子

ショート形式の例

この例では、管理対象オブジェクトを破棄します。

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 
13.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]

パラメータ

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

-x、--max

オプション

一意の識別子

-g、--group

オプション

グループ・メンバー

-y、--state

オプション

オブジェクトの状態。オブジェクトの有効な状態値のリストについては、OKVRESTSERVICEの使用時に使用できるKMIP RESTサービス・オプションを参照してください。

ショート形式の例

この例では、指定した検索基準に基づいてオブジェクトを検索します。

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
13.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]

パラメータ

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

-u、--uid

必須

一意の識別子

-q、--code

必須

取消しコード

-r、--reason

オプション

取り消す理由。取消しコードがKEY_COMPROMISEの場合は、--compromise_dateパラメータを使用して、漏えい発生日を指定する必要があります。有効な理由の完全なリストについては、OKVRESTSERVICEの使用時に使用できるKMIP RESTサービス・オプションを参照してください。

ショート形式の例

この例では、管理対象オブジェクトを取り消します。

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"
13.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

13.7.7 ウォレット・コマンド

ウォレット・コマンドは、ウォレットのメンバーシップを制御します。

  • add_memberコマンド
    add_memberコマンドは、ウォレット・メンバーシップを追加します。
  • del_memberコマンド
    del_memberコマンドは、ウォレット・メンバーシップを削除します。
  • list_walletコマンド
    list_walletコマンドは、Oracle Key Vaultへの接続に使用するエンドポイントで管理されているウォレットを表示します。

親トピック: Oracle Key Vaultのキー管理RESTクライアント・ツール・コマンド

13.7.7.1 add_memberコマンド

add_memberコマンドは、ウォレット・メンバーシップを追加します。

構文

ショート形式:

-s add_member -w wallet -u UUID

ロング形式:

--service add_member --wallet wallet --uid UUID

パラメータ

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

-u、--uid

必須

管理対象オブジェクトのUUID (Universally Unique ID)

-w、--wallet

必須

ウォレット名

ショート形式の例

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
13.7.7.2 del_memberコマンド

del_memberコマンドは、ウォレット・メンバーシップを削除します。

構文

ショート形式:

-s del_member -w wallet -u UUID

ロング形式:

--service del_member --wallet wallet --uid UUID

パラメータ

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

-u、--uid

必須

管理対象オブジェクトのUUID (Universally Unique ID)

-w、--wallet

必須

ウォレット名

ショート形式の例

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
13.7.7.3 list_walletコマンド

list_walletコマンドは、Oracle Key Vaultへの接続に使用するエンドポイントで管理されているウォレットを表示します。

構文

ショート形式:

-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