NetBackup™ Web UI

Backup Administrator’s
Guide

Release 8.2
NetBackup Web UI Backup Administrator’s Guide
Last updated: 2019-06-28

Legal Notice
Copyright © 2019 Veritas Technologies LLC. All rights reserved.

Veritas, the Veritas Logo, and NetBackup are trademarks or registered trademarks of Veritas
Technologies LLC or its affiliates in the U.S. and other countries. Other names may be
trademarks of their respective owners.

This product may contain third-party software for which Veritas is required to provide attribution
to the third party (“Third-party Programs”). Some of the Third-party Programs are available
under open source or free software licenses. The License Agreement accompanying the
Software does not alter any rights or obligations you may have under those open source or
free software licenses. Refer to the Third-party Legal Notices document accompanying this
Veritas product or available at:

https://www.veritas.com/about/legal/license-agreements

The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be
reproduced in any form by any means without prior written authorization of Veritas Technologies
LLC and its licensors, if any.

THE DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED

CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED
WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH
DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. VERITAS TECHNOLOGIES LLC
SHALL NOT BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN
CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS
DOCUMENTATION. THE INFORMATION CONTAINED IN THIS DOCUMENTATION IS
SUBJECT TO CHANGE WITHOUT NOTICE.

The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq.
"Commercial Computer Software and Commercial Computer Software Documentation," as
applicable, and any successor regulations, whether delivered by Veritas as on premises or
hosted services. Any use, modification, reproduction release, performance, display or disclosure
of the Licensed Software and Documentation by the U.S. Government shall be solely in
accordance with the terms of this Agreement.

Veritas Technologies LLC

2625 Augustine Drive
Santa Clara, CA 95054

http://www.veritas.com
Technical Support
Technical Support maintains support centers globally. All support services will be delivered
in accordance with your support agreement and the then-current enterprise technical support
policies. For information about our support offerings and how to contact Technical Support,
visit our website:

https://www.veritas.com/support

You can manage your Veritas account information at the following URL:

https://my.veritas.com

If you have questions regarding an existing support agreement, please email the support
agreement administration team for your region as follows:

Worldwide (except Japan) [email protected]

Japan [email protected]

Documentation
Make sure that you have the current version of the documentation. Each document displays
the date of the last update on page 2. The latest documentation is available on the Veritas
website:

https://sort.veritas.com/documents

Documentation feedback
Your feedback is important to us. Suggest improvements or report errors or omissions to the
documentation. Include the document title, document version, chapter title, and section title
of the text on which you are reporting. Send feedback to:

[email protected]

You can also see documentation information or ask a question on the Veritas community site:

http://www.veritas.com/community/

Veritas Services and Operations Readiness Tools (SORT)

Veritas Services and Operations Readiness Tools (SORT) is a website that provides information
and tools to automate and simplify certain time-consuming administrative tasks. Depending
on the product, SORT helps you prepare for installations and upgrades, identify risks in your
datacenters, and improve operational efficiency. To see what services and tools SORT provides
for your product, see the data sheet:

https://sort.veritas.com/data/support/SORT_Data_Sheet.pdf
 Contents

Chapter 1 Introducing the NetBackup web user interface

............................................................................................. 6

About the NetBackup web user interface ............................................. 6

Terminology .................................................................................. 8
Sign in to the NetBackup web UI ..................................................... 10
The NetBackup dashboard ............................................................. 11

Chapter 2 Managing protection plans ............................................. 12

Create a protection plan ................................................................. 12

Edit or delete a protection plan ........................................................ 16
Subscribe an asset or an asset group to a protection plan ..................... 17
Unsubscribe an asset from a protection plan ...................................... 18
About a NetBackup classic policy .................................................... 18

Chapter 3 Managing jobs .................................................................... 20

Monitoring jobs ............................................................................ 20

Jobs: canceling, suspending, restarting, resuming, deleting ................... 21
Filter jobs in the job list .................................................................. 21

Chapter 4 Configuring email notifications for alerts .................... 23

About NetBackup alerts ................................................................. 23

How to configure email notifications for alerts ..................................... 24
Prerequisites for using alerts and notifications .................................... 24
About the status codes supported for alerts ....................................... 25
Configure alert and notification settings ............................................. 25

Chapter 5 Usage reporting and capacity licensing ...................... 28

Track backup data size on your master servers .................................. 28
Adding a trusted master server using NetBackup CA-signed (host
ID-based) certificate ................................................................ 29
Configure the servers list for usage reporting ..................................... 32
Scheduling reports for capacity licensing ........................................... 32
Other configuration for incremental reporting ...................................... 35
 Contents 5

Troubleshooting failures for nbdeployutil and incremental reporting

........................................................................................... 37
 Chapter 1
Introducing the NetBackup
web user interface
This chapter includes the following topics:

■ About the NetBackup web user interface

■ Terminology

■ Sign in to the NetBackup web UI

■ The NetBackup dashboard

About the NetBackup web user interface

The NetBackup web user interface provides the following features:
■ Ability to access the master server from a web browser, including Chrome and
Firefox.
For details on supported browsers for the web UI, see the NetBackup Software
Compatibility List.
■ A dashboard that displays a quick overview of the information that is important
to you.
■ Role-based access control (RBAC) that lets the administrator configure user
access to NetBackup and to delegate the tasks that are related to security,
backup management, or workload protection.
■ NetBackup security administrators can manage NetBackup security, certificates,
RBAC, API keys, user sessions, and locked NetBackup user accounts.
■ Backup administrators provide protection services to satisfy their service level
objectives (SLOs). Protection of assets is achieved through protection plans,
job management, and visibility of the protection status of assets.
 Introducing the NetBackup web user interface 7
