NetBackup™ Self Service Configuration Guide

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

To remove a computer registration, go to the Assets list on the Assets home page, select an asset, and use the Remove Registration link from the Actions button. 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 Actions button on the asset details page, 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 Asset Imports > vCloud Director page to create a new vCloud Director Import. Follow the on-screen prompts to create a corresponding vCloud Import Integration Setting section.

If the vCloud Director is version 9.5 or higher, you must specify an administrator user name and password for the vCloud Director system. You must also add credentials for each of the underlying vCenter servers that the vCloud Director manages if you are using version 10.1 or below. The credentials are not required for version 10.2 and above. Each vCenter server must be running version 6.5 or higher. Select Manage vCenter Credentials and then Add vCenter Credential to add each vCenter. The vCenter is identified using the URL. This URL must match the name that is registered in vCloud Director.

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 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

Item

Details

vCloud Api

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

Location

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

Online

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 Admin UserName

The administrator user for vCloud in the format: Administrator@System. Required if using vCloud Director 9.5 or higher.

vCloud Admin Password

The password of the account with Admin credentials in vCloud. Required if using vCloud Director 9.5 or higher.

Note:

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 Cloud Assets 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.

Registering vCenter Assets by NetBackup Import

You can automatically import vCenter assets from NetBackup and register them with Self Service. The import is performed on a tenant by tenant basis, using filters or 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 must specify at least the vCenter server to identify the imported assets. You may also specify a set of other filter criteria which every asset must meet for it to be imported. During setup you can preview the results of the current filter criteria.

Alternatively, you can set up individual credentials for the import and use the NetBackup RBAC configuration to determine which assets are imported.