4 アクセスの管理コマンド
アクセスの管理コマンドを使用すると、ウォレットおよびエンドポイント・グループを管理できます。
- okv manage-access endpoint-group add-endpointコマンド
okv manage-access endpoint-group add-endpoint
コマンドでは、既存のエンドポイントをエンドポイント・グループに追加します。 - okv manage-access endpoint-group check-statusコマンド
okv manage-access endpoint-group check-status
コマンドでは、マルチマスター・クラスタ内のエンドポイント・グループのネーミング競合解決ステータスを確認します。 - okv manage-access endpoint-group createコマンド
okv manage-access endpoint-group create
コマンドでは、新しいエンドポイント・グループを作成します。 - okv manage-access endpoint-group deleteコマンド
okv manage-access endpoint-group delete
コマンドでは、エンドポイント・グループを削除します。 - okv manage-access endpoint-group remove-endpointコマンド
okv manage-access endpoint-group remove-endpoint
コマンドでは、エンドポイント・グループからエンドポイントを削除します。 - okv manage-access endpoint-group updateコマンド
okv manage-access endpoint-group update
コマンドでは、エンドポイント・グループの名前と説明を変更します。エンドポイント・グループ名が一意になるようにするために使用できます。 - okv manage-access wallet add-accessコマンド
okv manage-access wallet add-access
コマンドでは、エンドポイントまたはエンドポイント・グループにウォレットへのアクセス・レベルを付与します。 - okv manage-access wallet check-statusコマンド
okv manage-access wallet check-status
コマンドでは、マルチマスター・クラスタ内のウォレットのネーミング競合解決ステータスを確認します。 - okv manage-access wallet createコマンド
okv manage-access wallet create
コマンドでは、ウォレットを作成します。 - okv manage-access wallet deleteコマンド
okv manage-access wallet delete
コマンドでは、ウォレットを削除します。 - okv manage-access wallet get-defaultコマンド
okv manage-access wallet get-default
コマンドでは、エンドポイントに関連付けられているデフォルト・ウォレットを取得します。 - okv manage-access wallet list-endpoint-walletsコマンド
okv manage-access wallet list-endpoint-wallets
コマンドでは、エンドポイントに関連付けられているウォレットをリストします。 - okv manage-access wallet remove-accessコマンド
okv manage-access wallet remove-access
コマンドでは、エンドポイントまたはエンドポイント・グループのウォレットに対するアクセス権を削除します。 - okv manage-access wallet set-defaultコマンド
okv manage-access wallet set-default
コマンドでは、エンドポイントのデフォルト・ウォレットを設定します。 - okv manage-access wallet updateコマンド
okv manage-access wallet update
コマンドでは、ウォレットを更新します。 - okv manage-access wallet update-accessコマンド
okv manage-access wallet update-access
コマンドでは、エンドポイントまたはエンドポイント・グループのウォレットに対するアクセス権のレベルを更新します。
4.1 okv manage-access endpoint-group add-endpointコマンド
okv manage-access endpoint-group add-endpoint
コマンドでは、既存のエンドポイントをエンドポイント・グループに追加します。
必要な権限
キー管理者ロールまたはエンドポイント・グループに対するエンドポイント・グループ管理オブジェクト権限
構文
okv manage-access endpoint-group add-endpoint --endpoint-group endpoint_group_name --endpoint endpoint_member
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "add-endpoint", "options" : { "endpointGroup" : "#VALUE", "endpoint" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイント・グループの名前既存のエンドポイント・グループを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoint Groups」ページを確認します。 |
|
必須 |
エンドポイントの名前。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。 |
JSONの例
okv manage-access endpoint-group add-endpoint
コマンド用にJSON入力を生成します。okv manage-access endpoint-group add-endpoint --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "add-endpoint", "options" : { "endpointGroup" : "#VALUE", "endpoint" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
add_ep_to_group.json
)に保存し、エンドポイント・グループにエンドポイントを追加できるように編集します。{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "add-endpoint", "options" : { "endpointGroup" : "epg_hr", "endpoint" : "hr_db_ep" } } }
- 生成されたJSONファイルを使用して、
okv manage-access endpoint-group add-endpoint
コマンドを実行します。okv manage-access endpoint-group add-endpoint --from-json add_ep_to_group.json
出力は、次のようになります。
{ "result" : "Success" }
親トピック: アクセスの管理コマンド
4.2 okv manage-access endpoint-group check-statusコマンド
okv manage-access endpoint-group check-status
コマンドでは、マルチマスター・クラスタ内のエンドポイント・グループのネーミング競合解決ステータスを確認します。
このコマンドは、主にマルチマスター・クラスタ環境に向けられています。ただし、その他のデプロイメントにも有効であり、エンドポイント・グループの存在を確認するために使用できます。
必要な権限
キー管理者ロールまたはエンドポイント・グループに対するエンドポイント・グループ管理オブジェクト権限
構文
okv manage-access endpoint-group check-status --endpoint-group endpoint_group_name|--locator-id UUID
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "check-status", "options" : { "endpointGroup" : "#VALUE", "locatorID" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
確認するエンドポイント・グループのエンドポイント・グループ名またはロケータID (UUID (universally unique ID))。
既存のエンドポイント・グループを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、左側のナビゲーションバーの「Endpoint Groups」を選択し、「Endpoint Groups」ページで「Endpoint Groups」を確認します。 ロケータIDを調べるには、Oracle Key Vault管理コンソールで、左側のナビゲーションバーにある「Cluster」タブを選択して、「Conflict Resolution」を選択します。「Keys, Secrets & Objects」表で、「Unique Identifier」列を確認します。 |
JSONの例
okv manage-access endpoint-group check-status
コマンド用にJSON入力を生成します。okv manage-access endpoint-group check-status --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "check-status", "options" : { "endpointGroup" : "#VALUE", "locatorID" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
check-status_epg.json
)に保存して、エンドポイント・グループのステータスを確認できるように編集します。endpointGroup
値またはlocatorID
値のどちらかを指定します。その両方は指定できません。{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "check-status", "options" : { "locatorID" : "67E0906F-95EE-4A95-A496-D7DAEA5EDC5F" } } }
- 生成されたJSONファイルを使用して、
okv manage-access endpoint-group check-status
コマンドを実行します。okv manage-access endpoint-group check-status --from-json check-status_epg.json
出力は、次のようになります。
{ "result" : "Success", "value" : { "status" : "ACTIVE", "endpointGroup" : "EPG_HR" } }
エンドポイント・グループ・オブジェクトが
ACTIVE
状態の場合は、出力にエンドポイント・グループの名前が含まれます。ここに示されるエンドポイント・グループ名は、エンドポイント・グループの作成時に指定したものとは異なることがあります。複数のクラスタ・ノードで同じ名前のエンドポイント・グループが作成された場合、Oracle Key Vaultはネーミング競合の解決を実行して、エンドポイント名に_OKVnode-id
を追加することで、1つのエンドポイント・グループを除くすべてのエンドポイント・グループの名前を変更します。たとえば、エンドポイント・グループにEPG_HR
という名前を付けたときにネーミング競合があった場合、その名前はEPG_HR_OKV01
になります。マルチマスター・クラスタ以外のデプロイメントでは、このコマンドはエンドポイント・グループが存在している場合に
Success
を返し、出力にはエンドポイント・グループ名とその状態を示すエントリは含まれません。
親トピック: アクセスの管理コマンド
4.3 okv manage-access endpoint-group createコマンド
okv manage-access endpoint-group create
コマンドでは、新しいエンドポイント・グループを作成します。
必要な権限
キー管理者ロールまたはエンドポイント・グループ作成システム権限
構文
okv manage-access endpoint-group create --endpoint-group endpoint_group_name --description "endpoint group description" --unique TRUE|FALSE
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "create", "options" : { "endpointGroup" : "#VALUE", "description" : "#VALUE", "unique" : "#TRUE|FALSE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイント・グループの名前「オブジェクトのネーミング・ガイドライン」を参照してください。既存のエンドポイント・グループを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoint Groups」ページを確認します。 |
|
オプション |
二重引用符で囲まれたエンドポイント・グループのわかりやすい説明 |
|
オプション |
マルチマスター・クラスタ環境にのみ適用されます。この 有効な設定は次のとおりです。
|
JSONの例
okv manage-access endpoint-group create
コマンド用にJSON入力を生成します。okv manage-access endpoint-group create --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "create", "options" : { "endpointGroup" : "#VALUE", "description" : "#VALUE", "unique" : "#TRUE|FALSE" } } }
- 生成された入力をファイル(たとえば、
create_epg.json
)に保存して、エンドポイント・グループを作成できるように編集します。{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "create", "options" : { "endpointGroup" : "epg_hr", "description" : "HR endpoint group", "unique" : "FALSE" } } }
- 生成されたJSONファイルを使用して、
okv manage-access endpoint-group create
コマンドを実行します。okv manage-access endpoint-group create --from-json create_epg.json
マルチマスター・クラスタ環境の場合の出力は次のようになります。
{ "result" : "Success", "value" : { "status" : "PENDING", "locatorID" : "67E0906F-95EE-4A95-A496-D7DAEA5EDC5F" } }
この出力から得られた
locatorID
をokv manage-access endpoint-group check-status
コマンドに使用すると、エンドポイント・グループ・オブジェクトの現在の状態を表示できます。オブジェクト・ステータスがACTIVE
の場合、このコマンドは競合名の解決後のオブジェクト名も表示します。
親トピック: アクセスの管理コマンド
4.4 okv manage-access endpoint-group deleteコマンド
okv manage-access endpoint-group delete
コマンドでは、エンドポイント・グループを削除します。
必要な権限
キー管理者ロールまたはエンドポイント・グループに対するエンドポイント・グループ管理オブジェクト権限
構文
okv manage-access endpoint-group delete --endpoint-group endpoint_group_name
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "delete", "options" : { "endpointGroup" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイント・グループの名前既存のエンドポイント・グループを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoint Groups」ページを確認します。 |
JSONの例
okv manage-access endpoint-group delete
コマンド用にJSON入力を生成します。okv manage-access endpoint-group delete --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "delete", "options" : { "endpointGroup" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
delete_epg.json
)に保存して、エンドポイント・グループを削除できるように編集します。{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "delete", "options" : { "endpointGroup" : "epg_hr" } } }
- 生成されたJSONファイルを使用して、
okv manage-access endpoint-group delete
コマンドを実行します。okv manage-access endpoint-group delete --from-json delete_epg.json
出力は、次のようになります。
{ "result" : "Success" }
親トピック: アクセスの管理コマンド
4.5 okv manage-access endpoint-group remove-endpointコマンド
okv manage-access endpoint-group remove-endpoint
コマンドでは、エンドポイント・グループからエンドポイントを削除します。
必要な権限
キー管理者ロールまたはエンドポイント・グループに対するエンドポイント・グループ管理オブジェクト権限
構文
okv manage-access endpoint-group remove-endpoint --endpoint-group endpoint_group_name --endpoint endpoint_name
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "remove-endpoint", "options" : { "endpointGroup" : "#VALUE", "endpoint" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
削除するエンドポイント・グループの名前。既存のエンドポイント・グループを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoint Groups」ページを確認します。 |
|
必須 |
エンドポイント・グループに関連付けられているエンドポイントの名前。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。 |
JSONの例
okv manage-access endpoint-group remove-endpoint
コマンド用にJSON入力を生成します。okv manage-access endpoint-group remove-endpoint --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "remove-endpoint", "options" : { "endpointGroup" : "#VALUE", "endpoint" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
remove_ep_from_epg.json
)に保存し、エンドポイント・グループからエンドポイントを削除できるように編集します。{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "remove-endpoint", "options" : { "endpointGroup" : "epg_hr", "endpoint" : "hr_db_ep" } } }
- 生成されたJSONファイルを使用して、
okv manage-access endpoint-group remove-endpoint
コマンドを実行します。okv manage-access endpoint-group remove-endpoint --from-json remove_ep_from_epg.json
出力は、次のようになります。
{ "result" : "Success" }
親トピック: アクセスの管理コマンド
4.6 okv manage-access endpoint-group updateコマンド
okv manage-access endpoint-group update
コマンドでは、エンドポイント・グループの名前と説明を変更します。エンドポイント・グループ名が一意になるようにするために使用できます。
必要な権限
キー管理者ロールまたはエンドポイント・グループに対するエンドポイント・グループ管理オブジェクト権限
構文
okv manage-access endpoint-group update --endpoint-group endpoint_group_name --description "description" --name new_endpoint_group_name --unique TRUE|FALSE
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "update", "options" : { "endpointGroup" : "#VALUE", "name" : "#VALUE", "description" : "#VALUE", "unique" : "#TRUE|FALSE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイント・グループの現在の名前既存のエンドポイント・グループを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoint Groups」ページを確認します。 |
|
オプション |
二重引用符で囲まれたエンドポイント・グループのわかりやすい説明 |
|
オプション |
新しいエンドポイント・グループ名。「オブジェクトのネーミング・ガイドライン」を参照してください。 |
|
オプション |
マルチマスター・クラスタ環境にのみ適用されます。この 有効な設定は次のとおりです。
|
JSONの例
okv manage-access endpoint-group update
コマンド用にJSON入力を生成します。okv manage-access endpoint-group update --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "update", "options" : { "endpointGroup" : "#VALUE", "name" : "#VALUE", "description" : "#VALUE", "unique" : "#TRUE|FALSE" } } }
- 生成された入力をファイル(たとえば、
epg_update.json
)に保存して、エンドポイント・グループを更新できるように編集します。{ "service" : { "category" : "manage-access", "resource" : "endpoint-group", "action" : "update", "options" : { "endpointGroup" : "epg_hr", "name" : "epg_hr_global", "description" : "Global HR Endpoint Group", "unique" : "FALSE" } } }
- 生成されたJSONファイルを使用して、
okv manage-access endpoint-group update
コマンドを実行します。okv manage-access endpoint-group update --from-json epg_update.json
出力は、次のようになります。
{ "result" : "Success", "value" : { "status" : "PENDING", "locatorID" : "67E0906F-95EE-4A95-A496-D7DAEA5EDC5F" } }
この例は、マルチマスター・クラスタのエンドポイント・グループの名前を変更した場合の出力を示しています。名前の変更時、エンドポイント・グループはネーミング競合解決の間
PENDING
状態になります。この出力から得られた
locatorID
をokv manage-access endpoint-group check-status
コマンドに使用すると、エンドポイント・グループ・オブジェクトの現在の状態を表示できます。オブジェクト・ステータスがACTIVE
の場合に、このコマンドは競合名の解決後のオブジェクト名も表示します。マルチマスター・クラスタではエンドポイント・グループの名前を変更しないかぎり、ステータスと
locatorID
のエントリは出力に含まれません。
親トピック: アクセスの管理コマンド
4.7 okv manage-access wallet add-accessコマンド
okv manage-access wallet add-access
コマンドでは、エンドポイントまたはエンドポイント・グループにウォレットへのアクセス・レベルを付与します。
このコマンドは、認証のためにユーザー名とパスワードを使用します。
必要な権限
キー管理者ロールまたはウォレットに対するウォレット管理(MW
)権限
構文
okv manage-access wallet add-access --wallet wallet_name --endpoint endpoint_name|--endpoint-group endpoint_group_name --access RO|RM|RO_MW|RM_MW
JSON入力ファイル・テンプレート
{ "service": { "category": "manage-access", "resource": "wallet", "action": "add-access", "options": { "wallet": "#VALUE", "endpointGroup": "#VALUE", "endpoint": "#VALUE", "access": "#RO|RM|RO_MW|RM_MW" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。 |
または
|
必須 |
エンドポイントまたはエンドポイント・グループの名前。エンドポイントまたはエンドポイント・グループどちらかのみを指定できます。その両方は指定できません。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。エンドポイント・グループについては、「Endpoint Groups」ページを確認します。 |
|
必須 |
次のいずれかの値を入力します。
|
JSONの例
okv manage-access wallet add-access
コマンド用にJSON入力を生成します。okv manage-access wallet add-access --generate-json-input
次のような入力が生成されます。この出力には、エンドポイントとエンドポイント・グループの両方のウォレット・アクセス設定が含まれています。編集するときには、エンドポイント設定またはエンドポイント・グループ設定の両方ではなく、どちらかを含める必要があります。
{ "service": { "category": "manage-access", "resource": "wallet", "action": "add-access", "options": { "wallet": "#VALUE", "endpointGroup": "#VALUE", "endpoint": "#VALUE", "access": "#RO|RM|RO_MW|RM_MW" } } }
- 生成された入力をファイル(たとえば、
add_access_wallet.json
)に保存し、エンドポイントまたはエンドポイント・グループにウォレット・アクセス権を追加できるように編集します。次の例は、エンドポイントのみへのウォレット・アクセスの場合です。{ "service": { "category": "manage-access", "resource": "wallet", "action": "add-access", "options": { "wallet": "hr_wallet", "endpoint": "hr_db_ep", "access": "RO" } } }
- 生成されたJSONファイルを使用して、
okv manage-access wallet add-access
コマンドを実行します。okv manage-access wallet add-access --from-json add_access_wallet.json
出力は、次のようになります。
{ "result": "Success" }
親トピック: アクセスの管理コマンド
4.8 okv manage-access wallet check-statusコマンド
okv manage-access wallet check-status
コマンドでは、マルチマスター・クラスタ内のウォレットのネーミング競合解決ステータスを確認します。
このコマンドは、主にマルチマスター・クラスタ環境に向けられています。ただし、その他のデプロイメントにも有効であり、ウォレットの存在を確認するために使用できます。
このコマンドは、認証のためにユーザー名とパスワードを使用します。
必要な権限
なし。ただし、ユーザーがアクセス権を持つウォレットのステータスのみが取得されます。
構文
okv manage-access wallet check-status --wallet wallet_name|--locator-id UUID
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "check-status", "options" : { "wallet" : "#VALUE", "locatorID" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
オプション |
確認するウォレットのウォレット名またはロケータID (UUID (universally unique ID))。
アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。 ロケータIDを調べるには、Oracle Key Vault管理コンソールで、左側のナビゲーションバーにある「Cluster」タブを選択して、「Conflict Resolution」を選択します。「Keys, Secrets & Objects」表で、「Unique Identifier」列を確認します。 |
JSONの例
okv manage-access wallet check-status
コマンド用にJSON入力を生成します。okv manage-access wallet check-status --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "check-status", "options" : { "wallet" : "#VALUE", "locatorID" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
check_wallet.json
)に保存して、ウォレットのステータスを確認できるように編集します。wallet
値またはlocatorID
値のどちらかを指定します。その両方は指定できません。{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "check-status", "options" : { "locatorID" : "81800CE6-6AAF-4EF5-A0FD-446ED6625F6A" } } }
- 生成されたJSONファイルを使用して、
okv manage-access wallet check-status
コマンドを実行します。okv manage-access wallet check-status --from-json check_wallet.json
出力は、次のようになります。
{ "result" : "Success", "value" : { "status" : "ACTIVE", "wallet" : "hr_wallet" } }
ウォレット・オブジェクトが
ACTIVE
状態の場合は、出力にウォレットの名前が含まれます。ここに示されるウォレット名は、ウォレットの作成時に指定したものとは異なることがあります。複数のクラスタ・ノードで同じ名前のウォレットが作成された場合、Oracle Key Vaultはネーミング競合の解決を実行して、ウォレット名に_OKVnode-id
を追加することで、1つのウォレットを除くすべてのウォレットの名前を変更します。たとえば、ウォレットにHR_WALLET
という名前を付けたときにネーミング競合があった場合、その名前はHR_WALLET_OKV01
になります。マルチマスター・クラスタ以外のデプロイメントでは、このコマンドはウォレットが存在している場合に
Success
を返し、出力にはウォレット名とその状態を示すエントリは含まれません。
親トピック: アクセスの管理コマンド
4.9 okv manage-access wallet createコマンド
okv manage-access wallet create
コマンドでは、ウォレットを作成します。
このコマンドは、認証のためにユーザー名とパスワードを使用します。
必要な権限
なし
構文
okv manage-access wallet create --wallet wallet_name --description "wallet_description" --unique TRUE|FALSE
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "create", "options" : { "wallet" : "#VALUE", "description" : "#VALUE", "unique" : "#TRUE|FALSE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。 「オブジェクトのネーミング・ガイドライン」を参照してください。 |
|
オプション |
二重引用符で囲まれたウォレットのわかりやすい説明 |
|
オプション |
マルチマスター・クラスタ環境にのみ適用されます。この 有効な設定は次のとおりです。
|
JSONの例
okv manage-access wallet create
コマンド用にJSON入力を生成します。okv manage-access wallet create --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "create", "options" : { "wallet" : "#VALUE", "description" : "#VALUE", "unique" : "#TRUE|FALSE" } } }
- 生成された入力をファイル(たとえば、
create_wallet.json
)に保存して、ウォレットを作成できるように編集します。{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "create", "options" : { "wallet" : "hr_wallet", "description" : "wallet for HR endpoint", "unique" : "FALSE" } } }
- 生成されたJSONファイルを使用して、
okv manage-access wallet create
コマンドを実行します。okv manage-access wallet create --from-json create_wallet.json
マルチマスター・クラスタ環境の場合の出力は次のようになります。
{ "result" : "Success", "value" : { "status" : "PENDING", "locatorID" : "81800CE6-6AAF-4EF5-A0FD-446ED6625F6A" } }
この出力から得られた
locatorID
をokv manage-access wallet check-status
コマンドに使用すると、ウォレット・オブジェクトの現在の状態を表示できます。オブジェクト・ステータスがACTIVE
の場合に、このコマンドは競合名の解決後のオブジェクト名も表示します。
親トピック: アクセスの管理コマンド
4.10 okv manage-access wallet deleteコマンド
okv manage-access wallet delete
コマンドでは、ウォレットを削除します。
このコマンドは、認証のためにユーザー名とパスワードを使用します。
必要な権限
キー管理者ロールまたはウォレットに対するウォレット管理(MW
)権限
構文
okv manage-access wallet delete --wallet wallet_name
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "delete", "options" : { "wallet" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。 |
JSONの例
okv manage-access wallet delete
コマンド用にJSON入力を生成します。okv manage-access wallet delete --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "delete", "options" : { "wallet" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
del_wallet.json
)に保存して、Oracle Key Vaultからウォレットを削除できるように編集します。{ "service" : { "category" : "manage-access", "resource ": "wallet", "action" : "delete", "options" : { "wallet" : "hr_wallet" } } }
- 生成されたJSONファイルを使用して、
okv manage-access wallet delete
コマンドを実行します。okv manage-access wallet delete --from-json del_wallet.json
出力は、次のようになります。
{ "result" : "Success" }
親トピック: アクセスの管理コマンド
4.11 okv manage-access wallet get-defaultコマンド
okv manage-access wallet get-default
コマンドでは、エンドポイントに関連付けられているデフォルト・ウォレットを取得します。
このコマンドは、認証のためにユーザー名とパスワードを使用します。
必要な権限
なし。ただし、ユーザーがウォレットに対するなんらかのアクセス権を持っている場合に、エンドポイントのデフォルト・ウォレット情報が返されます。
構文
okv manage-access wallet get-default --endpoint endpoint_name
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "get-default", "options" : { "endpoint" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。 |
JSONの例
okv manage-access wallet get-default
コマンド用にJSON入力を生成します。okv manage-access wallet get-default --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "get-default", "options" : { "endpoint" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
get_def_wallet.json
)に保存し、指定したエンドポイントに関連付けられたデフォルト・ウォレットを取得できるように編集します。{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "get-default", "options" : { "endpoint" : "hr_db_ep" } } }
- 生成されたJSONファイルを使用して、
okv manage-access wallet get-default
コマンドを実行します。okv manage-access wallet get-default --from-json get_def_wallet.json
出力は、次のようになります。
{ "result" : "Success", "value" : { "defaultWallet" : "hr_wallet" } }
親トピック: アクセスの管理コマンド
4.12 okv manage-access wallet list-endpoint-walletsコマンド
okv manage-access wallet list-endpoint-wallets
コマンドでは、エンドポイントに関連付けられているウォレットをリストします。
このコマンドは、認証のためにユーザー名とパスワードを使用します。
必要な権限
なし。ただし、このコマンドは、ユーザーがなんらかのレベルのアクセス権を持つウォレットのみに関する情報を返します。
構文
okv manage-access wallet list-endpoint-wallets --endpoint endpoint_name
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "list-endpoint-wallets", "options" : { "endpoint" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
エンドポイントの名前。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します |
JSONの例
okv manage-access wallet list-endpoint-wallets
コマンド用にJSON入力を生成します。okv manage-access wallet list-endpoint-wallets --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "list-endpoint-wallets", "options" : { "endpoint" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
list_ep_wallets.json
)に保存し、指定したエンドポイントに関連付けられたウォレットを検索できるように編集します。{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "list-endpoint-wallets", "options" : { "endpoint" : "hr_db_ep" } } }
- 生成されたJSONファイルを使用して、
okv manage-access wallet list-endpoint-wallets
コマンドを実行します。okv manage-access wallet list-endpoint-wallets --from-json list_ep_wallets.json
出力は、次のようになります。
{ "result" : "Success", "value" : { "wallets" : [ "Wallet10", "Wallet11" ] } }
親トピック: アクセスの管理コマンド
4.13 okv manage-access wallet remove-accessコマンド
okv manage-access wallet remove-access
コマンドでは、エンドポイントまたはエンドポイント・グループのウォレットに対するアクセス権を削除します。
このコマンドは、認証のためにユーザー名とパスワードを使用します。
必要な権限
キー管理者ロールまたはウォレットに対するウォレット管理(MW
)権限
構文
okv manage-access wallet remove-access --wallet wallet_name --endpoint endpoint_name|--endpoint-group endpoint_group_name
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "remove-access", "options" : { "wallet" : "#VALUE", "endpointGroup" : "#VALUE", "endpoint" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。 |
または
|
必須 |
エンドポイントまたはエンドポイント・グループの名前。既存のエンドポイントまたはエンドポイント・グループを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」または「Endpoint Groups」ページを確認します。 |
JSONの例
okv manage-access wallet remove-access
コマンド用にJSON入力を生成します。okv manage-access wallet remove-access --generate-json-input
次のような入力が生成されます。この出力には、エンドポイントとエンドポイント・グループの両方の全体出力が含まれています。編集するときには、エンドポイントまたはエンドポイント・グループの両方のエントリではなく、どちらかのエントリを含める必要があります。
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "remove-access", "options" : { "wallet" : "#VALUE", "endpointGroup" : "#VALUE", "endpoint" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
remove_wallet_access_ep.json
)に保存し、エンドポイントまたはエンドポイント・グループからウォレット・アクセス権を削除できるように編集します。次の例では、エンドポイントからアクセス権を削除する方法を示します。{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "remove-access", "options" : { "wallet" : "hr_wallet", "endpoint" : "hr_db_ep" } } }
- 生成されたJSONファイルを使用して、
okv manage-access wallet remove-access
コマンドを実行します。okv manage-access wallet remove-access --from-json remove_wallet_access_ep.json
出力は、次のようになります。
{ "result" : "Success" }
親トピック: アクセスの管理コマンド
4.14 okv manage-access wallet set-defaultコマンド
okv manage-access wallet set-default
コマンドでは、エンドポイントのデフォルト・ウォレットを設定します。
このコマンドは、認証のためにユーザー名とパスワードを使用します。
必要な権限
キー管理者ロールまたはエンドポイントのエンドポイント管理権限とウォレットのフル・ウォレット権限
構文
okv manage-access wallet set-default --wallet wallet_name --endpoint endpoint_name
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "set-default", "options" : { "wallet" : "#VALUE", "endpoint" : "#VALUE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。 |
|
必須 |
エンドポイントの名前。既存のエンドポイントを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」ページを確認します。 |
例
okv manage-access wallet set-default
コマンド用にJSON入力を生成します。okv manage-access wallet set-default --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "set-default", "options" : { "wallet" : "#VALUE", "endpoint" : "#VALUE" } } }
- 生成された入力をファイル(たとえば、
set_def_wallet.json
)に保存して、エンドポイントのデフォルト・ウォレットを設定できるように編集します。{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "set-default", "options" : { "wallet" : "hr_wallet", "endpoint" : "hr_db_ep" } } }
- 生成されたJSONファイルを使用して、
okv manage-access wallet set-default
コマンドを実行します。okv manage-access wallet set-default --from-json set_def_wallet.json
出力は、次のようになります。
{ "result" : "Success" }
親トピック: アクセスの管理コマンド
4.15 okv manage-access wallet updateコマンド
okv manage-access wallet update
コマンドでは、ウォレットを更新します。
このコマンドは、認証のためにユーザー名とパスワードを使用します。
必要な権限
キー管理者ロールまたはウォレットに対するウォレット管理(MW
)権限
構文
okv manage-access wallet update --wallet wallet_name --name new_wallet_name
--description description --unique TRUE|FALSE
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "update", "options" : { "wallet" : "#VALUE", "name" : "#VALUE", "description" : "#VALUE", "unique" : "#TRUE|FALSE" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。 |
|
オプション |
ウォレットの新しい名前。「オブジェクトのネーミング・ガイドライン」を参照してください。 |
|
オプション |
二重引用符で囲まれたウォレットのわかりやすい説明 |
|
オプション |
マルチマスター・クラスタ環境にのみ適用されます。この 有効な設定は次のとおりです。
|
JSONの例
okv manage-access wallet update
コマンド用にJSON入力を生成します。okv manage-access wallet update --generate-json-input
次のような入力が生成されます。
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "update", "options" : { "wallet" : "#VALUE", "name" : "#VALUE", "description" : "#VALUE", "unique" : "#TRUE|FALSE" } } }
- 生成された入力をファイル(たとえば、
update_wallet.json
)に保存して、ウォレットの名前と説明を更新できるように編集します。この例では、ウォレットの名前を更新する方法を示します。{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "update", "options" : { "wallet" : "hr_wallet", "name" : "global_hr_wallet", "unique" : "FALSE" } } }
- 生成されたJSONファイルを使用して、
okv manage-access wallet update
コマンドを実行します。okv manage-access wallet update --from-json update_wallet.json
出力は、次のようになります。
{ "result" : "Success", "value" : { "status" : "PENDING", "locatorID" : "81800CE6-6AAF-4EF5-A0FD-446ED6625F6A" } }
この例は、マルチマスター・クラスタのウォレットの名前を変更した場合の出力を示しています。名前の変更時、ウォレットはネーミング競合解決の間
PENDING
状態になります。マルチマスター・クラスタではウォレットの名前を変更しないかぎり、ステータスとlocatorIDのエントリは出力に含まれません。
親トピック: アクセスの管理コマンド
4.16 okv manage-access wallet update-accessコマンド
okv manage-access wallet update-access
コマンドでは、エンドポイントまたはエンドポイント・グループのウォレットに対するアクセス権のレベルを更新します。
このコマンドは、認証のためにユーザー名とパスワードを使用します。
必要な権限
キー管理者ロールまたはウォレットに対するウォレット管理(MW
)権限
構文
okv manage-access wallet update-access --wallet wallet_name --endpoint endpoint_name|--endpoint-group endpoint_group_name --access RO|RM|RO_MW|RM_MW
JSON入力ファイル・テンプレート
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "update-access", "options" : { "wallet" : "#VALUE", "endpointGroup" : "#VALUE", "endpoint" : "#VALUE", "access" : "#RO|RM|RO_MW|RM_MW" } } }
パラメータ
パラメータ/テンプレート・パラメータ | 必須かどうか | 説明 |
---|---|---|
|
必須 |
ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。 |
または
|
必須 |
エンドポイントまたはエンドポイント・グループの名前。エンドポイントまたはエンドポイント・グループどちらかのみを指定できます。その両方は指定できません。既存のエンドポイントまたはエンドポイント・グループを調べるには、Oracle Key Vault管理コンソールで、「Endpoints」タブを選択して、「Endpoints」または「Endpoint Groups」ページを確認します。 |
|
必須 |
次のいずれかの値を入力します。
|
JSONの例
okv manage-access wallet update-access
コマンド用にJSON入力を生成します。okv manage-access wallet update-access --generate-json-input
次のような入力が生成されます。この出力には、エンドポイントとエンドポイント・グループの両方のウォレット・アクセス設定が含まれています。編集するときには、エンドポイント設定またはエンドポイント・グループ設定の両方ではなく、どちらかを含める必要があります。
{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "update-access", "options" : { "wallet" : "#VALUE", "endpointGroup" : "#VALUE", "endpoint" : "#VALUE", "access" : "#RO|RM|RO_MW|RM_MW" } } }
- 生成された入力をファイル(たとえば、
update_wallet_access_ep.json
)に保存し、エンドポイントまたはエンドポイント・グループに対するウォレット・アクセス権を更新できるように編集します。この例では、エンドポイントに対するウォレットのアクセス権を更新する方法を示します。{ "service" : { "category" : "manage-access", "resource" : "wallet", "action" : "update-access", "options" : { "wallet" : "hr_wallet", "endpoint" : "hr_db_ep", "access" : "RM" } } }
- 生成されたJSONファイルを使用して、
okv manage-access wallet update-access
コマンドを実行します。okv manage-access wallet update-access --from-json update_wallet_access_ep.json
出力は、次のようになります。
{ "result" : "Success" }
親トピック: アクセスの管理コマンド