Veritas NetBackup™ 命令参考指南
- 介绍
- 附录 A. NetBackup 命令
名称
nbcertcmd — 请求和管理基于主机 ID 的安全证书和用于授权证书请求的令牌。
大纲
-cleanupToken [-server master_server_name]
-createCertRequest -requestFile request_file_name [-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]
-checkClockSkew [-server master_server_name]
-deleteAllCertificates
-deleteCertificate -hostId host_id [-cluster]
-deleteToken -name token_name [-reason description_for_auditing] [-server master_server_name]
nbcertcmd -deployCertificate -certificateFile certificate_file_name
-displayCACertDetail [-server master_server_name] [-json | -json_compact]
-displayToken -name token_name [-json | -json_compact] [-server master_server_name]
-getCACertificate [-file hash_file_name] [-cluster] [-server master_server_name]
-getCertificate [-token | -envtoken environment_variable | -file authorization_token_file] [-force] [-cluster] [-server master_server_name] [-json | -json_compact]
-getCRL [-server master_server_name] [-cluster]
-getSecConfig -certDeployLevel [-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 [-json | -json_compact] [-cluster]
-listToken [-all] [-json | -json_compact] [-server master_server_name]
-removeCACertificate -fingerPrint certificate_fingerprint [-cluster]
-renewCertificate [-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
在 UNIX 系统上,此命令的目录路径为 /usr/openv/netbackup/bin/
在 Windows 系统中,此命令的目录路径为 install_path\NetBackup\bin\
描述
nbcertcmd 命令用于在每个 NetBackup 主机上请求和管理基于主机 ID 的安全证书。NetBackup 主机可以是主服务器、介质服务器或客户端。
此命令还可用于创建和管理 授权令牌,在请求 NetBackup 主机的证书时可能会用到该令牌。
此外,该命令还可用于设置和检索安全 配置属性。
“权限详细信息”表列出了需要管理员权限的操作以及不需要特殊权限的操作。
表:权限详细信息
需要 NetBackup 管理员权限的命令 |
-cleanupToken、-createToken、-deleteToken、-displayToken、-hostSelfCheck、-listAllDomainCertificates、-listToken、-revokeCertificate 和 -setSecConfig 注意: 这些操作要求使用具有 NetBackup 管理员权限的帐户进行 bpnbat Web 登录 (bpnbat -login -logintype WEB)。 |
需要主机管理员权限的命令 |
-createCertRequest、-deleteAllCertificates、-deleteCertificate、-deployCertificate、-displayCACertDetail、-getCACertificate、-getCertificate、-getCRL、-listAllCertificates、-listCertDetails、-removeCACertificate 和 -renewCertificate |
不需要特殊权限的命令 |
-checkClockSkew、-getSecConfig、-listCACertDetails 和 -signCertificate。 |
有关基于主机 ID 的安全证书和授权令牌的更多信息,请参见《NetBackup 安全和加密指南》。
nbcertcmd 支持以下操作:
-cleanupToken |
删除已达到其最大使用计数或已失效的令牌。 |
-createCertRequest |
在 NetBackup 主机上生成基于主机 ID 的安全证书签名请求并将其保存到指定文件。该命令应在未连接主服务器时用于 NetBackup 主机。该命令 必须在要请求其证书的 NetBackup 主机上 执行。 可使用 –server 选项指定证书签名请求中的主服务器名称。此名称是 NetBackup 主机从其请求证书的主服务器。 |
-createToken |
创建用于授权证书请求的令牌。 |
-checkClockSkew |
显示当前主机与主服务器之间的时差(秒)。 |
-deleteAllCertificates |
删除 NetBackup 主机上可用的所有安全证书和密钥。此选项仅适用于介质服务器和客户端。 |
-deleteCertificate |
删除与指定的主机 ID 相关联的 NetBackup 主机的安全证书,并从 |
-deleteToken |
删除指定令牌。 |
-deployCertificate |
从指定证书文件读取主机安全证书并将其部署到 NetBackup 主机。该命令必须在生成证书签名请求的 NetBackup 主机上执行。 |
-displayCACertDetail |
显示指定的主服务器中的 CA 证书详细信息。 |
-displayToken |
显示指定令牌的属性和值。 |
-getCACertificate |
连接到主服务器并获取证书颁发机构 (CA) 的证书。随后会显示证书指纹并在获得用户确认后将其添加到本地信任存储区。 |
-getCertificate |
此选项可执行以下操作:
|
-getCRL |
从主服务器获取最新证书吊销列表。您可以使用 –server 选项指定备用主服务器。使用 -cluster 选项从全局证书存储库获取最新 CRL。 |
-getSecConfig |
检索指定的安全配置属性。 |
-hostSelfCheck |
指示主机的证书在本地证书吊销列表 (CRL) 中是已吊销还是未吊销。要确保具有最新的 CRL 信息,请先运行 nbcertcmd -getCRL。 |
-listAllCertificates |
列出 NetBackup 主机上可用的所有安全证书的详细信息。 |
-listAllDomainCertificates |
从 NetBackup 主服务器请求域的所有安全证书。默认情况下,此操作使用 NetBackup 配置 ( |
-listCACertDetails |
列出 NetBackup 主机的本地信任存储区中存储的可信认证机构证书的详细信息。 |
-listCertDetails |
列出 NetBackup 主机上部署的每个安全证书的证书详细信息。 |
-listToken |
列出令牌。该选项不会显示令牌值。 |
-removeCACertificate |
从信任存储区中移除其指纹与输入指纹匹配的 CA 证书。使用 -listCACertDetails 选项查看现有认证机构证书的指纹。 |
-renewCertificate |
续订基于 NetBackup 主机 ID 的现有安全证书。使用 -host 选项可更改主机的主名称。 |
-revokeCertificate |
撤销基于主机 ID 的安全证书。NetBackup 主机无法再使用 证书与主服务器通信。 |
-setSecConfig |
设置指定的安全配置属性。 |
-signCertificate |
从指定请求文件中读取证书签名请求,并将其发送至签名请求中列出的主服务器。签名证书存储在指定的 证书文件中。该命令必须在已连接主服务器的 NetBackup 主机上执行。 |
注意:
群集 NetBackup 主机具有两个证书存储库:一个本地证书存储库,一个全局证书存储库。默认情况下,该命令在本地证书存储库中操作,除非指定 -cluster 选项。
注意:
请注意,对于用户定义的字符串,nbcertcmd 命令不支持非 US ASCII(非 7 位 ASCII)字符。
选项
- -all
显示所有令牌,包括已达到其最大使用计数或已失效的令牌。
- -certDeployLevel level
指定证书部署级别。该选项适用于 -getSecConfig 和 -setSecConfig 命令。-setSecConfig 命令要求您指定级别。-setSecConfig 参数的证书部署级别是:
0 - 非常高:禁用自动证书部署。
1 - 高:证书自动部署到已知主机上。
2 - 中:证书自动部署到所有请求主机上。
- -certificateFile certificate_file_name
指定证书文件的路径。
- -cluster
对全局证书存储库执行操作。
- -envtoken environment_variable
指示包含要用于请求的授权令牌的环境变量的名称。
- -file file_name
指定其中包含授权令牌(在第一行)或 CA 证书哈希的文件的路径。
- -fingerPrint certificate_fingerprint
指定认证机构证书指纹。
- -force
重写证书 (如果存在)。
- -host host_name
指定主机名。
- -hostId host_id
指定 NetBackup 主机 ID。
- -jks
显示来自 Java Keystore 的 Tomcat 证书信息。此选项仅在 NetBackup 主服务器上可用。
- -json
以
json
格式生成多行输出数据。- -json_compact
以
json
格式生成单行输出数据。- -maxUses number
指定令牌的最大使用计数。如果未指定此选项,则默认值为 1。maxUses 的最大值为 99999。
- -name token_name
指定令牌名称。
- -reason description_for_auditing
指定存储在此操作审核记录中的原因。
- -reasonCode value
指定吊销证书的原因代码。所示的值是 -reasonCode value 的唯一有效数字:
0 - 未指定,1 - 密钥损坏,2 - CA 损坏,3 - 附属关系已更改,4 - 已取代,5 - 停止操作
- -reissue
创建可用于重新发布证书的令牌。将此选项与 -host 选项或 -hostID 选项结合使用。
- -requestFile file_name
指定证书请求文件的路径。
- -server master_server_name
指定备用主服务器。默认情况下,此命令使用 NetBackup 配置中的第一个服务器条目。
- -token
指示在该请求中使用授权令牌。提示用户安全地指定令牌。
- -validFor numDnumHnumM
指定令牌有效期。此值的输入格式应为天数、小时数和分钟数。例如,12D6H30M的有效期将为 12 天 6 小时 30 分钟。可以选择指定一个或多个值。如果未指定此选项,默认值为 24 小时。请注意,如果您想要将令牌有效期设为 12 小时,则不必指定天数值或分钟数值。您可指定 12H。可以指定的最大有效期为 999 天。
示例
示例 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)。