Veritas NetBackup™ Self Service Configuration Guide

Last Published:
Product(s): NetBackup (8.2)
  1. Licensing
      Applying the full License
  2. Configuring a Self Service solution
      About configuring a Self Service solution
      Self Service scheduled backup
      Configuration checklist
  3. Configuring a NetBackup master server
      About configuring the NetBackup master server
      Enabling communication with a Windows NetBackup master server
      Enabling communication with a UNIX NetBackup master server
      Enabling communication with a NetBackup appliance
      Enabling communication with a NetBackup master server using the REST API
      Creating NetBackup Template Policies
  4. Configuring Self Service
      About Self Service configuration
      Configuring backup servers
      Configuring protection
      Configuring the Backup Now form
      Configuring tenants
      Access rights
      Registering computers
    8. Configuring the home page
        Home page integration settings
  5. Customizing Self Service
      Language settings
      Creating or customizing a request form
  6. User authentication methods
      About user authentication methods
      Forms based authentication
      Windows Authentication
      Active Directory Import
      Configuring Self Service to use Federated Single Sign-On
  7. Troubleshooting
      About troubleshooting
      Where to find troubleshooting information
      Impersonation of a tenant user
      Issues with Remote PowerShell to Windows master servers
  8. Appendix A. NetBackup policy types
      List of NetBackup policy types
  9. Appendix B. Dashboard traffic light status and usage
      About dashboard traffic light status and usage
      Assets with a protection type
      Assets without a Protection Type
      Usage and Charging
  10. Appendix C. Synchronizing data from NetBackup
      About synchronizing data from NetBackup
  11. Appendix D. NetBackup Self Service data caching process
      About NetBackup Self Service data caching process
      NetBackup Data Synchronization
      Backup Now
  12. Appendix E. Integration settings
      About integration settings
      NetBackup Adapter
      NetBackup Adapter Usage
      NetBackup Adapter Access Rights
      Action Request Types
      vCloud Director import
  13. Appendix F. REST API
      About the REST API
  14. Appendix G. Glossary

Registering computers

Computers within the estate must be registered to NetBackup Self Service. This requirement includes the name for display in the UI and configuration data for use with NetBackup.

You can register a computer in four different ways: through the user interface, through the API, through NetBackup cloud asset Import, or automatically through vCloud Director import. A single tenant can have more than one source of computer, for example, virtual machines imported from vCloud Director and physical computers imported through the API.

Registering a computer with the user interface

You can register a computer from the Assets page on the home page with Register Computer. Help text is available to assist in completion of the data. Fields are validated for accurate data either during entry or when you click OK.

To remove a computer registration, go to the Assets list on the home page and use the Remove Registration link. Computer registration cannot be edited so it is recommended that a computer registration is deleted and recreated if changes are required. Be sure to use the same computer code when you recreate a computer registration.

The computer registration process includes an automatic refresh of protection data and image data from NetBackup. Protection data indicates what is protected either by schedule or by a one-off Backup Now task. If you click Refresh NetBackup data from the computer row on the list, you can synchronize protection and backup images of a computer. Typically synchronization should not require manual intervention. Exceptions might be if you want to immediately see images from a new protection policy or images that have been created manually.

Registering a computer with the API

For automated or bulk import of computer details, an API is available. The SDK allows clients to be written in .NET and is the preferred usage of the API. A REST API can, however, be used outside Microsoft environments.

Please see the SDK documentation in Install directory.

Registering by vCloud Director Import

You can automatically import a vCloud hierarchy from vCloud Director and register the computers with NetBackup Self Service. The import is performed on a tenant by tenant basis using individual credentials.

A vCloud Director import must define the vCloud Director instance from which the hierarchy is imported. Additionally, it must specify the NetBackup Self Service settings you want to associate with it.

An import must specify a Protection Type and a Backup Server that the imported hierarchy is associated with.

An import may optionally use virtual data center (vDC) filtering. When vDC filtering is enabled, only vDCs in the filter are imported. Filtering occurs on a per tenant basis and each must be set up with a filter to import any vDCs. Each vDC should appear only in a single tenant's filter.

When vDC filtering is disabled, all vDCs that are visible through the import credentials are imported.

Use the Add Import option on the Imports tab to create a new vCloud Director Import. Follow the on-screen prompts to create a corresponding vCloud Import Integration Setting section.

You must specify logon credentials at a tenant level to enable import. The credentials in vCloud Director are defined against an Organization and must have the General > Administrator View right. Only a single tenant can import computers from any vCloud Director Organization.

When you create a new tenant, the Add Tenant form supports specifying credentials for a single vCloud Director system as part of the tenant creation process. Further credentials can be supplied either using the API or through the Integration Settings tab in Tenant administration. Once the initial password is set, a tenant-administrator can update the vCloud Director password that is used to access vCloud Director. The tenant-administrator updates the password through a drop-down on the root node of their Computers list.

Table: Integration Settings that are used in a vCloud Director Import



vCloud Api

This value should be set to the URL of the vCloud Director API, in the format of https://hostname/api/.


The name of the NetBackup backup server the computers are registered to


Indicates if the vCloud Director instance is considered online. Self Service does not use the instances that are not online.

Ignore SSL Certificate Errors

This option allows the Self Service to connect to vCloud Director instances where the SSL certificate is not valid.

vCloud username

The user name that the tenant uses to connect to the vCloud Director API. Each tenant must have their own credentials. It must be in the format userid@vOrg. Must be set at the tenant level only.

vCloud password

The tenant's corresponding vCloud Director password. Must be set at the tenant level only.

Protection Type Code

The protection type that is applied to imported computers.

Use vDC Filter

Set to enable vDC filtering.

vDC Filter

The filter to apply to vDCs during an import. This filter is a comma separated list and vDC names are case-sensitive. Set at the tenant level only.

Display Name

The name that is displayed for users. This name is displayed on the default view of the home page

Include Metadata

Determines if the metadata should be included in the import.


vCloud Director imports exist in Self Service as Integration Settings that are grouped into a section. A single section defines each individual vCloud Director import. When you use the Add function for each of these, they create Integration Settings behind the scenes.

You can edit or delete these only through Integration Settings. Care must be taken, however, as no validation is performed when editing values directly through Integration Settings.

Computers that are imported from vCloud Director are displayed to the tenant-user in a two-paned tree-view. Computers are listed within their parent containers. If the computer is from vCloud, containers display in left pane. When you click on the lowest level container, the contents are displayed on the right pane. Protection can be applied at either the container or the computer level. When only non-vCloud Director computers are registered, they are displayed in a full width list.

Registering by NetBackup Import

You can automatically import cloud assets from NetBackup and register them with Self Service. The import is performed on a tenant by tenant basis, using individual credentials.

You must define the NetBackup server from which the assets are to be imported. Additionally, you must specify the Self Service settings you want to associate with it.

You must specify a Protection Type and a Tenant that you want to associate the imported assets with.

You may also specify which types of cloud assets are to be imported.

You must specify logon credentials for each import. These credentials must only have access to the specified tenant's assets.

Veritas recommends that in the NetBackup Web UI you create a Cloud Provider configuration for each tenant. Create an RBAC object group for that tenant and set the assets access to the Config ID of the appropriate Cloud Provider configuration. You should create an RBAC Access rule for each tenant to link the user that Self Service uses to the object group. The access rule requires a role that includes the View Assets permission.