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
Default RBAC roles
The NetBackup web UI provides the following default RBAC roles with preconfigured permissions and settings.
Table: Default RBAC roles in the NetBackup web UI
Role name | Description |
|---|---|
Administrator | The Administrator role has full permissions for NetBackup and can manage all aspects of NetBackup. |
Default AHV Administrator | This role has all the permissions that are necessary to manage Nutanix Acropolis Hypervisor and to back up those assets with protection plans. |
Default Apache Cassandra Administrator | This role has all the permissions that are necessary to manage and protect Apache Cassandra assets with protection plans. |
Default Cloud Administrator | This role has all the permissions that are necessary to manage cloud assets and to back up those assets with protection plans. Note that a PaaS administrator requires some additional permissions that you can add to a custom role. Cloud administrators also need additional permissions to manage cloud and PaaS assets using intelligent groups. |
Default Cloud Object Store Administrator | This role has all the permissions to manage the protection for cloud objects using classic policies. |
Default DB2 Administrator | This role provides the ability to view and restore DB2 backups with the nbdb2adutl command. The administrator can also view and manage DB2 jobs. |
Default IRE SLP Administrator | Manages IRE (Isolated Recovery Environment) SLP (Storage lifecycle policies) functionalities. |
Default Kubernetes Administrator | This role has all the permissions that are necessary to manage Kubernetes and to back up those assets with protection plans. The permissions for this role give a user the ability to view and manage jobs for Kubernetes assets. To view all jobs for this asset type, a user must have the default role for that workload. Or, a similar custom role must have the following option applied when the role is created: . |
Default KVM Administrator | This role has all the permissions that are necessary to manage KVM and to back up those assets. The administrator can also view and manage KVM jobs. |
Default Microsoft Sentinel Administrator | This role has all the permissions necessary to add Microsoft Sentinel credentials in NetBackup and to send NetBackup audit events to Microsoft Sentinel. |
Default Microsoft SQL Server Administrator | This role has all the permissions that are necessary to manage SQL Server databases and to back up those assets with protection plans. In addition to this role, the NetBackup user must meet the following requirements:
|
Default MongoDB Ops Manager | This role has all the permissions that are necessary to manage and protect assets in MongoDB Ops Manager with protection plan. |
Default MultiPerson Authorization (MPA) Approver | This role has permissions to manage MPA tickets. |
Default MySQL Administrator | This role has all the permissions that are necessary to manage MySQL instances and databases and to back up those assets with protection plans. |
Default NAS Administrator | This role has all the permissions that are necessary to perform the backup and restore of NAS volumes using a policy. To view all jobs for the backups and restores of a NAS volume, a user must have this role. Or, the user must have a custom role with same permissions applied when the role was created. |
Default NetBackup Command Line (CLI) Administrator | This role has all the permissions that are necessary to manage NetBackup using the NetBackup command line (CLI). With this role a user can run most of the NetBackup commands with a non-root account. A user that has only this role cannot sign into the web UI. |
Default Oracle Administrator | This role has all the permissions that are necessary to manage Oracle databases and to back up those assets with protection plans. |
Default PostgreSQL Administrator | This role has all the permissions that are necessary to manage PostgreSQL instances and databases and to back up those assets with protection plans. |
Default Resiliency Administrator | This role has all the permissions to protect the Veritas Resiliency Platform (VRP) for VMware assets. |
Default RHV Administrator | This role has all the permissions that are necessary to manage Red Hat Virtualization computers and to back up those assets with protection plans. This role gives a user the ability to view and manage jobs for RHV assets. To view all jobs for RHV assets, a user must have this role. Or, the user must have a similar custom role with following option applied when the role was created: . |
Default SaaS Administrator | This role has all the permissions to view and manage SaaS assets. |
Default Security Administrator | This role has permissions to manage NetBackup security including role-based access control (RBAC), certificates, hosts, identity providers and domains, global security settings, and other permissions. This role can also view settings and assets in most areas of NetBackup: workloads, storage, licensing, and other areas. |
Default Storage Administrator | This role has permissions to configure disk-based storage and storage lifecycle policies. SLP settings are managed with the Administrator role. Note: A user that is assigned with this role also has access permissions to Tape vault in Vault management. |
Default Universal Share Administrator | This role has the permissions to manage policies and storage servers. It can also manage the assets for filesystem clients (MS-Windows and Standard policies) and for universal shares. |
Default VMware Administrator | This role has all the permissions that are necessary to manage VMware virtual machines and to back up those assets with protection plans. To view all jobs for VMware assets, a user must have this role. Or, the user must have a similar custom role with following option applied when the role was created: . |
NetBackup Read-Only Operator | This role provides the read-only permissions to the IT Analytics Operator, Multiperson Authorization Approver, and other operators in NetBackup, with no permissions for security. |
Note:
Cohesity reserves the right to update the RBAC permissions for default roles in future releases. Any revised permissions are automatically applied to users of these roles when NetBackup is upgraded. If you have copies of default roles these roles are not updated automatically. (Or, if you have any custom roles that are based on default roles.) If you want these custom roles to include changes to default roles, you must manually apply the changes or recreate the custom roles.