About the NetBackup web user interface

■ Workload administrators can subscribe assets to the protection plans that meet
the SLO, monitor protection status, and perform self-service recovery of virtual
machines. The web UI supports the following workloads:
■ Cloud
■ Red Hat Virtualization (RHV)
■ VMware

■ Usage reporting tracks the size of backup data on your master servers. You
can also easily connect to Veritas Smart Meter to view and manage NetBackup
licensing.

Access control in the NetBackup web UI

NetBackup uses role-based access control to grant access to the web UI. This
access control includes the tasks a user can perform and the assets the user can
view and manage. Access control is accomplished through access rules.
■ Access rules associate a user or a user group with a role and an object group.
The role defines the permissions a user has. An object group defines the assets
and NetBackup objects a user can access. Multiple access rules can be created
for a single user or group, allowing for full and flexible customization of user
access.
■ NetBackup comes with three default roles. Choose the role that best fits a user’s
needs or create a custom role to meet the requirements for that user.
■ Use object groups to define groups of assets or application servers or to indicate
the protection plans that users can view or manage. For example, you can grant
access for VMware administrators by creating an object group with specific
VMware application servers. Also add to the object group the specific protection
plans that the VMware administrator can choose to protect VMware assets.
■ RBAC is only available for the web UI and the APIs.
Other access control methods for NetBackup are not supported for the web UI
and APIs, with the exception of Enhanced Auditing (EA). You cannot use the
web UI if you have NetBackup Access Control (NBAC) enabled.

Monitor NetBackup jobs and events

The NetBackup web UI lets the security and the backup administrators more easily
monitor NetBackup operations and events and identify any issues that need
attention.
■ For a NetBackup security administrator, the dashboard lets the administrator
see the status of security certificates and of audit events.
 Introducing the NetBackup web user interface 8
Terminology

■ For a backup administrator, the dashboard allows the administrator to see the
status of NetBackup jobs. Email notifications can also be configured so they
receive notifications when job failures occur. NetBackup supports any ticketing
system that can receive inbound email.

Protection plans: One place to configure schedules,

storage, and storage options
Protection plans offer the following benefits:
■ In addition to schedules for backups, a protection plan can also include a
schedule for replication and long-term retention.
■ You can easily choose either on-premises or snapshot storage.
■ When you select from your available storage, you can see any additional features
available for that storage.
■ The backup administrator creates and manages protection plans and is therefore
responsible for backup schedules and storage.
■ The workload administrator primarily selects the protection plans to use to protect
assets or intelligent groups. However, the backup administrator can also
subscribe assets to protection plans if needed.

Self-service recovery

Terminology
The following table describes the concepts and terms that are introduced with the
new web user interface.

Table 1-1 Web user interface terminology and concepts

Term Definition

Access rule For RBAC, defines a user or a user group, the role or permissions,
and the object group that the user or the user group can access.
A user or group can have multiple access rules.

Administrator A user that has complete access and permissions to NetBackup

and all of the interfaces, including the NetBackup web UI. The
root, administrator, and Enhanced Auditing user all have complete
access to NetBackup. In the NetBackup Web UI guides, the term
NetBackup administrator also refers to a user that has full
permissions for NetBackup, usually in reference to a user of the
NetBackup Administration Console.

Also see Role.

 Introducing the NetBackup web user interface 9
Terminology

Table 1-1 Web user interface terminology and concepts (continued)

Term Definition

Asset group See intelligent group.

Asset The data to be protected, such as physical clients, virtual

machines, and database applications.

Classic policy In the NetBackup web UI, indicates that a legacy policy protects
the asset. Legacy policies are created with the NetBackup
Administration Console.

External certificate A security certificate issued from any CA other than NetBackup.

Intelligent group Allows NetBackup to automatically select assets for protection

based on the criteria (queries) that you specify. An intelligent
group automatically stays up-to-date with changes in the
production environment. These groups are also referred to as
asset groups.

For VMware and RHV, these groups appear under the tab
Intelligent VM groups.

Object group For RBAC, a collection of assets, protection plans, servers, and
other resources that the user is granted access to.

NetBackup certificate A security certificate issued from the NetBackup CA.

Protection plan A protection plan defines when backups are performed, how long
the backups are retained, and the type of storage to use. Once
a protection plan is set up, assets can be subscribed to the
protection plan.

RBAC Role-based access control. Administrators can delegate or limit

access to the NetBackup web UI through the access rules that
are configured in RBAC.

Note: The rules that you configure in RBAC do not control access
to the NetBackup Administration Console or the CLIs. The web
UI is not supported with NetBackup Access Control (NBAC) and
cannot be used if NBAC is enabled.

Role For RBAC, defines the permissions that a user can have.
NetBackup has three system-defined roles that allow a user to
manage security, protection plans and backups, or to manage
workload assets.

Storage The storage to which the data is backed up, replicated, or

duplicated (for long-term retention). Snapshot storage is used for
Cloud workloads.
 Introducing the NetBackup web user interface 10
Sign in to the NetBackup web UI

Table 1-1 Web user interface terminology and concepts (continued)

Term Definition

Subscribe, to a protection The action of selecting a protection plan to protect an asset or

plan an asset group. The asset is then protected according to the
schedule and the storage settings in the plan. The web UI also
refers to Subscribe as Add protection.

Unsubscribe, from a Unsubscribe refers to the action of removing protection or

protection plan removing an asset or asset group from a plan.

Workload The type of asset. For example, VMware, RHV, or Cloud.

Workflow An end-to-end process that can be completed using the

NetBackup web UI. For example, you can protect and recover
VMware and Cloud assets beginning with NetBackup 8.1.2.

