Veritas NetBackup Server / Enterprise Server 8.0 and later Cloud Configuration Package 2.5.2

Veritas NetBackup Server / Enterprise Server 8.0 and later Cloud Configuration Package 2.5.2

Article: 100033434
Modified: 2019-01-07
Ratings: 5 0
Product(s): NetBackup

Problem

Veritas NetBackup (tm) Server / Enterprise Server 8.0 and later Cloud Configuration Package 2.5.2

Solution

This package contains an update to the CloudProvider.xml configuration file for NetBackup 8.0 and later. This file contains setting details for the cloud providers that are configurable with NetBackup.

This package adds support for the following new cloud providers and locales: 

  • Microsoft Azure Germany


Below are support notes regarding this package:

  • Amazon Lifecycle Policy storage class is supported with NetBackup 8.1.1 and later. 
  • CloudCatalyst is supported with the NetBackup 8.1.1 and later Swift connector.  
  • NetBackup supports bucket creation for Google Nearline Storage Class. To create buckets for other Google Storage Classes, use the Google Portal.
  • NetBackup supports Amazon VPC with all regions. The US East (N. Virginia) region is supported with NetBackup 8.1 and later.
  • CloudCatalyst is supported with NetBackup 8.1 and later S3 and Azure connectors.
  • Amazon Glacier storage class configuration with NetBackup 8.1 is only supported using the csconfig CLI command. For more information, see Protecting data in Amazon Glacier using NetBackup 8.1.   
  • CMCC Cloud Storage v5 is supported with NetBackup 8.1 and later.
  • Fujitsu Cloud Service K5 is supported with NetBackup 8.1 and later.
  • Microsoft Azure Government is supported with NetBackup 8.1 and later.

The presence of a Storage Provider in the CloudProvider.xml file does not indicate, expressed or implied, support of the device on the target NetBackup Server / Enterprise Server platform. For the current list of Cloud Providers supported with NetBackup, refer to the following links: 

Veritas recommends downloading and installing this package:

    If your configuration contains a Cloud storage solution that requires this package. For information on the minimum cloud configuration package required for your solution, see the NetBackup HCL, above. Installation of this package and the latest NetBackup Device Mappings package is required to properly configure that storage.

    If you are configuring Iron Mountain Iron Cloud or Kingsoft Standard Storage Service (KS3), also install the updated cacert.pem file included in this package, following the directions below.

To enable NetBackup Cloud features, download and install the latest NetBackup Device Mappings file. For a link to the latest Device Mappings packages, see the NetBackup HCL, above.

These files are for the following NetBackup configuration only and will not work with earlier NetBackup releases:

  • NetBackup Master Server 8.0 or later with NetBackup Media Server 8.0 or later. NetBackup Media Server version cannot be later than its NetBackup Master Server version.


Installation Procedure
 
Note: You must perform the following procedures only on the NetBackup Master Server that is installed on a cloud-supported platform.
 
**************************************
 
Windows Installation Instructions
 

**************************************
 
These instructions assume that NetBackup is installed at the default location of C:\Program Files\VERITAS\. If NetBackup is installed at a different location, substitute that path for C:\Program Files\VERITAS\ in the instructions below:
 
1. Copy the existing CloudProvider.xml and  CloudInstance.xml files from the following location to an alternate location.
If you are configuring Iron Mountain Iron Cloud or Kingsoft Standard Storage Service, also copy the cacert.pem file.
Default file location in NetBackup:
   C:\Program Files\Veritas\NetBackup\db\cloud
   Note: You can revert this file, if needed.

2. Download and extract the zip file package to a temporary folder.  
This will create three files in the temporary location:
   * Readme.txt (this file)
   * CloudProvider.xml
   * cacert.pem

3. Stop all NetBackup services.

4. Copy the new CloudProvider.xml file from the temporary location, in step 2, to the location mentioned in step 1.

5. If you are configuring Iron Mountain Iron Cloud or Kingsoft Standard Storage Service, copy the new cacert.pem file from the temporary location, in step 2, to the location mentioned in step 1.
   This will need to be done on all media servers.  If you have made any changes to the original file they will be lost.  

6. Start all NetBackup services.  

