NetBackup™ Web UI Administrator's Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.3)
  1. Section I. About NetBackup
    1. Introducing NetBackup
      1.  
        About NetBackup
      2.  
        NetBackup documentation
      3.  
        NetBackup web UI features
      4.  
        NetBackup administration interfaces
      5.  
        Terminology
      6.  
        First-time sign in to the NetBackup web UI
      7.  
        Sign in to the NetBackup web UI
      8.  
        Sign out of the NetBackup web UI
      9.  
        Documentation for catalog recovery, disk pools, disk array hosts, and host properties in the NetBackup web UI
    2. Administering NetBackup licenses
      1.  
        About NetBackup licenses
      2.  
        Add licenses
      3.  
        View licenses
      4.  
        Renew licenses
      5.  
        Remove licenses
    3. Registering with Veritas Alta View
      1.  
        Register with Veritas Alta View
  2. Section II. Monitoring and notifications
    1. Monitoring NetBackup activity
      1.  
        The NetBackup dashboard
      2. Activity monitor
        1.  
          Monitor NetBackup daemons
        2.  
          Monitor NetBackup processes
      3. Job monitoring
        1.  
          Workloads that require a custom RBAC role for specific job permissions
        2.  
          View a job
        3.  
          View the jobs in the List view
        4.  
          View the jobs in the Hierarchy view
        5.  
          Jobs: cancel, suspend, restart, resume, delete
        6.  
          Search for or filter jobs in the jobs list
        7.  
          Create a jobs filter
        8.  
          Edit, copy, or delete a jobs filter
        9.  
          Import or export job filters
        10.  
          View the status of a redirected restore
        11. Troubleshooting the viewing and managing of jobs
          1.  
            Job actions not available for workload administrators with limited RBAC permissions on assets
    2. Device monitor
      1.  
        About the Device Monitor
      2.  
        About media mount errors
      3. About pending requests and actions
        1.  
          About pending requests for storage units
        2.  
          Resolve a pending request
        3.  
          Resolve a pending action
        4.  
          Resubmit a pending request
        5.  
          Deny a pending request
    3. Notifications
      1. Job notifications
        1. Send email notifications for job failures
          1.  
            Status codes that generate alerts
        2.  
          Send notifications to the backup administrator about failed backups
        3.  
          Send notifications to a host administrator about backups
        4.  
          Configure the nbmail.cmd script on the Windows hosts
      2. NetBackup event notifications
        1.  
          View notifications
        2.  
          Modify or disable NetBackup event notifications in the web UI
        3.  
          NetBackup event types supported with notifications
        4.  
          About configuring automatic notification cleanup tasks
  3. Section III. Configuring hosts
    1. Managing host properties
      1.  
        Overview of host properties
      2.  
        View or edit the host properties of a server or client
      3.  
        Host information and settings in Host properties
      4.  
        Reset a host's attributes
    2. Managing credentials for workloads and systems that NetBackup accesses
      1.  
        Overview of credential management in NetBackup
      2.  
        Add a credential in NetBackup
      3.  
        Add a credential for an external KMS
      4.  
        Add a credential for NetBackup Callhome Proxy
      5.  
        Edit or delete a named credential
      6. Add a credential for CyberArk
        1.  
          Certificate revocation lists for CyberArk server
      7.  
        Configure external credentials
      8.  
        Add a configuration for an external CMS server
      9.  
        Edit or delete the configuration for an external CMS server
      10.  
        Add a credential for Network Data Management Protocol (NDMP)
      11.  
        Edit or delete Network Data Management Protocol (NDMP) credentials in NetBackup
      12.  
        Troubleshooting the external CMS server issue
    3. Managing deployment
      1.  
        Managing the NetBackup Package repository
      2.  
        Update host
      3.  
        Deployment policies
  4. Section IV. Configuring storage
    1. Overview of storage options
      1.  
        About storage configuration
    2. Configuring storage units
      1.  
        Overview of storage units
      2.  
        Create a storage unit
      3.  
        Edit storage unit settings
      4.  
        Copy a storage unit
      5.  
        Delete a storage unit
      6.  
        About universal shares
      7. Create a universal share
        1.  
          Using instant access for MS-Windows and Standard policies
      8.  
        View or edit a universal share
      9.  
        Delete a universal share
    3. Configuring disk storage
      1.  
        About configuring BasicDisk storage
      2.  
        About configuring disk pool storage
      3.  
        Create a disk pool
      4.  
        Editing a disk pool
      5.  
        Create a Media Server Deduplication Pool (MSDP, MSDP Cloud) storage server
      6.  
        Editing a storage server
      7. Integrating MSDP Cloud and CMS
        1.  
          Migrating or upgrading MSDP Cloud and CMS
      8.  
        Create a Media Server Deduplication Pool (MSDP) storage server for image sharing
      9.  
        Create a AdvancedDisk, OpenStorage (OST), or Cloud Connector storage server
      10.  
        Using image sharing from the NetBackup web UI
    4. Managing media servers
      1.  
        Add a media server
      2.  
        Activate or deactivate a media server
      3.  
        Stop or restart the media manager device
      4.  
        About NetBackup server groups
      5.  
        Add a server group
      6.  
        Delete a server group
    5. Managing tape drives
      1.  
        Change a drive comment
      2.  
        About downed drives
      3.  
        Change a drive operating mode
      4.  
        Change a tape drive path
      5.  
        Change the operating mode for a drive path
      6.  
        Change tape drive properties
      7.  
        Change a tape drive to a shared drive
      8.  
        Clean a tape drive
      9.  
        Delete a drive
      10.  
        Reset a drive
      11.  
        Reset the mount time of a drive
      12.  
        Set the drive cleaning frequency
      13.  
        View drive details
    6. Staging backups
      1.  
        About staging backups
      2.  
        About basic disk staging
      3.  
        Create a BasicDisk storage unit with disk staging
      4.  
        Disk staging storage unit size and capacity
      5.  
        Finding potential free space on a BasicDisk disk staging storage unit
      6.  
        Schedule settings for disk staging
    7. Troubleshooting storage configuration
      1.  
        Registering a media server
      2.  
        Storage configuration issues
      3.  
        Troubleshooting universal share configuration issues
  5. Section V. Configuring backups
    1. Overview of backups in the NetBackup web UI
      1.  
        Backups methods supported in the NetBackup web UI
      2.  
        Protection plan vs. policy FAQs
      3.  
        Supported protection plan types
      4.  
        Support for NetBackup classic policies
    2. Managing protection plans
      1.  
        Create a protection plan
      2.  
        Customizing protection plans
      3.  
        Edit or delete a protection plan
      4.  
        Subscribe an asset or an asset group to a protection plan
      5.  
        Unsubscribe an asset from a protection plan
      6.  
        View protection plan overrides
      7.  
        About Backup Now
    3. Managing classic policies
      1.  
        Add a policy
      2.  
        Example policy - Exchange Server DAG backup
      3.  
        Example policy - Sharded MongoDB cluster
      4.  
        Edit, copy, or delete a policy
      5.  
        Deactivate or activate a policy
      6.  
        Edit or delete a client
      7.  
        Edit or delete a backup selection
      8.  
        Edit or delete a schedule
      9.  
        Perform manual backups
    4. Protecting the NetBackup catalog
      1.  
        About the NetBackup catalog
      2. Catalog backups
        1.  
          The catalog backup process
        2.  
          Prerequisites for backing up the NetBackup catalog
        3.  
          Configuring catalog backups
        4.  
          Backing up NetBackup catalogs manually
        5.  
          Concurrently running catalog backups with other backups
        6.  
          Catalog policy schedule considerations
        7.  
          How catalog incrementals and standard backups interact on UNIX
        8.  
          Determining whether or not a catalog backup succeeded
        9.  
          Strategies that ensure successful NetBackup catalog backups
      3.  
        Disaster recovery emails and the disaster recovery files
      4.  
        Disaster recovery packages
      5.  
        About disaster recovery settings
      6.  
        Setting the passphrase to encrypt disaster recovery packages
      7.  
        Recovering the catalog
    5. Managing backup images
      1.  
        About the Catalog utility
      2.  
        Catalog utility search criteria and backup image details
      3.  
        Verify backup images
      4.  
        Promote a copy to a primary copy
      5. Duplicate backup images
        1.  
          Multiplexed duplication considerations
        2.  
          Jobs that appear while making multiple copies
      6.  
        Expire backup images
      7. About importing backup images
        1.  
          About importing expired images
        2.  
          Import backup images, Phase I
        3.  
          Import backup images, Phase II
    6. Pausing data protection activity
      1.  
        Pause backups and other activity
      2.  
        Allow the automatic pause of data protection activity
      3.  
        Pause backups and other activity on a client
      4.  
        View paused backups and other paused activities
      5.  
        Resume data protection activity
  6. Section VI. 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
      4.  
        Send audit events to log forwarding endpoints
    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 host mappings
      1.  
        View host security and mapping information
      2.  
        Approve or add mappings for a host that has multiple host names
      3.  
        Example host mappings
      4.  
        Remove mappings for a host that has multiple host names
    4. Configuring multi-person authorization
      1.  
        About multi-person authorization
      2.  
        Workflow to configure multi-person authorization for NetBackup operations
      3.  
        RBAC roles and permissions for multi-person authorization
      4.  
        Multi-person authorization process with respect to roles
      5.  
        NetBackup operations that need multi-person authorization
      6.  
        Configure multi-person authorization
      7.  
        View multi-person authorization tickets
      8.  
        Manage multi-person authorization tickets
      9.  
        Add exempted users
      10.  
        Schedule expiration and purging of multi-person authorization tickets
      11.  
        Disable multi-person authorization
    5. Managing user sessions
      1.  
        Terminate 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. Configuring multi-factor authentication
      1.  
        About multi-factor authentication
      2.  
        Configure multi-factor authentication for your user account
      3.  
        Disable multi-factor authentication for your user account
      4.  
        Enforce multi-factor authentication for all users
      5.  
        Configure multi-factor authentication for your user account when it is enforced in the domain
      6.  
        Reset multi-factor authentication for a user
    7. Managing the global security settings for the primary server
      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.  
        Configure the global data-in-transit encryption setting
      5.  
        About NetBackup certificate deployment security levels
      6.  
        Select a security level for NetBackup certificate deployment
      7.  
        About TLS session resumption
      8.  
        Set a passphrase for disaster recovery
      9. About trusted primary servers
        1.  
          Add a trusted primary server
        2.  
          Remove a trusted primary server
    8. Using access keys, API keys, and access codes
      1.  
        Access keys
      2. API keys
        1.  
          Add an API key or view API key details (Administrators)
        2.  
          Edit, reissue, or delete an API key (Administrators)
        3.  
          Add an API key or view your API key details
        4.  
          Edit, reissue, or delete your API key
        5.  
          Use an API key with NetBackup REST APIs
      3. Access codes
        1.  
          Request CLI access through web UI authentication
        2.  
          Approve the CLI access request of another user
        3.  
          Edit the settings for command-line access
    9. Configuring authentication options
      1.  
        Sign-in options for the NetBackup web UI
      2. Configure user authentication with smart cards or digital certificates
        1.  
          Configure smart card authentication with a domain
        2.  
          Configure smart card authentication without a domain
        3.  
          Edit the configuration for smart card authentication
        4.  
          Add or delete a CA certificate that is used for smart card authentication
        5.  
          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
    10. Managing role-based access control
      1.  
        RBAC features
      2.  
        Authorized users
      3. Configuring RBAC
        1.  
          Notes for using NetBackup RBAC
        2.  
          Add AD or LDAP domains
        3.  
          View users in RBAC
        4.  
          Add a user to a role (non-SAML)
        5.  
          Add a smart card user to a role (non-SAML, without AD/LDAP)
        6.  
          Add a user to a role (SAML)
        7.  
          Remove a user from a role
      4.  
        Default RBAC roles
      5. Add a custom RBAC role
        1.  
          Edit or remove a role a custom role
        2.  
          Add a custom RBAC role to restore Azure-managed instances
        3.  
          Add a custom RBAC role for a PaaS administrator
        4.  
          Add a custom RBAC role for a Malware administrator
      6.  
        Role permissions
      7.  
        Manage access permission
      8.  
        View access definitions
    11. Disabling access to NetBackup interfaces for OS Administrators
      1.  
        Disable command-line (CLI) access for operating system (OS) administrators
      2.  
        Disable web UI access for operating system (OS) administrators
  7. Section VII. Detection and reporting
    1. Malware scanning
      1. About malware scanning
        1. Workflow for malware scanning
          1.  
            Malware scanning workflow for MSDP backup images
          2.  
            Malware scanning workflow for OST and AdvancedDisk
      2. Configurations
        1. Configuring scan host pool
          1.  
            Prerequisites for scan host pool
          2.  
            Configuring a new scan host pool
          3.  
            Add a new host in a scan host pool
        2. Managing scan host
          1.  
            Add an existing scan host
          2.  
            Remove the scan host
          3.  
            Deactivate the scan host
          4.  
            Managing credentials
        3.  
          Configure resource limits
      3. Perform a malware scan
        1.  
          Backup images
        2.  
          Assets by policy type
        3.  
          Assets by workload type
      4. Managing scan tasks
        1.  
          View the malware scan status
        2.  
          Actions for malware scanned images
        3.  
          Recover from malware-affected images (clients protected by policies)
        4.  
          Recover from malware-affected images (clients protected by protection plan)
    2. Detecting anomalies
      1. About backup anomaly detection
        1.  
          How a backup anomaly is detected
      2.  
        Configure backup anomaly detection settings
      3.  
        View backup anomalies
      4.  
        About system anomaly detection
      5.  
        Configure system anomaly detection settings
      6.  
        View system anomalies
    3. Usage reporting and capacity licensing
      1.  
        Track protected data size on your primary servers
      2.  
        Add a local primary server
      3.  
        Select license types to display in usage reporting
      4.  
        Scheduling reports for capacity licensing
      5.  
        Other configuration for incremental reporting
      6.  
        Troubleshooting failures for usage reporting and incremental reporting
  8. Section VIII. NetBackup workloads and NetBackup Flex Scale
    1. NetBackup SaaS Protection
      1.  
        Overview of NetBackup for SaaS
      2.  
        Adding NetBackup SaaS Protection Hubs
      3. Configuring the autodiscovery frequency
        1.  
          Proxy configuration for autodiscovery
      4.  
        Viewing asset details
      5.  
        Configuring permissions
      6.  
        Troubleshooting SaaS workload issues
    2. NetBackup Flex Scale
      1. Managing NetBackup Flex Scale
        1.  
          Access NetBackup from the Flex Scale infrastructure management console
        2.  
          Manage NetBackup and the NetBackup Flex Scale cluster management from the NetBackup Flex Scale web UI
        3.  
          Access NetBackup Flex Scale from the NetBackup web UI
    3. NetBackup workloads
      1.  
        Protection of other asset types and clients
  9. Section IX. Disaster recovery and troubleshooting
    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.  
          Configure a third-party CA certificate
        3.  
          Edit or delete a Resiliency Platform
        4.  
          View the automated or not-automated VMs
      4.  
        Troubleshooting NetBackup and Resiliency Platform issues
    2. Managing Bare Metal Restore (BMR)
      1.  
        About Bare Metal Restore (BMR)
      2.  
        Add a custom role for a Bare Metal Restore (BMR) administrator
    3. 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 validate the user or group when configuring LDAP server
  10. Section X. Other topics
    1. Additional NetBackup catalog information
      1. Parts of the NetBackup catalog
        1. NetBackup databases and configuration files
          1.  
            About the Enterprise Media Manager (EMM)
        2. About the NetBackup image database
          1.  
            About NetBackup image .f files
        3.  
          About the catalog backup of cloud configuration files
      2. Archiving the catalog and restoring from the catalog archive
        1.  
          Enabling intelligent catalog archiving (ICA) to reduce the number of .f files
        2.  
          Creating a catalog archiving policy
        3.  
          Catalog archiving commands
        4.  
          Catalog archiving considerations
        5.  
          Extracting images from the catalog archives
      3. Estimating catalog space requirements
        1.  
          NetBackup file size considerations on UNIX systems
        2.  
          Moving the image catalog
        3. About image catalog compression
          1.  
            Uncompressing the NetBackup catalog
    2. About the NetBackup database
      1. About the NetBackup database installation
        1. About NetBackup primary server installed directories and files
          1.  
            About the bin directory
          2.  
            About the contents of the NetBackupDB and db directories
          3.  
            About the data directory
          4.  
            vxdbms.conf
        2.  
          NetBackup configuration entry
        3.  
          NetBackup database server management
        4.  
          The NetBackup database and clustered environments
      2. Post-installation tasks
        1.  
          Changing the NetBackup database password
        2.  
          Moving a database after installation
        3.  
          Copying the NetBackup databases
        4. Creating the NBDB database manually
          1.  
            Additional create_nbdb options
      3. Using the NetBackup Database Administration utility on Windows
          1.  
            About fragmentation
          1.  
            Changing the DBA password using the NetBackup Database Administration utility
          2.  
            Moving a NetBackup database
          3.  
            Exporting database schema and data
          4.  
            Copying or backing up a database
          5.  
            Restoring a database from a backup
      4. Using the NetBackup Database Administration utility on UNIX
        1.  
          Select/Restart Database and Change Password menu options
        2.  
          Database Space Management menu options
        3.  
          Database Validation Check and Rebuild menu options
        4.  
          Move Database menu options
        5.  
          Unload Database menu options
        6.  
          Backup and Restore Database menu options

Add an API key or view your API key details

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

Add an API key

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

To add an API key

  1. If your API key has expired you can reissue the key.

    See Reissue your API key after it expires.

  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.

  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 and close.

    Store this key in a safe place. After you click Copy and 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.

 

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.