Sign in to the NetBackup web UI

Authorized users can sign in to a NetBackup master server from a web browser,
using the NetBackup web UI. The following sign-in options are available:
■ Sign in with a user name and password
■ Sign in with a certificate or smart card

Sign in with a user name and password

You can sign in to NetBackup web UI if you are an authorized user. Contact your
NetBackup security administrator for more information.
To sign in to a NetBackup master server using the NetBackup web UI
1 Open a web browser and go to the following URL.
https://masterserver/webui/login
The masterserver is the host name or IP address of the NetBackup master
server that you want to sign in to.
2 Enter your credentials and click Sign in.
For example:

For this type of Use this format Example

user

Local user username root

Domain user DOMAIN\username WINDOWS\Administrator

 Introducing the NetBackup web user interface 11
The NetBackup dashboard

Sign in with a certificate or smart card

You can sign in to NetBackup web UI with a smart card or digital certificate if you
are an authorized user. Contact your NetBackup security administrator for more
information.
To use a digital certificate that is not on a smart card, you must first upload the
certificate to the browser’s certificate manager. See the browser documentation for
instructions or contact your certificate administrator for more information.
To sign in with a certificate or smart card
1 Open a web browser and go to the following URL.
https://masterserver/webui/login
The masterserver is the host name or IP address of the NetBackup master
server that you want to sign in to.
2 Click Sign in with certificate or smart card.
3 When your browser prompts you, select the certificate.

The NetBackup dashboard

The NetBackup dashboard provides a quick view of the details that are related to
your role in your organization.

Table 1-2 The NetBackup dashboard for the backup administrator

Dashboard widget Description

Jobs Lists job information, including the number of active and queued jobs and the status
of attempted and completed jobs.

Usage reporting Lists the size of the backup data for the NetBackup master servers in your organization.
This reporting is useful to track capacity licensing. Use the drop-down lists in the top
right to select the time period and the view that you want to display. Click on a server
name to see specific details for that server.

Additional details are available for how to configure NetBackup to display master server
information in this widget.

See “Track backup data size on your master servers” on page 28.
 Chapter 2
Managing protection plans
This chapter includes the following topics:

■ Create a protection plan

■ Edit or delete a protection plan

■ Subscribe an asset or an asset group to a protection plan

■ Unsubscribe an asset from a protection plan

■ About a NetBackup classic policy

Create a protection plan

A protection plan defines when backups are performed, how long the backups are
retained, and the type of storage to use. Once you have set up a protection plan,
you can subscribe assets to that protection plan.
Before you create a protection plan, you must configure all storage options. You
must configure those storage options in the NetBackup Administration Console.
Refer to the following procedure (step 5) for the types of storage options that can
be configured.

Note: After upgrade, the protection plans may not appear in the web UI. The
conversion process may not have run but should run within 5 minutes of performing
the upgrade. However, it may take up to 4 hours if the conversion process failed
the first time.
 Managing protection plans 13
Create a protection plan

To create a protection plan

1 On the left, click Protection plans and then click Add.
2 In Basic properties, enter a Name, Description, and select a Supported
Workload from the drop-down list.
Optional selections:
■ Allow Custom Protection:
Select this option to allow workload administrators to create a custom
protection plan based on this protection plan. The Cloud workload does
not allow you to setup this option.
■ Policy name prefix:
Use this option for policy names. A prefix is appended to the policy name
when NetBackup automatically creates a policy when users subscribe
assets to this protection plan.

3 In Schedules and retention, click Add schedule. You can select the schedule
type, how often it runs, and how long to keep the backup for this protection
plan. The options change depending on workload chosen.
If you select Monthly as a frequency, you can select between Days of the
week (grid view) or Days of the month (calendar view).

Note: If you select Automatic for the schedule type, then all schedules for this
protection plan will be Automatic. If you select a Full, Differential
incremental, or Cumulative Incremental for the schedule type, then all
schedules for this protection plan must be one of these options.
If you select Automatic for the schedule type, NetBackup automatically sets
the schedule type for you. NetBackup calculates when to do a Full or
Differential incremental based on frequency you specify.

■ (Optional) To replicate the backup, turn on Replicate this backup.

■ To use the Replicate this backup option, the backup storage must be
a source in a targeted A.I.R. environment. The Replication target is
configured in step 5.
■ For more information about replication, review About NetBackup Auto
Image Replication in the NetBackup Administrator’s Guide, Volume I.

■ (Optional) To keep a copy in long-term storage, turn on Duplicate a copy

immediately to long-term retention.
■ NetBackup immediately duplicates a copy to long-term storage after the
backup completes.
 Managing protection plans 14
Create a protection plan

■ The schedule options that are available for long-term storage are based
on the frequency and the retention levels for the regular backup
schedules that you created.

4 (Optional) If you have selected the Cloud workload, you can configure snapshot
replication after you have configured a schedule and retention. For more
information about cloud snapshot replication, see the NetBackup Web UI for
Cloud Administrator’s Guide.
In the Additional copies column:
■ Click Configure Snapshot replication.
■ In the Configure snapshot replica dialog, click Add.
■ Configure the Retention and select the Destination for the replicated
snapshots.

Note: You can only create one additional cloud replication copy per protection
plan.

If you selected Cloud as a workload, proceed to step 7.

 Managing protection plans 15
Create a protection plan

5 In Storage options, select the storage type per schedule you configured in
step 3.
The options vary depending on storage options currently setup to work with
NetBackup.
When creating a protection plan, select only the storage that a NetBackup 8.1.2
or newer media server can access.

Storage option Requirements Description

