Symantec NetBackup™ コマンドリファレンスガイド
- 概要
- 付録 A. NetBackup コマンド
名前
nbkmsutil — NetBackup キーマネージメントサービスユーティリティの実行
概要
nbkmsutil [-createkey] [-createkg] [-deletekey] [-deletekg] [-export] [-gethmkid] [-getkpkid] [-import] [-ksstats] [-listkeys] [-listkgs] [-modifyhmk] [-modifykey] [-modifykg] [-modifykpk] [-quiescedb] [-recoverkey] [-unquiescedb]
nbkmsutil -createkey [ -nopphrase ] -kgname key_group_name -keyname key_name [ -activate ] [ -desc description ]
nbkmsutil -createkg -kgname key_group_name [ -cipher type ] [ -desc description ]
nbkmsutil -deletekey -keyname key_name -kgname key_group_name
nbkmsutil -deletekg -kgname key_group_name
nbkmsutil -export -path secure_key_container [-key_groups key_group_name_1 ... | -key_file key_file_name]
nbkmsutil -gethmkid
nbkmsutil -getkpkid
nbkmsutil -import -path secure_key_container [-preserve_kgname] [-desc description] [-preview]
nbkmsutil -ksstats [-noverbose]
nbkmsutil -listkeys -kgname key_group_name [ -keyname key_name | -activekey ] [ -verbose ]
nbkmsutil -listkgs [ -kgname key_group_name | -cipher type | -emptykgs | -noactive ] [ -verbose ]
nbkmsutil -modifyhmk [ -nopphrase ]
nbkmsutil -modifykey -keyname key_name -kgname key_group_name [ -state new_state | -activate ] [ -name new_keyname ] [ -desc new_description ]
nbkmsutil -modifykg -kgname key_group_name [ -name new_key_group_name ] [ -desc new_description ]
nbkmsutil -modifykpk [ -nopphrase ]
nbkmsutil -quiescedb
nbkmsutil -recoverkey -keyname key_name -kgnamekey_group_name -tag key_tag [-desc description]
nbkmsutil -unquiescedb
UNIX システムでは、このコマンドへのディレクトリパスは /usr/openv/netbackup/bin/admincmd/ です。
Windows システムでは、このコマンドへのディレクトリパスは install_path\NetBackup\bin\admincmd\
です。
説明
nbkmsutil コマンドは次の操作を実行します。
-createkey |
新しいキーを作成します。新しいキーのデフォルトの状態は prelive です。 |
-createkg |
新しいキーグループを作成します。新しいキーグループのデフォルトの暗号は AES_256 です。 |
-deletekey |
キーを削除します。prelive および terminated 状態のキーのみを削除できます。 |
-deletekg |
空のキーグループを削除します。
空ではないキーグループの削除を強制するには、-force オプションを使用します。 # nbkmsutil -deletekg -kgname key_group_name -force |
-export |
キーおよびキーグループをドメイン間でエクスポート |
-gethmkid |
現在の HMK ID を返します。 |
-getkpkid |
現在の KPK ID を返します。 |
-import |
キーおよびキーグループをドメイン間でインポート インポートオプションの結果をプレビューするには、-preview を使用します。 # nbkmsutil -import -path secure_key_container -preview |
-ksstats |
キーストアの統計を返します。統計には、キーグループの数、キーの合計数および未処理の静止要求が含まれます。 |
-listkeys |
キーの詳細を取得します。 |
-listkgs |
キーグループの詳細を取得します。オプションが指定されない場合は、すべてのキーグループの詳細を取得します。 |
-modifyhmk |
ホストマスターキー (HMK) を変更します。HMK は、キーストアの暗号化に使用します。HMK を変更するには、任意のシード (パスフレーズ) およびその指定されたパスフレーズをユーザーが連想できるような HMK ID を指定します。パスフレーズおよび HMK ID は、どちらも対話形式で読み込まれます。 |
-modifykey |
キーの属性を変更します。 |
-modifykg |
キーグループの属性を変更します。 |
-modifykpk |
キーの保護キー (KPK) を変更します。KPK は、KMS キーの暗号化に使用します。KPK は、キーストアごとに存在します。KPK を変更するには、任意のシード (パスフレーズ) およびその指定されたパスフレーズをユーザーが連想できるような KPK ID を指定します。パスフレーズおよび KPK ID は、どちらも対話形式で読み込まれます。 |
-quiescedb |
KMS へ静止要求を送信します。コマンドが正常に実行されると、現在の未処理の静止数が返されます (複数のバックアップジョブで KMS データベースが静止されてバックアップが行われる場合があるためです。) |
-recoverkey |
バックアップデータの暗号化に使用したキーが失われた場合、リストアは失敗することがあります。このようなキーは、元のキーの属性 (タグおよびパスフレーズ) がわかれば、リカバリ (再作成) できます。 |
-unquiescedb |
KMS へ静止解除要求を送信します。コマンドが正常に実行されると、現在の未処理の静止数が返されます。カウントが 0 (ゼロ) の場合は、KMS データベースが完全に静止解除されていることを意味します。 |
オプション
nbkmsutil コマンドは次のオプションを使用します。
-activate |
指定したキーの状態を active に設定します。デフォルトの状態は、prelive です。 |
-activekey |
特定のキーグループの有効なキーの詳細を取得します。 |
-cipher |
キーグループがサポートする暗号の種類。1 つのキーグループに属するすべてのキーは、同じ暗号形式をサポートします。サポートされる暗号形式は、BLOW、AES_128、AES_192 および AES_256 (デフォルトの暗号) です。 |
-emptykgs |
キーのないすべてのキーグループの詳細を取得します。 |
-keyname |
key_name にはキーの名前を指定します。この名前は、1 つのキーグループ内で一意である必要があります。キーグループの名前およびキーの名前により、キーストアのキーが一意に識別されます。 |
-kgname |
key_group_name はキーグループの名前を指定します。1 つのキーストア内で、キーグループの名前はキーグループを一意に識別します。 |
-name |
-modifykg を指定して使用する場合のキーグループの新しい名前または -modifykey を指定して使用する場合のキーの新しい名前を指定します。新しいキーグループの名前は、キーストア内の他の名前と競合しないようにします。 |
-noactive |
有効なキーが存在しないすべてのキーグループの詳細を取得します。 |
-nopphrase |
パスフレーズを求めるプロンプトを表示するユーティリティの機能を無効にします。代わりに、ユーティリティによってキーが作成されます。デフォルトの状態では、パスフレーズを入力して、シードを使用してキーを作成します。長くて強力なシードを使用すると、堅固なキーが作成できます。 |
-noverbose |
詳細出力を無効にします。デフォルトの状態では詳細出力は有効で、読み取り可能な形式で詳細を出力します。 |
-state |
new_state にはキーの新しい状態を指定します。指定可能な状態は、prelive、active、inactive、deprecated および terminated です。 キーの状態は、次に示す状態間でのみ変更できます。
|
-tag |
key_tag には、ユーティリティが作成するキーレコードのために作成されるランダムな一意識別子を指定します。listkey オプションはこのタグを表示できます。キーレコードをリカバリ (再作成) する必要がある場合は、これらのリカバリオプションについて、元のタグの値である -tag オプションを使用する必要があります。 |