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

About NetBackup auditing

Auditing is enabled by default in new installations. NetBackup auditing can be configured directly on a NetBackup master 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 master 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.

Asset actions

Deleting an asset, such as a vCenter server, as part of the asset cleanup process with the Asset Database API 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 master 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 host database-related operations.

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.

To set an interval to periodically add audit records of the browse image (bplist) operations from the cache into the NetBackup database, use the DATAACCESS_AUDIT_INTERVAL_HOURS configuration option. Setting this configuration option prevents the NetBackup database size from increasing exponentially because of the bplist audit records.

See the NetBackup Administrator's Guide Volume I.

To add all the bplist audit records from the cache into the NetBackup database, run the following command on the master server:

nbcertcmd -postAudit -dataAccess

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 Administration Console 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 (Administration Console) and in the Jobs (web UI).

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 using the bpsetconfig or the nbsetconfig commands, or the equivalent property in the Host Properties utility, are not audited. Changes that are made directly to the bp.conf file or to the registry are not audited.