NetBackup™ Web UI Administrator's Guide
- Section I. About NetBackup
- Section II. 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
- View the status of a redirected restore
- Troubleshooting the viewing and managing of jobs
- Device monitor
- Notifications
- Registering the data collector
- Monitoring NetBackup activity
- Section III. Configuring hosts
- Managing host properties
- Overview of host properties
- View or edit the host properties of a server or client
- Host information and settings in Host properties
- Reset a host's attributes
- Active Directory properties
- Backup pool host properties
- Busy file settings properties
- Clean up properties
- Client name properties
- Client attributes properties
- Client settings properties for UNIX clients
- Client settings properties for Windows clients
- Cloud Storage properties
- Credential access properties
- Data Classification properties
- Default job priorities properties
- Distributed application restore mapping properties
- Encryption properties
- Enterprise Vault properties
- Enterprise Vault hosts properties
- Exchange properties
- Exclude list properties
- Fibre transport properties
- Firewall properties
- General server properties
- Global attributes properties
- Logging properties
- Lotus Notes properties
- Media properties
- Network properties
- Network settings properties
- Nutanix AHV access hosts
- Port ranges properties
- Preferred network properties
- Add or edit a Preferred network setting
- How NetBackup uses the directives to determine which network to use
- Configurations to use IPv6 networks
- Configurations to use IPv4 networks
- Order of directive processing in the Preferred network properties
- bptestnetconn utility to display Preferred network information
- Configuration to prohibit using a specified address
- Configuration to prefer a specified address
- Configuration that restricts NetBackup to one set of addresses
- Configuration that limits the addresses, but allows any interfaces
- Properties setting in host properties
- RHV access hosts properties
- Resilient network properties
- Resource limit properties
- Restore failover properties
- Retention periods properties
- Scalable Storage properties
- Servers properties
- SharePoint properties
- SLP settings properties
- Throttle bandwidth properties
- Timeouts properties
- Universal settings properties
- UNIX client properties
- UNIX Server properties
- User account settings properties
- VMware access hosts properties
- Windows client properties
- Configuration options not found in the host properties
- About using commands to change the configuration options on UNIX or Linux clients and servers
- Managing credentials for workloads and systems that NetBackup accesses
- Managing deployment
- Managing host properties
- Section IV. Configuring storage
- Overview of storage options
- Configuring disk storage
- About configuring BasicDisk storage
- About configuring disk pool storage
- Create a disk pool
- Edit a disk pool
- Create a Media Server Deduplication Pool (MSDP, MSDP Cloud) storage server
- Edit a storage server
- Integrating MSDP Cloud and CMS
- Create a Media Server Deduplication Pool (MSDP) storage server for image sharing
- Create an AdvancedDisk, OpenStorage (OST), or Cloud Connector storage server
- Share images from an on-premises location to the cloud
- Overview of universal shares
- Create a universal share
- View or edit a universal share
- Delete a universal share
- Managing media servers
- Configuring storage units
- Managing tape drives
- Managing robots and tape drives
- Inventorying robots
- About robot inventory
- When to inventory a robot
- About showing a robot's contents
- Showing the media in a robot
- About comparing a robot's contents with the volume configuration
- Comparing media in a robot with the volume configuration
- About previewing volume configuration changes
- Previewing volume configuration changes for a robot
- About updating the NetBackup volume configuration
- Updating the NetBackup volume configuration with a robot's contents
- Robot inventory options
- Advanced options for robot inventory settings
- Configure media ID generation rules
- Barcode rules settings
- Media ID generation options
- Configure media settings
- About media type mapping rules
- Configure media type mappings
- Managing volumes
- About NetBackup tape volumes
- About adding volumes
- Add volumes
- Volume properties
- Edit volumes
- About moving volumes
- Move volumes
- Delete a volume
- About rules for moving volumes between groups
- Changing the volume group assignment
- Changing the media owner of a volume
- Rescanning and updating barcodes
- About barcode rules
- Freezing or unfreezing a volume
- Labeling a volume
- Erase a volume
- Suspending or unsuspending volumes
- Managing volume pools
- Managing volume groups
- Staging backups
- Troubleshooting storage configuration
- Section V. Configuring backups
- Overview of backups in the NetBackup web UI
- Managing protection plans
- Managing classic policies
- Protecting the NetBackup catalog
- About the NetBackup catalog
- Catalog backups
- The catalog backup process
- Prerequisites for backing up the NetBackup catalog
- Configuring catalog backups
- Backing up NetBackup catalogs manually
- Concurrently running catalog backups with other backups
- Catalog policy schedule considerations
- How catalog incrementals and standard backups interact on UNIX
- Determining whether or not a catalog backup succeeded
- Strategies that ensure successful NetBackup catalog backups
- Disaster recovery emails and the disaster recovery files
- Disaster recovery packages
- Set the passphrase to encrypt disaster recovery packages
- Recovering the catalog
- Managing backup images
- Pausing data protection activity
- Section VI. Managing security
- Security events and audit logs
- Managing security certificates
- Managing host mappings
- Configuring multi-person authorization
- About multi-person authorization
- Workflow to configure multi-person authorization for NetBackup operations
- RBAC roles and permissions for multi-person authorization
- Multi-person authorization process with respect to roles
- NetBackup operations that need multi-person authorization
- Configure multi-person authorization
- View multi-person authorization tickets
- Manage multi-person authorization tickets
- Add exempted users
- Schedule expiration and purging of multi-person authorization tickets
- Disable multi-person authorization
- Managing user sessions
- Configuring multifactor authentication
- About multifactor authentication
- Configure multifactor authentication for your user account
- Disable multifactor authentication for your user account
- Enforce multifactor authentication for all users
- Configure multifactor authentication for your user account when it is enforced in the domain
- Reset multifactor authentication for a user
- Managing the global security settings for the primary server
- View the 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
- Validate the disaster recovery package passphrase
- About trusted primary servers
- Configure the audit retention period
- Using access keys, API keys, and access codes
- Configuring authentication options
- Managing role-based access control
- Disabling access to NetBackup interfaces for OS Administrators
- Section VII. Detection and reporting
- Detecting anomalies
- About backup anomaly detection
- Configure backup anomaly detection settings
- View backup anomalies
- Disable backup anomaly detection and computation of entropy and file attributes for a client
- About system anomaly detection
- Configure system anomaly detection settings
- Configure rules-based anomaly detection
- Configure risk engine-based anomaly detection
- View system anomalies
- Malware scanning
- Usage reporting and capacity licensing
- Detecting anomalies
- Section VIII. NetBackup workloads and NetBackup Flex Scale
- Section IX. Administering NetBackup
- Management topics
- Managing client backups and restores
- About server-directed restores
- About client-redirected restores
- About restoring the files that have Access Control Lists (ACLs)
- About setting the original atime for files during restores on UNIX
- Restoring the System State
- About the backup and restore of compressed files on VxFS file systems
- About backups and restores on ReFS
- Section X. Disaster recovery and troubleshooting
- Section XI. Other topics
- Additional NetBackup catalog information
- About the NetBackup database
- About the NetBackup database installation
- Post-installation tasks
- Using the NetBackup Database Administration utility on Windows
- Using the NetBackup Database Administration utility on UNIX
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.