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
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.
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.