NetBackup™ Web UI Administrator's Guide
- Introducing NetBackup
- About NetBackup
- NetBackup documentation
- NetBackup web UI features
- NetBackup administration interfaces
- Terminology
- First-time sign in to the NetBackup web UI
- Sign in to the NetBackup web UI
- Sign out of the NetBackup web UI
- Documentation for Catalog Recovery Wizard, disk array hosts, disk pools, and Host Properties in the NetBackup web UI
- Section I. Monitoring and notifications
- Monitoring NetBackup activity
- The NetBackup dashboard
- Activity monitor
- Job monitoring
- Workloads that require a custom RBAC role for specific job permissions
- View a job
- View the jobs in the List view
- View the jobs in the Hierarchy view
- Jobs: cancel, suspend, restart, resume, delete
- Search for or filter jobs in the jobs list
- Create a jobs filter
- Edit, copy, or delete a jobs filter
- Import or export job filters
- Troubleshooting the viewing of jobs
- Notifications
- Monitoring NetBackup activity
- Section II. Configuring hosts
- Managing host properties
- Managing credentials for workloads and systems that NetBackup accesses
- Overview of credential management in NetBackup
- Add a credential in NetBackup
- Add a credential for an external KMS
- Add a credential for NetBackup Callhome Proxy
- Edit or delete a named credential
- Add a credential for Network Data Management Protocol (NDMP)
- Edit or delete Network Data Management Protocol (NDMP) credentials in NetBackup
- Managing deployment
- Section III. Configuring storage
- Section IV. Configuring backups
- Section V. Managing security
- Security events and audit logs
- Managing security certificates
- Managing host mappings
- Managing user sessions
- Managing the security settings for the primary server
- Certificate authority for secure communication
- Disable communication with NetBackup 8.0 and earlier hosts
- Disable automatic mapping of NetBackup host names
- Configure the global data-in-transit encryption setting
- About NetBackup certificate deployment security levels
- Select a security level for NetBackup certificate deployment
- About TLS session resumption
- Set a passphrase for disaster recovery
- About trusted primary servers
- Using access keys, API keys, and access codes
- Configuring authentication options
- Managing role-based access control
- RBAC features
- Authorized users
- Configuring RBAC
- Notes for using NetBackup RBAC
- Add AD or LDAP domains
- View users in RBAC
- Add a user to a role (non-SAML)
- Add a smart card user to a role (non-SAML, without AD/LDAP)
- Add a user to a role (SAML)
- Remove a user from a role
- Disable web UI access for operating system (OS) administrators
- Disable command-line (CLI) access for operating system (OS) administrators
- Default RBAC roles
- Add a custom RBAC role
- Role permissions
- Manage access permission
- View access definitions
- Section VI. Detection and reporting
- Detecting malware
- About malware detection
- Configure a new scan host pool
- Add an existing scan host
- Manage credentials
- Remove the scan host
- Deactivate the scan host
- Scan a policy client backup images for malware
- Perform malware scanning
- Scan a VMware asset for malware
- View the malware scan status
- Actions for malware scanned images
- Recover from malware-affected images (clients protected by policies)
- Recover a VMware asset affected by malware
- Troubleshooting
- Detecting anomalies
- Usage reporting and capacity licensing
- Detecting malware
- Section VII. NetBackup workloads and NetBackup Flex Scale
- Section VIII. Disaster recovery and troubleshooting
Manage an IDP configuration
You can manage the identity provider (IDP) configurations on the NetBackup primary server by using the enable (-e true), update (-uc), disable (-e false). and delete (-dc) options of the nbidpcmd command.
By default, an IDP configuration is not enabled in the product environment. If you did not enable the IDP when you added it, you can use the -uc -e true options to update and enable the IDP configuration.
To enable an IDP configuration
- Log on to the primary server as root or administrator.
- Run the following command:
nbidpcmd -uc -n IDP configuration name -e true
Where IDP configuration name is a unique name provided to the IDP configuration.
Note:
Even though you can configure multiple IDPs on a NetBackup primary server, only one IDP can be enabled at a time.
You can update the XML metadata file associated with an IDP configuration.
To update the IDP XML metadata file in an IDP configuration
- Log on to the primary server as root or administrator.
- Run the following command:
nbidpcmd -uc -n IDP configuration name -mxp IDP XML metadata file
Replace the variables as described below:
IDP configuration name is a unique name provided to the IDP configuration.
IDP XML metadata file is the path to the XML metadata file, which contains the configuration details of the IDP in Base64URL-encoded format.
If you want to update the IDP user or IDP user group values in an IDP configuration, you must first delete the configuration. The single sign-on (SSO) option is not available for users until you re-add the configuration with the updated IDP user or IDP user group values.
To update IDP user or IDP user group in an IDP configuration
- Log on to the primary server as root or administrator.
- Delete the IDP configuration.
nbidpcmd -dc -n IDP configuration name
Where IDP configuration name is a unique name provided to the IDP configuration.
- To add and enable the configuration again, run the following command:
nbidpcmd -ac -n IDP configuration name -mxp IDP XML metadata file [-t SAML2] [-e true | false] [-u IDP user] [-g IDP user group field] [-M Master Server
Replace the variables as described below:
IDP configuration name is a unique name provided to the IDP configuration.
IDP XML metadata file is the path to the XML metadata file, which contains the configuration details of the IDP in Base64URL-encoded format.
-e true | false enables or disables the IDP configuration. An IDP must be available and enabled otherwise users cannot sign in with the single sign-on (SSO) option. Even though you can add multiple IDP configurations on a NetBackup primary server, only one IDP configuration can be enabled at a time.
IDP user field and IDP user group field are the SAML attribute names, which are mapped to the userPrincipalName and the memberOf attributes in the AD or LDAP.
Note:
Ensure that the SAML attribute names are defined in the format of username@domainname and (CN=group name, DC=domainname) respectively.
Master Server is the host name or IP address of the primary server to which you want to add or modify the IDP configuration. The NetBackup primary server where you run the command is selected by default.
If an IDP configuration is disabled in the product environment, the single sign-on (SSO) option of that IDP is not available for users when they sign in.
To disable an IDP configuration
- Log on to the primary server as root or administrator.
- Run the following command:
nbidpcmd -uc -n IDP configuration name -e false
Where IDP configuration name is a unique name provided to the IDP configuration.
If an IDP configuration is deleted, the single sign-on (SSO) option of that IDP is not available for users when they sign in.
To delete an IDP configuration
- Log on to the primary server as root or administrator.
- Run the following command:
nbidpcmd -dc -n IDP configuration name
Where IDP configuration name is a unique name provided to the IDP configuration.