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
Configure the SAML KeyStore
To establish a trust between the NetBackup primary server and the IDP server, you must configure an SAML KeyStore on the NetBackup primary server. Depending on whether you are using the NetBackup CA or an external certificate authority (ECA), refer to either of the following sections:
Note:
If you are using a combination of an ECA and NetBackup CA in your environment, by default, the ECA is considered while establishing trust with the IDP server.
Note:
The SAML KeyStore configuration using batch files, such as configureCerts.bat, configureCerts, configureSAMLECACert.bat, configureSAMLECACertand their corresponding options is deprecated.
If you are using the NetBackup CA, create the NetBackup CA KeyStore on the NetBackup primary server.
To create a NetBackup CA KeyStore
- Log on to the NetBackup primary server as root or administrator.
- Run the following command:
nbidpcmd -cCert -M master_server -f
-f is optional. Use the option for the forceful update.
Once the NetBackup CA KeyStore is created, ensure that you update the NetBackup CA KeyStore every time the NetBackup CA certificate is renewed.
To renew the NetBackup CA KeyStore
- Log on to the NetBackup primary server as root or administrator.
- Run the following command:
nbidpcmd -rCert -M master_server
- Download the new SP metadata XML file from the NetBackup primary server by entering the following URL in your browser:
https://primaryserver/netbackup/sso/saml2/metadata
Where primaryserver is the IP address or host name of the NetBackup primary server.
- Upload the new SP metadata XML file to the IDP.
To remove the NetBackup CA KeyStore
- Log on to the NetBackup primary server as root or administrator.
- Run the following command
nbidpcmd -dCert -M master_server
- Download the new SP metadata XML file from the NetBackup primary server by entering the following URL in your browser:
https://primaryserver/netbackup/sso/saml2/metadata
Where primaryserver is the IP address or host name of the NetBackup primary server.
- Upload the new SP metadata XML file to the IDP.
- See Enroll the NetBackup primary server with the IDP.
If you are using an ECA, import the ECA KeyStore to the NetBackup primary server.
Note:
If you are using a combination of an ECA and the NetBackup CA in your environment, by default, the ECA is considered while establishing trust with the IDP server. To use the NetBackup CA, you must first remove the ECA KeyStore.
To configure an ECA KeyStore
- Log on to the primary server as root or administrator.
- Depending on whether you want to configure SAML ECA keystore using the configured NetBackup ECA KeyStore or you want to provide the ECA certificate chain and private key, run the following commands:
Run the following command to use NetBackup ECA configured KeyStore:
nbidpcmd -cECACert -uECA existing ECA configuration [-f] [-M primary_server]
Run the following command to use ECA certificate chain and private key provided by the user:
nbidpcmd -cECACert -certPEM certificate chain file -privKeyPath private key file [-ksPassPath Keystore Passkey File] [-f] [-M <master_server>]
Certificate chain file specifies the certificate chain file path. The file must be in PEM format and must be accessible to the primary server on which the configuration is being performed.
Private key file specifies the private key file path. The file must be in PEM format and must be accessible to the primary server on which the configuration is being performed.
KeyStore passkey file specifies the KeyStore password file path and must be accessible to the primary server on which the configuration is being performed.
Primary server is the host name or IP address of primary server on which you want to perform SAML ECA KeyStore configuration. The NetBackup primary server where you run the command is selected by default.
To remove the ECA KeyStore
- Log on to the primary server as root or administrator.
- Download the new SP metadata XML file from the NetBackup primary server by entering the following URL in your browser:
https://primaryserver/netbackup/sso/saml2/metadata
Where primaryserver is the IP address or host name of the NetBackup primary server.
- Upload the new SP metadata XML file to the IDP.