NetBackup™ Web UI Administrator's Guide

Last Published:
Product(s): NetBackup (10.1.1)
  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 Wizard, disk array hosts, disk pools, and Host Properties in the NetBackup web UI
  2. Section I. Monitoring and notifications
    1. Monitoring NetBackup activity
      1.  
        The NetBackup dashboard
      2. Activity monitor
        1.  
          View 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.  
          Troubleshooting the viewing of jobs
    2. 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.  
          About configuring automatic notification cleanup tasks
  3. Section II. Configuring hosts
    1. Managing host properties
      1.  
        Overview of host properties
      2.  
        View or edit the host properties of a server or client
      3.  
        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 Network Data Management Protocol (NDMP)
      7.  
        Edit or delete Network Data Management Protocol (NDMP) credentials in NetBackup
    3. Managing deployment
      1.  
        Managing the NetBackup Package repository
      2.  
        Update host
      3.  
        Deployment policies
  4. Section III. Configuring storage
    1. Overview of storage options
      1.  
        About storage configuration
    2. Configuring storage servers
      1.  
        Create a Cloud storage, OpenStorage, or AdvancedDisk storage server
      2.  
        Create a Media Server Deduplication Pool (MSDP) storage server
      3.  
        Create a Media Server Deduplication Pool (MSDP) storage server for image sharing
      4.  
        Using image sharing from the NetBackup web UI
    3. Configuring disk storage
      1.  
        About configuring BasicDisk storage
      2.  
        About configuring disk pool storage
      3.  
        Create a disk pool
    4. Configuring storage units
      1.  
        Overview of storage units
      2.  
        Create a storage unit
      3.  
        Edit or copy a storage unit
      4.  
        Delete a storage unit
    5. Configuring universal shares
      1. Create a universal share
        1.  
          Using instant access for MS-Windows and Standard policies
    6. Configuring server groups
      1.  
        About NetBackup server groups
      2.  
        Add a server group
      3.  
        Delete a server group
    7. Troubleshooting storage configuration
      1.  
        Troubleshooting storage configuration
      2.  
        Troubleshooting universal share configuration issues
  5. Section IV. 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. Managing backup images
      1.  
        About the NetBackup catalog
      2.  
        Search for backup images
    5. 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 V. 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 host mappings
      1.  
        View host security and mapping 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. 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 the 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
    6. 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.  
          Get CLI access through web UI authentication
        2.  
          Approve your CLI access request
        3.  
          Approve CLI access requests of other users
        4.  
          Edit access settings
    7. 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 domain
        2.  
          Configure smart card authentication without 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
    8. 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
        8.  
          Disable web UI access for operating system (OS) administrators
        9.  
          Disable command-line (CLI) access for operating system (OS) administrators
      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
      6.  
        Role permissions
      7.  
        Manage access permission
      8.  
        View access definitions
  7. Section VI. Detection and reporting
    1. Detecting malware
      1.  
        About malware detection
      2.  
        Configure a new scan host pool
      3.  
        Add an existing scan host
      4.  
        Manage credentials
      5.  
        Remove the scan host
      6.  
        Deactivate the scan host
      7.  
        Scan a policy client backup images for malware
      8.  
        Perform malware scanning
      9.  
        Scan a VMware asset for malware
      10.  
        View the malware scan status
      11.  
        Actions for malware scanned images
      12.  
        Recover from malware-affected images (clients protected by policies)
      13.  
        Recover a VMware asset affected by malware
      14.  
        Troubleshooting
    2. Detecting anomalies
      1.  
        About backup anomaly detection
      2.  
        How a backup anomaly is detected
      3.  
        View anomalies
      4.  
        Configure anomaly detection settings
    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 VII. 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 VIII. 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

About NetBackup auditing

Auditing is enabled by default in new installations. NetBackup auditing can be configured directly on a NetBackup primary server.

Auditing of NetBackup operations provides the following benefits:

  • Customers can gain insight from audit trails while they investigate unexpected changes in a NetBackup environment.

  • Regulatory compliance.

    The record complies with guidelines such as those required by the Sarbanes-Oxley Act (SOX).

  • A method for customers to adhere to internal change management policies.

  • Help for NetBackup Support in troubleshooting problems for customers.

About the NetBackup Audit Manager

The NetBackup Audit Manager (nbaudit) runs on the primary server and audit records are maintained in the Enterprise Media Manager (EMM) database.

An administrator can search specifically for:

  • When an action occurred

  • Failed actions in certain situations

  • The actions that a specific user performed

  • The actions that were performed in a specific content area

  • Changes to the audit configuration

