NetBackup™ Web UI Administrator's Guide

Last Published:
Product(s): NetBackup (9.1)
  1. Introducing the NetBackup web user interface
    1.  
      About the NetBackup web UI
    2.  
      Terminology
    3.  
      First-time sign in to a NetBackup primary server from the NetBackup web UI
    4.  
      Sign in to the NetBackup web UI
    5.  
      Sign out of the NetBackup web UI
  2. Monitoring NetBackup
    1.  
      The NetBackup dashboard
    2.  
      Monitoring jobs
    3.  
      Jobs: canceling, suspending, restarting, resuming, deleting
    4.  
      Filter jobs in the job list
  3. Notifications
    1. About notifications
      1.  
        View notifications
      2.  
        Modify or disable NetBackup event notifications in the web UI
      3.  
        About configuring automatic notification cleanup tasks
    2. About backup anomaly detection
      1.  
        How a backup anomaly is detected
      2.  
        View anomalies
    3. Send email notifications for job failures
      1.  
        Status codes that generate alerts
  4. Section I. Managing role-based access control
    1. About role-based access control in NetBackup
      1.  
        RBAC features
      2.  
        Authorized users
    2. Configuring RBAC roles
      1. Configuring RBAC
        1.  
          Notes for using NetBackup RBAC
        2.  
          Add AD or LDAP domains
        3.  
          Add a custom RBAC role
        4.  
          Edit or remove a role a custom role
        5.  
          View users in RBAC
        6.  
          Add a user to a role (non-SAML)
        7.  
          Add a user to a role (SAML)
        8.  
          Remove a user from a role
      2. Default RBAC roles
        1.  
          Administrator
        2.  
          Default AHV Administrator
        3.  
          Default Cloud Administrator
        4.  
          Default Kubernetes Administrator
        5.  
          Default NetBackup Kubernetes Operator Service
        6.  
          Default RHV Administrator
        7.  
          Default Resiliency Administrator
        8.  
          Default Microsoft SQL Server Administrator
        9.  
          Default Security Administrator
        10.  
          Default Storage Administrator
        11.  
          Default VMware Administrator
    3. RBAC permissions
      1.  
        About role permissions
      2. Global > NetBackup management
        1.  
          NetBackup Web Management Console Administration
        2.  
          Access hosts
        3.  
          Agentless hosts
        4.  
          Anomalies
        5.  
          Data classifications
        6.  
          Email notifications
        7.  
          Event logs
        8.  
          NetBackup hosts
        9.  
          Image sharing
        10.  
          NetBackup backup images
        11.  
          Jobs
        12.  
          Licensing
        13.  
          Media server
        14.  
          Remote primary server certificate authority
        15.  
          Resiliency
        16.  
          Resource limits
        17.  
          Retention levels
        18.  
          Servers > Trusted primary servers
        19.  
          Cloud providers
        20.  
          CloudPoint servers
        21.  
          WebSocket servers
      3.  
        Global > Protection
      4. Global > Security
        1.  
          Access control
        2.  
          Security events
        3.  
          Certificate management
        4.  
          Disaster recovery passphrase
        5.  
          Identity provider and SAML certificate configuration
        6.  
          Key Management Services (KMS)
        7.  
          Passphrase constraints
        8.  
          Global security settings
        9.  
          Trust versions
        10.  
          API keys
        11.  
          User certificates
        12.  
          User sessions and authentication
      5. Global > Storage
        1.  
          Cloud storage
        2.  
          Disk pools
        3.  
          Storage Key Management Services
        4.  
          Storage servers
        5.  
          Storage units
        6.  
          Tape media
        7.  
          Replication-capable target storage servers
      6. Assets
        1.  
          AHV assets
        2.  
          Cloud assets
        3.  
          Kubernetes assets
        4.  
          Microsoft SQL Server assets
        5.  
          OpenStack servers
        6.  
          RHV assets
        7.  
          Universal shares
        8.  
          VMware assets
        9.  
          Windows and Standard client types
      7.  
        Protection plans
      8.  
        Credentials
      9. Manage access
        1.  
          Remove a role that has access to an area of the web UI
        2.  
          View access definitions
  5. Section II. Managing security
    1. 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
    2. 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.  
          Configure an external certificate for the NetBackup web server
        2.  
          Remove the external certificate configured for the web server
        3.  
          Update or renew the external certificate for the web server
        4.  
          View external certificate information for the NetBackup hosts in the domain
    3. 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
    4. 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 primary servers
        1.  
          Add a trusted primary server
        2.  
          Remove a trusted primary server
    5. Creating and managing API keys for users (Administrators)
      1.  
        About API keys
      2.  
        Add an API key or view API key details
      3.  
        Edit, reissue, or delete an API key
    6. Adding and managing your API key (Users)
      1.  
        Add an API key or view your API key details
      2.  
        Edit, reissue, or delete your API key
      3.  
        Use an API key with NetBackup REST APIs
    7. 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 SAML KeyStore
        2.  
          Configure the SAML keystore and add and enable the IDP configuration
        3.  
          Enroll the NetBackup primary server with the IDP
        4.  
          Manage an IDP configuration
        5.  
          Video: Configure Single Sign-On in NetBackup
      5. Troubleshooting SSO
        1.  
          Redirection issues
        2.  
          Unable to sign in due to authorization-related issues
    8. 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
  6. Section III. 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 storage, 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
      10.  
        Create a Media Server Deduplication Pool (MSDP) storage server for image sharing
    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
    3. Managing classic policies
      1.  
        About a NetBackup classic policy
      2.  
        About policy management in the NetBackup web UI
    4. Usage reporting and capacity licensing
      1.  
        Track backup data size on your primary 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 usage reporting and incremental reporting
  7. Section IV. 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
  8. Section V. Credentials
    1. Managing credentials
      1.  
        About credential management in NetBackup
      2.  
        Viewing credentials
      3.  
        Add a credential in NetBackup
      4.  
        Edit a credential
      5.  
        Delete a credential
      6.  
        Add Network Data Management Protocol (NDMP) credentials in NetBackup
      7.  
        Edit or delete Network Data Management Protocol (NDMP) credentials in NetBackup
  9. Troubleshooting the NetBackup 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

