NetBackup™ コマンドリファレンスガイド
- 概要
- 付録 A. NetBackup コマンド
- acsd
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpcleanrestore
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureMQ
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- msdpcldutil
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcmdrun
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdb2adutl
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbmariadb
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbshvault
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbsqlite
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tldd
- tldcd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
名前
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 | -ecc -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] [-extended] [-verbose]
nbkmiputil -setState -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 -stateType 1 | 2 | 3 | 4 [-revocationReason 1 | 2 | 3 | 4 | 5 | 6 | 7] [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-connectTimeout time_in_seconds] [-requestTimeout seconds] [-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 または -ecc |
-ekmsCheckCompat または -ecc を使用して、指定した外部 KMS サーバーと NetBackup に互換性があるかどうかを判断します。このオプションを使用して、外部 KMS サーバーでキーの作成およびキーグループとキー ID によるキーの取得の KMIP 操作がサポートされているかどうかを確認することもできます。 |
|
-getKey |
外部 KMS サーバーから NetBackup キーをフェッチします。 |
|
-listKeyIDs |
指定されたオプションに従って、外部 KMS サーバーに存在する NetBackup キー ID を一覧表示します。 |
|
-setAttribute |
外部 KMS サーバー内の指定されたキーにカスタム属性を設定します。サポートされる属性名は x-application、x-keygroup、x-comment です。 |
|
-setState |
外部 KMS サーバー内の指定されたキーに状態を設定します。 |
|
-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 - ピア証明書の失効状態はチェックされません。
- -extended
キーグループとキー ID に基づいたキーの作成と取得に加えて、キーの検出、属性の取得、属性の設定などの操作を実行します。
- -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 秒です。
- -revocationReason 1 | 2 | 3| 4 | 5 | 6 | 7
サポート対象のキー失効の理由:
-stateType DEACTIVATED の場合:
1 | UNSPECIFIED: キー失効の理由が指定されていません。
2 | AFFILIATION_CHANGED: キー所有者の組織とのアフィリエーションが変更されました。
3 | SUPERSEDED: 現在のキーを新しく発行されたキーに置き換える必要があります。
4 | CESSATION_OF_OPERATION: 関連付けられた操作またはサービスが終了したため、キーは不要になりました。
5 | PRIVILEGE_WITHDRAWN: 指定したキーの権限は廃止されます。
-stateType COMPROMISED の場合:
6 | KEY_COMPROMISE: 証明書キーが危殆化されています。
7 | CA_COMPROMISE: 証明書を外部 KMS サーバーに発行した認証局 (CA) が危殆化されています。
- -stateType 1 | 2 | 3 | 4
サポート対象の状態の種類:
1 | ACTIVE: 暗号化の目的でこのキーを使用できます。
2 | DEACTIVATED: このキーを使用して暗号化情報を処理する必要があります。
3 | COMPROMISED: このキーは、危殆化した管理キーを使用して信頼できるクライアントの暗号化情報を処理する場合にのみ使用してください。
4 | DESTROYED: このキーを使用して暗号化情報を処理するべきではありません。
- -trustStorePath
外部 KMS サーバーを使用した認証で使用する、PEM エンコードされた CA 証明書のパスを指定します。
- -verbose
詳細出力を JSON 形式で表示するかどうかを指定します。
例
例 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