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

Configuring protection

A protection type defines all the ways a user can protect an asset. If all your users' assets have similar backup requirements you may only need a single protection type. If you offer different protection options for some assets, then each option needs a protection type. Examples of different protection types can include SQL servers, cloud volumes, or a mix of virtual and physical computers. As a general rule you need a protection type for each NetBackup Policy Type you support.

Within each protection type you can define a number of managed, unmanaged and Backup Now protection levels. Managed and Backup Now protection levels are the options that users see when they protect or back up an asset. They can be used to provide varying schedules, retention levels, or other options that you can configure directly on a NetBackup policy.

Each managed protection level or Backup Now level then defines one or more policies. These represent the policies that are created on the backup server in response to a user selecting that level. They define how the policy on the backup server is created, and how it is named. Each unmanaged protection level defines one or more policies. These represent manually created policies on the backup server.

Additionally you can configure a protection level to enable the availability of a Backup Now action. Use this Backup Now action for a computer using the policy it's protected by within the protection level.

Any changes you make to the protection definition are not automatically applied to NetBackup. The changes are not applied to the computers that use this protection type. If the change results in a different set of target policies, existing computers now have an unknown protection level. This change is shown as a black checkmark. You can remove the unknown protection level policies from each asset or container and reapply the modified protection level.

Creating Protection Types

From the Protection Types cog button on the Protection page, select Add.

Table: Settings on Protection Types

Item

Details

Name

The name identifying a protection type. This option is displayed to the users.

Code

The unique code for this protection type. NetBackup policies use this code in the policy name. For example [CustomerCode]-[Code]-[...]

Creating Protection Levels and Backup Now Levels

With a protection type selected, click the relevant Add Protection Level option. The Name, Description, and Color properties are all used to distinguish the level for users. The other settings control functionality.

Table: Settings on Protection Levels and Backup Now Levels

Item

Details

Name

Name of the level (for users).

Description

A description that helps the users decide between different levels.

Code

Code is used when creating NetBackup policies that are associated with this level. It forms part of the name of the policy created. It must be unique within the protection type.

Color

Color is mainly used in the user screens to visually distinguish the different levels that are applied to different computers.

Request type code

Should be left at the default value (DBNEWBACK for protection levels, DBBACKNOW for Backup Now levels) unless you need to customize the system.

Note:

This setting is not relevant to unmanaged protection levels and is not displayed on the screen. For Managed and Backup Now, you can display the field if you select Show Advanced Settings.

Visible

Controls the visibility of the level to users.

Note:

This setting is not relevant to unmanaged protection levels and is not displayed on the screen.

Creating Policies

From the details of a Protection Level or Backup Now Level, click Add Policy to create a policy within that level.

Managed protection levels offer the options shown: Scheduled, Scheduled with File Selection, Cloud Protection Plan, Immediate, and Immediate with File Selection. Backup Now protection levels offer the options shown: Immediate and Immediate with File Selection.

File Protection policies let you protect a list of files or folders on the target computer. File protection is only available for Standard (0) and MS-Windows (13) Policy Types. Immediate policies are run as a one-off backup using a new policy, rather than being added to an ongoing scheduled policy.

On the Policy you can set its Code. You can also see the Target Policy Name that is created with a combination of the code and the parent protection type and protection level codes.

Table: Settings on Policies

Item

Details

Name

Used only for administration; not displayed to users.

Code

Code must be unique within the containing level. NetBackup policies use this code in the policy name. For example CustomerCode-Code-[...]. If there is only one policy within the level you may leave the code blank.

Target Policy Name

Not editable. This field shows an example of the name of the target policy that is created on the backup server when a user selects this level. It is made up of the three codes from protection type, level (either protection level or Backup Now) and policy code.

Note:

This setting is not relevant to unmanaged protection levels and is not displayed on the screen.

Policy Name

This setting is for unmanaged protection level only. The policy determines which backups in the catalog are used to calculate the traffic light status. You can specify an exact policy name or use * to match backups from any policy.

Template Name

The name of a template policy that exists on the backup server which is copied to create the target policy. You can either accept the default name, choose from an existing template, or specify a template name that you create later.

Note:

This setting is not relevant to unmanaged protection levels and is not displayed on the screen.

More information is available.

See Creating NetBackup Template Policies.

Policy Type

You must specify the NetBackup policy type of the template policy.