Snapshot storage CloudPoint is Configure CloudPoint in the NetBackup Administration Console using the
only required for this Snapshot Management Server feature. If you use the Snapshot only storage
option. option, no other storage option can be selected. Go to step 6.

Backup storage OpenStorage is Click Edit to select the storage target. Click Use selected storage after
required for this selecting the storage target.
option. Tape,
The NetBackup Accelerator feature allows protection plans to execute faster
storage unit
than traditional backups, by creating a compact data stream that uses less
groups, and
network bandwidth. If the storage server on the NetBackup master server
Replication
supports NetBackup Accelerator, this feature is included in the protection
Director not
plan. For more details on NetBackup Accelerator, contact the NetBackup
supported.
administrator or see the NetBackup Administrator’s Guide, Volume I or the
NetBackup for VMware Administrator’s Guide.

The Instant access feature allows the plan’s VM recovery points to support
the creation of instant access VMs.

Replication target The backup Click Edit to select the replication target master server. Select a master
storage must be a server and then select a storage lifecycle policy. Click Use selected
source in a replication target to return to the storage options screen.
targeted A.I.R.
If the replication target master server is not in the list, you must add one in
environment.
NetBackup. For more information on how to add a replication target master
server, review Adding a trusted master server in the NetBackup Deduplication
Guide.

Long-term OpenStorage is Click Edit to select the cloud storage provider. Click Use selected storage
retention storage required for this after selecting the cloud provider target.
option. Tape,
storage unit
groups, and
Replication
Director not
supported.
 Managing protection plans 16
Edit or delete a protection plan

6 In Backup options, configure all options based on your workload type. The
options in this area change depending on workload option selected.
7 Review the plan details and click Save.

Edit or delete a protection plan

Edit a protection plan
You can make changes to the Name, Description, and Storage options in a
protection plan.

Note: You cannot edit the Backup schedules, Backup options, or Advanced
options after a protection plan is created. If you want to use different protection
settings, you must create a new protection plan.
See “Create a protection plan” on page 12.

To edit a protection plan

1 On the left, click Protection plans.
2 Click on the protection plan name that you want to edit.
3 (Optional) On the right, click Edit name and description to change the name
and description of the protection plan.
4 (Optional) In the Storage options section, click Edit to change the storage
options

Delete a protection plan

Before you delete a protection plan, you need to add the assets to another protection
plan. Moving the assets to another protection plan ensures that the data is protected
on those assets that this plan protects. You cannot delete a protection plan unless
all assets have been removed from the protection plan.
To delete a protection plan
1 Make note of the protection plan you want to add the assets to (new or existing).
See “Create a protection plan” on page 12.
2 Locate the assets that currently protected by the plan you want to delete.
3 (Optional) Subscribe the assets to the new or an existing protection plan.
See “Unsubscribe an asset from a protection plan” on page 18.
See “Subscribe an asset or an asset group to a protection plan” on page 17.
 Managing protection plans 17
Subscribe an asset or an asset group to a protection plan

4 Unsubscribe the assets from the protection plan you want to delete.
5 On the left, click Protection plans.
6 Select the protection plan you want to delete by selecting the check box.
7 On the top right, click Delete. Then click Yes.

Subscribe an asset or an asset group to a

protection plan
You can subscribe a single asset or a group of assets to a protection plan. An asset
or a group of assets can be subscribed to multiple protection plans. Before you can
subscribe assets to a protection plan, you must create a protection plan.
To subscribe an asset or an asset group to a protection plan
1 On the left, click the workload type (for example: VMware).
2 Select an asset type (for example: Virtual machines, Intelligent VM groups).
3 Select one or more assets.
4 Click Add protection.
If you selected a Cloud workload asset or asset group, proceed to step 7
5 In Protection method, select the type of protection plan.
■ Subscribe to a protection plan
Select this option to use the settings in a selected plan. Any changes to the
plan are inherited automatically.

■ Custom protection
Select this option to customize a selected plan. Not all plans and settings
can be customized. Any changes to the selected plan are not applied to
the assets or asset group you selected.

6 (Optional) If you select Custom protection, you can adjust the options as
follows:
■ Schedules and retention
Add a schedule and a retention period or edit the existing schedule and
retention period.
■ Storage
Adjust the storage options that were set up in the original protection plan.
■ Backup options
Adjust the backup options that were set up in the original protection plan.
The options in this area change depending on workload.
 Managing protection plans 18
Unsubscribe an asset from a protection plan

■ Advanced
Change or add any options that were set up in the original protection plan.

7 Click Protect.
See “Create a protection plan” on page 12.

Unsubscribe an asset from a protection plan

You can unsubscribe individual assets or groups of assets from a protection plan.

Note: When you unsubscribe an asset from a protection plan, there is a possibility
that the asset displays Classic policy in the web UI. This situation can happen
when an asset is subscribed to a protection plan and a backup runs for that asset.
Then the asset is unsubscribed from the protection plan while it has a valid backup
image. The web UI displays Classic policy, but there may or may not be an active
policy protecting the asset.

To unsubscribe a single asset from a protection plan

1 On the left, click the workload type (for example: VMware).
2 Select a single asset type (for example: Virtual machines).
3 Click on the specific asset name.
4 Click Remove protection and click Yes.
To unsubscribe a group of assets from the protection plan
1 On the left, click the workload type (for example: VMware).
2 Select a group asset type (for example: Intelligent VM groups).
3 Click on the specific group asset name.
4 Click Remove protection and click Yes.
See “Create a protection plan” on page 12.
See “Edit or delete a protection plan” on page 16.

About a NetBackup classic policy

