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

名称

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 运行各种外部 KMS 服务器操作，如检索密钥、列出密钥 ID、设置密钥属性、设置密钥状态以及验证 KMS 服务器。

该命令支持以下操作：

-ekmsCheckCompat 或 -ecc	使用 -ekmsCheckCompat 或 -ecc 确定 NetBackup 是否与指定的外部 KMS 服务器兼容。还可以使用此选项确定外部 KMS 服务器是否支持以下 KMIP 操作：创建密钥并按密钥组和密钥 ID 检索密钥。
-getKey	从外部 KMS 服务器获取 NetBackup 密钥。
-listKeyIDs	根据指定的选项列出外部 KMS 服务器中存在的 NetBackup 密钥 ID。
-setAttribute	为外部 KMS 服务器中的给定密钥设置自定义属性。支持的属性名称为 x-application、x-keygroup 和 x-comment。
-setState	为外部 KMS 服务器中的给定密钥设置状态。
-validate	使用外部 KMS 服务器验证相关功能。已验证的功能包括：连接到外部 KMS 服务器。列出外部 KMS 服务器中存在的 NetBackup 密钥 ID。获取任何活动 NetBackup 密钥 ID 的密钥。获取和设置任何 NetBackup 密钥 ID 的属性。

选项

-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 的偏移量，从此处开始列出密钥 ID。默认值为 0。

-passphrasePath

指定包含密码的文件路径，需要该密码才能访问 keystore 以向外部 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