NetBackup™ Snapshot Manager for Cloud Install and Upgrade Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (11.0)
  1. Introduction
    1.  
      About the deployment approach
    2.  
      Deciding where to run NetBackup Snapshot Manager for Cloud
    3.  
      About deploying NetBackup Snapshot Manager in the cloud
  2. Section I. NetBackup Snapshot Manager for Cloud installation and configuration
    1. Preparing for NetBackup Snapshot Manager for Cloud installation
      1.  
        Meeting system requirements
      2.  
        NetBackup Snapshot Manager host sizing recommendations
      3.  
        NetBackup Snapshot Manager extension sizing recommendations
      4.  
        Creating an instance or preparing the host to install NetBackup Snapshot Manager
      5.  
        Installing container platform (Docker, Podman)
      6.  
        Creating and mounting a volume to store NetBackup Snapshot Manager data
      7.  
        Verifying that specific ports are open on the instance or physical host
      8.  
        Preparing NetBackup Snapshot Manager for backup from snapshot jobs
      9.  
        OCI - iptables rules for backup from snapshot jobs
    2. Deploying NetBackup Snapshot Manager for Cloud using container images
      1.  
        Before you begin installing NetBackup Snapshot Manager
      2.  
        Installing NetBackup Snapshot Manager in the Docker/Podman environment
      3.  
        Installing NetBackup Snapshot Manager on CIS Level 2 v2 configured host
      4.  
        Securing the connection to NetBackup Snapshot Manager
      5.  
        Verifying that NetBackup Snapshot Manager is installed successfully
      6.  
        Restarting NetBackup Snapshot Manager
    3. Deploying NetBackup Snapshot Manager for Cloud extensions
      1.  
        Before you begin installing NetBackup Snapshot Manager extensions
      2.  
        Downloading the NetBackup Snapshot Manager extension
      3. Installing the NetBackup Snapshot Manager extension on a VM
        1.  
          Prerequisites to install the extension on VM
        2.  
          Installing the extension on a VM
      4. Installing the NetBackup Snapshot Manager extension on a managed Kubernetes cluster (AKS) in Azure
        1.  
          Prerequisites to install the extension on a managed Kubernetes cluster in Azure
        2.  
          Installing the extension on Azure (AKS)
      5. Installing the NetBackup Snapshot Manager extension on a managed Kubernetes cluster (EKS) in AWS
        1.  
          Prerequisites to install the extension on a managed Kubernetes cluster in AWS
        2. Installing the extension on AWS (EKS)
          1.  
            Install extension using the extension script
      6. Installing the NetBackup Snapshot Manager extension on a managed Kubernetes cluster (GKE) in GCP
        1.  
          Prerequisites to install the extension on a managed Kubernetes cluster in GCP
        2.  
          Installing the extension on GCP (GKE)
      7.  
        Install extension using the Kustomize and CR YAMLs
      8.  
        Managing the extensions
    4. NetBackup Snapshot Manager for cloud providers
      1.  
        Why to configure the NetBackup Snapshot Manager cloud providers?
      2. AWS plug-in configuration notes
        1.  
          Prerequisites for configuring the AWS plug-in
        2.  
          Before you create a cross account configuration
        3.  
          Prerequisites for application consistent snapshots using AWS Systems Service Manager
        4.  
          Prerequisites for configuring AWS plug-in using VPC endpoint
        5.  
          AWS permissions required by NetBackup Snapshot Manager
        6.  
          Configuring AWS permissions for NetBackup Snapshot Manager
      3. Google Cloud Platform plug-in configuration notes
        1. Prerequisites for configuring the GCP plug-in using Credential and Service Account option
          1.  
            Additional prerequisites for configuring the GCP plug-in using Service Account option
        2.  
          Google Cloud Platform permissions required by NetBackup Snapshot Manager
        3.  
          Preparing the GCP service account for plug-in configuration
        4.  
          Configuring a GCP service account for NetBackup Snapshot Manager
        5.  
          GCP cross-project configuration
        6.  
          GCP shared VPC configuration
      4. Microsoft Azure plug-in configuration notes
        1.  
          Configuring permissions on Microsoft Azure
        2.  
          About Azure snapshots
      5. Microsoft Azure Stack Hub plug-in configuration notes
        1.  
          Configuring permissions on Microsoft Azure Stack Hub
        2.  
          Configuring staging location for Azure Stack Hub VMs to restore from backup
        3.  
          About Azure Stack Hub snapshots
      6. OCI plug-in configuration notes
        1.  
          Limitation of NetBackup OCI support
        2.  
          Prerequisite for configuring the OCI plug-in
        3.  
          OCI configuration parameters
        4.  
          Configuring host support for OCI
        5.  
          OCI permissions required by NetBackup Snapshot Manager
      7.  
        Cloud Service Provider endpoints for DBPaaS
    5. Configuration for protecting assets on cloud hosts/VM
      1.  
        Deciding which feature (on-host agent or agentless) of NetBackup Snapshot Manager is to be used for protecting the assets
      2. Protecting assets with NetBackup Snapshot Manager's on-host agent feature
        1. Installing and configuring NetBackup Snapshot Manager agent
          1.  
            Downloading and installing the NetBackup Snapshot Manager agent
          2. Linux-based agent
            1.  
              Preparing to install the Linux-based agent
            2.  
              Registering the Linux-based agent
          3. Windows-based agent
            1.  
              Preparing to install the Windows-based agent
            2.  
              Registering the Windows-based agent
        2. Configuring the NetBackup Snapshot Manager application plug-in
          1.  
            Configuring an application plug-in
          2. Microsoft SQL plug-in
            1.  
              Microsoft SQL plug-in configuration requirements
            2.  
              Restore requirements and limitations for Microsoft SQL Server
            3.  
              Steps required before restoring SQL AG databases
            4.  
              Additional steps required after restoring SQL AG databases
            5. Additional steps required after a SQL Server instance snapshot restore
              1.  
                Steps required after a SQL Server host-level restore
              2.  
                Steps required after a SQL Server instance disk-level snapshot restore to new location
          3. Oracle plug-in
            1. Oracle plug-in configuration requirements
              1.  
                Optimizing your Oracle database data and metadata files
            2.  
              Restore requirements and limitations for Oracle
            3.  
              Additional steps required after an Oracle snapshot restore
      3. Protecting assets with NetBackup Snapshot Manager's agentless feature
        1.  
          Prerequisites for the agentless configuration
        2.  
          Configuring the agentless feature
        3.  
          Configuring the agentless feature after upgrading NetBackup Snapshot Manager
    6. Snapshot Manager for cloud catalog backup and recovery
      1.  
        About using script
      2.  
        NetBackup Snapshot Manager data backup
      3.  
        NetBackup Snapshot Manager data recovery
    7. NetBackup Snapshot Manager for cloud assets protection
      1. NetBackup protection plan
        1.  
          Creating a NetBackup protection plan for cloud assets
        2.  
          Subscribing cloud assets to a NetBackup protection plan
      2.  
        Assigning tags on snapshots and Restore Point Collection
      3.  
        Configuring VSS to store shadow copies on the originating drive
    8. Volume encryption in NetBackup Snapshot Manager for cloud
      1.  
        About volume encryption support in NetBackup Snapshot Manager
      2.  
        Volume encryption for Azure
      3.  
        Volume encryption for GCP
      4.  
        Volume encryption for AWS
      5.  
        Volume encryption for OCI
    9. NetBackup Snapshot Manager for Cloud security
      1.  
        Configuring security for Azure Stack
      2.  
        Configuring the cloud connector for Azure Stack
      3.  
        CA configuration for Azure Stack
  3. Section II. NetBackup Snapshot Manager for Cloud maintenance
    1. NetBackup Snapshot Manager for Cloud logging
      1.  
        About NetBackup Snapshot Manager logging mechanism
      2. How Fluentd-based NetBackup Snapshot Manager logging works
        1.  
          About the NetBackup Snapshot Manager fluentd configuration file
        2.  
          Modifying the fluentd configuration file
      3.  
        NetBackup Snapshot Manager logs
      4.  
        Agentless logs
      5.  
        Troubleshooting NetBackup Snapshot Manager logging
    2. Upgrading NetBackup Snapshot Manager for Cloud
      1.  
        About NetBackup Snapshot Manager for Cloud upgrades
      2.  
        Supported upgrade path
      3.  
        Upgrade scenarios
      4.  
        Preparing to upgrade NetBackup Snapshot Manager
      5.  
        Upgrading NetBackup Snapshot Manager
      6.  
        Upgrading NetBackup Snapshot Manager using patch or hotfix
      7.  
        Applying operating system patches on NetBackup Snapshot Manager host
      8. Migrating and upgrading NetBackup Snapshot Manager
        1.  
          Before you begin migrating NetBackup Snapshot Manager
        2.  
          Migrate and upgrade NetBackup Snapshot Manager on RHEL 8.x and 9.x
      9.  
        GCP configuration for migration from zone to region
      10. Post-upgrade tasks
        1.  
          Upgrading NetBackup Snapshot Manager extensions
        2.  
          Post upgrade limitations
      11.  
        Post-migration tasks
    3. Uninstalling NetBackup Snapshot Manager for Cloud
      1.  
        Preparing to uninstall NetBackup Snapshot Manager
      2.  
        Backing up NetBackup Snapshot Manager
      3.  
        Unconfiguring NetBackup Snapshot Manager plug-ins
      4.  
        Unconfiguring NetBackup Snapshot Manager agents
      5.  
        Removing the NetBackup Snapshot Manager agents
      6.  
        Removing NetBackup Snapshot Manager from a standalone Docker host environment
      7.  
        Removing NetBackup Snapshot Manager extensions - VM-based or managed Kubernetes cluster-based
      8.  
        Restoring NetBackup Snapshot Manager
    4. Troubleshooting NetBackup Snapshot Manager for Cloud
      1.  
        Troubleshooting NetBackup Snapshot Manager
      2.  
        SQL snapshot or restore and granular restore operations fail if the Windows instance loses connectivity with the NetBackup Snapshot Manager host
      3.  
        Disk-level snapshot restore fails if the original disk is detached from the instance
      4.  
        Discovery is not working even after assigning system managed identity to the control node pool
      5.  
        Performance issue with GCP backup from snapshot
      6.  
        Post migration on host agents fail with an error message
      7.  
        File restore job fails with an error message
      8.  
        Acknowledgment not received for datamover
      9.  
        Google Cloud Platform does display the Snapshot ID of the disk
      10.  
        Application state of the connected/configured cloud VM(s) displays an error after upgrading to NetBackup Snapshot Manager version 11.x
      11.  
        Backup and restore jobs fail with timeout error
      12.  
        GCP restore with encryption key failed with an error message
      13.  
        Amazon Redshift clusters and databases not available after discovery
      14.  
        Shared VPC subnet not visible
      15.  
        Container manager may not spawn the ephemeral registration container timely
      16.  
        GCP restore from VM fails to obtain firewall rules
      17.  
        Parameterised VM restore fails to retrieve encryption keys
      18.  
        Restore from snapshot of a VM with security type Trusted Launch fails
      19.  
        Snapshot Manager failed to retrieve the specified cloud domain(s), against the specified plugin instance
      20.  
        Issues with SELinux configuration
      21.  
        Performance issues with OCI backup from snapshot and restore from backup copy
      22.  
        Connection to Amazon Linux 2023 or Alma Linux machines fail
      23.  
        Single file restore from snapshot copy fails with an error
      24.  
        MS SQL application backup, restore, or SFR job on Windows cloud VM fails with an error
      25.  
        Status 49 error appears
      26.  
        Restore from backup fails with an error
      27.  
        (For AWS) If the specified AMI is not subscribed in the given region an error message appears
      28.  
        Restore of Azure Disk Encrypted VM fails with an error

