NetBackup™ Web UI Administrator's Guide

Last Published:
Product(s): NetBackup (8.3.0.1, 8.3)
  1. Introducing the NetBackup web user interface
    1.  
      About the NetBackup web UI
    2.  
      Terminology
    3.  
      First-time sign in to a NetBackup master server from the NetBackup web UI
    4.  
      Sign in to the NetBackup web UI
    5.  
      Sign out of the NetBackup web UI
    6.  
      Authorized users
  2. Section I. Managing security
    1. Monitoring and notifications
      1.  
        The NetBackup dashboard
      2. Monitoring jobs
        1.  
          Jobs: canceling, suspending, restarting, resuming, deleting
        2.  
          Filter jobs in the job list
      3. About notifications
        1.  
          Viewing notifications
        2.  
          How to disable or modify NetBackup event notifications in the web UI
        3.  
          About configuring automatic notification cleanup tasks
      4. Send email notifications for job failures
        1.  
          Status codes that generate alerts
    2. Managing role-based access control
      1.  
        About role-based access control (RBAC) in NetBackup
      2. Configuring RBAC
        1.  
          Upgrading API key users to NetBackup 8.3
        2.  
          Add AD or LDAP domains
        3.  
          Add an RBAC role
        4.  
          Edit or remove a role
        5.  
          View users in RBAC
        6.  
          Add a user to a role
        7.  
          Remove a user from a role
      3. Role permissions
        1. Global > NetBackup management
          1.  
            Access hosts
          2.  
            Email notifications
          3.  
            Data classification
          4.  
            Event logs
          5.  
            NetBackup hosts
          6.  
            Image sharing
          7.  
            NetBackup backup images
          8.  
            Jobs
          9.  
            Licensing
          10.  
            Media server
          11.  
            Remote master server certificate authority
          12.  
            Resiliency
          13.  
            Resource limits
          14.  
            Retention levels
          15.  
            Servers > Trusted master servers
          16.  
            Cloud providers
          17.  
            CloudPoint servers
          18.  
            WebSocket servers
        2.  
          Global > Protection
        3. Global > Security
          1.  
            Access control
          2.  
            Security events
          3.  
            Certificate management
          4.  
            Disaster recovery passphrase
          5.  
            Identity provider configuration
          6.  
            Key Management Services (KMS)
          7.  
            Global security settings
          8.  
            Trust versions
          9.  
            API keys
          10.  
            User certificates
          11.  
            User sessions and authentication
        4. Global > Storage
          1.  
            Cloud storage
          2.  
            Disk pools
          3.  
            Storage Key Management Services
          4.  
            Storage servers
          5.  
            Storage units
          6.  
            Replication-capable target storage servers
        5.  
          Assets
        6.  
          Protection plans
        7.  
          Credentials
      4. Manage access
        1.  
          Manage the permissions for an area of the web UI
        2.  
          View access definitions
      5. Configure an external certificate for the NetBackup web server
        1.  
          Update or renew the external certificate for the web server
        2.  
          Remove the external certificate configured for the web server
    3. Security events and audit logs
      1.  
        View security events and audit logs
      2. About NetBackup auditing
        1.  
          User identity in the audit report
        2.  
          Audit retention period and catalog backups of audit records
        3.  
          Viewing the detailed NetBackup audit report
      3.  
        Send audit events to system logs
    4. Managing security certificates
      1.  
        About security management and certificates in NetBackup
      2.  
        NetBackup host IDs and host ID-based certificates
      3. Managing NetBackup security certificates
        1.  
          Reissue a NetBackup certificate
        2.  
          Managing NetBackup certificate authorization tokens
      4. Using external security certificates with NetBackup
        1.  
          View external certificate information for the NetBackup hosts in the domain
    5. Managing user sessions
      1.  
        Sign out a NetBackup user session
      2.  
        Unlock a NetBackup user
      3.  
        Configure when idle sessions should time out
      4.  
        Configure the maximum of concurrent user sessions
      5.  
        Configure the maximum of failed sign-in attempts
      6.  
        Display a banner to users when they sign in
    6. Managing master server security settings
      1.  
        Certificate authority for secure communication
      2.  
        Disable communication with NetBackup 8.0 and earlier hosts
      3.  
        Disable automatic mapping of NetBackup host names
      4.  
        About NetBackup certificate deployment security levels
      5.  
        Select a security level for NetBackup certificate deployment
      6.  
        Set a passphrase for disaster recovery
      7. About trusted master servers
        1.  
          Add a trusted master server
        2.  
          Remove a trusted master server
    7. Creating and using API keys
      1.  
        About API keys
      2.  
        Manage API keys
      3.  
        Use an API key with NetBackup REST APIs
      4.  
        View API keys
    8. Configuring authentication options
      1.  
        Sign-in options for the NetBackup web UI
      2. Configure user authentication with smart cards or digital certificates
        1.  
          Edit the configuration for smart card authentication
        2.  
          Add or delete a CA certificate that is used for smart card authentication
        3.  
          Disable or temporarily disable smart card authentication
      3.  
        About Single Sign-On (SSO) configuration
      4. Configure NetBackup for Single Sign-On (SSO)
        1.  
          Configure the Java KeyStore
        2.  
          Add and enable the IDP configuration
        3.  
          Enroll the NetBackup master server with the IDP
        4.  
          Manage an IDP configuration
      5. Troubleshooting SSO
        1.  
          Redirection issues
        2.  
          Unable to sign in due to authorization-related issues
    9. Managing hosts
      1.  
        View NetBackup host information
      2.  
        Approve or add mappings for a host that has multiple host names
      3.  
        Remove mappings for a host that has multiple host names
      4.  
        Reset a host's attributes
    10. Troubleshooting the web UI
      1.  
        Tips for accessing the NetBackup web UI
      2.  
        If a user doesn't have the correct permissions or access in the NetBackup web UI
      3. Unable to add AD or LDAP domains with the vssat command
        1.  
          Connection cannot be established with the AD or the LDAP server
        2.  
          User credentials are not valid
        3.  
          An incorrect user base DN or group base DN was provided
        4.  
          Multiple users or groups exist with the same name under user base DN or group base DN
        5.  
          User or group does not exist
      4.  
        Unable to validate the user or group
  3. Section II. Managing storage and backups
    1. Configuring storage
      1.  
        About storage configuration
      2.  
        Create a Media Server Deduplication Pool (MSDP) storage server
      3.  
        Create a Cloud (Cloud Catalyst), OpenStorage, or AdvancedDisk storage server
      4.  
        Create a disk pool
      5.  
        Create a storage unit
      6.  
        Create a universal share
      7.  
        Using image sharing from the NetBackup Web UI
      8.  
        Troubleshooting storage configuration
      9.  
        Troubleshooting universal share configuration issues
    2. Managing protection plans
      1.  
        Create a protection plan
      2.  
        Edit or delete a protection plan
      3.  
        Subscribe an asset or an asset group to a protection plan
      4.  
        Unsubscribe an asset from a protection plan
      5.  
        View protection plan overrides
      6.  
        About Backup Now
      7.  
        About a NetBackup classic policy
      8.  
        About policy management in the NetBackup web UI
    3. Managing protection plans for Microsoft SQL Server
      1.  
        About protecting SQL Server availability groups
      2. Create a protection plan to protect SQL Server assets
        1.  
          Schedules and retention
        2.  
          Performance tuning and configuration options
        3.  
          Using copy-only snapshot backups to affect how differentials are based
        4.  
          Snapshot methods
      3.  
        Protect a SQL Server availability group that crosses NetBackup domains
    4. Usage reporting and capacity licensing
      1.  
        Track backup data size on your master servers
      2.  
        Configure the servers list for usage reporting
      3.  
        Scheduling reports for capacity licensing
      4.  
        Other configuration for incremental reporting
      5.  
        Troubleshooting failures for nbdeployutil and incremental reporting
  4. Section III. Veritas Resiliency Platform
    1. Managing Resiliency Platforms
      1.  
        About Resiliency Platform in NetBackup
      2.  
        Understanding the terms
      3. Configuring a Resiliency Platform
        1.  
          Add a Resiliency Platform
        2.  
          Configuring a third-party CA certificate
        3.  
          Editing or deleting a Resiliency Platform
        4.  
          Viewing the automated or not-automated VMs
      4.  
        Troubleshooting NetBackup and Resiliency Platform issues
  5. Section IV. Managing credentials
    1. Managing external KMS and workload credentials
      1.  
        About credential management in NetBackup
      2.  
        Add a credential in NetBackup
      3.  
        Edit a credential
      4.  
        Delete a credential
      5. Select or add credentials to SQL Server instances or replicas
        1.  
          About Microsoft SQL Server credentials
        2.  
          Configuring the NetBackup services for SQL Server backups and restores
        3.  
          Configuring local security privileges for SQL Server

