Veritas NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
Name
nbidpcmd — configure an identity provider (IDP) on the NetBackup master server to use with the Single Sign-On (SSO) method.
SYNOPSIS
-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]
-dc -n IDP configuration name [-M master_server]
-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\
DESCRIPTION
The nbidpcmd command can add, modify, list, and delete the configuration for identity providers on the NetBackup master server.
OPTIONS
- -ac
Adds a configuration for an identity provider. Use the -e option to enable an IDP configuration.
- -dc
Deletes the configuration of the identity provider with the specified ID.
- -e true | false
Enables or disables the identity provider configuration. An IDP must be available and enabled otherwise users cannot sign in with the Single Sign-On (SSO) option.
true = Enable
false = Disable
- -M master_server
The master server to which you want to add or modify the identity provider configuration. The default is the NetBackup server master where you run the command.
- -n IDP configuration name
The unique name of the identity provider.
- -mxp IDP XML metadata file
The metadata file that contains configuration details for the identity provider, in Base64-encoded format.
- -sc
Display the details for the configured identity provider with the specified ID. If the ID is not provided the details of all the configured identity providers are listed. Or, use -scl to display a specific identity provider.
- -scl
Display the details for all the configured identity providers. Use -sc -n to display a specific identity provider.
- -t SAML2
Indicates the type of protocol that the identity provider supports. The following types are supported: SAML2.
- -u IDP user field, -g IDP user group field
Retrieves the fields from the SAML assertion that are the primary keys for the user and the user group. You can specify these fields together or individually.
- -uc
Updates the details for the configured identity provider with the specified ID. In addition to the -n option, you must use the -mxp or the -e option, or both options.
- -v
Shows the version of the nbidpcmd utility.