1. RESTfulサービス管理者ガイド
  2. 管理コマンド

3 管理コマンド

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

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

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

クライアント・ウォレットの管理コマンドを使用すると、ユーザー資格証明を格納するクライアント・ウォレットを管理できます。クライアント・ウォレット管理コマンドは、LDAPユーザーおよびデータベース・ユーザーのみをサポートします。

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

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

3.1.1 okv admin client-wallet addコマンド

okv admin client-wallet addコマンドでは、ユーザーの資格証明をクライアント・ウォレットに追加します。クライアント・ウォレットが存在しない場合は、Oracle Key Vaultによってewallet.p12およびcwallet.ssoが作成されます。

必要な権限

なし

構文

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

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

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

パラメータ

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

--client-wallet / clientWallet

必須

クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ)

--wallet-user / walletUser

必須

ユーザー名

JSONの例

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

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

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

    プロンプトが表示されたら、ユーザーのパスワードを入力します。パスワードを入力すると、次のような出力が表示されます。

    Password: password
{
  "result" : "Success"
}

ノート:

Oracle Key Vaultリリース21.7より前は、クライアント・ウォレット・ファイルにユーザーへの書込み権限がない場合、ウォレット・クライアント・ファイルにユーザーを追加していなくても、'okv admin client-wallet add'によって成功メッセージが表示されます。Oracle Key Vaultリリース21.7以降、RESTfulサービス・ユーティリティ・コマンドのエラー・メッセージで権限の問題が報告されます

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

3.1.2 okv admin client-wallet deleteコマンド

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

必要な権限

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

構文

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

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

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

パラメータ

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

--client-wallet / clientWallet

必須

クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ)

--wallet-user / walletUser

必須

ユーザー名

JSONの例

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

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

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

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

    {
  "result" : "Success"
}

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

3.1.3 okv admin client-wallet listコマンド

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

必要な権限

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

構文

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

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

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

パラメータ

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

--client-wallet / clientWallet

必須

クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ)

JSONの例

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

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

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

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

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

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

3.1.4 okv admin client-wallet updateコマンド

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

必要な権限

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

構文

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

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

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

パラメータ

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

--client-wallet / clientWallet

必須

クライアント・ウォレットの場所(クライアント・ウォレットが作成されたディレクトリ)

--wallet-user / walletUser

必須

ユーザー名

JSONの例

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

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

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

    プロンプトが表示されたら、ユーザーのパスワードを入力します。パスワードを入力すると、次のような出力が表示されます。

    Password: password
{
  "result" : "Success"
}

関連項目

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

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

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

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

3.2.1 okv admin endpoint check-statusコマンド

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

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

必要な権限

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

構文

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

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

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

パラメータ

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

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

オプション

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

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

既存のエンドポイントを調べるには、okv admin endpoint listコマンドを実行します。

ロケータIDを調べるには、このエンドポイントの作成に使用されたokv admin endpoint createコマンドの出力を確認します。