AWS plug-in configuration notes

The Amazon Web Services (AWS) plug-in lets you create, restore, and delete snapshots of the following assets in an Amazon cloud:

  • Elastic Compute Cloud (EC2) instances

  • Elastic Block Store (EBS) volumes

  • Amazon Relational Database Service (RDS) instances

  • Aurora clusters

  • Redshift clusters

  • AWS DocumentDB

  • AWS Neptune

  • RDS Custom for SQL

  • RDS Custom for Oracle

Note:

Before you configure the AWS plug-in, ensure that you have enabled the regions that you want to protect and configured the proper permissions so that NetBackup Snapshot Manager can work with your AWS assets.

NetBackup Snapshot Manager supports the following AWS regions:

Table: AWS regions supported by NetBackup Snapshot Manager

AWS commercial regions

AWS GovCloud (US) regions

  • us-east-1, us-east-2, us-west-1, us-west-2

  • ap-east-1, ap-south-1, ap-south-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-4, ap-southeast-5, ap-southeast-7

  • eu-central-1, eu-central-2, eu-west-1, eu-west-2, eu-west-3, eu-north-1, eu-south-1, eu-south-2

  • cn-north-1, cn-northwest-1

  • ca-central-1

  • me-south-1, me-central-1

  • mx-central-1

  • sa-east-1

  • cn-north-1, cn-northwest-1

  • af-south-1

  • il-central-1

  • FIPS supported regions: us-east-1, us-east-2, us-west-1, us-west-2

  • us-gov-east-1

  • us-gov-west-1