You can protect an asset using a NetBackup classic policy, a protection plan, or
both at the same time. This topic answers some common questions about NetBackup
classic policies in the NetBackup web UI.
 Managing protection plans 19
About a NetBackup classic policy

Table 2-1 Classic policy FAQ

Question Answer

In the web UI’s Protected by The asset is not currently subscribed to a protection plan.
column, what does Classic However, it was subscribed to a protection plan or
policy only mean? covered by a classic policy at one time and it has a Last
backup status. There may or may not be an active classic
policy protecting the asset (contact the NetBackup
administrator to find out).

Where can I find the details of a The details of a classic policy are not visible in the web
classic policy? UI. To manage a classic policy, a NetBackup
administrator can use the NetBackup Administration
Console or the NetBackup CLIs. Also, the NetBackup
administrator or the backup admin can manage and
create policies using the NetBackup APIs.

When should I subscribe an asset Only a NetBackup administrator can create a classic
to a protection plan versus policy. If you do not have the required permissions to
protecting the asset with a classic subscribe assets to protection plans, ask the backup
policy? administrator to configure the protection plan. The backup
administrator may choose to protect the asset through a
protection plan (web UI) or through a classic policy
(Administration Console).

Can I use both a protection plan Yes. The web UI shows the details of the protection plan
and a classic policy to protect an but not the details of the classic policy. You can contact
asset? the NetBackup administrator for the classic policy details.

What action should I take when You can ask the NetBackup administrator if a classic
an asset is unsubscribed from a policy protects the asset.
protection plan and the web UI
shows Classic policy only for
that asset?
 Chapter 3
Managing jobs
This chapter includes the following topics:

■ Monitoring jobs

■ Jobs: canceling, suspending, restarting, resuming, deleting

■ Filter jobs in the job list

Monitoring jobs
Use the Jobs node to monitor the jobs in your NetBackup environment and view
the details for a specific job.
To monitor a job
1 Click Jobs and select the job name or check the box of the job that you want
to view. You can select the checkbox for a job to perform a particular action
on that job, such as restarting the job. Under Status, click the status code to
view the status code message.
■ Select the Overview tab to view information about a job. The tab displays
the File List and Status. The File List contains the files that are included
in the backup image. Under Status, click the status code number to view
information about this status code in the Veritas Knowledge Base.
See the NetBackup Status Codes Reference Guide.
■ Select the Details tab to view the logged details about a job. You can filter
the logs by error type using the drop-down menu.

2 From here, you can perform additional tasks.

See “Jobs: canceling, suspending, restarting, resuming, deleting” on page 21.
 Managing jobs 21
Jobs: canceling, suspending, restarting, resuming, deleting

Jobs: canceling, suspending, restarting,

resuming, deleting
To manage jobs
1 Click Jobs.
2 Select one or more jobs.
3 The top menu shows the actions that you are able to perform for the selected
jobs.

Cancel You can cancel the jobs that have not yet completed. They can be in
one of the following states: queued, re-queued, active, incomplete,
or suspended.

When a parent job is canceled, any child jobs are also canceled.

Suspend You can suspend backup and restore jobs that contain checkpoints.

Restart You can restart the jobs that have completed, failed, or that have
been canceled or suspended.

A new job ID is created for the new job.

Resume You can resume the jobs that have been suspended or are in an
incomplete state.

Delete You can delete the jobs that have completed. When a parent job is
deleted, any child jobs are also deleted.

Filter jobs in the job list

You can filter the jobs to display the jobs in a specific state. For example, you can
display all of the active jobs or all of the suspended jobs.
To filter the job list
1 Click Jobs.
2 Above the job list, click the Filter option.
3 In the Filter window, select a filter option to dynamically change the jobs that
are displayed. The filter options are as follows:
■ All
■ Active
■ Done
 Managing jobs 22
Filter jobs in the job list

■ Failed
■ Incomplete
■ Partially Successful
■ Queued
■ Successful
■ Suspended
■ Waiting for Retry

4 Click Apply Filters.

5 To remove the selected filters, click Clear All.
 Chapter 4
Configuring email
notifications for alerts
This chapter includes the following topics:

■ About NetBackup alerts

■ How to configure email notifications for alerts

■ Prerequisites for using alerts and notifications

■ About the status codes supported for alerts

■ Configure alert and notification settings

About NetBackup alerts

The backup administrator can configure NetBackup to send email notifications when
job failures occur. These notifications can also be directed to a supported ticketing
system.
This feature saves NetBackup administrators from spending time monitoring
NetBackup for job failures and manually creating tickets to track issues. NetBackup
supports the ticketing systems that use inbound email service for ticket creation.
NetBackup generates alerts based on certain status codes.
See “About the status codes supported for alerts” on page 25.
Alerts that are similar or have a similar reason for failure are marked as duplicates.
Email notifications for duplicate alerts are not sent for the next 24 hours. If an email
notification cannot be sent, NetBackup tries the notification every 2 hours, up to
three retry attempts.
 Configuring email notifications for alerts 24
How to configure email notifications for alerts

How to configure email notifications for alerts

Based on certain job failure conditions or NetBackup status codes, alerts are
generated and sent to your ticketing system through email notifications.
See “About NetBackup alerts” on page 23.
See “About the status codes supported for alerts” on page 25.
The following table lists the procedures that you need to do to generate alerts and
tickets.

Table 4-1 NetBackup alerts and ticket generation

Step Action Reference topic

1 Review the prerequisites for alerts See “Prerequisites for using alerts and
and notifications. notifications” on page 24.

2 Learn about the conditions or See “About the status codes supported for
status codes for which alerts are alerts” on page 25.
generated and are sent to the
ticketing system as email
notifications.

