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
名前
nbkmscmd — NetBackup でキーマネージメントサービス (KMS) を構成します。
概要
nbkmscmd -configureCredential -credName credential_name -certPath certificate_file_path -privateKeyPath private_key_file_path -trustStorePath CA_certificate_file_path [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-server master_server_name] [-description description] [-force]
To configure NetBackup KMS (NBKMS):
nbkmscmd -configureKMS -name configuration_name -type NBKMS -hmkId host_master_key_ID_to_identify_HMK_passphrase -kpkId key_protection_key_ID_to_identify_KPK_passphrase [-useRandomPassphrase 0 | 1] [-enabledForBackup 0 | 1] [-priority priority_of_KMS_server] [-server master_server_name] [-description description]
To configure external KMS:
nbkmscmd -configureKMS -name configuration_name -type KMIP -port port_to_connect_to_external_KMS_server -kmsServerName network_name_of_external_KMS_server -credId credential_ID | -credName credential_name [-enabledForBackup 0 | 1] [-priority priority_of_KMS_server] [-server master_server_name] [-description description]
nbkmscmd -createKey -name configuration_name -keyName name_of_the_key_to _be_created -keyGroupName key_group_name [-algorithm key_algorithm] [-comment comment_about_the_key] [-keyPassphraseFilePath file_path_of_the_key_passphrase] [-reason reason][-server master_server_name]
nbkmscmd -deleteCredential -credName credential_name | -credId credential_ID [-force] [-server master_server_name]
nbkmscmd -deleteKMSConfig -name configuration_name [-server master_server_name] [-reason reason_for_deleting] [-force]
nbkmscmd -discoverNBKMS
nbkmscmd -listCredential [-credName credential_name | -credId credential_ID] [-server master_server_name] [-jsonCompact] [-jsonRaw] [-pageLimit number_of_records_to_be_listed after_offset] [-pageOffset record_number]
nbkmscmd -listKeys -name configuration_name [-keyGroupName key_group_name] [-server master_server_name] [-jsonCompact] [-jsonRaw] [-pageLimit number_of_records_to_be_listed_after_offset] [-pageOffset record_number]
nbkmscmd -listKMSConfig [-name configuration_name] [-server master_server_name] [-jsonCompact] [-jsonRaw] [-pageLimit number_of_records_to_be_listed_after_offset] [-pageOffset record_number]
nbkmscmd -precheckKMSConfig -port port_to_connect_to_external_KMS_server -kmsServerName network_name_of_external_KMS_server -certPath certificate_file_path -privateKeyPath private_key_file_path -trustStorePath CA_certificate_file_path [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-credId credential_ID | -credName credential_name] [-server master_server_name] [-jsonRaw]
nbkmscmd -updateCredential -credId credential_ID | -credName credential_name -certPath certificate_file_path -privateKeyPath private_key_file_path -trustStorePath CA_certificate_file_path [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-server master_server_name] [-description description] [-force]
To update NetBackup KMS (NBKMS) configuration:
nbkmscmd -updateKMSConfig -name configuration_name [-server master_server_name] [-priority priority_of_KMS_server] [-enabledForBackup 0 | 1] [-description description]
To update external KMS configuration:
nbkmscmd -updateKMSConfig -name configuration_name [-server master_server_name] [-priority priority_of_KMS_server] [-port port_to_connect_to_external_KMS_server] [-kmsServerName network_name_of_external_KMS_server] [-credId credential_ID | -credName credential_name] [-enabledForBackup 0 | 1] [-description description]
nbkmscmd -validateKMSConfig -name configuration_name [-server master_server_name] [-jsonRaw]
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/
On Windows systems, the directory path to this command is install_path\NetBackup\bin\
説明
nbkmscmd コマンドを実行して、KMS を構成します。KMS クレデンシャルとキーも作成できます。これらすべてのコマンドは、実行するには NetBackup の管理者権限が必要です。さらに、これらの操作では、NetBackup 管理者権限を持つアカウントを使って、bpnbat Web ログオン (bpnbat -login -loginType WEB) を行う必要があります。
nbkmscmd は次の操作をサポートします。
|
-configureCredential |
NetBackup データベースに KMS 構成のクレデンシャルを追加します。クレデンシャル ID とそのクレデンシャル名がデータベースに追加されます。これらのクレデンシャルは外部 KMS に接続するために使用されます。 |
|
-configureKMS |
NetBackup データベースに KMS 構成のエントリを追加します。 |
|
-createKey |
指定された構成名に関連付けられた KMS サーバーで有効な NetBackup キーを作成します。キーを作成するには、KMS サーバーが NetBackup に対して、キーの作成およびそのキーへの NetBackup 属性の設定を許可する必要があります。 NetBackup KMS (NBKMS) では、指定されたキーグループ名が存在しない場合、指定されたアルゴリズムでキーグループが作成されます。 |
|
-deleteCredential |
NetBackup データベースから、指定された KMS 構成のクレデンシャルを削除します。 |
|
-deleteKMSConfig |
NetBackup データベースから KMS 構成のエントリを削除します。 |
|
-discoverNBKMS |
NetBackup KMS (NBKMS) が構成済みで実行されているかどうかを検出し、それを NetBackup データベースに追加します。 |
|
-listCredential |
指定された KMS 構成のクレデンシャルの詳細を JSON 形式で一覧表示します。クレデンシャルの名前または ID が指定されていない場合、すべての KMS 構成のクレデンシャルの詳細を一覧表示します。 |
|
-listKeys |
指定された KMS 構成の NetBackup キーを JSON 形式で一覧表示します。 |
|
-listKMSConfig |
指定された KMS 構成の詳細を JSON 形式で一覧表示します。構成名が指定されていない場合、この操作はすべての KMS の構成の詳細を一覧表示します。 |
|
-precheckKMSConfig |
KMS 構成操作のドライランを実行し、必要な接続と設定を検証します。 |
|
-updateCredential |
指定された KMS 構成のクレデンシャルを更新します。 |
|
-updateKMSConfig |
NetBackup データベースの指定された KMS 構成を更新します。 |
|
-validateKMSConfig |
指定された KMS 構成で機能を検証し、バックアップおよびリストア機能が動作することを確認します。 |
オプション
- -algorithm algorithm
キーを作成するための暗号化アルゴリズムを指定します。
- -certPath certificate_file_path
リモートサーバーへの接続に使用される証明書のパスを指定します。
- -comment comment
キーのコメントを指定します。
- -credId credential_ID
KMS 構成のクレデンシャル ID を指定します。
- -credName credential_name
KMS 構成のクレデンシャル名を指定します。
- -crlCheckLevel LEAF | CHAIN | DISABLE
外部 KMS サーバーの証明書に対する失効の確認レベルを指定します。デフォルト値は LEAF です。
CRL 確認レベルの有効値:
DISABLE: 失効の確認を無効にします。ホストとの通信時に、CRL で証明書の失効状態は検証されません。
LEAF: CRL でリーフ証明書の失効状態が検証されます。
CHAIN: CRL で証明書チェーンのすべての証明書の失効状態が検証されます。
- -description description
現在の操作に関する詳細情報の表示に使用します。
- -enabledForBackup 0 | 1
この KMS のキーをバックアップに使用するべきかどうかを指定します。デフォルト値は 1 です。
この KMS のキーをバックアップに使用しない場合は 0 を指定します。
- -force
確認メッセージを抑制し、指定した操作を実行します。
- -hmkId host_master_key_ID_to_identify_HMK_passphrase
ホストマスターキー (HMK) パスフレーズを識別する HMK ID を指定します。このオプションは、KMS タイプが NBKMS の場合にのみ適用されます。
- -jsonCompact
出力データを圧縮された JSON 形式で生成します。
- -jsonRaw
Web サーバーの JSON レスポンスを表示します。
- -keyGroupName key_group_name
キーの取得または設定に使用するキーグループの名前を指定します。
- -keyName key_name
キーの名前を指定します。
- -keyPassphraseFilePath file_path_of_the_key_passphrase
キーの作成に使用されるパスフレーズが存在するファイルパスを指定します。キーのパスフレーズはすべての KMS タイプでサポートされているわけではありません。
- -kmsServerName network_name_of_external_KMS_server
KMS サーバーのネットワーク名を指定します。KMS サーバーに複数のネットワーク名がある場合、名前をカンマ (,) で区切ります。このオプションは、KMS タイプが KMIP の場合にのみ適用されます。
- -kpkId key_protection_key_ID_to_identify_KPK_passphrase
キーの保護キー (KPK) パスフレーズを識別する KPK ID を指定します。このオプションは、KMS タイプが NBKMS の場合にのみ適用されます。
- -name configuration_name
一意の KMS 構成名を指定します。
- -pageLimit number_of_records_to_be_listed after_offset
オフセットより後の一覧表示するレコードの数を指定します。-pageLimit の有効な値は 1 から 100 までです。デフォルト値は 100 です。
- -pageOffset record_number
レコードの一覧表示を開始する位置のレコード番号を指定します。デフォルト値は 0 です。
- -passphrasePath private_key_passphrase_file_path
証明書の秘密鍵の暗号化に使用されるパスフレーズのファイルパスを指定します。
- -port port_to_connect_to_external_KMS_server
外部 KMS サーバーに接続するために使用するポート番号を指定します。このオプションは、KMS タイプが KMIP の場合にのみ適用されます。
- -priority priority_of_KMS_server
NetBackup が暗号化または復号中にキーの確認に使用する KMS サーバーを指定します。デフォルトでは KMS サーバーの優先度は 0 に設定されます。最高値の KMS サーバーが暗号化または復号中に最初に優先されます。
- -privateKeyPath private_key_file_path
証明書の秘密鍵のファイルパスを指定します。
- -reason reason
現在の操作を実行する理由を指定します。
- -server master_server_name
代替マスターサーバーを指定します。デフォルトでは、このコマンドは NetBackup 構成ファイル内の最初のサーバーエントリを使用します。
- -trustStorePath CA_certificate_file_path
リモートサーバーの検証に使用される CA 証明書のファイルパスを指定します。
- -type NBKMS | KMIP
KMS タイプを指定します。NBKMS と KMIP は有効な KMS タイプです。
- -useRandomPassphrase 0|1
ランダムなパスフレーズを使用するかどうかを指定します。デフォルト値は 0 です。KMS 構成でランダムなパスフレーズを使用する必要がある場合は 1 を指定します。
例
例 1: 外部 KMS のクレデンシャルの構成
nbkmscmd -configureCredential -credName ExtKMS_Credential -certPath /EKMS_creds/cert_chain.pem -privateKeyPath /EKMS_creds/key.pem -trustStorePath /EKMS_creds/cacerts.pem -description "Configuring credential for external KMS"
例 2: 外部 KMS の構成
nbkmscmd -configureKMS -name ExtKMS -type KMIP -kmsServerName extkms.veritas.com -port 5696 -credName ExtKMS_Credential -priority 1 -description "Configuring external KMS with configutation name ExtKMS"