プライマリ・コンテンツに移動
Oracle® Key Vault管理者ガイド
リリース12.2 BP11
E76998-09
目次へ移動
目次
索引へ移動
索引

前
次

10 RESTfulサービスによるエンドポイント・エンロールの自動化

Key Vault RESTfulサービス・ユーティリティを使用すると、エンドポイント・エンロールのプロセスおよび大規模な分散型エンタープライズ・デプロイメントの仮想ウォレット管理を自動化できます。

10.1 RESTfulサービスについて

Oracle Key Vault管理コンソールのユーザー・インタフェースでは複数のエンドポイントを効率的に管理できる一方、エンドポイントと仮想ウォレットの間のアクセス制御マッピングを定義するプロセスは手動となり、管理者がユーザー・インタフェースをクリックして処理する必要があります。

多くの場合、大規模な分散型エンタープライズ・デプロイメントにおいては、一括デプロイメントを可能にするために、スクリプティングによる自動化が必要となります。Oracle Key VaultのRESTfulサービス機能を使用すると、人による操作を削減してより高速にデプロイメントするために、何百ものエンドポイントをエンロールおよびプロビジョニングしたり、エンドポイントとその仮想ウォレットの間のアクセス制御マッピングを定義することができます。また、この機能を使用して、ユーザー、ユーザー・グループおよびエンドポイント・グループの管理を自動化することもできます。

RESTfulサービスを使用すると、エンドポイントのエンロールおよびプロビジョニング、エンドポイント・グループの作成およびエンドポイント、エンドポイント・グループ、仮想ウォレットの間のアクセス制御マッピングの定義を行うことができます。コマンドラインから単一のサービス・コマンドを実行したり、1つのスクリプトから複数のサービス・コマンドを実行することができます。コマンドラインまたはスクリプトからサービス・コマンドを実行するには、特定のプロパティ・セットを含む構成ファイルが必要です。RESTfulサービス・ユーティリティを実行するには、エンドポイントに、少なくともJava Runtime Environmentバージョン1.7.0.21がインストールされている必要があります。

RESTfulサービスは、Oracle Real Application Clusters (Oracle RAC)とマルチテナント環境の両方で使用できます。これらの環境での構成プロセスは、単一インスタンス環境と同じです。

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サービスを無効にします。

10.2 RESTfulサービスの有効化

RESTfulサービスを正常に有効化および使用するためのステップは、次の3つです。

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

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アドレス・オプションのいずれかを選択します。

    1. すべてのIPアドレスを許可する場合は、「All」

    2. 一連のIPアドレスを指定する場合は、「IP address(es)」。このオプションを選択した場合は、隣のフィールドにIPアドレスを入力します(各IPアドレスは空白で区切ります)。

  4. 右上の「Save」をクリックします。

10.2.2 ステップ2: RESTfulサービスの有効化

RESTfulサービスを有効にする手順:

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

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

    「RESTful Services」セクションに移動します。

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

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

RESTfulソフトウェア・ユーティリティokvrestservices.jarをダウンロードする手順:

  1. システム管理者権限を持っているユーザーとしてOracle Key Vault管理コンソールにログインします。
  2. 左サイドバーの「Downloads」で、「RESTful Service Utility」をクリックします。

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

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

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

  4. ファイルを保存します。

注意:

  • サード・パーティの証明書をインストールする場合は、新しい証明書を使用するために、RESTfulソフトウェア・ユーティリティokvrestservices.jarを再度ダウンロードする必要があります。

  • 証明書を変更する場合や、新しいソフトウェアまたはバックアップを使用してKey Vaultアプライアンスを再インストールする場合は、常に、RESTfulソフトウェア・ユーティリティを再ダウンロードする必要があります。

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

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

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

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

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

    server

    文字列

    必須

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

    script

    文字列

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

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

    log_level

    文字列

    必須

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

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

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

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

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

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

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

    log

    文字列

    オプション

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

    usr

    文字列

    オプション

    Oracle Key Vaultアカウントのユーザー名を指定します。このプロパティの設定を省略すると、ユーザー名の入力を求められます。通常、このユーザーは、コマンドの実行に必要な権限のあるシステム管理者ロールまたはキー管理者ロールを持ちます。

    pwd

    文字列

    オプション

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

    client_wallet

    文字列

    オプション

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

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

