Veritas NetBackup™ コマンドリファレンスガイド
- 概要
- 付録 A. NetBackup コマンド
名前
nbkmiputil — さまざまな外部 KMS サーバーの操作を実行します。
概要
nbkmiputil -getKey -kmsServer kms_server_name -port kms_server_port -trustStorePath CA_certificate_file_path -certPath certificate_file_path -privateKeyPath private_key_file_path -keyId key_ID [-kadLength KAD_length] | -nbKeyGroup key_group_name [-kadLength KAD_length] | -kad key_associated_data [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-getDetails] [-connectTimeout time_in_seconds] [-requestTimeout time_in_seconds] [-kmipVersion version] [-jsonCompact]
nbkmiputil -listKeyIDs -kmsServer kms_server_name -port kms_server_port -trustStorePath CA_certificate_file_path -certPath certificate_file_path -privateKeyPath private_key_file_path [-nbKeyGroup key_group_name] [-activeKey] [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-getDetails] [-connectTimeout time_in_seconds] [-requestTimeout time_in_seconds] [-kmipVersion version] [-maxItems number] [-offset number] [-jsonCompact]
nbkmiputil -setAttribute -kmsServer kms_server_name -port kms_server_port -trustStorePath CA_certificate_file_path -certPath certificate_file_path -privateKeyPath private_key_file_path -keyId key_ID -attributeName attribute_name -attributeValue attribute_value [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-connectTimeout time_in_seconds] [-requestTimeout time_in_seconds] [-kmipVersion version] [-jsonCompact]
nbkmiputil -validate -kmsServer kms_server_name -port kms_server_port -trustStorePath CA_certificate_file_path -certPath certificate_file_path -privateKeyPath private_key_file_path [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-connectTimeout time_in_seconds] [-requestTimeout time_in_seconds] [-kmipVersion version] [-jsonCompact]
nbkmiputil -ekmsCheckCompat -kmsServer kms_server_name -port kms_server_port -trustStorePath CA_certificate_file_path -certPath certificate_file_path -privateKeyPath private_key_file_path [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-kmipVersion version] [-jsonCompact]
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/goodies/
On Windows systems, the directory path to this command is install_path\NetBackup\bin\goodies\
説明
nbkmiputil は、キーの取得、キー ID の一覧表示、キーの属性の設定、KMS サーバーの検証など、さまざまな外部 KMS サーバー操作を実行します。
このコマンドでは次の操作をサポートします。
-ekmsCheckCompat |
-ekmsCheckCompat を使用して、指定した外部 KMS サーバーと NetBackup に互換性があるかどうかを判断します。このオプションを使用して、サポート対象のバージョンの検出、キーの作成、取得、検出、属性の取得、設定、変更、削除の KMIP 操作が外部 KMS サーバーでサポートされているかどうかも判断できます。 |
-getKey |
外部 KMS サーバーから NetBackup キーをフェッチします。 |
-listKeyIDs |
指定されたオプションに従って、外部 KMS サーバーに存在する NetBackup キー ID を一覧表示します。 |
-setAttribute |
外部 KMS サーバー内の指定されたキーにカスタム属性を設定します。サポートされる属性名は x-application、x-keygroup、x-comment です。 |
-validate |
外部 KMS サーバーに関連する機能を検証します。検証の対象には次の機能が含まれます。
|
オプション
- -activekey
有効な NetBackup キーのみを一覧表示するかどうかを指定します。
- -attributeName
設定するカスタム属性名を指定します。サポートされる属性名は x-application、x-keygroup、x-comment です。
- -attributeValue
設定するカスタム属性値を指定します。属性 x-application : NetBackup でサポートされている属性値です。
- -certPath
外部 KMS サーバーを使用した認証で使用する、PEM エンコードされた証明書のパスを指定します。
- -connectTimeout
外部 KMS サーバーに接続する際のタイムアウト値を秒単位で指定します。デフォルト値は 120 秒です。
- -crlCheckLevel
CRL の確認レベルを指定します。有効な値は、LEAF、CHAIN、DISABLE です。デフォルト値は LEAF です。
LEAF - ピアのリーフ証明書の失効状態がチェックされます。
CHAIN - ピア証明書の完全チェーンの失効状態がチェックされます。
DISABLE - ピア証明書の失効状態はチェックされません。
- -getDetails
NetBackup キーの追加のキー属性の詳細を表示します。
- -jsonCompact
圧縮形式の JSON で出力を表示するかどうかを指定します。
- -kad
外部 KMS サーバーからフェッチする NetBackup キーのキー関連データ (KAD) を指定します。
- -kadLength
生成する NetBackup キーの KAD の長さの上限を指定します。
- -keyId
-keyId を -getKey オプションとともに使用する場合は、外部 KMS サーバーからフェッチする NetBackup キーのキー ID を指定します。-setAttributeオプションとともに使用する場合は、カスタム属性を設定するキーのキー ID を指定します。
- -kmsServer
接続する外部 KMS サーバー名を指定します。
- -kmipVersion version
使用する KMIP のバージョンを指定します。サポートされている KMIP のバージョンは 1.0、1.1、1.2、1.3、1.4、2.0 です。
- -maxItems
一覧表示するキー ID の最大数を指定します。
- -nbKeyGroup
-getKey オプションとともに使用する場合は、有効な最新のキーを外部の KMS サーバーからフェッチするキーグループ名を指定します。-listKeyIDs オプションとともに使用する場合は、キーを一覧表示するキーグループ名を指定します。
- -offset
一覧表示を開始する位置のキー ID のオフセット数を指定します。デフォルト値は 0 です。
- -passphrasePath
外部 KMS サーバーによる認証のために、キーストアにアクセスする際に必要なパスフレーズが含まれたファイルのパスを指定します。
- -port
外部 KMS サーバーによって使用されているポート番号。
- -privateKeyPath
外部 KMS サーバーを使用した認証で使用する秘密鍵のパスを指定します。
- -requestTimeout
外部 KMS サーバーに対して指定する要求のタイムアウト値を秒単位で指定します。デフォルト値は 300 秒です。
- -trustStorePath
外部 KMS サーバーを使用した認証で使用する、PEM エンコードされた CA 証明書のパスを指定します。
例
例 1: 外部 KMS のカスタム属性を設定します。
nbkmiputil -setAttribute -kmsServer example.veritas.com -port 5696 -certPath /usr/cert.pem -privateKeyPath /usr/key.pem -trustStorePath /usr/ca.pem -keyId EFF18E49-DBBF-4F84-BF94-13F4A6B6E32B -attributeName x-keygroup -attributeValue msdp