NetBackup™ 命令参考指南

Last Published:
Product(s): NetBackup & Alta Data Protection (10.0)
  1. 介绍
    1.  
      关于 NetBackup 命令
    2.  
      浏览多个菜单级别
    3.  
      NetBackup 命令约定
    4.  
      NetBackup 介质管理器命令说明
    5.  
      IPv6 更新
  2. 附录 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
  3.  
    索引

名称

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 -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]

 

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

使用 -ekmsCheckCompat 确定 NetBackup 是否与指定的外部 KMS 服务器兼容。也可以使用此选项确定外部 KMS 服务器是否支持以下 KMIP 操作:发现支持的版本;创建、获取或查找密钥;以及获取、设置、修改或删除属性。

-getKey

从外部 KMS 服务器获取 NetBackup 密钥。

-listKeyIDs

根据指定的选项列出外部 KMS 服务器中存在的 NetBackup 密钥 ID。

-setAttribute

为外部 KMS 服务器中的给定密钥设置自定义属性。支持的属性名称为 x-applicationx-keygroupx-comment

-validate

使用外部 KMS 服务器验证相关功能。已验证的功能包括:

  • 连接到外部 KMS 服务器。

  • 列出外部 KMS 服务器中存在的 NetBackup 密钥 ID。

  • 获取任何活动 NetBackup 密钥 ID 的密钥。

  • 获取和设置任何 NetBackup 密钥 ID 的属性。

选项

-activekey

指定是否仅列出活动 NetBackup 密钥。

-attributeName

指定要设置的自定义属性名称。支持的属性名称为 x-applicationx-keygroupx-comment

-attributeValue

指定要设置的自定义属性值。属性 x-application : NetBackup 的受支持属性值。

-certPath

指定要用于向外部 KMS 服务器进行身份验证的 PEM 编码证书的路径。

-connectTimeout

指定连接到外部 KMS 服务器的超时值(以秒为单位)。默认值为 120 秒。

-crlCheckLevel

指定 CRL 检查级别。可能的值为:LEAFCHAINDISABLE。默认值为 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