搜索 <book_title>...

NetBackup™ 命令参考指南

Last Published: 2022-04-27

Product(s): NetBackup & Alta Data Protection (10.0)

介绍
附录 A. NetBackup 命令
1. acsd
2. add_media_server_on_clients
3. backupdbtrace
4. backuptrace
5. bmrc
6. bmrconfig
7. bmrepadm
8. bmrprep
9. bmrs
10. bmrsrtadm
11. bp
12. bparchive
13. bpbackup
14. bpbackupdb
15. bpcatarc
16. bpcatlist
17. bpcatres
18. bpcatrm
19. bpcd
20. bpchangeprimary
21. bpcleanrestore
22. bpclient
23. bpclimagelist
24. bpclntcmd
25. bpclusterutil
26. bpcompatd
27. bpconfig
28. bpdbjobs
29. bpdbm
30. bpdgclone
31. bpdown
32. bpduplicate
33. bperror
34. bpexpdate
35. bpfis
36. bpflist
37. bpgetconfig
38. bpgetdebuglog
39. bpimage
40. bpimagelist
41. bpimmedia
42. bpimport
43. bpinst
44. bpkeyfile
45. bpkeyutil
46. bplabel
47. bplist
48. bpmedia
49. bpmedialist
50. bpminlicense
51. bpnbat
52. bpnbaz
53. bppficorr
54. bpplcatdrinfo
55. bpplclients
56. bppldelete
57. bpplinclude
58. bpplinfo
59. bppllist
60. bpplsched
61. bpplschedrep
62. bpplschedwin
63. bppolicynew
64. bpps
65. bprd
66. bprecover
67. bprestore
68. bpretlevel
69. bpschedule
70. bpschedulerep
71. bpsetconfig
72. bpstsinfo
73. bpstuadd
74. bpstudel
75. bpstulist
76. bpsturep
77. bptestbpcd
78. bptestnetconn
79. bptpcinfo
80. bpup
81. bpverify
82. cat_convert
83. cat_export
84. cat_import
85. configureCerts
86. configureMQ
87. configurePorts
88. configureWebServerCerts
89. create_nbdb
90. csconfig cldinstance
91. csconfig cldprovider
92. csconfig meter
93. csconfig reinitialize
94. csconfig throttle
95. duplicatetrace
96. importtrace
97. jbpSA
98. jnbSA
99. ltid
100. mklogdir
101. nbauditreport
102. nbcallhomeproxyconfig
103. nbcatsync
104. NBCC
105. NBCCR
106. nbcertcmd
107. nbcertupdater
108. nbcldutil
109. nbcloudrestore
110. nbcomponentupdate
111. nbcplogs
112. nbcredkeyutil
113. nbdb_admin
114. nbdb_backup
115. nbdb_move
116. nbdb_ping
117. nbdb_restore
118. nbdb_unload
119. nbdb2adutl
120. nbdbms_start_server
121. nbdbms_start_stop
122. nbdc
123. nbdecommission
124. nbdelete
125. nbdeployutil
126. nbdevconfig
127. nbdevquery
128. nbdiscover
129. nbdna
130. nbemm
131. nbemmcmd
132. nbfindfile
133. nbfirescan
134. nbfp
135. nbftadm
136. nbftconfig
137. nbgetconfig
138. nbhba
139. nbholdutil
140. nbhostidentity
141. nbhostmgmt
142. nbhypervtool
143. nbidpcmd
144. nbimageshare
145. nbinstallcmd
146. nbjm
147. nbkmiputil
148. nbkmscmd
149. nbkmsutil
150. nboraadm
151. nborair
152. nbpem
153. nbpemreq
154. nbmlb
155. nbperfchk
156. nbplupgrade
157. nbrb
158. nbrbutil
159. nbregopsc
160. nbreplicate
161. nbrepo
162. nbrestorevm
163. nbseccmd
164. nbserviceusercmd
165. nbsetconfig
166. nbsmartdiag
167. nbsnapimport
168. nbsnapreplicate
169. nbsqladm
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"