Performance tuning and configuration options

When you have the necessary RBAC permissions, you can adjust the following settings when you subscribe an asset to a protection plan.

Table: Performance tuning and configuration options

Field

Description

Client buffers per stripe

(Stream-based backups only) This option affects buffer space availability. NetBackup uses this parameter to decide how many buffers to allocate for reading or writing each data stream during a backup operation. By allocating a greater number of buffers, you can affect how quickly NetBackup can send data to the NetBackup master server.

The default value for this option is 2, which allows double buffering. You may get slightly better performance by increasing this value to a higher value. Range is 1 - 32.

Maximum transfer size

(Stream-based backups only) This option is the buffer size used by SQL Server for reading and writing backup images. Generally, you can get better SQL Server performance by using a larger value. This option can be set for each backup operation. Calculated as 64 KB * 2^MAX_TRANSFER_SIZE. It ranges in size from 64 KB to 4 MB. The default is 4 MB.

Parallel backup operations

This option is the number of backup operations to start simultaneously, per database instance. Range is 1 - 32. The default is 1.

VDI timeout (seconds)

Determines the time-out interval for SQL Server Virtual Device Interface. The selected interval is applied to backups and restores of databases and of transaction logs.

The default value for backups is 300. The default value for restore jobs is 600. Range is 300 - 2147483647.