Note the following:

  • The audit record truncates any entries greater than 4096 characters. (For example, policy name.)

  • The audit record truncates any restore image IDs greater than 1024 characters.

Actions that NetBackup audits

NetBackup records the following user-initiated actions.

Activity monitor actions

Canceling, suspending, resuming, restarting, or deleting any type of job creates an audit record.

Alerts and email notifications

If an alert cannot be generated or an email notification cannot be sent for NetBackup configuration settings. For example, SMTP server configuration and the list of excluded status codes for alerts.

Anomalies

When a user reports an anomaly as false positive, the action is audited and logged for that user.

Asset actions

Deleting an asset, such as a vCenter server, as part of the asset cleanup process is audited and logged.

Creating, modifying, or deleting an asset group as well any action on an asset group for which a user is not authorized is audited and logged.

Authorization failure

Authorization failure is audited when you use the NetBackup web UI, the NetBackup APIs, or Enhanced Auditing.

Catalog information

This information includes:

  • Verifying and expiring images.

  • Read the requests that are sent for the front-end usage data.

Certificate management

Creating, revoking, renewing, and deploying of NetBackup certificates and specific NetBackup certificate failures.

Certificate Verification Failures (CVFs)

Any failed connection attempts that involve SSL handshake errors, revoked certificates, or host name validation failures.

For certificate verification failures (CVFs) that involve SSL handshakes and revoked certificates, the timestamp indicates when the audit record is posted to the primary server. (Rather than when an individual certificate verification fails.) A CVF audit record represents a group of CVF events over a time period. The record details provide the start and the end times of the time period as well as the total number of CVFs that occurred in that period.

Disk pools and Volume pools actions

Adding, deleting, or updating disk or volume pools.

Hold operations

Creating, modifying, and deleting hold operations.

Host database

NetBackup operations that are related to the host database.

Logon attempts

Any successful or any failed logon attempts for the NetBackup Administration Console, the NetBackup web UI or the NetBackup APIs.

Policies actions

Adding, deleting, or updating policy attributes, clients, schedules, and backup selections lists.

Restore and browse image user actions

All the restore and browse image content (bplist) operations that a user performs are audited with the user identity.

Security configuration

Information that is related to changes that are made to the security configuration settings.

Starting a restore job

NetBackup does not audit when other types of jobs begin. For example, NetBackup does not audit when a backup job begins.

Starting and stopping the NetBackup Audit Manager (nbaudit).

Starting and stopping of the nbaudit manager is always audited, even if auditing is disabled.

Storage lifecycle policy actions

Attempts to create, modify, or delete a storage lifecycle policy (SLP) are audited and logged. However, activating and suspending an SLP using the command nbstlutil are not audited. These operations are audited only when they are initiated from a NetBackup graphical user interface or API.

Storage servers actions

Adding, deleting, or updating storage servers.

Storage units actions

Adding, deleting, or updating storage units.

Note:

Actions that are related to storage lifecycle policies are not audited.

Token management

Creating, deleting, and cleanup of tokens and specific token issuing failures.

User management

Adding and deleting Enhanced Auditing users in the Enhanced Auditing mode.

User action that fails to create an audit record

If auditing is enabled but a user action fails to create an audit record, the audit failure is captured in the nbaudit log. NetBackup status code 108 is returned (Action succeeded but auditing failed). The NetBackup does not return an exit status code 108 when auditing fails.

Actions that NetBackup does not audit

The following actions are not audited and do not display in the audit report:

Any failed actions.

NetBackup logs failed actions in NetBackup error logs. Failed actions do not display in audit reports because a failed attempt does not bring about a change in the NetBackup system state.

The effect of a configuration change

The results of a change to the NetBackup configuration are not audited. For example, the creation of a policy is audited, but the jobs that result from its creation are not.

The completion status of a manually initiated restore job

While the act of initiating a restore job is audited, the completion status of the job is not audited. Nor is the completion status of any other job type, whether initiated manually or not. The completion status is displayed in the Activity Monitor.

Internally initiated actions

NetBackup-initiated internal actions are not audited. For example, the scheduled deletion of expired images, scheduled backups, or periodic image database cleanup is not audited.

Rollback operations

Some operations are carried out as multiple steps. For example, creating an MSDP-based storage server consists of multiple steps. Every successful step is audited. Failure in any of the steps results in a rollback, or rather, the successful steps may need to be undone. The audit record does not contain details about rollback operations.

Host properties actions

Changes made with the bpsetconfig or the nbsetconfig commands, or the equivalent property in host properties, are not audited. Changes that are made directly to the bp.conf file or to the registry are not audited.