About configuring automatic notification cleanup tasks

By default, NetBackup runs event notification cleanup tasks every 4 hours. Up to 10,000 event records are stored for up to 3 days in the event database. During the cleanup tasks, NetBackup removes the older notifications from the database.

You can change how often the cleanup tasks run, how many event records are kept at one time, and the number of days a record is retained.

From a command line, use bpsetconfig or bpgetconfig to change the parameter values listed in Table: Configurable parameters for automatic notification cleanup tasks. See the NetBackup Command Reference Guide for more information about these commands.

You can also change the parameter values with the following APIs:

  • GET/config/hosts/{hostId}/configurations

  • POST/config/hosts/{hostId}/configurations

  • GET/config/hosts/{hostId}/configurations/configurationName (for a specific property)

  • PUT/config/hosts/{hostId}/configurations/configurationName

  • DELETE/config/hosts/{hostId}/configurations/configurationName

See the NetBackup 9.1 API Reference on SORT for more information about these APIs.

Table: Configurable parameters for automatic notification cleanup tasks

Parameter and description

Minimum value

Default value

Maximum value

EVENT_LOG_NOTIFICATIONS_COUNT

The maximum number of records that are stored, after which the cleanup process removes the oldest record, overriding the retention value.

1000

10000

100000

EVENT_LOG_NOTIFICATIONS_RETENTION_IN_HOURS

The number of hours for which the events are stored in the database.

24 (hours)

72 (hours)

168 (hours)

EVENT_LOG_NOTIFICATIONS_CLEANUP_INTERVAL_IN_HOURS

The frequency at which the event cleanup service runs.

1 (hour)

4 (hours)

24 (hours)