NetBackup™ Web UI Administrator's Guide

Last Published:
Product(s): NetBackup (9.0.0.1, 9.0)
  1. Introducing the NetBackup web user interface
    1.  
      About the NetBackup web UI
    2.  
      Terminology
    3.  
      Sign in to the NetBackup web UI
    4.  
      Sign out of the NetBackup web UI
  2. Section I. Monitoring and notifications
    1. Monitoring NetBackup
      1.  
        The NetBackup dashboard
    2. Managing jobs
      1.  
        Monitoring jobs
      2.  
        Jobs: canceling, suspending, restarting, resuming, deleting
      3.  
        Filter jobs in the job list
    3. Notifications
      1.  
        About notifications
      2.  
        Viewing notifications
      3.  
        Modify or disable NetBackup event notifications in the web UI
      4.  
        About configuring automatic notification cleanup tasks
      5. Send email notifications for job failures
        1.  
          Status codes that generate alerts
  3. Section II. Managing security
    1. Managing role-based access control
      1.  
        First-time sign in to a NetBackup master server from the NetBackup web UI
      2.  
        Authorized users
      3.  
        About role-based access control (RBAC) in NetBackup
      4. Configuring RBAC
        1.  
          Add AD or LDAP domains
        2.  
          Default RBAC roles
        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
      5. Role permissions
        1. Global > NetBackup management
          1.  
            NetBackup Web Management Console Administration
          2.  
            Access hosts
          3.  
            Data classification
          4.  
            Email notifications
          5.  
            Event logs
          6.  
            NetBackup hosts
          7.  
            Image sharing
          8.  
            NetBackup backup images
          9.  
            Jobs
          10.  
            Licensing
          11.  
            Media server
          12.  
            Remote master server certificate authority
          13.  
            Resiliency
          14.  
            Resource limits
          15.  
            Retention levels
          16.  
            Servers > Trusted master servers
          17.  
            Cloud providers
          18.  
            CloudPoint servers
          19.  
            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.  
            Passphrase constraints
          8.  
            Global security settings
          9.  
            Trust versions
          10.  
            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.  
            Tape media
          7.  
            Replication-capable target storage servers
        5.  
          Assets
        6.  
          Protection plans
        7.  
          Credentials
      6. Manage access
        1.  
          Manage the permissions for an area of the web UI
        2.  
          View access definitions
      7. 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
    2. 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
    3. 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
    4. 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
    5. 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
    6. Creating and managing API keys for users (Administrators)
      1.  
        About API keys
      2.  
        Add an API key or view API key details
      3.  
        Edit or delete API keys
    7. Adding and managing your API key (Users)
      1.  
        Add an API key or view your API key details
      2.  
        Edit or delete your API key
      3.  
        Use an API key with NetBackup REST APIs
    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.  
          Video: Configure Single Sign-On in NetBackup
      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
  4. 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 (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
      10.  
        Creating a cloud recovery host 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
      7.  
        About a NetBackup classic policy
      8.  
        About policy management in the NetBackup web UI
    3. 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
  5. 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
  6. Section V. Managing credentials
    1. Managing credentials
      1.  
        About credential management in NetBackup
      2.  
        Add a credential in NetBackup
      3.  
        Edit a credential
      4.  
        Delete a credential
  7. 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

Add an API key or view your API key details

As NetBackup web UI user you can use the web UI to add or view the details for your own API key.

Add an API key

You can create an API key to authenticate your NetBackup user account when using NetBackup RESTful APIs.

To add an API key

  1. For non-SAML users, if your API key has expired you must first delete that key.
  2. On the top right, click the profile icon and click Add API key.
  3. (Non-SAML users) Indicate how long you want the API key to be valid, from today's date.

    NetBackup calculates the expiration date and displays it below.

  4. (SAML users) After NetBackup validates the token from the SAML session, then the expiration date for the API key can be determined.
  5. Click Add.
  6. To copy the API key, click Copy to clipboard.

    Store this key in a safe place. After you click Close, the key cannot be retrieved again. If this API key replaces a previous key for your account, you must update any scripts, etc. to reflect the new API key.

  7. Click Close.

 

View your API key details

To view your API key details

  • On the top right, click the profile icon and select View my API key details.