3 Configure email notifications so Note: You can exclude status codes for which
that the alerts are sent to the you do not want to send email notifications.
ticketing system.
See “Configure alert and notification settings”
on page 25.

4 View NetBackup alerts (or tickets) Log on to the ticketing system to view the
in the ticketing system. tickets that are generated by NetBackup alerts.

Prerequisites for using alerts and notifications

Ensure the following before you configure the web UI for alerts and notifications
using a ticketing system.
■ The ticketing system is up and running.
■ The SMTP server is up and running.
■ A policy is configured in the ticketing system to create tickets (or incidents)
based on inbound emails that NetBackup sends.
 Configuring email notifications for alerts 25
About the status codes supported for alerts

About the status codes supported for alerts

The NetBackup web UI supports alerts for VMware job failures and retains the alerts
for 90 days. NetBackup generates alerts for the supported status codes for following
job types: backup, snapshot, snapshot replication, index from snapshot, and backup
from snapshot. For the complete list of status codes for which alerts are generated,
refer to the information for alert notification status codes in the NetBackup Status
Codes Reference Guide.
Table 4-2 lists some of the conditions or status codes for which alerts are generated.
These alerts are sent to the ticketing system through email notifications.

Table 4-2 Examples of the supported status codes

Status Error message

code

10 Allocation failed

196 Client backup was not attempted because backup window closed

213 No storage units available for use

219 The required storage unit is unavailable

2001 No drives are available

2074 Disk volume is down

2505 Unable to connect to the database

4200 Operation failed: Unable to acquire snapshot lock

5449 The script is not approved for execution

7625 SSL socket connection failed

Configure alert and notification settings

You can configure NetBackup to send email notifications when an event that is
related to a job failure occurs.
To configure email notifications
1 At the top right, click Settings > Alerts and notification settings.
2 Click Email notifications.
3 Enable the Send email notifications option.
 Configuring email notifications for alerts 26
Configure alert and notification settings

4 Enter the email information including the recipient's email address, the sender's
email address, and the email sender's name.
5 Enter the SMTP server details including the SMTP server name and port
number.
Provide the SMTP user name and password if you have specified the
credentials earlier on the SMTP server.
6 Click Save.

Exclude specific status codes from email notifications

You can exclude specific status codes so that email notifications are not sent for
these errors.
To exclude specific status codes
1 At the top right, click Settings > Alerts and notification settings.
2 Click Exclude status codes.
3 Enter the status codes or a range of status codes (separated by commas) for
which you do not want to receive email notifications.
4 Click Save.

Sample email notification for an alert

An email notification for an alert contains information about master server, job,
policy, schedule, and error. Emails may contain other information based on the type
of job. For example, for VMware job failures, details such as vCenter Server and
ESX host are present in the email notification.
Example email notification:
Master Server: master1.example.com

Client Name: client1.example.com

Job ID: 50

Job Start Time: 2018-05-17 14:43:52.0

Job End Time: 2018-05-17 15:01:27.0

Job Type: BACKUP

Parent Job ID: 49

Policy Name: Win_policy

Policy Type: WINDOWS_NT

Schedule Name: schedule1

 Configuring email notifications for alerts 27
Configure alert and notification settings

Schedule Type: FULL

Status Code: 2074

Error Message: Disk volume is down

 Chapter 5
Usage reporting and
capacity licensing
This chapter includes the following topics:

■ Track backup data size on your master servers

■ Adding a trusted master server using NetBackup CA-signed (host ID-based)

certificate

■ Configure the servers list for usage reporting

■ Scheduling reports for capacity licensing

■ Other configuration for incremental reporting

■ Troubleshooting failures for nbdeployutil and incremental reporting

Track backup data size on your master servers

The Usage reporting application lists the size of the backup data for the NetBackup
master servers in your organization. This reporting provides the following benefits:
■ Ability to plan for capacity licensing.
■ On a weekly basis, NetBackup gathers and reports usage and trend information.
The nbdeployutil utility has scheduled runs to gather data for the report
(enabled by default). For more information, see Scheduling capacity licensing
reports.
■ A link to Smart Meter. This tool allows NetBackup customers to proactively
manage their license use through near real-time visibility of consumption patterns.
■ Reporting for the following policy types.
 Usage reporting and capacity licensing 29
Adding a trusted master server using NetBackup CA-signed (host ID-based) certificate

BigData Informix NDMP Sybase

MS-Exchange-Server MS-SQL-Server Oracle VMware

Hyper-V MS-Windows Standard Hypervisor

Requirements
NetBackup automatically collects data for the usage reporting, provided the following
requirements are met:
■ The master server (or master servers) are at NetBackup 8.1.2 or later.
■ You use capacity licensing.
■ You use automatic, scheduled reports. If you manually generate capacity license
reports, the data does not display in the usage report in the NetBackupweb UI.
■ The following file exists:
UNIX: /usr/openv/var/global/incremental/Capacity_Trend.out
Windows: install_path\var\global\incremental\Capacity_Trend.out
■ If you want one of your master servers to gather usage reporting data for other
remote master servers, additional configuration is required. You must create a
trust relationship between the master servers. You must also add the local
master server (where you plan to run nbdeployutil) to the Servers list on each
remote master server.
See “Configure the servers list for usage reporting” on page 32.
See “Adding a trusted master server using NetBackup CA-signed (host ID-based)
certificate” on page 29.

Additional information
Scheduling capacity licensing reports. Details on capacity licensing, scheduling,
and options for capacity licensing reports.
Veritas Smart Meter Getting Started Guide. Details on how to use Smart Meter to
manage your NetBackup deployment and licensing. This tool provides accurate,
near real-time reporting for the total amount of data that is backed up.

