Veritas NetBackup™ 命令参考指南
- 介绍
- 附录 A. NetBackup 命令
名称
nbcertcmd — 请求和管理基于主机 ID 的安全证书和用于授权证书请求的令牌。在 NetBackup 主机上注册外部证书。
大纲
-checkClockSkew [-server master_server_name]
-cleanupCRLCache -expired | -issuerHash SHA-1_hash_of_CRL_issuer_name
-cleanupToken [-server master_server_name]
-createCertRequest -requestFile request_file_name [-servermaster_server_name]
-createECACertEntry -host host_name | -hostId host_ID -subject subject_name_of_the_certificate [-server master_server_name]
-createToken -name token_name [-reissue -host host_name | -hostId host_id] [-maxUses number] [-validFor numDnumHnumM] [-reason description_for_auditing] [-server master_server_name]
-deleteAllCertificates
-deleteCertificate -hostId host_id [-cluster]
-deleteECACertEntry -subject subject_name [-server master_server_name]
-deleteToken -name token_name [-reason description_for_auditing] [-server master_server_name]
-deployCertificate -certificateFile certificate_file_name
-displayCACertDetail [-server master_server_name] [-json | -json_compact]
-displayToken -name token_name [-json | -json_compact] [-server master_server_name]
-ecaHealthCheck [-trustStorePath path_to_CA_certificate_file] [-certPath path_to_certificate_file] [-privateKeyPath path_to_certificate_key_file] [-passphraseFile path_to_passphrase_file] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-crlPath path_to_CRLs] [-cluster] [-web] [-fmt details | failures_only] [-json | -json_compact]
-enrollCertificate [-force] [-preCheck] [-cluster] [-server master_server_name] [-remoteHost remote_host_name]
-getCACertificate [-file hash_file_name] [-cluster] [-server master_server_name] [-updateTrustVersion]
-getCertificate [-token | -envtoken environment_variable | -file authorization_token_file] [-force] [-cluster] [-server master_server_name] [-json | -json_compact]
-getCRL [-server master_server_name] [-cluster]
-getExternalCertDetails -certPath path_to_certificate_file [-json | -json_compact]
-getNBKeysize [-server master_server_name] [-json]
-getSecConfig [-certDeployLevel] [-caUsage] [-server master_server_name]
-hostSelfCheck [-cluster] [-server master_server_name]
-listAllCertificates [-jks]
-listAllDomainCertificates [-json | -json_compact] [-server master_server_name]
-listCACertDetails [-json | -json_compact] [-cluster]
-listCertDetails [-ECA | -NBCA] [-json | -json_compact] [-cluster]
-listEnrollmentStatus [-remoteHost remote_client_name] [-cluster] [-json | -json_compact]
-listToken [-all] [-json | -json_compact] [-server master_server_name]
-reissueCertificates [-cluster] [-server master_server_name]
-removeCACertificate -fingerPrint certificate_fingerprint [-cluster]
-removeEnrollment [-cluster] [-server master_server_name] [-remoteHost remote_client_name]
-renewCertificate [-hostnameCerts] [-host host_name] [-cluster] [-server master_server_name]
-revokeCertificate -host host_name | -hostId host_id [-reasonCode value] [-server master_server_name]
-setSecConfig -certDeployLevel level [-server master_server_name]
-signCertificate -token | -file authorization_token_file-requestFile request_file_name -certificateFile certificate_file_name
-updateConf
-updateCRLCache
在 UNIX 系统上,此命令的目录路径为 /usr/openv/netbackup/bin/
在 Windows 系统上,此命令的目录路径为 install_path\NetBackup\bin\
描述
nbcertcmd 命令用于在每个 NetBackup 主机上请求和管理基于主机 ID 的安全证书。NetBackup 主机可以是主服务器、介质服务器或客户端。使用此命令可在 NetBackup 主机上注册外部 CA 签名证书。
此命令还可用于创建和管理 授权令牌,在请求 NetBackup 主机的证书时可能会用到该令牌。
此外,该命令还可用于设置和检索安全 配置属性。
“权限详细信息”表列出了需要管理员权限的操作以及不需要特殊权限的操作。
表:权限详细信息
需要 NetBackup 管理员权限的命令 |
-cleanupToken、-createECACertEntry、-createToken、-deleteToken、-deleteECACertEntry、-displayToken、-listAllDomainCertificates、-listToken、-reissueCertificates、-revokeCertificate 和 -setSecConfig 注意: 这些操作要求使用具有 NetBackup 管理员权限的帐户进行 bpnbat Web 登录 (bpnbat -login -logintype WEB)。 |
需要主机管理员权限的命令 |
-cleanupCRLCache、-createCertRequest、-deleteAllCertificates、-deleteCertificate、-deployCertificate、-displayCACertDetail、-ecaHealthCheck、-enrollCertificate、-getCACertificate、-getCertificate、-getCRL、-hostSelfCheck、-listAllCertificates、-listCertDetails、-listEnrollmentStatus、-removeCACertificate、-removeEnrollment、、-updateCRLCache、-renewCertificate 和 -updateConf |
不需要特殊权限的命令 |
-checkClockSkew、、-getExternalCertDetails、-getNBKeysize、-getSecConfig、-listCACertDetails 和 -signCertificate。 |
有关基于主机 ID 的安全证书和授权令牌的更多信息,请参见 NetBackup 安全和加密指南。
nbcertcmd 支持以下操作:
-cleanupCRLCache |
清除 NetBackup 证书吊销列表 (CRL) 缓存。 此命令选项仅适用于外部 CA 签名证书。 |
-cleanupToken |
删除已达到其最大使用计数或已失效的令牌。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-createCertRequest |
在 NetBackup 主机上生成 NetBackup 安全证书签名请求并将其保存到指定文件。该命令应在未连接主服务器时用于 NetBackup 主机。该命令 必须在要请求其证书的 NetBackup 主机上 执行。 可使用 -server 选项指定证书签名请求中的主服务器名称。此名称是 NetBackup 主机从其请求证书的主服务器。 |
-createECACertEntry |
在 NetBackup 数据库中为主机和证书的关联使用者名称添加条目,以便与主服务器进行安全通信。如果要使用 OpenSSL API 提供使用者名称,请确保它采用 RFC 2253 格式。 此命令选项仅适用于外部 CA 签名证书。 |
-createToken |
创建用于授权证书请求的令牌。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-checkClockSkew |
显示当前主机与主服务器之间的时差(秒)。 |
-deleteAllCertificates |
删除 NetBackup 主机上可用的所有 NetBackup 证书和密钥。此选项仅适用于介质服务器和客户端。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-deleteCertificate |
删除与指定的主机 ID 关联的 NetBackup 主机的 NetBackup 证书,并从 此命令选项仅适用于 NetBackup CA 签名证书。 |
-deleteECACertEntry |
删除外部证书与主机的关联。将从数据库中删除该证书条目。 此命令选项仅适用于外部 CA 签名证书。 |
-deleteToken |
删除指定令牌。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-deployCertificate |
从指定证书文件读取主机安全证书并将其部署到 NetBackup 主机。该命令必须在生成证书签名请求的 NetBackup 主机上执行。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-displayCACertDetail |
显示指定的主服务器中的 NetBackup CA 证书详细信息。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-displayToken |
显示指定令牌的属性和值。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-ecaHealthCheck |
检查为外部 CA 签名证书提供的详细信息是否有效。 此命令选项仅适用于外部 CA 签名证书 |
-enrollCertificate |
在 NetBackup 域中注册外部 CA 签名证书。在主机通信期间使用此证书。 此命令选项仅适用于外部 CA 签名证书。 |
-getCACertificate |
连接到主服务器并获取 NetBackup 证书颁发机构 (CA) 的证书。随后会显示证书指纹并在获得用户确认后将其添加到 NetBackup 信任存储区。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-getCertificate |
此选项可执行以下操作:
此命令选项仅适用于 NetBackup CA 签名证书。 |
-getCRL |
获取主服务器上 NetBackup CA 的最新证书吊销列表。您可以使用 –server 选项指定备用主服务器。使用 -cluster 选项从全局证书存储库获取最新 CRL。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-getExternalCertDetails |
列出指定的外部 CA 签名证书的详细信息。 此命令选项仅适用于外部 CA 签名证书。 |
-getNBKeysize |
显示 NetBackup 生成的新证书密钥对的密钥大小。 |
-getSecConfig |
检索指定的安全配置属性。 |
-hostSelfCheck |
指示主机的证书是否已吊销。对于 NetBackup CA 签名证书,要确保具有最新的 CRL 信息,请先运行 nbcertcmd -getCRL。对于外部 CA 签名证书,要确保具有最新的 CRL 信息,请先运行 nbcertcmd -updateCRLCache。在运行 nbcertcmd -updateCRLCache 之前,请确保在 ECA_CRL_PATH 配置选项中定义的位置可以使用最新的 CRL。 |
-listAllCertificates |
列出 NetBackup 主机上可用的所有安全证书的详细信息。 |
-listAllDomainCertificates |
从 NetBackup 主服务器请求该域的所有 NetBackup 证书。默认情况下,此操作使用 NetBackup 配置 ( 此命令选项仅适用于 NetBackup CA 签名证书。 |
-listCACertDetails |
列出 NetBackup 主机的 NetBackup 信任存储区中存储的可信 CA 证书的详细信息。 |
-listCertDetails |
列出 NetBackup 主机上部署的每个安全证书的证书详细信息。 |
-listEnrollmentStatus |
从本地证书存储库检索关联的主服务器的注册状态。主服务器的注册状态可以为以下项之一:
|
-listToken |
列出令牌。该选项不会显示令牌值。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-reissueCertificates |
生成新的密钥对,并向主机重新颁发基于主机 ID 的证书和基于主机名的证书。在群集中,执行以下操作以重新颁发证书:
|
-removeCACertificate |
从用于安全通信的 NetBackup 信任存储区删除其指纹与输入指纹匹配的 NetBackup CA 证书。使用 -listCACertDetails 选项可查看现有 CA 证书的指纹。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-removeEnrollment |
从本地证书存储库中删除有关指定主服务器的外部证书详细信息。不会从系统或 NetBackup 数据库中删除证书。 |
-renewCertificate |
续订基于主机 ID 的现有证书。使用 -hostnameCerts 选项可续订基于主机名的证书。使用 -host 选项可更改主机的主名称。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-revokeCertificate |
吊销 NetBackup 证书。NetBackup 主机无法再使用 证书与主服务器通信。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-setSecConfig |
设置指定的安全配置属性。 |
-signCertificate |
从指定请求文件中读取证书签名请求,并将其发送至签名请求中列出的主服务器上的 NetBackup CA。签名证书存储在指定的 证书文件中。该命令必须在已连接主服务器的 NetBackup 主机上执行。 此命令选项仅适用于 NetBackup CA 签名证书。 |
-updateConf |
成功运行 ecaHealthCheck 命令后更新外部证书专属配置选项。 |
-updateCRLCache |
使用 ECA_CRL_PATH 中的 CRL 文件更新 NetBackup CRL 缓存。在 NetBackup 配置文件中指定 ECA_CRL_PATH 设置。 如果 ECA_CRL_PATH 中的 CRL 文件有效且比缓存的 CRL 副本更新,则会使用 ECA_CRL_PATH 中的 CRL 文件。 此命令选项仅适用于外部 CA 签名证书。 |
注意:
群集 NetBackup 主机具有两个证书存储库:一个本地证书存储库,一个全局证书存储库。默认情况下,该命令在本地证书存储库中操作,除非指定 -cluster 选项。
注意:
请注意,对于用户定义的字符串,nbcertcmd 命令不支持非 US ASCII(非 7 位 ASCII)字符。
选项
- -all
显示所有令牌,包括已达到其最大使用计数或已失效的令牌。
- -caUsage
指定证书颁发机构 (CA) - NetBackup 域支持的 NetBackup CA 和/或外部 CA。该命令的输出可以为以下项之一:
NBCA:ON ECA:OFF - 表示 Web 服务器仅使用 NetBackup 证书颁发机构签名证书。
NBCA:OFF ECA:ON - 表示 Web 服务器仅使用外部证书颁发机构签名证书。
NBCA:ON ECA:ON - 表示 Web 服务器同时使用 NetBackup 证书颁发机构签名证书和外部证书颁发机构签名证书。
- -certDeployLevel level
指定 NetBackup 证书的部署级别。该选项适用于 -getSecConfig 和 -setSecConfig 命令。-setSecConfig 命令要求您指定级别。-setSecConfig 参数的证书部署级别是:
0 - 非常高:禁用自动证书部署。
1 - 高:证书自动部署到已知主机上。
2 - 中:证书自动部署到所有请求主机上。
- -certPath
指定证书文件的路径。
- -crlCheck
指定主机外部证书的吊销检查级别。可以指定以下值:
DISABLE 或 0:禁用吊销检查。在主机通信期间,不会根据 CRL 验证证书的吊销状态。
LEAF 或 1:根据 CRL 验证分支证书的吊销状态。LEAF 为此选项的默认值。
CHAIN 或 2:根据 CRL 验证证书链中所有证书的吊销状态。
- -crlPath
指定外部 CA 证书吊销列表 (CRL) 所在目录的路径。
- -ECA
列出 NetBackup 主机上部署的每个外部证书颁发机构签名证书的证书详细信息。如果未指定此选项,则会检索 NetBackup 证书详细信息。
- -envtoken environment_variable
指示包含要用于请求的授权令牌的环境变量的名称。
- -file file_name
指定其中包含授权令牌(在第一行)或 CA 证书哈希的文件的路径。
- -fingerPrint certificate_fingerprint
指定 CA 证书指纹。
- -fmt details | failures_only
提供针对特定于外部证书的配置选项运行的验证检查的详细信息。details 选项用于提供有关所有成功的验证检查和所有失败的验证检查的报告。failures_only 选项用于仅提供有关失败的检查的报告。
- -force
如果将此选项与 -getCertificate 选项结合使用,证书会被覆盖(如果存在)。如果将此选项与 -enrollCertificate 选项结合使用,无论现有注册状态如何,都会注册给定的证书。
- -host host_name
指定主机名。
- -hostId host_id
指定 NetBackup 主机 ID。
- -hostnameCerts
指定要续订基于主机名的证书。
- -jks
显示来自 Java Keystore 的 Web 服务器证书信息。此选项仅在 NetBackup 主服务器上可用。
- -json
以
json
格式生成多行输出数据。- -json_compact
以
json
格式生成单行输出数据。- -maxUses number
指定令牌的最大使用计数。如果未指定此选项,则默认值为 1。maxUses 的最大值为 99999。
- -name token_name
指定令牌名称。
- -NBCA
列出 NetBackup 主机上部署的每个 NetBackup 证书的证书详细信息。
- -passphrasePath
指定存储密码的密码文件的路径,解密私钥时要使用密码。
- -privateKeyPath
指定证书私钥文件的路径。
- -preCheck
检查外部证书并确定是否可以注册。
- -reason description_for_auditing
指定存储在此操作审核记录中的原因。
- -reasonCode value
指定吊销证书的原因代码。所示的值是 -reasonCode value 的唯一有效数字:
0 - 未指定,1 - 密钥损坏,2 - CA 损坏,3 - 附属关系已更改,4 - 已取代,5 - 停止操作
- -reissue
创建可用于重新发布证书的令牌。将此选项与 -host 选项或 -hostID 选项结合使用。
- -remoteHost
将 -remoteHost 与 -removeEnrollment 选项结合使用时,将在使用 -server 选项提供的主服务器上为指定的远程主机注册外部证书。
将 -remoteHost 与 -listEnrollmentStatus 选项结合使用时,-remoteHost 选项将列出与指定远程主机关联的主服务器的注册状态。
将 -remoteHost 与 -removeEnrollment 选项结合使用时,-remoteHost 选项将删除指定远程主机在指定主服务器上的注册。
确保您从其运行 -remoteHost 选项的服务器的名称在远程主机的 SERVER 配置选项中列出。
例如:如果要从 Server1 为 remoteHost1 注册证书,请确保 remoteHost1 上的配置文件中存在以下项:SERVER = Server1
- -requestFile file_name
指定证书请求文件的路径。
- -server master_server_name
指定备用主服务器。默认情况下,此命令使用 NetBackup 配置中的第一个服务器条目。
- -subject
指定外部证书的使用者名称。如果要使用 OpenSSL API 提供使用者名称,请确保它采用 RFC 2253 格式。
- -token
指示在该请求中使用授权令牌。提示用户安全地指定令牌。
- -trustStorePath
指定证书颁发机构捆绑包文件的路径。
- -updateTrustVersion
使用主机的信任版本更新 NetBackup 数据库。要成功激活 NetBackup CA 迁移,主机的信任版本应与主服务器的信任版本匹配。主机的信任版本是自动生成的字母数字值,它定义主机的 CA 设置。每次更改 CA 设置时(例如,从主机的信任存储区中删除 CA),都会更新信任版本。
在以下情况下,主机的信任版本与主服务器的信任版本可能不同:
主服务器信任存储区中的一个或多个 CA 证书在主机的信任存储区中不存在
未在 NetBackup 数据库中更新主机的信任版本
- -validFor numDnumHnumM
指定令牌有效期。此值的输入格式应为天数、小时数和分钟数。例如,12D6H30M的有效期将为 12 天 6 小时 30 分钟。可以选择指定一个或多个值。如果未指定此选项,默认值为 24 小时。请注意,如果您想要将令牌有效期设为 12 小时,则不必指定天数值或分钟数值。您可指定 12H。可以指定的最大有效期为 999 天。
- -web
配置外部证书以与 NetBackup Web 用户界面进行通信。
示例
示例 1:创建用于请求重新发布证书的令牌。
# nbcertcmd -createToken -name acme01_HR05 -reissue -validFor 10D -host HRfileserver.acme.com -reason "issued token on request of Alice through email dated 12/08/2016"
已成功创建令牌 XXXXXXXXXXXXXXXX。
示例 2:使用令牌从指定主服务器获取证书
# nbcertcmd -getCertificate -token -server nbmaster01.acme.com
Authorization Token: Host certificate received successfully from server nbmaster01.acme.com.
示例 3:在未连接主服务器的 NetBackup 主机上请求和部署证书。
在未连接主服务器的 NetBackup 主机上运行所示命令:
# nbcertcmd -createCertRequest -requestFile /tmp/request_file_name -server master.servername
已成功生成主机证书请求。
将 /tmp/request_file_name 复制到已连接主服务器的 NetBackup 主机,然后在该 NetBackup 主机上运行所示命令:
# nbcertcmd -signCertificate -file authorization_token_file -requestFile /tmp/request_file_name -certificateFile /tmp/signed_certificate
Sending certificate request to server: master.servername Host certificate request signed successfully.
将
/tmp/signed_certificate
复制到已生成请求文件 (/tmp/request_file_name) 的原始 NetBackup 主机上,然后运行所示命令:# nbcertcmd -deployCertificate -certificateFile /tmp/signed_certificate Deploying certificate from master server: master.servername Host certificate deployed successfully
另请参见
请参见bpnbat(1m)。