Use Microsoft SQL Server compression

Enable this option to use SQL Server to compress the backup image. If you enable SQL Server compression, do not enable NetBackup compression.

SQL Server compression is not supported for snapshot backups.

Skip unavailable (offline, restoring, etc.) databases

NetBackup skips any database with a status that prevents NetBackup from successfully backing up the database. These statuses include offline, restoring, recovering, and emergency mode, etc.

NetBackup skips the backup of the unavailable database, but continues with the backup of the other databases that are subscribed to the protection plan. The backup completes with a status 0 and the job details indicate that the database was skipped.

Create copy-only backup

This option allows SQL Server to create an out-of-band backup so that it does not interfere with the normal backup sequence.

Perform Microsoft SQL Server checksum

Choose one of the following options for SQL Server backup checksums:

  • None. Disables the backup checksums.

  • To verify the checksums before the backup, choose one of the following options. Note that these options impose a performance penalty on a backup or restore operation.

    • Continue on error. If the backup encounters a verification error, the backup continues.

    • Fail on error. If the backup encounters a verification error, the backup stops.

Convert incremental backup to full backup

If no previous full backup exists for the database, then NetBackup converts a differential backup to a full backup.

The agent determines if a full backup exists for each database. If no previous full backup exists, a differential backup is converted to a full as follows:

  • If you select a database for a differential backup, the backup is converted to a full database backup.

  • For snapshot backup policies, a Full schedule must exist to successfully convert differential backups to full backups.

Note: NetBackup only converts a differential backup if a full backup was never performed on the database. If a full backup does not exist in the NetBackup catalog but SQL Server detects an existing full LSN, NetBackup performs a differential backup and not a full. In this situation, you can restore the full backup with native tools and any differentials with the NetBackup MS SQL Client. Or, if you expired the backup in NetBackup, you can import the full backups into the NetBackup catalog. Then you can restore both the full and the differential backups with the NetBackup MS SQL Client.

Convert transaction log backup to full backup

If no previous full backup exists for the database, then NetBackup converts a transaction backup to a full backup.

This option also detects if a full recovery database was switched to the simple recovery model and back to the full recovery model. In this scenario, the log chain is broken and SQL Server requires a differential backup before a subsequent log backup can be created. If NetBackup detects this situation, the backup is converted to a differential database backup.

Note: NetBackup only converts a transaction log backup if a full backup was never performed on the database. If a full backup does not exist in the NetBackup catalog but SQL Server detects an existing full LSN, NetBackup performs a transaction log backup and not a full. In this situation, you can restore the full backup with native tools and any differentials and log backups with the NetBackup MS SQL Client. Or, if the backup is expired, you can import the full backups into the NetBackup catalog. Then you can restore the full, differential, and log backups with the NetBackup MS SQL Client.

Availability database backup preference

This option determines where backups of availability groups occur. Ensure that you select a setting for databases and a setting for transaction logs.

  • None

    Perform the backup on the specified instance. Use this option when you intend to protect individual availability databases.

    Note: Do not select this option if you intend to protect availability groups.

  • Protect primary replica

    Backups always occur on the primary replica. This option applies to availability replicas and to instances that have both standard databases and availability databases.

  • Protect preferred replica

    Honors your SQL Server backup preferences. These preferences include the preferred replica, backup priority, and excluded replicas. Note that NetBackup initiates a backup job on each replica. The backup is skipped on any replica that isn't the intended backup source. This option applies to availability replicas and to instances that have both standard databases and availability databases,

  • Skip availability databases

    Skips any availability databases on the instance. Use this option when you intend to protect any instances that contain both standalone databases and availability databases and only want to protect the standalone databases.

    Note: Do not select this option if you intend to protect availability groups.

Backup preference for individual availability databases

Note the following behavior when you select a protection plan to protect individual availability databases.

  • If the preference for Databases is set to Skip availability databases, scheduled backups cannot succeed. Databases must have the setting None, Protect preferred replica, or Protect primary replica.

  • When a user selects Backup now to back up an availability database, the backup is performed on the selected node. The image is cataloged under the cluster name.

Truncate logs after backup

This option backs up the active part of the transaction log and then marks it inactive or empty. This option is enabled by default.