Important Update: Cohesity Products Documentation
All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.
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
- Expand or collapse rows in the Jobs tab
- View the jobs in the List view
- View the jobs in the Hierarchy view
- Jobs: cancel, suspend, restart, resume, delete
- View the logs for a job
- 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
- Collect logs for Cohesity Technical Support
- 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
- Overview of credential management in NetBackup
- Adding credentials in NetBackup
- Add a credential for NetBackup Callhome Proxy
- Add a credential for cloud KMS
- Add a credential for an external KMS
- Add a credential for Network Data Management Protocol (NDMP)
- Add a credential for proxy server
- Add a credential for WebSocket server
- Add a configuration for an external CMS server
- Edit or delete a named credential
- Edit or delete Network Data Management Protocol (NDMP) credentials in NetBackup
- Managing deployment
- Managing host properties
- Section IV. Configuring storage
- Overview of storage options
- Configuring disk storage
- Create a Media Server Deduplication Pool storage server
- Create an MSDP server for MSDP volume group (MVG)
- Integrating MSDP Cloud and CMS
- Create a Media Server Deduplication Pool (MSDP) storage server for image sharing
- Create an AdvancedDisk storage server
- Create an OpenStorage (OST) storage server
- Create a Cloud Connector server
- Edit a storage server
- Edit storage server credentials
- About configuring disk pool storage
- Share images from an on-premises location to the cloud
- Overview of universal shares
- About the MSDP object store
- Managing media servers
- Configuring storage units
- Configuring storage unit groups
- Configuring robots and tape drives
- NetBackup robot types
- About the device mapping files
- Downloading the device mapping files
- Prerequisites for configuring robots and drives
- About configuring robots and tapes drives in NetBackup
- Configure drives and robots by using the wizard
- Configure drive name rules
- Update the device configuration by using the wizard
- Robot properties and configuration options
- Robot control (robot configuration options)
- Managing robots
- Adding a shared tape drive to a NetBackup environment
- Correlating tape drives and SCSI addresses on Windows hosts
- Correlating tape drives and device files on UNIX hosts
- Managing tape drives
- Verifying the device configuration
- About automatic path correction
- Enable automatic path correction
- Replacing a device
- Updating device firmware
- About the NetBackup Device Manager
- About external access to NetBackup controlled devices on UNIX
- Configuring tape media
- About NetBackup tape volumes
- About NetBackup volume pools
- About NetBackup volume groups
- NetBackup media types
- About WORM media
- About adding volumes
- About configuring media name and attribute rules
- Add a volume
- About barcodes
- Configure media settings
- Configure barcode rules
- Configure media type mappings
- Configure media ID generation rules
- About media type mapping rules
- Managing volumes
- Edit a volume
- About rules for moving volumes between groups
- About moving volumes
- Delete a volume
- Changing the media owner of a volume
- Change the group of a volume
- Rescan and update barcodes
- About injecting and ejecting volumes
- About recycling a volume
- Label a volume
- Erase a volume
- About exchanging a volume
- About frozen media
- Suspend or unsuspend volumes
- About assigning and deassigning volumes
- Managing volume pools
- Managing volume groups
- About media sharing
- Configure unrestricted media sharing
- Configure media sharing with a server group
- Inventorying robots
- About robot inventory
- When to inventory a robot
- About showing a robot's contents
- Show the media in a robot
- About comparing a robot's contents with the volume configuration
- Compare media in a robot with the volume configuration
- Preview volume configuration changes for a robot
- About updating the NetBackup volume configuration
- Update the NetBackup volume configuration with a robot's contents
- Robot inventory options
- Advanced options for robot inventory settings
- Staging backups
- Troubleshooting storage configuration
- Section V. Configuring storage lifecycle policies (SLPs)
- Configuring storage lifecycle policies
- Storage operations
- Operation types in a storage lifecycle policy
- Backup operation in an SLP
- Backup From Snapshot operation in an SLP
- Duplication operation in an SLP
- Import operation in an SLP
- Index From Snapshot operation in an SLP
- Replication operation in an SLP
- Snapshot operation in an SLP
- Primary snapshot storage unit
- Primary + Replication source snapshot storage unit
- Replication source + Replication target snapshot storage unit
- Replication target snapshot storage unit
- Replication source + Replication target + Mirror snapshot storage unit
- Replication target + Mirror snapshot storage unit
- Creating a hierarchy of storage operations in a storage lifecycle policy
- Retention types for SLP operations
- Retention types for storage lifecycle policy operations
- Capacity managed retention type for SLP operations
- Expire after copy retention type for SLP operations
- Fixed retention type for SLP operations
- Maximum snapshot limit retention type for SLP operations
- Mirror retention type for SLP operations
- Target retention type for SLP operations
- Storage lifecycle policy options
- Using a storage lifecycle policy to create multiple copies
- Storage lifecycle policy versions
- Section VI. Configuring backups
- Overview of backups in the NetBackup web UI
- Managing policies
- About the Policies utility
- Planning for policies
- Add a policy
- About the Epic-Large-File policy type
- Example policy - Exchange Server DAG backup
- Example policy - Sharded MongoDB cluster
- Example policy - Epic-Large-File
- Edit a policy
- Edit attributes for multiple policies at the same time
- Edit multiple clients at a time
- Edit the settings for multiple schedules at a time
- Copy or delete a policy
- Deactivate or activate a policy
- Manage permissions for policies
- About automanaged policies or storage lifecycle policies
- View automanaged policies and SLPs
- Perform manual backups
- Managing protection plans
- Create a protection plan
- Customizing protection plans
- Edit or delete a protection plan
- Subscribe an asset or an asset group to a protection plan
- Unsubscribe an asset from a protection plan
- View protection plan overrides
- Copy a protection plan policy (automanaged policy) to a classic policy
- About Backup now
- 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 VII. Configuring replication
- About NetBackup replication
- About NetBackup replication
- About NetBackup Auto Image Replication
- One-to-many Auto Image Replication model
- Cascading Auto Image Replication model
- About the domain relationship for replication
- About the replication topology for Auto Image Replication
- Viewing the replication topology for Auto Image Replication
- About trusted primary servers for Auto Image Replication
- About the storage lifecycle policies required for Auto Image Replication
- About Auto Image Replication import confirmation
- Auto Image Replication setup overview
- How to resolve volume changes for Auto Image Replication
- Removing or replacing replication relationships in an Auto Image Replication configuration
- Adding or removing a replication relationship between two storage servers
- Removing all replication relationships between a domain and a storage server
- Replacing all replication relationships between a domain and a storage server
- Removing or replacing all replication relationships involving a storage server
- Example: Replacing a storage server in a non-targeted Auto Image Replication configuration
- Example: Replacing a storage server in a cascading, targeted Auto Image Replication configuration
- About restoring from a backup at a target primary domain
- Reporting on Auto Image Replication jobs
- About NetBackup Replication Director
- About NetBackup replication
- Section VIII. Performing restores
- Section IX. Managing security
- Security events and audit logs
- Managing security certificates
- About security management and certificates in NetBackup
- NetBackup host IDs and host ID-based certificates
- Manage NetBackup security certificates
- Using external security certificates with NetBackup
- Configure an external certificate for the NetBackup web server
- Remove the external certificate configured for the web server
- Update or renew the external certificate for the web server
- View external certificate information for the NetBackup hosts in the domain
- Configuring rotation of external CA-issued certificates for host communication
- Managing host mappings
- Configuring KMS
- Minimizing security configuration risk
- Configuring multiperson authorization
- About multiperson authorization
- Workflow to configure multiperson authorization for NetBackup operations
- RBAC roles and permissions for multiperson authorization
- multiperson authorization process with respect to roles
- NetBackup operations that need multiperson authorization
- Configure multiperson authorization
- View multiperson authorization tickets
- Manage multiperson authorization tickets
- Add exempted users
- Schedule expiration and purging of multiperson authorization tickets
- Disable multiperson authorization
- Configuring freeze mode
- Configuring network control access of NetBackup web API
- 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 (RBAC)
- Disabling access to NetBackup interfaces for OS Administrators
- Section X. 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
- Compute host
- Malware scanning
- Threat library
- YARA scanning
- Usage reporting and capacity licensing
- Reports
- Detecting anomalies
- Section XI. NetBackup workloads and NetBackup Flex Scale
- Section XII. Administering NetBackup
- Management topics
- Managing client backups and restores
- Powering down and rebooting NetBackup servers
- About Granular Recovery Technology
- About installing and configuring Network File System (NFS) for Active Directory Granular Recovery
- About configuring Services for Network File System (NFS)
- Configuring a UNIX media server and Windows clients for backups and restores that use Granular Recovery Technology (GRT)
- Configuring a different network port for NBFSD
- Section XIII. Disaster recovery and troubleshooting
- Section XIV. Other topics
Examples of redirected restores
This topic provides some example configurations that allow clients to restore the files that were backed up by other clients. These methods may be required when a client connects through a gateway or has multiple Ethernet connections.
In all cases, the requesting client must have access to an image database directory on the primary server or the requesting client must be a member of an existing NetBackup policy.
On Windows: install_path\NetBackup\db\images\client_name
On UNIX: /usr/openv/netbackup/db/images/client_name
Note:
Not all file system types on all computers support the same features. Problems can be encountered when a file is restored from one file system type to another. For example, the S51K file system on an SCO computer does not support symbolic links nor does it support names greater than 14 characters long. You may want to restore a file to a computer that doesn't support all the features of the computer from which the restore was performed. In this case, all files may not be recovered.
In the following examples, assume the following conditions:
client1 is the client that requests the restore.
client2 is the client that created the backups that the requesting client wants to restore.
On Windows: install_path is the path where you installed the NetBackup software. By default, this path is C:\Program Files\Cohesity NetBackup.
Note:
On Windows: You must have the necessary permissions to perform the following steps.
On UNIX: You must be a root user for any of the steps that must be performed on the NetBackup server. You may also need to be a root user to make the changes on the client.
Assume you must restore files to client1 that were backed up from client2. The client1 and client2 names are those specified by the NetBackup client name setting on the clients.
On Windows:
- Log on to the NetBackup server.
- Add client2 to the following file and perform one of the following:
Edit install_path\NetBackup\db\altnames\client1 to include the name of client2.
Create the following empty file:
install_path\NetBackup\db\altnames\No.Restrictions
On UNIX:
- Log on as root on the NetBackup server.
- Perform one of the following actions:
Edit /usr/openv/netbackup/db/altnames/client1 so it includes the name of client2. Or,
Run the touch command on the following file:
/usr/openv/netbackup/db/altnames/No.Restrictions
Note:
The No.Restrictions file allows any client to restore files from client2.
- Log on to client1 and change the NetBackup client name to client2.
- Restore the file.
- Undo the changes that were made on the server and client.
This example explains how altnames provides restore capabilities to clients that do not use their own host name when they connect to the NetBackup server.
By default, the NetBackup client name of the requesting client must match the peer name that is used in the connection to the NetBackup server. When the NetBackup client name is the host name for the client and matches the peer name (normal case), this requirement is met.
However, problems arise when clients connect to multiple ethernet or connect to the NetBackup server through a gateway.
In this example, restore requests from client1, client2, and client3 are routed through the TCP gateway. Because the gateway uses its own peer name rather than the client host names for connection to the NetBackup server, NetBackup refuses the requests. Clients cannot restore even their own files.
To correct the situation, do the following
- Determine the peer name of the gateway:
Try a restore from the client in question. In this example, the request fails with an error message similar to the following:
client is not validated to use the server
Examine the NetBackup problems report and identify the peer name that is used on the request. Entries in the report may be similar to the following:
01/29/12 08:25:03 bpserver - request from invalid server or client client1.dvlp.null.com
In this example, the peer name is client1.dvlp.null.com.
- Do one of the following:
On Windows: Determine the peer name, then create the following file on the NetBackup primary server:
install_path\NetBackup\db\altnames\peername
In this example, the file is:
install_path\NetBackup\db\altnames\client1.dvlp.null.com
On UNIX: Run the touch command on the following file:
/usr/openv/netbackup/db/altnames/peername
In this example, the file is:
/usr/openv/netbackup/db/altnames/client1.dvlp.null.com
- Edit the peername file so that it includes the client names.
For example, if you leave file client1.dvlp.null.com empty, client1, client2, and client3 can all access the backups that correspond to their NetBackup client name setting.
If you add the names client2 and client3 to the file, you give these two clients access to NetBackup file restores, but exclude client1.
Note that this example requires no changes on the clients.
- Restore the files.
If you cannot restore files with a redirected client restore by using the altnames file, troubleshoot the situation, as follows.
On Windows:
- Create the debug log directory for the NetBackup Request Daemon:
install_path\NetBackup\logs\bprd
- On the primary server, stop and restart the NetBackup Request Daemon. Restart the service to ensure that this service is running in verbose mode and logs information regarding client requests.
- On client1 (the requesting client), try the file restore.
- On the primary server, identify the peer name connection that client1 uses.
- Examine the debug log for the NetBackup Request Daemon to identify the failing name combination:
Examine the failure as logged on the All log entries report. Or, examine the debug log for the NetBackup Request Daemon to identify the failing name combination:
install_path\NetBackup\logs\bprd\mmddyy.log
- On the primary server, do one of the following:
Create an install_path\NetBackup\db\altnames\No.Restrictions file. The file allows any client to access client2 backups if the client changes its NetBackup client name setting to client2.
Create an install_path\NetBackup\db\altnames\peername file. The file allows client1 to access client2 backups if client1 changes its NetBackup client name setting to client2.
Add client2 name to the following file: install_path\NetBackup\db\altnames\peername.
client1 is allowed to access backups on client2 only.
- On client1, change the NetBackup client name setting to match what is specified on client2.
- Restore the files from client1.
- Perform the following actions:
Delete install_path\NetBackup\logs\bprd and the contents.
In the NetBackup web UI, open the host properties for the primary server. Click Logging. Clear the Keep logs for days setting.
- If you do not want the change to be permanent, do the following:
Delete install_path\NetBackup\db\altnames\No.Restrictions (if existent).
Delete install_path\NetBackup\db\altnames\peername (if existent).
On client1, change the NetBackup client name to its original value.
On UNIX:
- On the NetBackup primary server, add the VERBOSE entry and a logging level to the bp.conf file. For example:
VERBOSE = 3
- Create the debug log directory for bprd by running the following command:
mkdir /usr/openv/netbackup/logs/bprd
- On the NetBackup server, stop the NetBackup Request Daemon, bprd, and restart it in verbose mode by running:
/usr/openv/netbackup/bin/admincmd/bprdreq -terminate /usr/openv/netbackup/bin/bprd -verbose
Restart bprd to ensure that bprd logs information regarding client requests.
- On client1, try the file restore.
- On the NetBackup server, identify the peer name connection that client1 used.
Examine the bard debug log to identify the failing name combination:
Examine the failure as logged on the All log entries report or examine the bard debug log to identify the failing name combination:
/usr/openv/netbackup/logs/bprd/log.date
- On the NetBackup server enter the following command:
mkdir -p /usr/openv/netbackup/db/altnames touch /usr/openv/netbackup/db/altnames/No.Restrictions
This command allows any client access to client2 backups by changing its NetBackup client name setting to specify the client2.
- Run the touch command on the following file:
/usr/openv/netbackup/db/altnames/peername
The command allows client1 access to any client2 backups by changing its NetBackup client name setting to specify client2.
- Add client2 to the /usr/openv/netbackup/db/altnames/peername file. The addition to the peername file allows client1 access to the backups that were created on client2 only.
- On client1, change the NetBackup client name setting in the user interface to match what is specified on client2.
- Restore the files to client1.
- Do the following:
Delete the VERBOSE entry from the /usr/openv/netbackup/bp.conf file on the primary server.
Delete /usr/openv/netbackup/logs/bprd and the contents.
- Return the configuration to what it was before the restore.
Delete /usr/openv/netbackup/db/altnames/peer.or.hostname (if it exists)
Delete /usr/openv/netbackup/db/altnames/No.Restrictions (if it exists)
On client1, restore the NetBackup client name setting to its original value.