10.4 構成ファイルの例

次に、サーバー・プロパティにIPアドレスおよびホスト名を使用する構成ファイルの2つの例を示します。

例10-1 IPアドレスを使用する構成ファイル

server=192.0.2.254
usr=okvadmin
log=/<absolute_path_to_your_log_file>/<your_log_file_name>
log_level=warning

例10-2 ホスト名を使用する構成ファイル

server=HR_HQ-Database
usr=okvadmin
log=/<absolute_path_to_your_log_file>/<your_log_file_name>
log_level=warning

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

数個のコマンドのみを実行する場合は、コマンドから-rオプションまたは--serviceオプションを使用して、それらを1つずつ実行できます。

単一のRESTfulコマンドを実行する手順:

  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@enterprise.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@enterprise.comを示します。

注意:

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

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

一連のコマンドは、コマンドラインから1つずつ実行できます。ただし、一連のコマンドを1つのスクリプトに記述すると、より効率的に実行できます。スクリプト・ファイルの各コマンドは、サービス・コマンドとして解釈されます。-iオプションまたは--scriptオプションを含むスクリプトを起動して、スクリプト・ファイルのパスを指定する必要があります。

注意:

構成ファイルでscriptプロパティを定義すると、コマンドラインにこれを入力する必要がなくなります。scriptパラメータは、構成ファイルまたはコマンドラインのいずれかで1回のみ入力します。

スクリプトを作成する手順:

  1. コマンドを実行するシステムにログインします。
  2. スクリプト・ファイルを作成して、このスクリプト・ファイルに実行するサービス・コマンドを記述します。

    たとえば、次のコマンドをスクリプト・ファイルに記述して、エンドポイント、エンドポイント・グループを作成し、エンドポイントをエンドポイント・グループに追加します。

    create_endpoint -e hr_db_ep -d "HR database endpoint" -q solaris64 -t oracle_db -m psmith@enterprise.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
    
  5. スクリプト・プロパティは構成ファイルで定義されるため、RESTfulサービス・ユーティリティを実行する場合は、構成ファイルのみを指定することのみが必要となります。
    java -jar okvrestservices.jar -c conf_file 
    User: Key_Vault_user
    Password: Key_Vault_user_password
    

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

    java -jar okvrestservices.jar -c conf_file -i /scripts/create_hr_endpoint_group.txt
    User: Key_Vault_user
    Password: Key_Vault_user_password
    

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

関連項目:

Key Vaultのロギングの詳細は、「エラー・レポート」を参照してください。

10.7 スクリプト作成ガイドライン

スクリプトの実行エラーを回避するために、次のガイドラインを使用してください。

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

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

  • 各コマンドを個別の行に置きます。

  • コマンドがない行は、先頭を#文字にする必要があります。

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

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

  • すべての必須オプションには有効な値が必要です。

  • -iオプションまたは--scriptオプションを指定する必要があります。

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

10.8 RESTfulサービスの無効化

RESTfulサービスはデフォルトでは無効になっています。RESTfulサービスは、エンドポイントを登録およびエンロールする間の短期間のみ有効にすることをお薦めします。エンドポイントがエンロールされた後、RESTfulサービスを無効にする必要があります。

RESTfulサービスを無効にする手順:

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

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

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

10.9 RESTfulサービス・コマンド・リファレンス

RESTfulサービス・コマンドのリファレンスには、すべてのコマンドの詳細な説明と例が含まれているため、コマンドを迅速に記述および実行するために役立ちます。

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

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

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

表10-2 すべてのRESTfulコマンドに共通のオプション

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

-c--config

必須

構成ファイルの絶対パスを示します。

-i--script <arg>

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