JSONの例

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

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "check-status",
    "options" : {
      "endpoint" : "#VALUE",
      "locatorID" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、check-status_ep.json)に保存して、エンドポイントを確認できるように編集します。endpoint値またはlocatorID値のどちらかを指定します(両方は指定できません)。 
    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "check-status",
    "options" : {
      "locatorID" : "1AC9B321-6540-4F2B-809B-95FD7416999E"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint check-statusコマンドを実行します。 
    okv admin endpoint check-status --from-json check-status_ep.json

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

    {
  "result" : "Success",
  "value" : {
    "status" : "ACTIVE",
    "endpoint" : "HR_DB_EP"
  }
}

    エンドポイント・オブジェクトがACTIVE状態の場合は、出力にエンドポイントの名前が含まれます。ここに示されるエンドポイント名は、エンドポイントの作成時に指定したものとは異なることがあります。複数のクラスタ・ノードで同じ名前のエンドポイントが作成された場合、Oracle Key Vaultはネーミング競合の解決を実行して、エンドポイント名に_OKVnode-idを追加することで、1つのエンドポイントを除くすべてのエンドポイントの名前を変更します。たとえば、エンドポイントにhr_db_epという名前を付けたときにネーミング競合があった場合、その名前はhr_db_ep_okv01になります。

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

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

3.2.2 okv admin endpoint createコマンド

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

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

必要な権限

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

構文

okv admin endpoint create [--description <description>] [--email <email>] --endpoint <endpoint> [--platform <platform>] [--ssh-server-host-name <ssh-server-host-name>] [--strict-ip-check <strict-ip-check>] [--subgroup <subgroup>] [--type <type>] [--unique <unique>]

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

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

パラメータ

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

--endpoint / endpoint

必須

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

既存のエンドポイントを調べるには、okv admin endpoint listコマンドを実行します。

--description / description

オプション

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

--email / email

オプション

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

--platform / platform

オプション

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

  • AIX

  • HP-UX

  • LINUX64

  • SOLARIS64

  • SOLARIS_SPARC

  • WINDOWS

    デフォルト値は次のとおりです。

  • LINUX64

--type / type

オプション

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

  • MYSQL_DB

  • ORACLE_ACFS

  • ORACLE_DB

  • ORACLE_NON_DB

  • SSH_SERVER

  • OTHER

    デフォルト値は次のとおりです。

  • ORACLE_DB

--subgroup / subgroup

オプション

マルチマスター・クラスタ環境の場合は、特定のOracle Key Vaultクラスタ・サブグループに対するエンドポイントのアフィニティを定義します。値は次のとおりです。

  • マルチマスター・クラスタ・サブグループの名前を入力します。サブグループを調べるには、Oracle Key Vault管理コンソールで、「Cluster」タブを選択し、左側のナビゲーションバーにある「Management」を選択します。クラスタのサブグループは、「Cluster Information」の下にリストされています。
  • NO SUBGROUPでは、Oracle Key Vaultクラスタ・サブグループのアフィニティを持たないエンドポイントを作成します。
  • USE CREATOR SUBGROUPでは、エンドポイントが作成されたノードが属するOracle Key Vaultクラスタ・サブグループへのアフィニティを持つエンドポイントを作成します。

--strict-ip-check / strictIpCheck

オプション

Oracle Key Vaultサーバーで特定のエンドポイントの着信IPアドレスをチェックするかどうかを制御します。

  • TRUEにすると、Oracle Key Vaultでエンドポイントの着信IPアドレスをチェックできます。IPアドレスが、クライアント・エンドポイント・ソフトウェアのインストール時に使用されたIPアドレスと一致しない場合、Oracle Key Vaultでは接続が許可されません。
  • FALSEは、このチェックを無効にし、エンドポイントの任意のIPアドレスからの着信接続要求を許可します。

ノート:

デフォルト値はTRUEです。

--unique / unique

オプション

マルチマスター・クラスタ環境では、一意のエンドポイントとしてエンドポイントを作成します。マルチマスター・クラスタでは、2つの異なるノードから同じ名前のエンドポイントを作成することが可能です。その場合は、エンドポイント名が競合することがあります。Oracle Key Vaultの競合解決スキームでは、1つのエンドポイントに所定の名前が維持され、それ以外の競合する名前を持つエンドポイントはgiven_ep_name_OKVnode_idという形式を使用して名前が付けられます。

有効な設定は次のとおりです。

  • TRUEは、所定の名前に_OKVnode_idを追加して、このエンドポイント名が競合しないようにします。そのエンドポイントは、すぐに使用可能になります。
  • FALSE (デフォルト)にすると、Oracle Key Vaultによってエンドポイント名が一意であるかどうかを調べるチェック・プロセスが開始されます。一意のIDが返されます。このIDを使用して、エンドポイント作成のステータスが進行中(PENDING)であるか、完了している(ACTIVE)かを確認できます。ステータスがPENDINGの場合は、まだ使用できないため、エンドポイントに対して実行されたアクションは失敗します。ステータスがACTIVEの場合、エンドポイントは使用可能です。ステータスを確認するには、okv admin endpoint check_statusコマンドを実行します。指定した名前が別のノードですでに使用されている場合、このエンドポイントの名前には_OKVxxが付加されます。たとえば、エンドポイントにep12という名前を付けてネーミングの競合があった場合、名前はEP12_OKV01になります。
--ssh-server-host-name / sshServerHostName オプション

SSH_SERVERエンドポイントをデプロイするホストのホスト名またはIPアドレス。このオプションは、SSH_SERVERタイプのエンドポイントでのみ使用できます。

JSONの例

  1. okv admin endpoint createコマンド用にJSON入力を生成します。 
    okv admin endpoint create --generate-json-input

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "create",
    "options" : {
      "endpoint" : "#VALUE",
      "description" : "#VALUE",
      "email" : "#VALUE",
      "platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS",
      "type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|SSH_SERVER|OTHER",
      "subgroup" : "#VALUE|NO SUBGROUP|USE CREATOR SUBGROUP",
      "strictIpCheck" : "#TRUE|FALSE",
      "unique" : "#TRUE|FALSE",
      "sshServerHostName" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、create_ep.json)に保存して、エンドポイントを作成できるように編集します。
    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "create",
    "options" : {
      "endpoint" : "hr_db_ep",
      "description" : "HR database endpoint",
      "email" : "psmith@example.com",
      "platform" : "LINUX64",
      "type" : "ORACLE_DB",
      "subgroup" : "USE CREATOR SUBGROUP",
      "strictIpCheck" : "TRUE",
      "unique" : "FALSE"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint createコマンドを実行します。 
    okv admin endpoint create --from-json create_ep.json

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

    {
  "result" : "Success",
  "value" : {
    "status" : "PENDING",
    "locatorID" : "1AC9B321-6540-4F2B-809B-95FD7416999E"
  }
}

    okv admin endpoint check-statusコマンドに前述の出力から得られたlocatorIDを使用すると、エンドポイント・オブジェクトの現在の状態を表示できます。オブジェクト・ステータスがACTIVEの場合、このコマンドは競合名の解決後のオブジェクト名も表示します。

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

3.2.3 okv admin endpoint deleteコマンド

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

必要な権限

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

構文

okv admin endpoint delete --endpoint endpoint_name

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

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

パラメータ

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

--endpoint / endpoint

必須

エンドポイントの名前。

既存のエンドポイントを調べるには、okv admin endpoint listコマンドを実行します。

JSONの例

  1. okv admin endpoint deleteコマンド用にJSON入力を生成します。 
    okv admin endpoint delete --generate-json-input

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "delete",
    "options" : {
      "endpoint" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、delete_ep.json)に保存して、エンドポイントを削除できるように編集します。
    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "delete",
    "options" : {
      "endpoint" : "hr_db_ep"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint deleteコマンドを実行します。 
    okv admin endpoint delete --from-json delete_ep.json

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

    {
  "result" : "Success"
}

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

3.2.4 okv admin endpoint downloadコマンド

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

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

必要な権限

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

構文

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

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

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

パラメータ

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

--endpoint

/ endpoint

必須

エンドポイントの名前。

既存のエンドポイントを調べるには、okv admin endpoint listコマンドを実行します

--location / location

必須

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

JSONの例

  1. okv admin endpoint downloadコマンド用にJSON入力を生成します。 
    okv admin endpoint download --generate-json-input

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "download",
    "options" : {
      "endpoint" : "#VALUE",
      "location" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、download_ep.json)に保存して、エンドポイントを作成できるように編集します。
    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "download",
    "options" : {
      "endpoint" : "hr_db_ep",
      "location": "/opt/downloads/okv"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint downloadコマンドを実行します。 
    okv admin endpoint download --from-json download_ep.json

    okvclient.jarファイルのダウンロードが成功すると、次の出力が表示されます。 

    {
  "result" : "Success"
}

関連項目

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

3.2.5 okv admin endpoint getコマンド

okv admin endpoint getコマンドでは、エンドポイント・グループや関連するウォレットなど、エンドポイントの詳細情報を取得します。

必要な権限

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

構文

okv admin endpoint get --endpoint endpoint_name

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

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

パラメータ

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

--endpoint / endpoint

必須

エンドポイントの名前。

既存のエンドポイントを調べるには、okv admin endpoint listコマンドを実行します。

JSONの例

  1. okv admin endpoint getコマンド用にJSON入力を生成します。 
    okv admin endpoint get --generate-json-input

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "get",
    "options" : {
           "endpoint" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、get_ep.json)に保存し、それを編集してエンドポイントを指定します。
    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "get",
    "options" : {
           "endpoint" : "hr_db_ep"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint getコマンドを実行します。 
    okv admin endpoint get --from-json get_ep.json

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

    {
  "result" : "Success",
  "value" : {
    "administratorEmail" : "",
    "certificateExpirationTime" : "2023-10-29 14:48:46",
    "creationTime" : "2021-11-02 14:48:46",
    "defaultWallet" : "",
    "description" : "",
    "effectiveEndpointConfiguration" : {         
                                       "expirePkcs11PersistentCacheOnDatabaseShutdown" : "FALSE",
                                       "serverPollTimeout" : "PT0.3S",
                                       "pkcs11ConfigurationParameterRefreshInterval" : "PT10M",
                                       "pkcs11InMemoryCacheTimeout" : "PT1H",
                                       "pkcs11PersistentCacheRefreshWindow"\" : "PT30M",
                                       "pkcs11PersistentCacheTimeout" : "PT24H",
                                       "pkcs11TraceDirectoryPath" : "/tmp"
                                        },
    "effectiveEndpointSettingsForManagedObjects" : {
      "extractableAttribute" : {
        "symmetricKey" : "TRUE"
      }
    },
    "endpoint" : "HR_DB_EP",
    "endpointConfiguration" : {
      "expirePkcs11PersistentCacheOnDatabaseShutdown" : "FALSE",
      "serverPollTimeout" : "",
      "pkcs11ConfigulationParameterRefreshInterval" : "",
      "pkcs11InMemoryCacheTimeout" : "",
      "pkcs11PersistentCacheRefreshWindow" : "",
      "pkcs11PersistentCacheTimeout" : "",
      "pkcs11TraceDirectoryPath" : ""
    },
    "endpointGroupMembership" : [ {
      "endpointGroup" : "EPG_HR",
      "description" : ""
    } ],
    "endpointSettingsForManagedObjects" : {
      "extractableAttribute" : {
        "symmetricKey" : ""
      }
    },
    "ipAddress" : "100.70.00.00",
    "platform" : "LINUX",
    "selfEnrolled" : "FALSE",
    "status" : "ENROLLED",
    "strictIpCheck" : "TRUE",
    "type" : "ORACLE DATABASE",
    "walletAccess" : [ {
      "access" : "RO",
      "type" : "VIA ENDPOINT GROUP",
      "wallet" : "HR_WALLET"
    } ]
  }
}

    effectiveEndpointConfigurationおよびeffectiveEndpointSettingsForManagedObjectsの下の出力は、エンドポイント構成に使用される設定を表します(そのために、名前にeffectiveEndpoint...が使用されています)。これらは、エンドポイント固有の設定およびグローバル・エンドポイント固有の設定に基づいて決定されます。

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

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

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

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

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

必要な権限

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

構文

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

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

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

パラメータ

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

--endpoint / endpoint

必須

登録されたエンドポイントの名前。

既存のエンドポイントを調べるには、okv admin endpoint listコマンドを実行します。

JSONの例

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

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "get-enrollment-token",
    "options" : {
      "endpoint" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、get_token.json)に保存して、エンロール・トークンを取得できるように編集します。
    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "get-enrollment-token",
    "options" : {
      "endpoint" : "hr_db_ep"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint get-enrollment-tokenコマンドを実行します。 
    okv admin endpoint get-enrollment-token --from-json get_token.json

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

    {
  "result" : "Success",
  "value" : {
    "token" : "Si71duR2mGQ8naSZ"
  }
}

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

3.2.7 okv admin endpoint listコマンド

okv admin endpoint listコマンドでは、エンドポイントとその関連情報(作成時間、証明書の有効期限、デフォルト・ウォレットなど)をリストします。

必要な権限

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

構文

okv admin endpoint list [--limit <limit>] [--platform <platform>]
     [--status <status>] [--type <type>]

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "list",
    "options" : {
      "platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS",
      "type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|SSH_SERVER|OTHER",
      "status" : "#REGISTERED|ENROLLED|SUSPENDED",
      "limit" : "#VALUE"
    }
  }
}

パラメータ

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

--limit / limit

オプション

リストするエンドポイント・オブジェクトの数。

1以上の整数を入力します。制限が指定されている場合、Oracle Key Vaultは指定された制限数までのオブジェクトをフェッチします。制限が指定されていない場合、Oracle Key Vaultは最大10,000オブジェクトをフェッチします。10,000より大きい値を指定すると、Oracle Key Vaultは、サーバー、クライアントおよびネットワーク・リソースに応じてその値のフェッチを試行します。取得された出力のfetchedObjectCount値に、フェッチされたオブジェクトの実際の数が表示されます。たとえば、制限として100を指定したがフェッチされるオブジェクトが50個しかない場合、Oracle Key VaultはfetchedObjectCountを50に設定します。このパラメータを省略すると、Oracle Key Vaultは最大10,000個のオブジェクトを取得します。別の例として、制限が100でfetchedObjectCountが100の場合、これはさらにオブジェクトがあることを意味します。すべてのオブジェクトをフェッチするには、--limitパラメータの値を増やしてこのコマンドを実行する必要があります。fetchedObjectCountが指定した制限よりも小さい場合、使用可能なすべてのオブジェクトを取得したことを意味します。

--platform /platform

オプション
エンドポイント・プラットフォーム。使用可能な値は次のとおりです。
  • AIX
  • HP-UX
  • LINUX64
  • SOLARIS64
  • SOLARIS_SPARC
  • WINDOWS

カンマ区切り値の組合せを指定することもできます。フィルタは各値に個別に適用され、OR演算が効果的にサポートされて、結合された結果が返されます。

--type / type

オプション
エンドポイント・プラットフォームのタイプ。使用可能な値は次のとおりです。
  • MYSQL_DB
  • ORACLE_ACFS
  • ORACLE_DB
  • ORACLE_NON_DB
  • SSH_SERVER
  • OTHER

カンマ区切り値の組合せを指定することもできます。フィルタは各値に個別に適用され、OR演算が効果的にサポートされて、結合された結果が返されます。

--status / status

オプション
エンドポイント・プラットフォームのステータス。使用可能な値は次のとおりです。
  • REGISTERED
  • ENROLLED
  • SUSPENDED

カンマ区切り値の組合せを指定することもできます。フィルタは各値に個別に適用され、OR演算が効果的にサポートされて、結合された結果が返されます。

JSONの例

  1. okv admin endpoint listコマンド用にJSON入力テンプレートを生成します。 
    okv admin endpoint list --generate-json-input

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "list",
    "options" : {
      "platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS",
      "type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|SSH_SERVER|OTHER",
      "status" : "#REGISTERED|ENROLLED|SUSPENDED",
      "limit" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、list_ep.json)に保存し、それを編集して、フェッチするオブジェクトの数を指定します。 
    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "list",
    "options" : {
           "limit" : "2"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint listコマンドを実行します。 
    okv admin endpoint list --from-json list_ep.json

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

    {
  "result" : "Success",
  "value" : {
    "endpoints" : [ {
      "commonNameOfCertificateIssuer" : "CA",
      "createdBy" : "OKVADMIN",
      "creationTime" : "2021-07-13 15:26:47",
      "defaultWallet" : "HR_WALLET",
      "description" : " ",
      "endpoint" : "HR_DB_EP_1",
      "endpointCertificateExpiration" : "2023-07-13 15:26:47",
      "enrollmentToken" : "",
      "ipAddress" : "",
      "platform" : "LINUX",
      "status" : "ENROLLED",
      "type" : "ORACLE DATABASE"
    }, {
      "commonNameOfCertificateIssuer" : "CA",
      "createdBy" : "OKVADMIN",
      "creationTime" : "2021-06-25 19:22:36",
      "defaultWallet" : "",
      "description" : "",
      "endpoint" : "HR_DB_EP_2",
      "endpointCertificateExpiration" : "2023-06-25 19:22:36",
      "enrollmentToken" : "",
      "ipAddress" : "192.0.2.143",
      "platform" : "LINUX",
      "status" : "ENROLLED",
      "type" : "ORACLE DATABASE"
    } ],
    "fetchedObjectCount" : "2"
  }
}

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

3.2.8 okv admin endpoint list-objectsコマンド

okv admin endpoint list-objectsコマンドでは、指定されたエンドポイントに関連付けられたセキュリティ・オブジェクトをリストします。

必要な権限

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

構文

okv admin endpoint list-objects --endpoint <endpoint> [--exclude-wallet-membership  <exclude-wallet-membership>] 
    [--limit <limit>][--state <state>] [--type <type>]

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "list-objects",
    "options" : {
      "endpoint" : "#VALUE",
      "state" : "#PRE-ACTIVE|ACTIVE|DEACTIVATED|COMPROMISED|DESTROYED|DESTROYED_COMPROMISED",
      "type" : "#CERTIFICATE|OPAQUE|PRIVATE_KEY|PUBLIC_KEY|SECRET|SYMMETRIC_KEY",
      "limit" : "#VALUE",
      "excludeWalletMembership" : "#TRUE|FALSE"
    }
  }
}

パラメータ

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

--endpoint / endpoint

必須

エンドポイントの名前。

既存のエンドポイントを調べるには、okv admin endpoint listコマンドを実行します。

--limit / limit

オプション

リストするオブジェクトの数。

1以上の整数を入力します。制限が指定されている場合、Oracle Key Vaultは指定された制限数までのオブジェクトをフェッチします。制限が指定されていない場合、Oracle Key Vaultは最大10,000オブジェクトをフェッチします。10,000より大きい値を指定すると、Oracle Key Vaultは、サーバー、クライアントおよびネットワーク・リソースに応じてその値のフェッチを試行します。取得された出力のfetchedObjectCount値に、フェッチされたオブジェクトの実際の数が表示されます。たとえば、制限として100を指定したがフェッチされるオブジェクトが50個しかない場合、Oracle Key VaultはfetchedObjectCountを50に設定します。このパラメータを省略すると、Oracle Key Vaultは最大10,000個のオブジェクトを取得します。別の例として、制限が100でfetchedObjectCountが100の場合、これはさらにオブジェクトがあることを意味します。すべてのオブジェクトをフェッチするには、--limitパラメータの値を増やしてこのコマンドを実行する必要があります。fetchedObjectCountが指定した制限よりも小さい場合、使用可能なすべてのオブジェクトを取得したことを意味します。

--exclude-wallet-membership / excludeWalletMembership

オプション

各オブジェクトに対してウォレット・メンバーシップを表示するかどうかを制御します。

  • TRUEは、エンドポイント・オブジェクトのウォレット・メンバーシップの表示を無効にします。
  • FALSE (デフォルト)は、エンドポイント・オブジェクトのウォレット・メンバーシップの表示を有効にします。

--type / type

オプション

セキュリティ・オブジェクトのタイプ。使用可能な値は次のとおりです。

  • CERTIFICATE
  • OPAQUE
  • PRIVATE_KEY
  • PUBLIC_KEY
  • SECRET
  • SYMMETRIC_KEY

カンマ区切り値の組合せを指定することもできます。フィルタは各値に個別に適用され、OR演算が効果的にサポートされて、結合された結果が返されます。

--state / state

オプション

セキュリティ・オブジェクトの状態。使用可能な値は次のとおりです。

  • PRE-ACTIVE
  • ACTIVE
  • DEACTIVATED
  • COMPROMISED
  • DESTROYED
  • DESTROYED_COMPROMISED

カンマ区切り値の組合せを指定することもできます。フィルタは各値に個別に適用され、OR演算が効果的にサポートされて、結合された結果が返されます。

JSONの例

  1. okv admin endpoint list-objectsコマンド用にJSON入力テンプレートを生成します。 
    okv admin endpoint list-objects --generate-json-input

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "list-objects",
    "options" : {
      "endpoint" : "#VALUE",
      "state" : "#PRE-ACTIVE|ACTIVE|DEACTIVATED|COMPROMISED|DESTROYED|DESTROYED_COMPROMISED",
      "type" : "#CERTIFICATE|OPAQUE|PRIVATE_KEY|PUBLIC_KEY|SECRET|SYMMETRIC_KEY",
      "limit" : "#VALUE",
      "excludeWalletMembership" : "#TRUE|FALSE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、list-obj_ep.json)に保存し、それを編集して、エンドポイントにレコード数を指定します。 
    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "list-objects",
    "options" : {
        "endpoint" : "sales-ep",
        "limit" : "8"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint list-objectsコマンドを実行します。 
    okv admin endpoint list-objects --from-json list-obj_ep.json

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

    {
  "result" : "Success",
  "value" : {
    "fetchedObjectCount" : "8",
    "managedObjects" : [ {
      "creatingEndpoint" : "SALES-EP",
      "creationDate" : "2021-08-04 18:34:52",
      "deactivationDate" : "2051-10-10 10:10:10",
      "displayName" : "X.509 Certificate: DN EMAILADDRESS=psmith@example.com, CN=vienna, OU=Security, O=Oracle, L=Reston, ST=VA, C=US",
      "name" : "ps30090",
      "protectStopDate" : "2053-10-10 10:10:10",
      "state" : "PRE-ACTIVE",
      "type" : "CERTIFICATE",
      "uuid" : "847D1538-915D-4FD7-BF14-829B1A11FAF9"
    }, {
      "creatingEndpoint" : "SALES-EP",
      "creationDate" : "2021-08-03 21:40:25",
      "deactivationDate" : "2029-12-25 15:11:11",
      "displayName" : "Symmetric Key: Name Sales Key 1",
      "name" : "sales_key_1",
      "protectStopDate" : "",
      "state" : "Pre-Active",
      "type" : "Symmetric Key",
      "uuid" : "670B600E-1667-4FD1-BF94-C35C4BC81E8B"
    }, {
      "creatingEndpoint" : "SALES-EP",
      "creationDate" : "2021-08-03 21:21:33",
      "deactivationDate" : "2029-12-25 15:11:11",
      "displayName" : "X.509 Certificate: DN EMAILADDRESS=psmith@example.com, CN=vienna, OU=Security, O=Oracle, L=Reston, ST=VA, C=US",
      "name" : "orders_key_1",
      "protectStopDate" : "2029-12-25 15:11:11",
      "state" : "Pre-Active",
      "type" : "Certificate",
      "uuid" : "0C11B125-B17A-4F90-BF16-F876E5E20A21"
    }, {
      "creatingEndpoint" : "SALES-EP",
      "creationDate" : "2021-08-03 13:36:01",
      "deactivationDate" : "",
      "displayName" : "rec_key_1",
      "protectStopDate" : "",
      "state" : "Pre-Active",
      "type" : "Symmetric Key",
      "uuid" : "780608F6-0CA6-4FC5-BF46-A7B8A36074F7"
    }, {
      "creatingEndpoint" : "SALES-EP",
      "creationDate" : "2021-08-02 15:41:38",
      "deactivationDate" : "2029-12-25 15:11:11",
      "displayName" : "X.509 Certificate: DN EMAILADDRESS=psmith@example.com, CN=vienna, OU=Security, O=Oracle, L=Reston, ST=VA, C=US",
      "name" : "cert_key_1",
      "protectStopDate" : "2029-12-25 15:11:11",
      "state" : "Pre-Active",
      "type" : "Certificate",
      "uuid" : "72EA8183-98BA-4F5A-BF31-CE7256E29496"
    }, {
      "creatingEndpoint" : "SALES-EP",
      "creationDate" : "2021-07-26 20:19:32",
      "deactivationDate" : "2029-12-25 15:11:11",
      "displayName" : "X.509 Certificate: DN EMAILADDRESS=psmith@example.com, CN=vienna, OU=Security, O=Oracle, L=Reston, ST=VA, C=US",
      "name" : "emp_key_1",
      "protectStopDate" : "2029-12-25 15:11:11",
      "state" : "Pre-Active",
      "type" : "Certificate",
      "uuid" : "975F17DF-11C1-4F16-BFBC-28E9C200C99F"
    }, {
      "creatingEndpoint" : "SALES-EP",
      "creationDate" : "2021-07-23 17:22:14",
      "deactivationDate" : "2041-10-10 10:10:10",
      "displayName" : "emp_key_2",
      "protectStopDate" : "",
      "state" : "Active",
      "type" : "Symmetric Key",
      "uuid" : "330F5527-0DB2-4FD1-BF54-1FA189C8A765"
    }, {
      "creatingEndpoint" : "SALES-EP",
      "creationDate" : "2021-06-30 21:01:48",
      "deactivationDate" : "",
      "displayName" : "Symmetric Key: Name psc7",
      "name" : "emp_key_2,emp_key_3,emp_key_5,emp_key_6,emp_key_7",
      "protectStopDate" : "",
      "state" : "Active",
      "type" : "Symmetric Key",
      "uuid" : "7432AED6-6628-4F43-BF7C-9D30023A4301"
    } ]
  }
}

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

3.2.9 okv admin endpoint provisionコマンド

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

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

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

  • ユーザーには、システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限が必要です。

  • ソフト・リンク/usr/bin/javaが$ORACLE_HOME/jdk/jre/bin/javaを指していることを確認する必要があります。

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

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

必要な権限

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

構文

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

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

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

パラメータ

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

--endpoint / endpoint

必須

エンドポイントの名前。

既存のエンドポイントを調べるには、okv admin endpoint listコマンドを実行します。

--location / location

必須

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

--auto-login / autoLogin

オプション

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

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

JSONの例

  1. okv admin endpoint provisionコマンド用にJSON入力を生成します。 
    okv admin endpoint provision --generate-json-input

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "provision",
    "options" : {
      "endpoint" : "#VALUE",
      "location" : "#VALUE",
      "autoLogin" : "#TRUE|FALSE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、provision_ep.json)に保存して、エンドポイント・ソフトウェアをダウンロードしてインストールできるように編集します。
    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "provision",
    "options" : {
      "endpoint" : "hr_db_ep",
      "location" : "/u01/opt/oracle/product/okv",
      "autoLogin" : "TRUE"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint provisionコマンドを実行します。 
    okv admin endpoint provision --from-json provision_ep.json

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

    {
  "result" : "Success"
}

関連項目

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

3.2.10 okv admin endpoint re-enrollコマンド

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

必要な権限

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

構文

okv admin endpoint re-enroll --endpoint endpoint_name

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

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

パラメータ

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

--endpoint / endpoint

必須

エンドポイントの名前。

既存のエンドポイントを調べるには、okv admin endpoint listコマンドを実行します。

JSONの例

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

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

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

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

    {
  "result" : "Success"
}

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

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

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

必要な権限

システム管理者ロール

構文

okv admin endpoint re-enroll-all

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

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

パラメータ

なし

JSONの例

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

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "re-enroll-all"
  }
}
  2. 生成された入力をファイル(たとえば、re-enroll-all_ep.json)に保存します。
  3. 生成されたJSONファイルを使用して、okv admin endpoint re-enroll-allコマンドを実行します。 
    okv admin endpoint re-enroll-all --from-json re-enroll-all_ep.json

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

    {
  "result" : "Success"
}

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

3.2.12 okv admin endpoint resumeコマンド

okv admin endpoint resumeコマンドでは、一時停止されたエンドポイントを再開します。

必要な権限

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

構文

okv admin endpoint resume --endpoint endpoint_name

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

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

パラメータ

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

--endpoint / endpoint

必須

一時停止されたエンドポイントの名前。

一時停止されているエンドポイントの名前を調べるには、okv admin endpoint listコマンドを実行し、その出力で、ステータスがSuspendedのエンドポイントを検索します。

JSONの例

  1. okv admin endpoint resumeコマンド用にJSON入力を生成します。 
    okv admin endpoint resume --generate-json-input

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "resume",
    "options" : {
     "endpoint" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、resume_ep.json)に保存し、それを編集して、一時停止されたエンドポイントを指定します。 
    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "resume",
    "options" : {
     "endpoint" : "hr_db_ep"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint resumeコマンドを実行します。 
    okv admin endpoint resume --from-json resume_ep.json

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

    {
  "result" : "Success"
}

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

3.2.13 okv admin endpoint suspendコマンド

okv admin endpoint suspendコマンドでは、エンドポイントを一時停止します。

必要な権限

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

構文

okv admin endpoint suspend --endpoint endpoint_name

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

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

パラメータ

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

--endpoint / endpoint

必須

エンドポイントの名前。

既存のエンドポイントを調べるには、okv admin endpoint listコマンドを実行します。

JSONの例

  1. okv admin endpoint suspendコマンド用にJSON入力を生成します。 
    okv admin endpoint suspend --generate-json-input

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "suspend",
    "options" : {
           "endpoint" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、suspend_ep.json)に保存し、それを編集して、一時停止するエンドポイントを指定します。
    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "suspend",
    "options" : {
           "endpoint" : "hr_db_ep"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint suspendコマンドを実行します。 
    okv admin endpoint suspend --from-json suspend_ep.json

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

    {
  "result" : "Success"
}

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

3.2.14 okv admin endpoint updateコマンド

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

必要な権限

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

構文

okv admin endpoint update 
--endpoint current_endpoint_name 
--name new_endpoint_name
--description "description" 
--email email_address 
--platform platform --type type  
--subgroup "subgroup_value" 
--unique #TRUE|FALSE
--strict-ip-check #TRUE|FALSE

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

{
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "update",
    "options" : {
      "endpoint" : "#VALUE",
      "name" : "#VALUE",
      "description" : "#VALUE",
      "email" : "#VALUE",
      "platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS",
      "type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|OTHER",
      "subgroup" : "#VALUE|NO SUBGROUP|USE CREATOR SUBGROUP",
      "unique" : "#TRUE|FALSE",
      "strictIpCheck" : "#TRUE|FALSE",
      "endpointConfiguration" : {
        "expirePkcs11PersistentCacheOnDatabaseShutdown" : "#TRUE|FALSE",
        "serverPollTimeout" : "#VALUE",
        "pkcs11ConfigurationParameterRefreshInterval" : "#VALUE",
        "pkcs11InMemoryCacheTimeout" : "#VALUE",
        "pkcs11PersistentCacheRefreshWindow" : "#VALUE",
        "pkcs11PersistentCacheTimeout" : "#VALUE",
        "pkcs11TraceDirectoryPath" : "#VALUE"
      },
      "endpointSettingsForManagedObjects" : {
        "extractableAttribute" : {
          "privateKey" : "#TRUE|FALSE",
          "symmetricKey" : "#TRUE|FALSE"
        }
      }
    }
  }
}

パラメータ

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

--endpoint / endpoint

必須

更新するエンドポイントの名前。

既存のエンドポイントを調べるには、okv admin endpoint listコマンドを実行します。

--name / name

オプション

エンドポイントの新しい名前。オブジェクトのネーミング・ガイドラインに従っていることを確認します。「オブジェクトのネーミング・ガイドライン」を参照してください。

--description / description

オプション

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

--email / email

オプション

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

--platform / platform

オプション

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

  • AIX

  • HP-UX

  • LINUX64

  • SOLARIS64

  • SOLARIS_SPARC

  • WINDOWS

--type / type

オプション

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

  • MYSQL_DB

  • ORACLE_ACFS

  • ORACLE_DB

  • ORACLE_NON_DB

  • OTHER

--subgroup / subgroup

オプション

マルチマスター・クラスタ環境の場合は、特定のOracle Key Vaultクラスタ・サブグループに対するエンドポイントのアフィニティを定義します。値は次のとおりです。

  • マルチマスター・クラスタ・サブグループの名前を入力します。サブグループを調べるには、Oracle Key Vault管理コンソールで、「Cluster」タブを選択し、左側のナビゲーションバーにある「Management」を選択します。クラスタのサブグループは、「Cluster Information」の下にリストされています。
  • NO SUBGROUPでは、Oracle Key Vaultクラスタ・サブグループのアフィニティを持たないエンドポイントを作成します。
  • USE CREATOR SUBGROUPでは、エンドポイントが作成されたノードが属するOracle Key Vaultクラスタ・サブグループへのアフィニティがあるエンドポイントを作成します。

--unique / unique

オプション

マルチマスター・クラスタ環境では、一意のエンドポイントとしてエンドポイントを作成します。マルチマスター・クラスタでは、2つの異なるノードから同じ名前のエンドポイントを作成することが可能です。その場合は、エンドポイント名が競合することがあります。Oracle Key Vaultの競合解決スキームでは、1つのエンドポイントに所定の名前が維持され、それ以外の競合する名前を持つエンドポイントはgiven_ep_name_OKVnode_idという形式を使用して名前が付けられます。

有効な設定は次のとおりです。

  • TRUEは、所定の名前に_OKVnode_idを追加して、このエンドポイント名が競合しないようにします。
  • FALSE (デフォルト)にすると、Oracle Key Vaultによってエンドポイント名が一意であるかどうかを調べるチェック・プロセスが開始されます。一意のIDが返されます。このIDを使用して、エンドポイント作成のステータスが進行中(PENDING)であるか、完了している(ACTIVE)かを確認できます。ステータスがPENDINGの場合は、まだ使用できないため、エンドポイントに対して実行されたアクションは失敗します。ステータスがACTIVEの場合、エンドポイントは使用可能です。ステータスを確認するには、okv admin endpoint check_statusコマンドを実行します。指定した名前が別のノードですでに使用されている場合、このエンドポイントの名前には_OKVxxが付加されます。たとえば、エンドポイントにep12という名前を付けてネーミングの競合があった場合、名前はEP12_OKV01になります。

--strict-ip-check / strictIpCheck

オプション

Oracle Key Vaultサーバーで特定のエンドポイントの着信IPアドレスをチェックするかどうかを制御します。

  • TRUEにすると、Oracle Key Vaultでエンドポイントの着信IPアドレスをチェックできます。IPアドレスが、クライアント・エンドポイント・ソフトウェアのインストール時に使用されたIPアドレスと一致しない場合、Oracle Key Vaultでは接続が許可されません。
  • FALSEは、このチェックを無効にし、エンドポイントの任意のIPアドレスからの着信接続要求を許可します。

/endpointConfiguration

オプション

各endpointConfiguration設定は、エンドポイント構成パラメータを表します。エンドポイント構成パラメータを追加するには、JSON構文を使用する必要があります。これらのエンドポイント構成パラメータは、コマンドラインでは指定できません。

入力できる値は次のとおりです。

  • expirePkcs11PersistentCacheOnDatabaseShutdownは、指定したエンドポイント・データベースのPKCS#11永続キャッシュがエンドポイント・データベースの停止時に自動的に期限切れになるかどうかを設定します。
    • TRUE (デフォルト)にすると、expirePkcs11PersistentCacheOnDatabaseShutdownが有効になります。
    • FALSEにすると、expirePkcs11PersistentCacheOnDatabaseShutdownが無効になります。

    エンドポイント固有の構成パラメータの場合は、エンドポイント固有のパラメータがないことを示す空の値(デフォルト)に設定することもできます。この場合、エンドポイントはグローバル・エンドポイントからこのパラメータを継承します。

    エンドポイント固有の構成パラメータを削除するには、空の値を指定します。エンドポイント固有のパラメータが削除されると、エンドポイントはグローバル・エンドポイントから設定を継承し始めます。

  • 次にタイムアウト・パラメータを示します。
    • serverPollTimeoutは、サーバーのポーリング・タイムアウトを指定します。
    • pkcs11ConfigurationParameterRefreshIntervalは、長時間実行されるプロセスがokvclient.ora構成ファイルを再読取りする頻度を設定します。
    • pkcs11InMemoryCacheTimeoutは、インメモリー・キャッシュでマスター暗号化キーが使用可能になる期間を設定します。
    • pkcs11PersistentCacheRefreshWindowは、永続キャッシュ・タイムアウト期間の期限が切れた後、永続キャッシュでマスター暗号化キーが使用可能なままになる時間を延長します。
    • pkcs11PersistentCacheTimeoutは、永続キャッシュでマスター暗号化が使用可能になる期間を設定します。

    これらのタイムアウト値は、ISO-8601標準に基づく期間書式を使用する様々な方法で設定できます。次に各例を示します。 

    "serverPollTimeout" : "PT0.3S", -- 300 millseconds
"pkcs11InMemoryCacheTimeout" : "PT10M", -- 10 minutes
"pkcs11PersistentCacheTimeout" : "PT5H", -- 5 hours
"pkcs11PersistentCacheRefreshWindow" : "P1D", -- 1 day
  • pkcs11TraceDirectoryPathは、トレース・ファイルのパスを設定します

/endpointSettingsForManagedObjects

オプション

extractableAttributeでは、対称キーをOracle Key Vaultから抽出できるかどうかを指定できます。この設定を追加または変更するには、JSON構文を使用する必要があります。この設定はコマンドラインでは指定できません。設定は次のとおりです。

  • symmetricKey
    • TRUEにすると、symmetricKeyオブジェクト値をOracle Key Vaultから抽出できるようになります。
    • FALSEにすると、symmetricKeyオブジェクト値をOracle Key Vaultから抽出できなくなります。
  • privateKey
    • TRUEにすると、privateKeyオブジェクト値をOracle Key Vaultから抽出できるようになります。
    • FALSEにすると、privateKeyオブジェクト値をOracle Key Vaultから抽出できなくなります。

    エンドポイント固有の設定の場合は、エンドポイント固有の設定がないことを示す空の値(デフォルト)に設定することもできます。この場合、エンドポイントはグローバル・エンドポイントからこの設定を継承します。

    エンドポイント固有の設定を削除するには、空の値を指定します。エンドポイント固有の設定が削除されると、エンドポイントはグローバル・エンドポイントから設定を継承し始めます。

    symmetricKeyおよびprivateKey設定のデフォルト値は、グローバル・エンドポイント構成から継承されます。endpointConfigurationやextractableAttributeに空の値を指定すると、対応する構成が削除されます。

JSONの例

  1. okv admin endpoint updateコマンド用にJSON入力を生成します。 
    okv admin endpoint update --generate-json-input

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

    {
  "service" : {
    "category" : "admin",
    "resource" : "endpoint",
    "action" : "update",
    "options" : {
      "endpoint" : "#VALUE",
      "name" : "#VALUE",
      "description" : "#VALUE",
      "email" : "#VALUE",
      "platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS",
      "type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|OTHER",
      "subgroup" : "#VALUE|NO SUBGROUP|USE CREATOR SUBGROUP",
      "unique" : "#TRUE|FALSE",
      "strictIpCheck" : "#TRUE|FALSE",
      "endpointConfiguration" : {
        "expirePkcs11PersistentCacheOnDatabaseShutdown" : "#TRUE|FALSE",
        "serverPollTimeout" : "#VALUE",
        "pkcs11ConfigurationParameterRefreshInterval" : "#VALUE",
        "pkcs11InMemoryCacheTimeout" : "#VALUE",
        "pkcs11PersistentCacheRefreshWindow" : "#VALUE",
        "pkcs11PersistentCacheTimeout" : "#VALUE",
        "pkcs11TraceDirectoryPath" : "#VALUE"
      },
      "endpointSettingsForManagedObjects" : {
        "extractableAttribute" : {
          "privateKey" : "#TRUE|FALSE",
          "symmetricKey" : "#TRUE|FALSE"
        }
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、update_ep.json)に保存し、それを編集してエンドポイントを更新します。
    {
  "service": {
    "category": "admin",
    "resource": "endpoint",
    "action": "update",
    "options": {
      "endpoint": "hr_db_ep",
      "description": "",
      "platform": "LINUX64",
      "email": "",
      "type": "ORACLE_DB",
      "strictIpCheck" : "TRUE",
      "endpointConfiguration" : {
          "expirePkcs11PersistentCacheOnDatabaseShutdown" : "TRUE",
          "serverPollTimeout" : "PT5M",
          "pkcs11ConfigurationParameterRefresh" : "PT11M",
          "pkcs11InMemoryCacheTimeout" : "PT20M",
          "pkcs11PersistentCacheRefreshWindow" : "PT30M",
          "pkcs11PersistentCacheTimeout" : "PT40M",
          "pkcs11TraceDirectoryPath" : "/users/psmith/work"
      },
      "endpointSettingsForManagedObjects" : {
          "extractableAttribute" : {
              "symmetricKey" : "FALSE"
          }
        }
     }
  }
}
  3. 生成されたJSONファイルを使用して、okv admin endpoint updateコマンドを実行します。 
    okv admin endpoint update --from-json update_ep.json

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

    {
  "result" : "Success",
}

関連項目

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