Search <book_title>...

NetBackup™ 命令参考指南

Last Published: 2023-12-28

Product(s): NetBackup (10.3)

介绍
附录 A. NetBackup 命令
1. acsd
2. backupdbtrace
3. backuptrace
4. bmrc
5. bmrconfig
6. bmrepadm
7. bmrprep
8. bmrs
9. bmrsrtadm
10. bp
11. bparchive
12. bpbackup
13. bpbackupdb
14. bpcatarc
15. bpcatlist
16. bpcatres
17. bpcatrm
18. bpcd
19. bpchangeprimary
20. bpcleanrestore
21. bpclient
22. bpclimagelist
23. bpclntcmd
24. bpclusterutil
25. bpcompatd
26. bpconfig
27. bpdbjobs
28. bpdbm
29. bpdgclone
30. bpdown
31. bpduplicate
32. bperror
33. bpexpdate
34. bpfis
35. bpflist
36. bpgetconfig
37. bpgetdebuglog
38. bpimage
39. bpimagelist
40. bpimmedia
41. bpimport
42. bpinst
43. bpkeyfile
44. bpkeyutil
45. bplabel
46. bplist
47. bpmedia
48. bpmedialist
49. bpminlicense
50. bpnbat
51. bpnbaz
52. bppficorr
53. bpplcatdrinfo
54. bpplclients
55. bppldelete
56. bpplinclude
57. bpplinfo
58. bppllist
59. bpplsched
60. bpplschedrep
61. bpplschedwin
62. bppolicynew
63. bpps
64. bprd
65. bprecover
66. bprestore
67. bpretlevel
68. bpschedule
69. bpschedulerep
70. bpsetconfig
71. bpstsinfo
72. bpstuadd
73. bpstudel
74. bpstulist
75. bpsturep
76. bptestbpcd
77. bptestnetconn
78. bpup
79. bpverify
80. cat_convert
81. cat_export
82. cat_import
83. configureCerts
84. configureMQ
85. configureWebServerCerts
86. create_nbdb
87. csconfig cldinstance
88. csconfig cldprovider
89. csconfig meter
90. csconfig reinitialize
91. csconfig throttle
92. duplicatetrace
93. importtrace
94. jbpSA
95. jnbSA
96. ltid
97. mklogdir
98. msdpcldutil
99. nbauditreport
100. nbcallhomeproxyconfig
101. nbcatsync
102. NBCC
103. NBCCR
104. nbcertcmd
105. nbcertupdater
106. nbcldutil
107. nbcmdrun
108. nbcomponentupdate
109. nbcplogs
110. nbcredkeyutil
111. nbdb_admin
112. nbdb_backup
113. nbdb_move
114. nbdb_ping
115. nbdb_restore
116. nbdb_unload
117. nbdb2adutl
118. nbdbms_start_server
119. nbdbms_start_stop
120. nbdc
121. nbdecommission
122. nbdelete
123. nbdeployutil
124. nbdevconfig
125. nbdevquery
126. nbdiscover
127. nbdna
128. nbemm
129. nbemmcmd
130. nbfindfile
131. nbfirescan
132. nbfp
133. nbftadm
134. nbftconfig
135. nbgetconfig
136. nbhba
137. nbholdutil
138. nbhostidentity
139. nbhostmgmt
140. nbhypervtool
141. nbidpcmd
142. nbimageshare
143. nbinstallcmd
144. nbjm
145. nbkmiputil
146. nbkmscmd
147. nbkmsutil
148. nboraadm
149. nborair
150. nbpem
151. nbpemreq
152. nbmariadb
153. nbmlb
154. nbperfchk
155. nbplupgrade
156. nbrb
157. nbrbutil
158. nbreplicate
159. nbrepo
160. nbrestorevm
161. nbseccmd
162. nbserviceusercmd
163. nbsetconfig
164. nbshvault
165. nbsmartdiag
166. nbsnapimport
167. nbsnapreplicate
168. nbsqladm
169. nbsqlite
170. nbstl
171. nbstlutil
172. nbstop
173. nbsu
174. nbsvrgrp
175. netbackup_deployment_insights
176. resilient_clients
177. restoretrace
178. stopltid
179. tldd
180. tldcd
181. tpautoconf
182. tpclean
183. tpconfig
184. tpext
185. tpreq
186. tpunmount
187. verifytrace
188. vltadm
189. vltcontainers
190. vlteject
191. vltinject
192. vltoffsitemedia
193. vltopmenu
194. vltrun
195. vmadd
196. vmchange
197. vmcheckxxx
198. vmd
199. vmdelete
200. vmoprcmd
201. vmphyinv
202. vmpool
203. vmquery
204. vmrule
205. vmupdate
206. vnetd
207. vssat
208. vwcp_manage
209. vxlogcfg
210. vxlogmgr
211. vxlogview
212. 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	以 JSON 格式列出指定 KMS 配置凭据的详细信息。如果未指定凭据名称或 ID，则会列出所有 KMS 配置的凭据详细信息。
-listKeys	以 JSON 格式列出指定 KMS 配置中的 NetBackup 密钥。
-listKMSConfig	以 JSON 格式列出指定 KMS 配置的详细信息。如果未提供配置名称，此操作将列出所有 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"