The following information is required for configuring the NetBackup Snapshot Manager plug-in for AWS:

If NetBackup Snapshot Manager is deployed in the AWS cloud:

Table: AWS plug-in configuration parameters: cloud deployment

NetBackup Snapshot Manager configuration parameter

Description

For Source Account configuration

Regions

One or more AWS regions associated with the AWS source account in which to discover cloud assets.

Note:

If you deploy NetBackup Snapshot Manager using the CloudFormation template (CFT), then the source account is automatically configured as part of the template-based deployment workflow.

VPC Endpoint

First DNS name of AWS Security Token Service (STS) endpoint service with no zone specified.

For Cross Account configuration

Account ID

The account ID of the other AWS account (cross account) whose assets you wish to protect using the NetBackup Snapshot Manager instance configured in the Source Account.

Role Name

The IAM role that is attached to the other AWS account (cross account).

Regions

One or more AWS regions associated with the AWS cross account in which to discover cloud assets.

VPC Endpoint

First DNS name of AWS Security Token Service (STS) endpoint service with no zone specified.

For example,

vpce-044994fccdfd11b6f-k5hd5cx1.sts.us-east-2.vpce.amazonaws.com

Note:

For an existing NetBackup Snapshot Manager deployed on AWS cloud to be used by using VPC Endpoint, then edit the configured plug-in by adding the VPC Endpoint entry.