Adding a trusted master server using NetBackup

CA-signed (host ID-based) certificate
If you want to have usage reporting for multiple master servers in the NetBackup
web UI, you need to configure a trust relationship exists between the NetBackup
servers in the different domains.
 Usage reporting and capacity licensing 30
Adding a trusted master server using NetBackup CA-signed (host ID-based) certificate

Before you begin

Perform the following steps on both the source and the target server:
■ Identify the NetBackup versions that are installed on the source and the target
servers.
Usage reporting and Smart Meter are supported for NetBackup 8.1.2 and later.
■ Obtain the authorization tokens of the remote server.
Use the bpnbat command to log on and nbcertcmd to get the authorization
tokens.
■ Obtain the fingerprints for the remote server.
To obtain the SHA1 fingerprint of root certificate, use the nbcertcmd
-displayCACertDetail command.

■ Ensure that you have one of the following permissions:

■ System administrator permissions with root permissions for UNIX,
administrator permissions for Windows, or a NetBackupCLI user for a 3.1
NetBackup appliance.
■ Access to the NetBackup Administration Console, where you have
<username> ADMIN=ALL permissions through auth.conf.
■ Enhanced Auditing (EA) user permissions through authalias.conf.
■ For remote Windows master server, if the user's domain is not same as that
of the authentication service, you must add the domain with LDAP using the
vssat addldapdomain command. See the NetBackup Commands Reference
Guide.
Also, this user must have RBAC security administrator permissions. See the
WEB UI for the Security Administrators Guide..

Adding a trusted master server using NetBackup

CA-signed certificates, when both the source and the target
servers are NetBackup version 8.1 or later
Use this procedure to add a trusted master server when a NetBackup CA-based
certificate is used to establish the trust.
To add a trusted master server, when both the source and the target servers
are NetBackup version 8.1 or later
1 In the NetBackup Administration Console, expand NetBackup Management
> Host Properties > Master Servers in the left pane.
2 In the right pane, select the master server and Actions > Properties.
3 In the properties dialog box left pane, select Servers.
 Usage reporting and capacity licensing 31
Adding a trusted master server using NetBackup CA-signed (host ID-based) certificate

4 On the Trusted Master Servers tab, click Add.

5 Enter the fully-qualified host name of the remote master server and click
Validate Certificate Authority.
6 In the Validate Certificate Authority dialog box, verify if the CA certificate
fingerprint of the remote server is correct.
To proceed, click Yes.
If the fingerprints don’t match, click No. Contact the remote server admin to
provide the correct fingerprints.
7 Enter the trusted master server details using one of the following methods.
■ (Recommended) Select Specify authentication token of the trusted
master server and enter the token details of the remote master server.
■ Select Specify credentials of the trusted master server and enter the
user name and password. Note that this method may present a possible
security breach. Only an authentication token can provide restricted access
and allow secure communication between both the hosts.
To establish trust with a 3.1 NetBackup master appliance, use the
NetBackup CLI credentials.

8 Click OK.
9 Perform the same procedure on the remote master server that you added in
step 5.

Adding a trusted master server using NetBackup

CA-signed certificates, when both the source and the target
server are NetBackup version 8.0 or earlier
To add a trusted master server, when both the source and the target server
are NetBackup version 8.0 or earlier
1 Ensure that the Enable insecure communication with NetBackup 8.0 and
earlier hosts option is enabled in the global security settings.
2 In the NetBackup Administration Console, expand NetBackup Management
> Host Properties > Master Servers in the left pane.
3 In the right pane, select the master server and Actions > Properties.
4 In the properties dialog box left pane, select Servers.
5 On the Trusted Master Servers tab, click Add.
6 Enter the fully-qualified host name of the remote master server and click
Validate Certificate Authority.
 Usage reporting and capacity licensing 32
Configure the servers list for usage reporting

7 Enter the Username and Password of the remote master server host.
8 Click OK.

More information
For details on usage reporting in the web UI, see the NetBackup Web UI for Backup
Administrator's Guide.
For more information on commands, see the NetBackup Commands Reference
Guide. For details on the authalias.conf, see the NetBackup Security and
Encryption Guide.

Configure the servers list for usage reporting

If a you want to add usage reporting information for a master server but that server
does not have an internet connection, you need to add the name of the local master
server to the servers list of the remote master server. The local master server is
where you plan to run nbdeployutil.
To add a server to a list
1 On the remote master server, log on as root or administrator.
2 In the NetBackup Administration Console, in the left pane, expand
NetBackup Management > Host Properties.
3 Select Master Servers.
4 In the right pane, double-click the master server that you want to modify.
5 In the properties dialog box, in the left pane, click Servers.
6 Select the Additional Severs tab.
7 Click Add.
8 In the Add a New Server Entry dialog box, enter the name of the master server
where you plan to run nbdeployutil.
9 Click Add. The dialog box remains open for another entry.
10 Click Close.

Scheduling reports for capacity licensing

By default, NetBackup triggers nbdeployutil to run on a specified schedule to
incrementally gather data and to generate licensing reports. For the first run, the
duration of the report uses the frequency that is specified in the configuration file.
 Usage reporting and capacity licensing 33
Scheduling reports for capacity licensing

For capacity licensing, the report duration is always for the last 90 days based on
the availability of the gathered data. Any data older than 90 days is not considered
in the report. Each time nbdeployutil runs, it gathers information for the time
between the latest run of nbdeployutil and the previous successful run.

Licensing report location

The current capacity licensing report resides in the following directory:
On Windows: install_path\NetBackup\var\global\incremental
On UNIX: /usr/openv/var/global/incremental
It contains the following files:
■ The generated report for the latest nbdeployutil result.
■ Folders containing incrementally gathered data.
■ The archive folder that contains the older generated reports.
■ nbdeployutil log files.