スクリプト・ファイルの絶対パスを示します。

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

-r--service <arg>

必須

実行するRESTfulサービス(表2を参照)を示します。

-u--usr <arg>

オプション

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

-p --pwd <arg>

オプション

--usrオプションで指定されたOracle Key Vaultユーザー・アカウントのパスワードを示します。このオプションを省略すると、対話式でパスワードの入力を求められます(セキュリティ強化のために推奨)。

次の表に、-rオプションまたは--service <arg>オプションで使用できるRESTfulサービス・コマンドを示します。

表10-3 RESTfulサービス・コマンドのリスト

RESTfulサービス・コマンド 説明

create_endpoint

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

get_enrollment_token

エンロール・トークンを取得して、登録されたエンドポイントのエンドポイント・ソフトウェアをダウンロードします。

download

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

provision

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

re_enroll

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

re_enroll_all

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

delete_endpoint

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

create_endpoint_group

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

add_epg_member

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

drop_epg_member

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

delete_endpoint_group

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

create_wallet

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

add_wallet_access_ep

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

modify_wallet_access_ep

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

drop_wallet_access_ep

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

set_default_wallet

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

get_default_wallet エンドポイントのデフォルト・ウォレットを取得します。
get_wallets エンドポイントのすべての仮想ウォレットを取得します。

add_wallet_access_epg

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

modify_wallet_access_epg

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

drop_wallet_access_epg

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

delete_wallet

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

modify_wallet_desc

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

modify_endpoint_name

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

modify_endpoint_platform

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

modify_endpoint_type

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

modify_endpoint_desc

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

modify_endpoint_email

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

modify_endpoint_group_desc

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

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

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

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

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

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

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

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

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

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

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

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

-A、--add

オプション

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

-M、--modify

オプション

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

-L、--listuser

オプション

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

-D、--delete

オプション

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

-w、--wallet_name <arg>

必須

ウォレット名を表します。

-j、--client_wallet <arg>

必須

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

-f、--force

オプション

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

例10-5 ウォレット・コマンド構文

ユーザーにウォレットに対するアクセス権を付与します。

java -jar okvrestservices.jar -c <path_to_configuration file>/rest.init --client_wallet <absolute path to wallet location> --add <user>

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

java -jar okvrestservices.jar -c <path_to_configuration file>/rest.init --client_wallet <absolute path to wallet location> --modify <user>

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

java -jar okvrestservices.jar --config <path_to_configuration file>/rest.init --client_wallet <absolute path to wallet location> --listuser <user>

ウォレットに対するユーザーのアクセス権を削除します。

java -jar okvrestservices.jar --config <path_to_configuration file>/rest.init --client_wallet <absolute path to wallet location> --delete <user>

10.9.3 エンドポイントを追加およびエンロールするコマンド

create、enroll、get_enrollment_token、download、provisionという一連のコマンドは、Key Vaultにエンドポイントを追加およびエンロールするために使用されます。エンドポイントにエンドポイント・ソフトウェアokvclient.jarがダウンロードされてインストールされると、エンドポイントがエンロールされます。エンロールされたエンドポイントは、セキュリティ・オブジェクトを格納、共有および管理するためにKey Vaultにアップロードできます。

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

  • windows

-t--ep_type

必須

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

  • oracle_db

  • oracle_non_db

  • other

-m--ep_email

オプション

エンドポイント管理者の電子メール・アドレス

-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アカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

ショート形式の例

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

10.9.3.2 get_enrollment_tokenコマンド

get_enrollment_tokenコマンドは、登録済エンドポイントのエンロール・トークンを取得します。このコマンドは、登録済状態のエンドポイントに対してのみ機能します。エンドポイントがすでにエンロールされている場合は、エラー・メッセージが表示されます。

構文

ショート形式:

get_enrollment_token -e endpoint_name

ロング形式:

get_enrollment_token --ep_name endpoint_name

パラメータ

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

-e--ep_name

必須

エンドポイントの名前。

ショート形式の例

この例では、登録済エンドポイント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