See Prerequisites for configuring AWS plug-in using VPC endpoint.

When NetBackup Snapshot Manager connects to AWS, it uses the following endpoints. You can use this information to create a allowed list on your firewall.

Note:

Amazon Web Services recommends using the regional endpoint instead of global endpoints.

  • ec2.*.amazonaws.com

  • sts.*.amazonaws.com

  • rds.*.amazonaws.com

  • kms. *.amazonaws.com

  • ebs.*.amazonaws.com

  • iam.*.amazonaws.com

  • eks.*.amazonaws.com

  • autoscaling.*.amazonaws.com

  • (For DBPaaS protection) dynamodb.*.amazonaws.com, redshift.*.amazonaws.com

  • (For provider managed consistency) ssm.*.amazonaws.com

In addition, you must specify the following resources and actions:

  • ec2.SecurityGroup.*

  • ec2.Subnet.*

  • ec2.Vpc.*

  • ec2.createInstance

  • ec2.runInstances

Support for restore of multiple network interfaces (NIC)

NetBackup Snapshot Manager provides an option to restores the original network configuration (all the NIC's and IP addresses on the source VM) on AWS:

  • Private IPs are restored as they were on the source VM, if that IP is available to attach.

  • For public IPs, the AssociatePublicIpAddress property is restored as it was on the source VM. Based on this attribute, a public IP would be assigned to the VM.

Configuring multiple accounts or subscriptions or projects
  • If you are creating multiple configurations for the same plug-in, ensure that they manage assets from different Regions. Two or more plug-in configurations should not manage the same set of cloud assets simultaneously.

  • When multiple accounts are all managed with a single NetBackup Snapshot Manager, the number of assets being managed by a single NetBackup Snapshot Manager instance might get too large and it would be better to space them out.

  • To achieve application consistent snapshots,

    • Ensure that the prerequisites for provider managed consistency are met. For more information, refer to AWS Documentation.

    • If above prerequisites are not met, then agent/agentless network connections between the remote VM instance and NetBackup Snapshot Manager is required. This would require setting up cross account/subscription/project networking.

AWS plug-in considerations and limitations

Before you configure the plug-in, consider the following:

  • NetBackup Snapshot Manager does not support AWS Nitro-based instances that use EBS volumes that are exposed as non-volatile memory express (NVMe) devices.

    To allow NetBackup Snapshot Manager to discover and protect AWS Nitro-based Windows instances that use NVMe EBS volumes, ensure that the AWS NVMe tool executable file, ebsnvme-id.exe, is present in any of the following locations on the AWS Windows instance:

    • %PROGRAMDATA%\Amazon\Tools

      This is the default location for most AWS instances.

    • %PROGRAMFILES%\Veritas\Cloudpoint

      Manually download and copy the executable file to this location.

    • System PATH environment variable

      Add or update the executable file path in the system's PATH environment variable.

      If the NVMe tool is not present in one of the mentioned locations, NetBackup Snapshot Manager may fail to discover the file systems on such instances.

      You may see the following error in the logs:

      "ebsnvme-id.exe" not found in expected paths!"
  • To allow NetBackup Snapshot Manager to discover and protect Windows instances created from custom/community AMI.

    • AWS NVMe drivers must be installed on custom or community AMIs. See this link.

    • Install the ebsnvme-id.exe either in %PROGRAMDATA%\Amazon\Tools or %PROGRAMFILES%\Veritas\Cloudpoint

    • Friendly device name must contain the substring "NVMe", or update in Windows registry for all NVMe backed devices.

      Registry path:

      Computer\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001

      \Enum\SCSI\Disk&Ven_NVMe&Prod_Amazon_Elastic_B\

      Property Name: FriendlyName

      Value: NVMe Amazon Elastic B SCSI Disk Drive

  • Missing permission exception during discovery: By default, while adding a new AWS provider plug-in configuration, no permission check would be done for AWS cloud related operations. To enable permission check during AWS provider plug-in configuration, add skip_permissions_check = "no" parameter under the AWS section in flexsnap.conf file.

  • Redshift clusters and databases must be in an available state on the AWS portal in order to allow NetBackup Snapshot Manager to discover and protect Redshift assets. When Redshift cluster is in the available state, assets are marked as Active on NetBackup UI; otherwise, assets are marked as Inactive.

  • You cannot delete automated snapshots of RDS instances, Redshift clusters, and Aurora clusters through NetBackup Snapshot Manager.

  • The application consistency of AWS RDS applications depend on the behavior of AWS. (AWS suspends I/O while backing up the DB instance).

    This is a limitation from AWS and is currently outside the scope of NetBackup Snapshot Manager.

  • All automated snapshot names start with the pattern rds:. For Redshift clusters, it starts with rs:

  • If you are configuring the plug-in to discover and protect AWS Nitro-based Windows instances that use NVMe EBS volumes, you must ensure that the AWS NVMe tool executable file, ebsnvme-id.exe, is present in any of the following locations on the AWS instance:

    • %PROGRAMDATA%\Amazon\Tools

      This is the default location for most AWS instances.

    • %PROGRAMFILES%\Veritas\Cloudpoint

      Manually download and copy the executable file to this location.

    • System PATH environment variable

      Add or update the executable file path in the system's PATH environment variable.

    If the NVMe tool is not present in one of the mentioned locations, NetBackup Snapshot Manager may fail to discover the file systems on such instances. You may see the following error in the logs:

    "ebsnvme-id.exe" not found in expected paths!"

    This is required for AWS Nitro-based Windows instances only. Also, if the instance is launched using the community AMI or custom AMI, you might need to install the tool manually.

  • NetBackup Snapshot Manager does not support cross-account replication for AWS RDS instances, RDS clusters, or Redshift clusters, if the snapshots are encrypted using the default RDS encryption key (aws/rds). You cannot share such encrypted snapshots between AWS accounts.

    If you try to replicate such snapshots between AWS accounts, the operation fails with the following error:

    Replication failed The source snapshot KMS key [<key>] does not exist, 
    is not enabled or you do not have permissions to access it.

    This is a limitation from AWS and is currently outside the scope of NetBackup Snapshot Manager.

  • If a region is removed from the AWS plug-in configuration, then all the discovered assets from that region are also removed from the NetBackup Snapshot Manager assets database. If there are any active snapshots that are associated with the assets that get removed, then you may not be able perform any operations on those snapshots.

    Once you add that region back into the plug-in configuration, NetBackup Snapshot Manager discovers all the assets again and you can resume operations on the associated snapshots. However, you cannot perform restore operations on the associated snapshots.

  • NetBackup Snapshot Manager supports commercial as well as GovCloud (US) regions. During AWS plug-in configuration, even though you can select a combination of AWS commercial and GovCloud (US) regions, the configuration will eventually fail.

  • NetBackup Snapshot Manager does not support IPv6 addresses for AWS RDS instances. This is a limitation of Amazon RDS itself and is not related to NetBackup Snapshot Manager.

    For more information, refer to the AWS documentation.

  • NetBackup Snapshot Manager does not support application consistent snapshots and granular file restores for Windows systems with virtual disks or storage spaces that are created from a storage pool. If a Microsoft SQL server snapshot job uses disks from a storage pool, the job fails with an error. But if a snapshot job for virtual machine which is in a connected state is triggered, the job might be successful. In this case, the file system quiescing and indexing is skipped. The restore job for such an individual disk to original location also fails. In this condition, the host might move to an unrecoverable state and requires a manual recovery.

  • AWS virtual machine cannot be restored with a security group not owned by the account where the restore is being performed. This is due to a limitation from AWS which restricts creating the EC2 instance on shared VPC's security group that is not owned by the account creating the virtual machine.

    For more information, refer to the 'Share your VPC' section of the Amazon VPC User Guide.

  • For filesystem/application consistent snapshots using AWS Systems Service Manager:

    • The SSM document created must be removed manually on plug-in/NetBackup Snapshot Manager removal.

    • Snapshot of the VM workloads having ext2 filesystem would be consistent depending on the kernel/Operating system version.

    • If AWS CLI, AWS VSS components module is not installed on the VM workload, then internet is required to install.

    • If pre- and post- script is not provided, Linux application consistent snapshot requires VM to be in connected state with application plug-in configured.