Veritas NetBackup™ Self Service Configuration Guide

Last Published:
Product(s): NetBackup (8.3.0.1, 8.3)
  1. Licensing
    1.  
      Applying the full License
  2. Configuring a Self Service solution
    1.  
      About configuring a Self Service solution
    2.  
      Self Service scheduled backup
    3.  
      Configuration checklist
  3. 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
  4. 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
  5. Customizing Self Service
    1.  
      Language settings
    2.  
      Creating or customizing a request form
    3.  
      Themes
    4.  
      Notices
  6. 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
  7. 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
  8. Appendix A. NetBackup policy types
    1.  
      List of NetBackup policy types
  9. 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
  10. Appendix C. Synchronizing data from NetBackup
    1.  
      About synchronizing data from NetBackup
  11. 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
  12. 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
  13. Appendix F. REST API
    1.  
      About the REST API
  14. Appendix G. Glossary
    1.  
      Glossary

Enabling communication with a NetBackup master server using the REST API

NetBackup Self Service can use the NetBackup REST API for some communication with the master server. Your master server must be version 8.1.2 or higher.

Basic Setup

To enable communication using the REST API

  1. Log on to NetBackup Self Service as an administrator and navigate to the Backup Servers tab. Select the appropriate master server.
  2. Fill in the details in the REST API Connection section.

    A background task automatically examines the connectivity with the master server.

  3. Once the job has completed, click the status icon to open connectivity summary screen
  4. Review that the REST API has been contacted successfully.
Credentials

By default NetBackup Self Service uses the same credentials to access the REST API as it uses to access the CLI. If you want to use a different account and RBAC security, the account requires a role with at least View Protection Plans, Manage Protection Plans, View Assets, Manage Assets, Recover/Restore, and View Jobs. It also requires an object group with access to all Assets, and all Protection plans.

Certificates

Communication with the NetBackup REST API is over https. Https requires a trust relationship to exist between the client and the server. In this instance the client is the NetBackup Self Service web server or Task engine server, and the server is the NetBackup master server. The trust relationship is established using a certificate.

You have three options for the certificate:

  1. The master server uses a certificate that is issued from a trusted certificate authority.

    The NetBackup Self Service web server has the trust of the https connection and no other actions are necessary.

  2. The master server certificate is either from a private certificate authority, or a self-signed certificate. You must install the certificate authority certificate manually in the trusted certificate store of the web server and task engine server. See To install the Certificate Authority certificate from the master server onto the NetBackup Self Service web server or Task Engine server for more information.

  3. Ignore certificate errors.

    • Go into NetBackup Self Service as an administrator and navigate to the Backup Servers tab.

    • Select the master server. Click Show Advanced Settings. In the REST API Connection section review Ignore Certificate Errors, and save changes.

      This choice is a good option to use when first setting up the REST API, as it eliminates one source of problems. However, once the REST API connection works, you should only use trusted certificates. Once trusted certificates are established, clear the 'Ignore Certificate Errors' option.

Installing a Trusted Certificate Authority Certificate

To install the Certificate Authority certificate from the master server onto the NetBackup Self Service web server or Task Engine server

  1. In NetBackup Self Service:
    • In the Backup Servers tab, select the master server. Click the status icon, to open the configuration summary screen.

    • In the REST Connection Status section, click to download the master server's certificate onto your computer.

  2. In Windows Explorer, on the appropriate NetBackup Self Service server:
    • Locate the certificate and right-click to open it.

    • Review the certificate to ensure that it is correct.

    • Click Install Certificate....

      • Select the Local Machine store location.

      • Browse to the certificate store Trusted Root Certification Authorities and select OK.

      • Select Next.

      • Select Finish.

  3. This process installs the master server's Certificate Authority certificate on the NetBackup Self Service server. The server now trusts the master server certificate.
  4. Return to NetBackup Self Service and in the Backup Servers tab, select the master server. Ensure that the Ignore Certificate Errors option is cleared.
  5. Run the connectivity check. Verify that you can still connect to the master server.