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
SLP settings properties
To access this setting, in the web UI select . Select the primary server. If necessary click , then click . Click . You can also configure the SLP settings from .
The SLP settings properties allow administrators to customize how storage lifecycle policies (SLPs) are maintained and how SLP jobs run. These properties apply to the SLPs of the currently selected primary server.
Table: SLP settings describes the available properties for SLPs. It also lists the syntax to use with the command-line method.
Use the list in the Units column to change the units of measurement for the size or the time.
Table: SLP settings
Property | Description |
|---|---|
Minimum size per duplication job | The smallest batch size that can run as a single duplication job. The job does not run until enough images accumulate to reach this minimum batch size or until the Force interval for small jobs time is reached. Minimum: 1 kilobyte; no maximum size. Default: 8 gigabytes. Configuration option default: SLP.MIN_SIZE_PER_DUPLICATION_JOB = 8 GB |
Maximum size per duplication job | The largest batch size that can run as a single duplication job. Minimum: 1 kilobyte; no maximum size. Default: 100 gigabytes. Configuration entry default: SLP.MAX_SIZE_PER_DUPLICATION_JOB = 100 GB |
Maximum size per A.I.R. replication job | The largest batch size that can run as a single job for Auto Image Replication. Minimum: 1 kilobyte; no maximum size. Default: 100 gigabytes. Configuration entry default: SLP.MAX_SIZE_PER_BACKUP_REPLICATION_JOB = 100 GB |
Maximum images per snapshot replication job | The largest number of images in a single batch that can run as a single job. Default: 50 images, with no minimum number or maximum number. Use this parameter with the Limit I/O streams disk pool option which limits the number of jobs that can run concurrently to each volume in the disk pool. Configuration entry default: SLP.MAX_IMAGES_PER_SNAPSHOT_REPLICATION_JOB = 50 |
Minimum images per A.I.R. Import job | The fewest number of images in a single batch that can run as an Auto Image Replication import job. The job does not run until either the minimum size is reached or the Force interval for small jobs time is reached. Minimum: 1 image; no maximum number of images. Default: 1 image. Configuration entry default: SLP.MIN_IMAGES_PER_IMPORT_JOB = 1 |
Maximum images per A.I.R. Import job | The largest number of images in a single batch that can run as an Auto Image Replication import job. Minimum: 1 job; no maximum number of images. Default: 250 images. Configuration entry default: SLP.MAX_IMAGES_PER_IMPORT_JOB = 250 |
Force interval for small jobs | The age that the oldest image in a batch must reach after which the batch is submitted as a duplication job. This value prevents many small duplication jobs from running at one time or running too frequently. It also prevents NetBackup from waiting too long before it submits a small job. Default: 30 minutes, with no minimum number or maximum number. Configuration entry default: SLP.MAX_TIME_TIL_FORCE_SMALL_DUPLICATION_JOB = 30 MINUTES |
Job submission interval | Indicates the frequency of the job submission for all operations. No minimum interval or maximum interval. Default: 5 minutes. By default, all jobs are processed before more jobs are submitted. Increase this interval to allow NetBackup to submit more jobs before all jobs are processed. Set the interval when the list of available images is scanned for those that can be batched together and jobs submitted. A shorter interval allows for a better response to changing system workloads at the cost of increased processing. Configuration entry default: SLP.JOB_SUBMISSION_INTERVAL = 5 MINUTES |
Image processing interval | The number of minutes between image-processing sessions. Set the interval when newly created images are recognized and set up for SLP processing. Default: 5 minutes. Configuration entry default: SLP.IMAGE_PROCESSING_INTERVAL = 5 MINUTES |
Cleanup interval | The time between when a job finishes and before NetBackup removes the job artifacts for the completed job. No minimum interval or maximum interval. Default: 24 hours. Configuration entry default: SLP.CLEANUP_SESSION_INTERVAL = 24 HOURS |
Extended image retry interval | The amount of time to wait before an unsuccessful operation is added to the first job that runs after the delay. (This behavior applies to all SLP jobs.) The extra time gives the administrator additional time to solve a problem that prevents job completion. No minimum interval or maximum interval. Default: 2 hours. Configuration entry default: SLP.IMAGE_EXTENDED_RETRY_PERIOD = 2 HOURS |
Unused SLP definition version cleanup delay | Concerns the deletion of SLP versions where a more recent version exists. The setting controls how long a version must be inactive before NetBackup deletes it. Default: 14 days. Configuration entry default: SLP.VERSION_CLEANUP_DELAY = 14 DAYS |
Tape resource multiplier | Limits the number of concurrently active duplication jobs that can access a single tape media storage unit to xx times the number of available drives. Allows tuning to avoid overloading the Resource Broker, yet makes sure that the devices are not idle. No minimum multiplier or maximum multiplier. Default: 2 (multiply access to the write drives by two). Configuration entry default: SLP.TAPE_RESOURCE_MULTIPLIER = 2 |
Disk resource multiplier | Limits the number of concurrently active duplication jobs that can access a single disk storage unit to xx times the number of available drives. Allows tuning to avoid overloading the Resource Broker, yet makes sure that the devices are not idle. No minimum multiplier or maximum multiplier. Default: 2 (multiply access to the write drives by two). Configuration entry default: SLP.DISK_RESOURCE_MULTIPLIER = 2 |
Group images across SLPs | If this parameter is set to Yes (default), multiple SLPs of the same priority can be processed in the same job. If No, batching can occur only within a single SLP. Configuration entry default: SLP.DUPLICATION_GROUP_CRITERIA = 1 Configuration entry for no, do not allow batching:SLP.DUPLICATION_GROUP_CRITERIA = 0 |
Window close buffer time | Sets the amount of time before a window closes when NetBackup does not submit new jobs using that window. Minimum 2 minutes; maximum: 60 minutes. Default: 15 minutes. Configuration entry default: SLP.WINDOW_CLOSE_BUFFER_TIME = 15 MINUTES |
Deferred duplication offset time | For deferred operations, jobs are submitted x time before the source copy is due to expire. Default: 4 hours. Configuration entry default: SLP.DEFERRED_DUPLICATION_OFFSET_TIME = 4 HOURS |
Auto create A.I.R. Import SLP | Used for Auto Image Replication, indicates whether an SLP (that contains an Import operation) is created automatically in the target domain if no SLP is configured there. Default: Yes, an SLP is created in the target domain. Configuration entry default: SLP.AUTO_CREATE_IMPORT_SLP = 1 |
How long to retry failed A.I.R. import jobs | How long NetBackup retries an Import job before it stops and deletes the record. After the initial four attempts, the retries become less frequent. Default: 0 (do not retry after the initial four attempts). Configuration entry default: SLP.REPLICA_METADATA_CLEANUP_TIMER = 0 HOURS |
Pending A.I.R import threshold | How long NetBackup waits before it generates a notification that an Auto Image Replication copy is still in import pending state. After an Auto Image Replication copy has been replicated, NetBackup puts the source copy into import pending state. If the copy is in import pending state for the time period that this threshold sets, NetBackup generates a notification. Notifications are sent to the NetBackup error log and are visible in the Problems report. Notifications may also be sent to an email address, if specified. Default: 24 hours Configuration entry default: SLP.PENDING_IMPORT_THRESHOLD = 24 HOURS |
Email address to receive notifications | The email address that receives pending A.I.R. import notifications. Default: None. Configuration entry format: SLP.NOTIFICATIONS ADDRESS = user@company.com |
You can also change the parameters using the command line.
To use the command-line method, use the nbgetconfig and the nbsetconfig commands to change the defaults. For information about these commands, see the NetBackup Commands Reference Guide.
The abbreviations are case-insensitive for units of measurement.
The following abbreviations can be used where sizes are indicated:
bytes | kb | kilobyte | kilobyte(s) | kilobytes | mb | megabyte |
megabyte(s) | megabytes | gb | gigabyte | gigabyte(s) | gigabytes | tb |
terabyte | terabyte(s) | terabytes | pb | petabyte | petabyte(s) | petabytes |
The following abbreviations can be used where units of time are indicated:
sec | second | second(s) | seconds | min | minute | minute(s) | minutes |
hour | hour(s) | hours | day | day(s) | days | mon | month |
month(s) | months | week | week(s) | weeks | year | year(s) | years |
Whenever a storage lifecycle policy parameter is changed from the default, the change creates the nbcl.conf configuration file.
This file is found in the following locations. It is present only if the default of any parameter has been changed.
On Windows:
install_path\NetBackup\var\global\nbcl.conf
On UNIX:
/usr/openv/var/global/nbcl.conf