NetBackup™ 命令参考指南
- 介绍
- 附录 A. NetBackup 命令
名称
nbidpcmd — 在 NetBackup 主服务器上配置身份提供程序 (IDP)、SAML 证书和 keystore,以与单点登录 (SSO) 方法配合使用。
大纲
For IDP configuration and NetBackup CA SAML keystore configuration, use the following command:
-ac -n IDP configuration name -mxp IDP XML metadata file [-t SAML2] [-e true | false] [-u IDP user field] [-g IDP user group field] [-M master_server] [-cCert] [-f]
For IDP configuration and ECA SAML keystore configuration, either of the commands shown can be used:
Use NetBackup ECA configured keystore for SAML keystore configuration:
-ac -n IDP configuration name -mxp IDP XML metadata file [-t SAML2] [-e true | false] [-u IDP user field] [-g IDP user group field] [-M master_server] -cECACert -uECA [-f]
Use ECA certificate chain and private key provided by user for SAML keystore configuration:
-ac -n IDP configuration name -mxp IDP XML metadata file [-t SAML2] [-e true | false] [-u IDP user field] [-g IDP user group field] [-M master_server] -cECACert -certPEM Certificate Chain File -privKeyPath Private Key File [-ksPassPath Keystore Passkey File] [-f]
-cCert [-f]
-cECACert -uECA use existing ECA configuration [-f force_option] [-M master_server]
-cECACert -certPEM Certificate Chain File -privKeyPath Private Key File -ksPassPath Keystore Passkey File [-f force_option] [-M master_server]
-dc -n IDP configuration name [-M master_server]
-dCert
-dECACert
-rCert
-sc -n IDP configuration name [-M master_server]
-scl [-M master_server]
-uc -n IDP configuration name {-mxp IDP XML metadata file| -e true | false} [-M master_server]
-v [-M master_server]
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/
On Windows systems, the directory path to this command is install_path\NetBackup\bin\
描述
nbidpcmd 命令可以在 NetBackup 主服务器上添加、修改、列出和删除身份提供程序的配置。此外,使用此命令可添加、更新、续订和删除 NetBackup CA、ECA SAML 证书和 keystore。
选项
- -ac
添加身份提供程序的配置。使用 -e 选项启用 IDP 配置。
- -cCert
配置 SAML 证书和 keystore。
- -cECACert
配置 SAML 外部 CA keystore。
- -certPEM Certificate Chain File
指定证书链文件路径。该文件必须为 PEM 格式,并且执行配置的主服务器必须可以访问该文件。
- -dc
删除具有指定 ID 的身份提供程序的配置。
- -dCert
删除 SAML 证书和 keystore。
- -dECACert
删除 SAML 外部 CA 配置的 keystore。
- -e true | false
启用或禁用身份提供程序配置。IDP 必须可用并已启用,否则用户无法使用单点登录 (SSO) 选项登录。
true = 启用
false = 禁用
- -f
指定是否重写现有 SAML keystore。
- -ksPassPath Keystore Passkey File
指定 keystore 的密码文件路径。执行配置的主服务器必须可以访问该文件。
- -M master_server
是要在其中添加或修改身份提供程序配置的主服务器 。默认值为运行命令的 NetBackup 主服务器。
- -mxp IDP XML metadata file
包含身份提供程序配置详细信息的元数据文件,采用 Base64 编码格式。
- -n IDP configuration name
身份提供程序的唯一名称。
- -privKeyPath Private Key File
指定证书的私钥文件路径。该文件必须为 PEM 格式,并且执行配置的主服务器必须可以访问该文件。
- -rCert
续订 SAML 证书和密钥对,然后使用续订的密钥对证书更新 SAML keystore。
- -sc
显示具有指定 ID 的已配置身份提供程序的详细信息。如果未提供 ID,则列出所有已配置身份提供程序的详细信息。或者,使用 -scl 显示特定身份提供程序。
- -scl
显示所有已配置身份提供程序的详细信息。使用 -sc -n 显示特定身份提供程序。
- -t SAML2
表示身份提供程序支持的协议类型。支持下列类型:SAML2。
- -u IDP user field, -g IDP user group field
从 SAML 断言中检索作为用户和用户组主键的字段。可以一起指定这些字段,也可以单独指定。
如果未提供这些字段,则默认值为 userPrincipalName 和 memberOf。
IDP user field 和 IDP user group field 是 IDP SAML 属性名称,分别映射到 AD 或 LDAP 的 userPrincipalName 和 memberOf 属性。
为 -u IDP user field 和 -g IDP user group field 输入的值区分大小写,并且必须与 IDP 主机上相应的映射 SAML 属性完全匹配。
请确保 SAML 属性名称分别以 username@domainname 和 (CN=group name, DC=domainname) 格式进行定义。
- -uc
更新具有指定 ID 的已配置身份提供程序的详细信息。除了 -n 选项之外,还必须使用 -mxp 或 -e 选项,或者同时使用这两个选项。
- -uECA
指定是否从 NetBackup 中配置的现有外部 CA 证书配置外部 CA 签名 SAML keystore。
- -v
显示 nbidpcmd 实用程序的版本。