The older reports are placed in the archive folder. Veritas recommends that you
retain at least 90 days of reporting data. Data can be kept longer than 90 days,
depending on the requirements of your environment. Older reports can help to show
how the capacity usage has changed over time. Delete the reports or the folder
when they are no longer required.

Use Case I: Using the default values for the licensing report
The nbdeployutilconfig.txt file is not required when you use the default
parameters. nbdeployutil uses the following default values for capacity licensing:
■ FREQUENCY_IN_DAYS=7
■ MASTER_SERVERS=local_server
■ PARENTDIR=folder_name
For Windows: install_path\NetBackup\var\global\incremental
For UNIX: /usr/openv/var/global/incremental
■ PURGE_INTERVAL=180 (number of days).

Use Case II: Using custom values for the licensing report
If the file nbdeployutilconfig.txt is not present, create a file using the following
format:

[NBDEPLOYUTIL_INCREMENTAL]
MASTER_SERVERS=<server_names>
FREQUENCY_IN_DAYS=7
 Usage reporting and capacity licensing 34
Scheduling reports for capacity licensing

PARENTDIR=<folder_name_with_path>
PURGE_INTERVAL=180

To use custom values for the licensing report

1 Copy the nbdeployutilconfig.txt file to the following location:
For Windows: install_path\NetBackup\var\global
For UNIX: /usr/openv/var/global
2 Open the nbdeployutilconfig.txt file.
3 Edit the FREQUENCY_IN_DAYS value to reflect how often you want the report to
be created.

Default 7
(recommended)

Minimum 1

Value of 0 Disables the incremental reporting and no licensing information

is captured.

Parameter deleted nbdeployutil uses the default value.

4 Edit the MASTER_SERVERS value to include a comma-separated list of the master

servers you want to include in the report.

Note: Veritas Smart Meter requires that master servers be at NetBackup 8.1.2
or later.

No value nbdeployutil uses the default value.

Parameter deleted nbdeployutil uses the default value.

For example:
■ MASTER_SERVERS=newserver, oldserver
■ MASTER_SERVERS=newserver, oldserver.domain.com
■ MASTER_SERVERS=myserver1.somedomain.com, newserver.domain.com
 Usage reporting and capacity licensing 35
Other configuration for incremental reporting

5 Edit the PARENTDIR value to include the full path for location where the data is
gathered and reported.

No value nbdeployutil uses the default value.

Parameter deleted nbdeployutil uses the default value.

6 Edit the PURGE_INTERVAL to indicate the interval (in days) for how often you
want to delete the report data. Data that is older than 180 days is automatically
purged.

Default 180

Minimum 90

No value nbdeployutil uses the default value.

Parameter deleted nbdeployutil uses the default value.

Other configuration for incremental reporting

To change the directory of the gathered data and capacity licensing report
1 If you have older gathered data and licensing reports, copy the complete
directory to the new location.
2 Edit nbdeployutilconfig.txt and change the location of the gathered data
and licensing report in the PARENTDIR=folder_name field.
 Usage reporting and capacity licensing 36
Other configuration for incremental reporting

To use the data that was gathered previously to generate a capacity licensing
report
1 Locate the folder that was generated for the gathered data after the previous
run of nbdeployutil and copy it to the following location:
On Windows: install_path\NetBackup\var\global\incremental
On UNIX: /usr/openv/var/global/incremental
2 Create the gather_end.json file inside the copied folder and add the following
text:
{"success":0}

The next incremental run considers the data inside the copied folder to generate
a capacity licensing report.

Note: Delete any other gather folders inside the copied folder to avoid gaps
for the period in which data is gathered. The missing data is automatically
generated during the next incremental run.

To create a custom interval report using existing gathered data for capacity
licensing
◆ To create a report for a time interval that is different than the default interval
of 90 days, run the following command:
On Windows:

nbdeployutil.exe --capacity --incremental --report --inc-settings

"install_dir\netbackup\var\global\nbdeployutilconfig.txt"
--hoursago <custom-time-interval>

On UNIX:

nbdeployutil.exe --capacity --incremental --report --inc-settings

"/usr/openv/var/global/nbdeployutilconfig.txt"
--hoursago <custom-time-interval>

The number of hours specified in --hoursago must be fewer than the

purge-interval that is specified in the nbdeployutilconfig.txt file.

Note: nbdeployutil uses existing gathered data to generate the custom

interval report. You are not required to use the --gather option.
 Usage reporting and capacity licensing 37
Troubleshooting failures for nbdeployutil and incremental reporting

Troubleshooting failures for nbdeployutil and

incremental reporting
■ nbdeployutil fails to gather data and generate the report for your environment.
Refer to the logs to understand when the task failed and the reason for the
failure.
■ nbdeployutil fails with a bpimagelist error with status 37 after you run the utility
manually. Ensure that you added the master servers to the additional servers
list.
■ For Oracle Real Application Clusters (RAC), protected data size may be reported
more than once because the size is reported for the node where data backup
happens.
If the backup operation is initiated from different nodes in the Oracle Real
Application Clusters (RAC), the capacity licensing report displays a separate
row for every node.
■ The following error displays because of internal web service communication
failures:
Report for master server SERVER_NAME is generated using the backup image
header method instead of accurate licensing method because of web service
interruptions during the gather phase.
■ For VMware or NDMP, when the backup agent fails to post licensing information
to the database, a status code 5930 or 26 displays in the Activity Monitor: For
more information, see the NetBackup Status Codes Reference Guide.