Note:

This setting is not relevant to unmanaged protection levels and is not displayed on the screen.

Always Show as Protected

Used to bypass the calculation of a computer's traffic light status. When selected the computer always shows as protected.

Warning (hours)

Used in the calculation of a computer's traffic light status. More information is available.

If the field is left blank computers without a backup are flagged for attention. If the field is completed, the computer is flagged for attention when a backup with the correct policy name has not occurred within the specified number of hours.

See About dashboard traffic light status and usage.

Single Client Backup Schedule Name

If you enter a value in this field, this Protection Level is shown as a Backup Now option once a computer has been protected with the level. This field specifies the name of the Schedule that is used when the backup of the single computer is initiated.

Note:

This field applies only to scheduled policies.

Storage Lifecycle Policy Name

The name of the storage lifecycle policy that is used when the Template policy is copied.

VM File Restore

Use this field to determine if the virtual machine backup extracts information to allow for file restore.

This field is only available for VMware or Hyper-V policies.

Client Selection Type

Use this field to select how computers are identified in a VMware or Hyper-V policy. Options are:

  • Client Based Display Name: Use a Client List and the VM Display Name

  • Client Based Hostname: Use a Client List and the host name, or the NetBackup client name

  • Query Display Name: Use a VMware or Hyper-V Intelligent Policy and use the VM Display Name. This option is the default.

  • Query Hostname: Use a VMware Intelligent Policy and the host name, or the NetBackup client name. Hyper-V does not support this option.

  • Query Computer Name (SCVMM only): Use a Hyper-V intelligent policy and the NetBackup Client Name for the SCVMM computer name.

  • Query Name (SCVMM only): Use a Hyper-V intelligent policy and the VM Display Name for the SCVMM name.

If you use vCloud Director Imports then you must use Query Display Name. This option allows vApp and vDC protection as well as the import only obtaining the VM Display Name.

This field is only available for VMware or Hyper-V policies.

Policies that are created within a Backup Now level are always set to Run Immediately. Backup Now policies do not have the Warning (hours) option. Managed protection levels need to contain at least one policy that is not Run Immediately, before they are available for users to select.

Schedule Overrides

You may want to have different protection levels change schedule information when the policy that protects the computer is created. This option helps reduce the number of template policies you create on your backup servers. Schedule overrides allow a number of changes to be made. Use Add Schedule Override in a policy to create an override for each schedule that you want to modify.

Table: Schedule Overrides settings

Item

Details

Name

The name of the schedule that you want to modify. The schedule must exist in the template policy. You can either select from the list or enter the name.

Override Frequency

If this option is selected you can set the frequency at which the schedule runs.

Override Storage Lifecycle Policy Name

If this option is selected you can either select or enter the name of a Storage Lifecycle Policy this schedule uses. This option cannot be used with Override Retention Level.

Override Retention Level

If this option is selected you can either select a retention level or enter the number that is associated with the retention level. This option cannot be used with Override Storage Lifecycle Policy Name.

Override Backup Window

If this option is selected you can set the backup window for the schedule. You can either use the mouse to create windows in the grid, or use the detailed settings. The values completely replace the backup window that is associated with the schedule.

Multiple Policies within a Level

You may want to specify multiple policies within a single level. For example, you want to provide protection for a database server with policies to back up both the database and the operating system.

After you add a protection level and the associated policies, click Refresh link from the cog icon on the Protection page. This action ensures that this data matches policies on the NetBackup master servers. The cog icon becomes animated which indicates that the check is active. The check reviews each defined backup server in the system for the template policies that correspond to the protection levels. Please be aware the system does not check for unmanaged protection levels. Any issues within template policies are highlighted on screen. If you click the highlighted row, further details about the issue that must be resolved are displayed. Once the issues are resolved on the backup server you can refresh to confirm that they are correct. More information about template policy creation is available.

See Creating NetBackup Template Policies.

Creating Cloud Protection Plans

From the details of a Protection Level, click Add Policy and select Cloud Protection Plan to create a plan within that level.

Self Service uses the details in a Cloud Protection Plan to create an appropriate Protection Plan on the NetBackup master server when assets are protected. The created Protection Plan is named after the codes of the Protection Type, Level, and Plan, and displayed in the Cloud Protection Plan UI.

Cloud Protection Plans can set multiple schedules, but must always have at least one.