7. Run the following command. If the command outputs a list of cloud providers, the new CloudProvider.xml was updated successfully. If the command does not output a list of cloud providers or outputs an error message, refer to the troubleshooting section below.
    <NB_INSTALL_PATH>\NetBackup\bin\admincmd\csconfig cldprovider -l
 
 
**************************************
 
UNIX / Linux Installation Instructions
 

**************************************
 
These instructions assume that NetBackup is installed at the default location of /usr/openv/.  If NetBackup is installed at a different location, substitute that path for /usr/openv/ in the instructions below:
 
1. Copy the existing CloudProvider.xml and CloudInstance.xml files from the following location to an alternate location.
If you are configuring Iron Mountain Iron Cloud or Kingsoft Standard Storage Service, also copy the cacert.pem file.
Default file location in NetBackup:
   /usr/openv/netbackup/db/cloud
   Note: You can revert this file, if needed.

2. Download and extract the zip file package to a temporary folder.  
This will create three files in the temporary location:
   * Readme.txt (this file)
   * CloudProvider.xml
   * cacert.pem

3. Stop all NetBackup services.

4. Copy the new CloudProvider.xml file from the temporary location, in step 2, to the location mentioned in step 1.

5. If you are configuring Iron Mountain Iron Cloud or Kingsoft Standard Storage Service, copy the new cacert.pem file from the temporary location, in step 2, to the location mentioned in step 1.
   This will need to be done on all media servers.  If you have made any changes to the original file they will be lost.  

6. Start all NetBackup services.

7. Run the following command. If the command outputs a list of cloud providers, the new CloudProvider.xml was updated successfully. If the command does not output a list of cloud providers or outputs an error message, refer to the troubleshooting section below.
   <NB_INSTALL_PATH>/netbackup/bin/admincmd/csconfig cldprovider -l
 
 
**************************************

Amazon Glacier Storage Server Configuration Information

**************************************"  

  • Master server version must be 8.1 or later.
  • Media server version must be 8.1 or later.


NOTE:  Storage Class "GLACIER" is supported with CloudProvider.xml v2.3.2 and later.

1. Create an alias for the Amazon Glacier cloud storage server using the following csconfig command:
     For Windows:  <NB_INSTALL_PATH>\NetBackup\bin\admincmd\csconfig cldinstance -as -in amazon.com -sts <storage_server_name> -storage_class GLACIER
     For Unix/Linux:  <NB_INSTALL_PATH>/netbackup/bin/admincmd/csconfig cldinstance -as -in amazon.com -sts <storage_server_name> -storage_class GLACIER
   
   If the command completes successfully, then the new CloudProvider.xml was updated successfully.
   If the command returns a failed message, refer to the troubleshooting section below.
   
2. Verify the newly-created alias using the following csconfig command:
     For Windows:  <NB_INSTALL_PATH>\NetBackup\bin\admincmd\csconfig cldinstance -i amazon.com
     For Unix/Linux:  <NB_INSTALL_PATH>/netbackup/bin/admincmd/csconfig cldinstance -i amazon.com
   
3. Configure the Amazon Glacier cloud storage server using the "Configure Cloud Storage Server" Wizard on the NetBackup Administration Console.
     Or
   Follow steps 4-5 to complete storage server configuration through the CLI.

4. Create the storage server with the specific storage type:
     For Windows:  <NB_INSTALL_PATH>\NetBackup\bin\admincmd\nbdevconfig.exe -creatests -storage_server <storage_server_name> -stype <Storage Server Type> -media_server <Media Server Name>
     For Unix/Linux:  <NB_INSTALL_PATH>/netbackup/bin/admincmd/nbdevconfig -creatests -storage_server <storage_server_name> -stype <Storage Server Type> -media_server <Media Server Name>
   
   NOTE: Possible values for stype can be amazon_raw, amazon_rawc, amazon_crypt, amazon_cryptc. For more details, refer to the NetBackup Commands Reference Guide.

