NetBackup™ Snapshot Manager for Cloud Install and Upgrade Guide
- Introduction
- Section I. NetBackup Snapshot Manager for Cloud installation and configuration
- Preparing for NetBackup Snapshot Manager for Cloud installation
- Meeting system requirements
- NetBackup Snapshot Manager host sizing recommendations
- NetBackup Snapshot Manager extension sizing recommendations
- Creating an instance or preparing the host to install NetBackup Snapshot Manager
- Installing container platform (Docker, Podman)
- Creating and mounting a volume to store NetBackup Snapshot Manager data
- Verifying that specific ports are open on the instance or physical host
- Preparing NetBackup Snapshot Manager for backup from snapshot jobs
- OCI - iptables rules for backup from snapshot jobs
- Deploying NetBackup Snapshot Manager for Cloud using container images
- Before you begin installing NetBackup Snapshot Manager
- Installing NetBackup Snapshot Manager in the Docker/Podman environment
- Installing NetBackup Snapshot Manager on CIS Level 2 v2 configured host
- Securing the connection to NetBackup Snapshot Manager
- Verifying that NetBackup Snapshot Manager is installed successfully
- Restarting NetBackup Snapshot Manager
- Deploying NetBackup Snapshot Manager for Cloud extensions
- Before you begin installing NetBackup Snapshot Manager extensions
- Downloading the NetBackup Snapshot Manager extension
- Installing the NetBackup Snapshot Manager extension on a VM
- Installing the NetBackup Snapshot Manager extension on a managed Kubernetes cluster (AKS) in Azure
- Installing the NetBackup Snapshot Manager extension on a managed Kubernetes cluster (EKS) in AWS
- Installing the NetBackup Snapshot Manager extension on a managed Kubernetes cluster (GKE) in GCP
- Install extension using the Kustomize and CR YAMLs
- Managing the extensions
- NetBackup Snapshot Manager for cloud providers
- Why to configure the NetBackup Snapshot Manager cloud providers?
- AWS plug-in configuration notes
- Prerequisites for configuring the AWS plug-in
- Before you create a cross account configuration
- Prerequisites for application consistent snapshots using AWS Systems Service Manager
- Prerequisites for configuring AWS plug-in using VPC endpoint
- AWS permissions required by NetBackup Snapshot Manager
- Configuring AWS permissions for NetBackup Snapshot Manager
- Google Cloud Platform plug-in configuration notes
- Prerequisites for configuring the GCP plug-in using Credential and Service Account option
- Google Cloud Platform permissions required by NetBackup Snapshot Manager
- Preparing the GCP service account for plug-in configuration
- Configuring a GCP service account for NetBackup Snapshot Manager
- GCP cross-project configuration
- GCP shared VPC configuration
- Microsoft Azure plug-in configuration notes
- Microsoft Azure Stack Hub plug-in configuration notes
- OCI plug-in configuration notes
- Cloud Service Provider endpoints for DBPaaS
- Configuration for protecting assets on cloud hosts/VM
- Deciding which feature (on-host agent or agentless) of NetBackup Snapshot Manager is to be used for protecting the assets
- Protecting assets with NetBackup Snapshot Manager's on-host agent feature
- Installing and configuring NetBackup Snapshot Manager agent
- Configuring the NetBackup Snapshot Manager application plug-in
- Configuring an application plug-in
- Microsoft SQL plug-in
- Oracle plug-in
- Protecting assets with NetBackup Snapshot Manager's agentless feature
- Snapshot Manager for cloud catalog backup and recovery
- NetBackup Snapshot Manager for cloud assets protection
- Volume encryption in NetBackup Snapshot Manager for cloud
- NetBackup Snapshot Manager for Cloud security
- Preparing for NetBackup Snapshot Manager for Cloud installation
- Section II. NetBackup Snapshot Manager for Cloud maintenance
- NetBackup Snapshot Manager for Cloud logging
- Upgrading NetBackup Snapshot Manager for Cloud
- About NetBackup Snapshot Manager for Cloud upgrades
- Supported upgrade path
- Upgrade scenarios
- Preparing to upgrade NetBackup Snapshot Manager
- Upgrading NetBackup Snapshot Manager
- Upgrading NetBackup Snapshot Manager using patch or hotfix
- Applying operating system patches on NetBackup Snapshot Manager host
- Migrating and upgrading NetBackup Snapshot Manager
- GCP configuration for migration from zone to region
- Post-upgrade tasks
- Post-migration tasks
- Uninstalling NetBackup Snapshot Manager for Cloud
- Preparing to uninstall NetBackup Snapshot Manager
- Backing up NetBackup Snapshot Manager
- Unconfiguring NetBackup Snapshot Manager plug-ins
- Unconfiguring NetBackup Snapshot Manager agents
- Removing the NetBackup Snapshot Manager agents
- Removing NetBackup Snapshot Manager from a standalone Docker host environment
- Removing NetBackup Snapshot Manager extensions - VM-based or managed Kubernetes cluster-based
- Restoring NetBackup Snapshot Manager
- Troubleshooting NetBackup Snapshot Manager for Cloud
- Troubleshooting NetBackup Snapshot Manager
- SQL snapshot or restore and granular restore operations fail if the Windows instance loses connectivity with the NetBackup Snapshot Manager host
- Disk-level snapshot restore fails if the original disk is detached from the instance
- Discovery is not working even after assigning system managed identity to the control node pool
- Performance issue with GCP backup from snapshot
- Post migration on host agents fail with an error message
- File restore job fails with an error message
- Acknowledgment not received for datamover
- Google Cloud Platform does display the Snapshot ID of the disk
- Application state of the connected/configured cloud VM(s) displays an error after upgrading to NetBackup Snapshot Manager version 11.x
- Backup and restore jobs fail with timeout error
- GCP restore with encryption key failed with an error message
- Amazon Redshift clusters and databases not available after discovery
- Shared VPC subnet not visible
- Container manager may not spawn the ephemeral registration container timely
- GCP restore from VM fails to obtain firewall rules
- Parameterised VM restore fails to retrieve encryption keys
- Restore from snapshot of a VM with security type Trusted Launch fails
- Snapshot Manager failed to retrieve the specified cloud domain(s), against the specified plugin instance
- Issues with SELinux configuration
- Performance issues with OCI backup from snapshot and restore from backup copy
- Connection to Amazon Linux 2023 or Alma Linux machines fail
- Single file restore from snapshot copy fails with an error
- MS SQL application backup, restore, or SFR job on Windows cloud VM fails with an error
- Status 49 error appears
- Restore from backup fails with an error
- (For AWS) If the specified AMI is not subscribed in the given region an error message appears
- Restore of Azure Disk Encrypted VM fails with an error
Meeting system requirements
The host on which you install NetBackup Snapshot Manager must meet the following requirements.
See NetBackup Snapshot Manager host sizing recommendations.
Table: Operating system, processor, and package requirements for NetBackup Snapshot Manager host
Category | Requirement |
|---|---|
Operating system | See the NetBackup Snapshot Manager Software Compatibility List (SCL) for details. |
Processor architecture | See the NetBackup Snapshot Manager Software Compatibility List (SCL) for details. |
Packages on NetBackup Snapshot Manager host | Following are the required packages to be installed on NetBackup Snapshot Manager host for operating system specific:
|
Note:
The single hostname or FQDN for NetBackup Snapshot Manager has limit of 64 characters which is required at the time of installation.
Multi-alias feature is no longer supported for Snapshot Manager.
Installation of Snapshot Manager version 10.4 or later is not supported with backlevel NetBackup Primary Server (10.2 or earlier). For the upgrade support from 10.2 or earlier releases:
Table: System requirements for the NetBackup Snapshot Manager host
Host on which NetBackup Snapshot Manager is installed | Requirements |
|---|---|
Amazon Web Services (AWS) instance |
For PaaS workloads:
|
Microsoft Azure VM |
Ensure that do the following before you deploy NetBackup Snapshot Manager on an RHEL instance in the Azure cloud:
|
Microsoft Azure Stack Hub VM |
Ensure that do the following before you deploy NetBackup Snapshot Manager on an RHEL instance in the Azure Stack Hub cloud:
|
Google Cloud Platform (GCP) VM |
Note: When using the custom image to deploy NetBackup Snapshot Manager, follow the guidelines listed by GCP in Install the guest environment. |
Oracle Cloud Infrastructure (OCI) |
Note: To use backup from snapshot and Single file restore, ensure that the Oracle Cloud Agent is running and Block Volume Management plug-in is enabled from the OCI console. See Oracle documentation for details. |
NetBackup Snapshot Manager uses the following file systems on the host to store all the container images and files during installation:
/(root file system)/var
The /var file system is further used for container run times. Ensure that the host on which you install or upgrade NetBackup Snapshot Manager has sufficient space for the following components.
Table: Space considerations for NetBackup Snapshot Manager components
Component | Space requirements |
|---|---|
NetBackup Snapshot Manager containers | Minimum 10 GB (recommended 30 GB) free space. |
NetBackup Snapshot Manager agents and plug-ins | 350 MB free space, for every NetBackup Snapshot Manager plug-in and agent is configured. |
Additionally, NetBackup Snapshot Manager also requires a separate volume for storing NetBackup Snapshot Manager data. Ensure that you create and mount this volume to /cloudpoint on the NetBackup Snapshot Manager host. Ensure that the permission of /cloudpoint directory is 755.
Table: Space consideration for NetBackup Snapshot Manager data volume
Volume mount path | Size |
|---|---|
| 50 GB or more |
See NetBackup Snapshot Manager host sizing recommendations.
Following are the inbound and the outbound firewall port requirements:
The following inbound ports must be open:
443: To handle API requests from primary, media, client. If configured with default port else inbound must be allowed by firewall for custom port.
5671: For Snapshot Manager's agents.
The following outbound ports are required:
22: For agentless connection to Linux VM (OpenSSH) and Windows VM (WMI).
1556: For registration with NetBackup primary server.
Following are the additional ports required for Single File Restore (SFR) from a backup copy:
For Windows: Ports 139 and 445 must be open outbound from the clients (target VMs on which on-host agents are running) to access SMB share from the storage server(s).
For Linux: Ports 2049 and 111, the standard NFS ports, 2049 and 111 must be open outbound from the clients (target VMs on which on-host agents are running) to access NFS share from the storage server(s).
NetBackup Snapshot Manager supports the following applications, operating systems and cloud platforms.
These assets are supported irrespective of how you configure NetBackup Snapshot Manager, whether using the NetBackup Snapshot Manager cloud agents and plug-ins (earlier known as off-host plug-ins), or using the NetBackup Snapshot Manager application configuration plug-ins (earlier known as on-host plug-ins), or using the NetBackup Snapshot Manager agentless feature.
Table: Supported applications, operating systems, and cloud platforms
Category | Support |
|---|---|
Applications |
Note: For a complete list of the versions supported, see the NetBackup Snapshot Manager Software Compatibility List (SCL). |
Operating systems on supported assets |
Note: For a complete list of the versions supported, see the NetBackup Snapshot Manager Software Compatibility List (SCL). |
Cloud platforms | Amazon Web Services (AWS) If you want to protect applications, the applications must be hosted on a t2.large or a higher specification AWS instance type. NetBackup Snapshot Manager currently does not support applications that are running on t2.medium or a lower instance type. The t2 series instances are supported only if the device naming conventions recommended by AWS are followed. For more details, refer to the following links:
For protecting Microsoft Windows-based applications, use t2.xlarge or t3.xlarge or a higher specification instance type. For more information on the required permissions for configuring AWS, refer to the following link: |
Microsoft Azure If you wish to protect applications, the applications must be hosted on a D2s_V3 Standard or a higher specification Azure virtual machine type. For protecting Microsoft Windows-based applications, use B4ms or D4s_V3 or a higher specification virtual machine. Note: The NetBackup Snapshot Manager Azure plug-in supports disks of type Premium SSD v2 (PremiumV2_LRS), UltraSSD_LRS, Premium_LRS, Standard_LRS, and StandardSSD_LRS. All other disk types are defaulted to Standard_LRS during snapshot restore operations. For more information on the required permissions for configuring Azure, refer to the following link: | |
Microsoft Azure Stack Hub (2008 and later) If you wish to protect applications, the applications must be hosted on a DS2_v2 Standard or a higher specification Azure Stack Hub virtual machine type. For more information, see VM sizes supported in Azure Stack Hub. Note: The NetBackup Snapshot Manager Azure Stack Hub plug-in supports disks of type Premium_LRS, Standard_LRS, and StandardSSD_LRS. All other disk types are defaulted to Standard_LRS during snapshot restore operations. For more information on the required permissions for configuring Microsoft Azure Stack, refer to the following link: | |
Google Cloud Platform (GCP) If you wish to protect applications, the applications must be hosted on a n2-standard-4 or a higher specification GCP virtual machine type. For more information on the required permissions for configuring Google cloud platform, refer to the following link: See Google Cloud Platform permissions required by NetBackup Snapshot Manager. | |
Oracle Cloud Infrastructure (OCI) If you wish to protect applications, host the applications on a x86_64 machine. With 2 OCPU and 16 GB RAM. For more information on the required permissions for configuring OCI, refer to the following link: See OCI permissions required by NetBackup Snapshot Manager. To use the application restore functionality, enable the Block Volume Management plug-in on the hosted VM from the OCI console. For details, see: |
Ensure that the time zone settings on the host where you wish to deploy NetBackup Snapshot Manager are as per your requirement and synchronized with a public NTP server.
By default, NetBackup Snapshot Manager uses the time zone that is set on the host where you install NetBackup Snapshot Manager. The timestamp for all the entries in the logs are as per the clock settings of the host machine.
If the instance on which you are deploying NetBackup Snapshot Manager is behind a proxy server, that is, if the NetBackup Snapshot Manager instance connects to the internet using a proxy server, you must specify the proxy server details during the NetBackup Snapshot Manager installation. The NetBackup Snapshot Manager installer stores the proxy server information in a set of environment variables that are specific for the NetBackup Snapshot Manager containers.
The following table displays the environment variables and the proxy server information that you must provide to the NetBackup Snapshot Manager installer. Make sure you keep this information ready; you are required to provide these details during NetBackup Snapshot Manager installation.
Table: Proxy server details required by NetBackup Snapshot Manager
Environment variables created by NetBackup Snapshot Manager installer | Description |
|---|---|
VX_HTTP_PROXY | Contains the HTTP proxy value to be used for all connections. For example, |
VX_HTTPS_PROXY | Contains the HTTP proxy value to be used for all connections. For example, |
VX_NO_PROXY | Contains the hosts that are allowed to bypass the proxy server. For example, Note: If NetBackup Snapshot Manager is being deployed in the cloud, ensure that you set the following respective values in this parameter: For AWS instance, Azure VMs, and OCI instances: 169.254.169.254 For a GCP virtual machine: 169.254.169.254,metadata,metadata.google.internal NetBackup Snapshot Manager uses these addresses to gather instance metadata from the instance metadata service. |
NetBackup Snapshot Manager services that need to communicate externally via a proxy server, use these predefined environment variables that are set during the NetBackup Snapshot Manager installation.
FIPS support is applicable only in the following scenarios:
When NetBackup, NetBackup Snapshot Manager and all the protected workloads are FIPS compliant as mentioned in the table below:
Component
FIPS status
FIPS status
NetBackup
Y
N
Y
Y
NetBackup Snapshot Manager
N
Y
Y
Y
Workload system
Y/N
Y/N
Y
N
N
N
N
With fresh installation on RHEL 8 platform, and limited only to VM based (BYOD) deployments.
Note:
Any NetBackup Snapshot Manager deployments in OCI is not FIPS compliant.