10.9.3.3 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

必須

エンドポイント・ソフトウェアのダウンロード・ディレクトリの絶対パス。

ショート形式の例

この例では、エンドポイント・ソフトウェアokvclient.jarは、エンドポイントhr_db_ep/home/oracle/downloads/にダウンロードされます。

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/

10.9.3.4 provisionコマンド

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

  • システム管理権限を持つユーザーである必要があります。

  • ソフト・リンク/usr/bin/javaは、Java 1.4以上を指す必要があります。

  • インストール・プロセスがokvclient.oraファイルの場所を決定する方法を理解しておく必要があります。

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

エンドポイントをエンロールするには、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

必須

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

-v--endpoint_password

オプション

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

-a--autologin

必須

これは、Key Vaultサーバーに接続するエンドポイントの資格証明が、自動ログイン・ウォレットに格納されることを意味します。

ショート形式の例

自動ログイン・モード

この例では、エンドポイントhr_db_epのエンドポイント・ソフトウェアは、パスワードなし(自動ログイン・モード)でディレクトリ/home/oracle/okvutilにインストールされます。

java -jar okvrestservices.jar -c conf_file -r provision -a -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/ 

10.9.3.5 re_enrollコマンド

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

構文

ショート形式:

re_enroll -e endpoint_name

ロング形式:

re_enroll --ep_name endpoint_name

パラメータ

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

-e--ep_name

必須

エンドポイントの名前。

この例では、エンドポイント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

10.9.3.6 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

10.9.3.7 delete_endpointコマンド

delete_endpointコマンドは、Key Vaultからエンドポイントを削除します。エンドポイントを削除するかどうかを尋ねる確認メッセージが表示されます。

-fオプションまたは--forceオプションを使用すると、確認メッセージなしでエンドポイントを削除できます。確認メッセージが抑止されるため、-fオプションまたは--forceオプションは慎重に使用してください。

構文

ショート形式:

delete_endpoint -f -e endpoint_name

ロング形式:

delete_endpoint --force --ep_name endpoint_name

パラメータ

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

-e--ep_name

必須。

エンドポイントの名前。

-f--force

オプションです。

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

ショート形式の例

この例は、確認なしで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 

10.9.4 エンドポイント詳細の変更コマンド

エンドポイントの作成後にエンドポイントの詳細を変更して、機能、名前、プラットフォーム、タイプおよび電子メールの変更に対応できます。

10.9.4.1 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

必須

このエンドポイントの新しい名前

ショート形式の例

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

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

ロング形式の例

java -jar okvrestservices.jar --config conf_file --service modify_endpoint_name --ep_name hr_db --ep_new_name hr_db_ep

10.9.4.2 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

ショート形式の例

この例は、エンドポイント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

10.9.4.3 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

  • windows

-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アカウント・ユーザーのユーザー名を指定します。このオプションを省略すると、対話式でユーザー名の入力を求められます

ショート形式の例

この例は、エンドポイント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

10.9.4.4 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

必須

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

ショート形式の例

この例は、エンドポイント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"

10.9.4.5 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

必須

このエンドポイントの新しい電子メール・アドレス

ショート形式の例

この例は、エンドポイントhr_dbの電子メールをtjones@enterprise.comに変更します。

java -jar okvrestservices.jar -c conf_file -r modify_endpoint_email -e hr_db -m tjones@enterprise.com

ロング形式の例

java -jar okvrestservices.jar --config conf_file --service modify_endpoint_email --ep_name hr_db --ep_email tjones@enterprise.com

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

次のコマンドは、エンドポイント・グループの作成方法および管理方法について説明します。

10.9.5.1 create_endpoint_groupコマンド

create_endpoint_groupコマンドは、新しいエンドポイント・グループを作成します。

構文

ショート形式:

create_endpoint_group -g endpoint_group_name -d "endpoint group description"

ロング形式:

create_endpoint_group --epg_name endpoint_group_name --desc "endpoint group description"

パラメータ

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