5. Add credentials to the newly-created server:
     For Windows:  <NB_INSTALL_PATH>\Volmgr\bin\tpconfig -add -storage_server <storage_server_name> -stype amazon_crypt -sts_user_id <Access Key ID> -password <Secret access key>
     For Unix/Linux:  <NB_INSTALL_PATH>/volmgr/bin/tpconfig -add -storage_server <storage_server_name> -stype amazon_crypt -sts_user_id <Access Key ID> -password <Secret access key>
   
   NOTE: You need to provide the Amazon credentials to access your cloud storage account. For more details, refer to the NetBackup Commands Reference Guide.

**************************************
 
Troubleshooting
 
**************************************
 
NetBackup Cloud service fails to start

NetBackup fails to display a list of Cloud Providers in the admin console, or command line, after updating the CloudProvider.xml file. This is due to NetBackup encountering an entry conflict between the new CloudProvider.xml and the current CloudInstance.xml. To resolve the issue, perform the following:
 
Note: These steps are only to be performed on the NetBackup Master Server.
 

  1. Stop all NetBackup services.
  2. Revert the CloudProvider.xml and CloudInstance.xml file. Refer to the installation section above for file locations.
  3. Start all NetBackup services.
  4. Run the following command:
       For Windows: <NB_INSTALL_PATH>\NetBackup\bin\admincmd\csconfig cldinstance -i
       For Unix/Linux: <NB_INSTALL_PATH>/netbackup/bin/admincmd/csconfig cldinstance -i
  5. Record the output of Cloud Instances in the previous step.
  6. Stop all NetBackup services.
  7. Move both the CloudProvider.xml and CloudInstance.xml files, in the NetBackup directory, to an alternate location. The CloudInstance.xml is stored at the same location as the CloudProvider.xml. You can revert these files, if needed.
  8. Copy the new CloudProvider.xml file, from the update package, into the NetBackup CloudProvider.xml location. Refer to the Installation section above for the default NetBackup CloudProvider.xml location.
  9. Start all NetBackup services.
  10. Run the following command. If the command outputs a list of cloud providers, the CloudProvider.xml was updated successfully.
       For Windows: <NB_INSTALL_PATH>\NetBackup\bin\admincmd\csconfig cldprovider -l
       For Unix/Linux: <NB_INSTALL_PATH>/netbackup/bin/admincmd/csconfig cldprovider -l

Use the NetBackup csconfig command to add missing Cloud Instances, recorded in step 5. For instructions on how to use the csconfig command, use the command help option: csconfig --help.
 
Note: Until missing Cloud Instances are added, NetBackup jobs to these Cloud Provider storage solutions will fail.

Conflict between user-created cloud instance and NetBackup default cloud instance

If there is a conflict between a user-created cloud instance and a NetBackup default cloud instance, the user can update the NetBackup Storage Server to use the NetBackup default cloud instance by following this procedure:

  1. Stop all NetBackup jobs associated with the NetBackup Storage Server.
  2. Run the following cmd to find the cloud instance "Storage Server" name for your Cloud Provider: 
        <NB_INSTALL_PATH>/bin/admincmd/csconfig cldinstance -l
  3. Record the User-Created cloud instance "Storage Server" name and the Default cloud instance "Storage Server" name for your Cloud Provider.
  4. Verify that your Cloud Storage Server name matches the User-Created cloud instance "Storage Server" name. (The NetBackup Storage Server name is displayed in the NetBackup admin console under "Credentials" -> "Storage Servers".)
  5. Run the following cmd to update your NetBackup Storage Server name and to associate it with the Cloud Provider's default cloud instance: 
        <NB_INSTALL_PATH>/bin/admincmd/nbnbemmcmd -renamehost -machinename <user-created Storage Server name> -machinetype ndmp -newmachinename <user-created Storage Server name>
  6. Verify that your Cloud Storage Server name has been updated.
        a.  In the NetBackup admin console, go to "Credentials" -> "Storage Servers".
        b.  Click "Refresh".
  7. Remove the user-created cloud instance.
        a.  In the NetBackup admin console, to go "Host Properties" -> "Master Server".
        b.  Open the Master Server properties.
        c.  Select "Cloud storage" in the left panel and let the right panel load.
        d.  Select the user-created cloud instance under "Cloud Storage".
        e.  Click "Remove".

     
    Related Articles

Was this content helpful?