Veritas NetBackup™ 命令参考指南
- 介绍
- 附录 A. NetBackup 命令
- acsd
- add_media_server_on_clients
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- 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
- bptpcinfo
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureCertsForPlugins
- configureMQ
- configurePorts
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig throttle
- csconfig reinitialize
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- manageClientCerts
- mklogdir
- nbauditreport
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- 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
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbsetconfig
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- 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 服务器操作。
大纲
-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]
-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]
-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]
-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]
-ekmsCheckCompat -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]
在 UNIX 系统上，此命令的目录路径为 /usr/openv/netbackup/bin/goodies/
在 Windows 系统上，此命令的目录路径为 install_path\NetBackup\bin\goodies\
描述
nbkmiputil 执行各种外部 KMS 服务器操作，如检索密钥、列出密钥 ID、设置密钥属性以及验证 KMS 服务器。
该命令支持以下操作：
|
-ekmsCheckCompat |
使用 -ekmsCheckCompat 确定 NetBackup 是否与指定的外部 KMS 服务器兼容。也可以使用此选项确定外部 KMS 服务器是否支持以下 KMIP 操作：发现支持的版本；创建、获取或查找密钥；以及获取、设置、修改或删除属性。 |
|
-getKey |
从外部 KMS 服务器获取 NetBackup 密钥。 |
|
-listKeyIDs |
根据指定的选项列出外部 KMS 服务器中存在的 NetBackup 密钥 ID。 |
|
-setAttribute |
为外部 KMS 服务器中的给定密钥设置自定义属性。支持的属性名称为 x-application、x-keygroup 和 x-comment。 |
|
-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 - 不检查对等证书的吊销状态。
- -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 秒。
- -trustStorePath
指定要用于向外部 KMS 服务器进行身份验证的 PEM 编码 CA 证书的路径。
示例
示例 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