-g--epg_name

必須

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

-d--desc

オプション

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

ショート形式の例

この例では、説明"HR endpoint group"が付加されたepg_hrというエンドポイント・グループが作成されることを示しています。

java -jar okvrestservices.jar -c conf_file -r create_endpoint_group -g epg_hr -d "HR endpoint group"

ロング形式の例

java -jar okvrestservices.jar --config conf_file --service create_endpoint_group --epg_name epg_hr --desc "HR endpoint group"

10.9.5.2 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

必須

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

ショート形式の例

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

10.9.5.3 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

必須

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

ショート形式の例

この例では、エンドポイント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

10.9.5.4 delete_endpoint_groupコマンド

delete_endpoint_groupコマンドは、Key Vaultからエンドポイント・グループを削除します。エンドポイント・グループが存在しない場合は、エラー・メッセージが表示されます。

構文

ショート形式:

delete_endpoint_group -f -g endpoint_group

ロング形式:

delete_endpoint_group --force --endpoint_group

パラメータ

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

-g--epg_name

必須

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

-f--force

オプション

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

ショート形式の例

この例では、エンドポイント・グループ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

10.9.5.5 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

必須

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

ショート形式の例

この例では、エンドポイント・グループ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"

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

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

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

10.9.6.1 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

オプション

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

ショート形式の例

この例では、説明"HR DB endpoint group"が付加されたhr_walletというウォレットを作成します。

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"

10.9.6.2 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

必須

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

ショート形式の例

この例では、ウォレット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"

10.9.6.3 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: 読取りおよび変更、および仮想ウォレット管理

ショート形式の例

この例では、エンドポイント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

10.9.6.4 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: 読取り、変更、および仮想ウォレット管理

ショート形式の例

この例では、ウォレット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

10.9.6.5 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

必須

仮想ウォレットの名前。

ショート形式の例

この例では、エンドポイント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

10.9.6.6 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

必須

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

ショート形式の例

この例では、エンドポイント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

10.9.6.7 get_default_walletコマンド

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

構文

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

パラメータ

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

ショート形式の例

エンドポイント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

10.9.6.8 get_walletsコマンド

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

構文

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

パラメータ

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

ショート形式の例

エンドポイント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

10.9.6.9 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: 読取りおよび変更、および仮想ウォレット管理

ショート形式の例

この例では、エンドポイント・グループ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

10.9.6.10 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: 読取りおよび変更、および仮想ウォレット管理

ショート形式の例

この例では、エンドポイント・グループ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

10.9.6.11 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

必須

仮想ウォレットの名前。

ショート形式の例

この例では、エンドポイント・グループ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

10.9.6.12 delete_walletコマンド

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

構文

ショート形式:

delete_wallet -f -w virtual_wallet_name 

ロング形式:

delete_wallet --force --wallet_name virtual_wallet_name 

パラメータ

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

-w--wallet_name

必須

仮想ウォレットの名前。

-f--force

オプション

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

ショート形式の例

この例では、確認なしでウォレット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

10.9.7 エラー・レポート

RESTfulサービス・ユーティリティには強固なエラー・レポートがあるため、これを使用してデバッグを行い、RESTfulサービス・コマンドを簡単に正常に実行できます。コマンド実行のステータス(成功および失敗)は、コマンドラインですぐにレポートされ、ログ・ファイルに書き込まれます。

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

コマンド実行のステータス(成功および失敗)は、コマンドラインですぐにレポートされ、ログ・ファイルに書き込まれます。特定のエラーはレポートされ、必要に応じて修正処理が示されます。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

10.9.7.4 -hまたは--helpを使用した有効なオプションの表示

有効なオプションのリストを表示する場合は、RESTfulサービス・ユーティリティokvrestservices.jarとともに-hオプションまたは--helpオプションを使用できます。

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

10.9.7.5 -Hまたは--listを使用したRESTfulコマンドのリストの表示

RESTfulサービス・コマンドのリストを表示するには、コマンドラインで-Hまたは--listを入力します。