NetBackup™ Snapshot Manager Install and Upgrade Guide

Last Published:
Product(s): NetBackup (10.1)
  1. Introduction
    1.  
      About the deployment approach
    2.  
      Deciding where to run Snapshot Manager
    3.  
      About deploying Snapshot Manager in the cloud
  2. Section I. NetBackup Snapshot Manager installation and configuration
    1. Preparing for NetBackup Snapshot Manager installation
      1.  
        Meeting system requirements
      2.  
        Snapshot Manager host sizing recommendations
      3.  
        Snapshot Manager extension sizing recommendations
      4.  
        Creating an instance or preparing the host to install Snapshot Manager
      5.  
        Installing container platform (Docker, Podman)
      6.  
        Creating and mounting a volume to store Snapshot Manager data
      7.  
        Verifying that specific ports are open on the instance or physical host
      8.  
        Preparing Snapshot Manager for backup from snapshot jobs
    2. Deploying NetBackup Snapshot Manager using container images
      1.  
        Before you begin installing Snapshot Manager
      2.  
        Installing Snapshot Manager in the Docker/Podman environment
      3.  
        Verifying that Snapshot Manager is installed successfully
      4.  
        Restarting Snapshot Manager
    3. Deploying NetBackup Snapshot Manager extensions
      1.  
        Before you begin installing Snapshot Manager extensions
      2.  
        Downloading the Snapshot Manager extension
      3. Installing the Snapshot Manager extension on a VM
        1.  
          Prerequisites to install the extension on VM
        2.  
          Installing the extension on a VM
      4. Installing the 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 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 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 cloud plug-ins
      1.  
        How to configure the Snapshot Manager cloud plug-ins?
      2. AWS plug-in configuration notes
        1.  
          Prerequisites for configuring the AWS plug-in
        2.  
          Configuring AWS permissions for Snapshot Manager
        3.  
          AWS permissions required by Snapshot Manager
        4.  
          Before you create a cross account configuration
      3. Google Cloud Platform plug-in configuration notes
        1.  
          Google Cloud Platform permissions required by Snapshot Manager
        2.  
          Configuring a GCP service account for Snapshot Manager
        3.  
          Preparing the GCP service account for plug-in 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
    5. NetBackup Snapshot Manager application agents and plug-ins
      1.  
        About the installation and configuration process
      2. Installing and configuring Snapshot Manager agent
        1.  
          Downloading and installing the 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
      3. Configuring the 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
      4. NetBackup protection plan
        1.  
          Creating a NetBackup protection plan for cloud assets
        2.  
          Subscribing cloud assets to a NetBackup protection plan
      5.  
        Configuring VSS to store shadow copies on the originating drive
      6.  
        Additional steps required after restoring an AWS RDS database instance
    6. Protecting assets with NetBackup Snapshot Manager's agentless feature
      1.  
        About the agentless feature
      2. Prerequisites for the agentless configuration
        1.  
          Configuring SMB for Windows (Optional)
        2.  
          Configuring WMI security for Windows (optional)
      3.  
        Configuring the agentless feature
      4.  
        Configuring the agentless feature after upgrading Snapshot Manager
    7. Volume Encryption in NetBackup Snapshot Manager
      1.  
        About volume encryption support in Snapshot Manager
      2.  
        Volume encryption for Azure
      3.  
        Volume encryption for GCP
      4.  
        Volume encryption for AWS
    8. NetBackup Snapshot Manager security
      1.  
        Configuring security for Azure Stack
      2.  
        Configuring the cloud connector for Azure Stack
      3.  
        CA configuration for Azure Stack
      4.  
        Securing the connection to Snapshot Manager
  3. Section II. NetBackup Snapshot Manager maintenance
    1. NetBackup Snapshot Manager logging
      1.  
        About Snapshot Manager logging mechanism
      2. How Fluentd-based Snapshot Manager logging works
        1.  
          About the Snapshot Manager fluentd configuration file
        2.  
          Modifying the fluentd configuration file
      3.  
        Snapshot Manager logs
      4.  
        Agentless logs
      5.  
        Troubleshooting Snapshot Manager logging
    2. Upgrading NetBackup Snapshot Manager
      1.  
        About Snapshot Manager upgrades
      2.  
        Supported upgrade path
      3.  
        Upgrade scenarios
      4.  
        Preparing to upgrade Snapshot Manager
      5.  
        Upgrading Snapshot Manager
      6.  
        Upgrading Snapshot Manager using patch or hotfix
      7. Migrating and upgrading Snapshot Manager
        1.  
          Before you begin migrating Snapshot Manager
        2.  
          Migrate and upgrade Snapshot Manager on RHEL 8.6 or 8.4
      8. Post-upgrade tasks
        1.  
          Upgrading Snapshot Manager extensions
      9.  
        Post-migration tasks
    3. Uninstalling NetBackup Snapshot Manager
      1.  
        Preparing to uninstall Snapshot Manager
      2.  
        Backing up Snapshot Manager
      3.  
        Unconfiguring Snapshot Manager plug-ins
      4.  
        Unconfiguring Snapshot Manager agents
      5.  
        Removing the Snapshot Manager agents
      6.  
        Removing Snapshot Manager from a standalone Docker host environment
      7.  
        Removing Snapshot Manager extensions - VM-based or managed Kubernetes cluster-based
      8.  
        Restoring Snapshot Manager
    4. Troubleshooting NetBackup Snapshot Manager
      1.  
        Troubleshooting Snapshot Manager
      2.  
        SQL snapshot or restore and granular restore operations fail if the Windows instance loses connectivity with the 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

Upgrading Snapshot Manager

The following procedures describe how to upgrade your Snapshot Manager deployment. During the upgrade, you replace the container that runs your current version of Snapshot Manager with a newer container.

To upgrade Snapshot Manager server in Podman/Docker environment

  1. Download the Snapshot Manager upgrade installer.

    On the Snapshot Manager download page, click Download Now to download the Snapshot Manager installer.

    The Snapshot Manager software components are available in a package form. The file name has the following format:

    NetBackup_SnapshotManager_<version>.tar.gz

    Note:

    The actual file name may vary depending on the release version.

  2. Copy the downloaded compressed image file to the computer on which you want to deploy Snapshot Manager.
  3. Un-tar the image file and list the contents:
    # ls
    NetBackup_SnapshotManager_10.1.x.x.xxxx.tar.gz
    netbackup-flexsnap-10.1.x.x.xxxx.tar.gz
    flexsnap_preinstall.sh
    
  4. Run the following command to prepare the Snapshot Manager host for installation:

    # sudo ./flexsnap_preinstall.sh

    The output resembles the following:

    Executing the following changes on this node to prepare the 
    NetBackup Snapshot Manager for installation: 
         1) Validate SELINUX
        2) Loading Snapshot Manager service images.
    9a585888b624: Loading layer [==================================================>]  24.58kB/24.58kB
    2e62066f7e63: Loading layer [==================================================>]  475.2MB/475.2MB
    f685725593dc: Loading layer [==================================================>]  6.144kB/6.144kB
    696db75055f2: Loading layer [==================================================>]  406.4MB/406.4MB
    Loaded image: veritas/flexsnap-core:10.1.0.0.1005
    231ab0b2c170: Loading layer [==================================================>]  23.04kB/23.04kB
    8c28932ae9d0: Loading layer [==================================================>]  98.46MB/98.46MB
    Loaded image: veritas/flexsnap-certauth:10.1.0.0.1005
    943d68324d6c: Loading layer [==================================================>]  32.26kB/32.26kB
    191891ecc4f9: Loading layer [==================================================>]  28.47MB/28.47MB
    Loaded image: veritas/flexsnap-nginx:10.1.0.0.1005
    ceec3f55b2db: Loading layer [==================================================>]  284.1MB/284.1MB
    Loaded image: veritas/flexsnap-idm:10.1.0.0.1005
    1dea31649399: Loading layer [==================================================>]  27.14kB/27.14kB
    fed7c9c63244: Loading layer [==================================================>]  195.1kB/195.1kB
    085e29ab3a40: Loading layer [==================================================>]  68.61kB/68.61kB
    db18b0c91f2b: Loading layer [==================================================>]   57.2MB/57.2MB
    Loaded image: veritas/flexsnap-deploy:10.1.0.0.1005
    439f0da098cd: Loading layer [==================================================>]  5.632kB/5.632kB
    330348b98074: Loading layer [==================================================>]     64MB/64MB
    Loaded image: veritas/flexsnap-rabbitmq:10.1.0.0.1005
    2070f36290f4: Loading layer [==================================================>]   34.3kB/34.3kB
    faca6ad364c3: Loading layer [==================================================>]  865.8kB/865.8kB
    b0f22c31174d: Loading layer [==================================================>]  279.6MB/279.6MB
    Loaded image: veritas/flexsnap-api-gateway:10.1.0.0.1005
    7bb7b547ef29: Loading layer [==================================================>]  8.192kB/8.192kB
    244ad9d09146: Loading layer [==================================================>]  6.656kB/6.656kB
    c10ebc736986: Loading layer [==================================================>]  193.7MB/193.7MB
    Loaded image: veritas/flexsnap-fluentd:10.1.0.0.1005
    e48739b330f1: Loading layer [==================================================>]  23.55kB/23.55kB
    5686c5f93e1a: Loading layer [==================================================>]  876.5kB/876.5kB
    8ecac31f1564: Loading layer [==================================================>]  418.6MB/418.6MB
    5fd91c9cd7b3: Loading layer [==================================================>]  2.048kB/2.048kB
    ff641dd08e00: Loading layer [==================================================>]  28.16kB/28.16kB
    Loaded image: veritas/flexsnap-datamover:10.1.0.0.1005
    6f063a66d20a: Loading layer [==================================================>]   5.12kB/5.12kB
    0ae89ddd7a56: Loading layer [==================================================>]  342.7MB/342.7MB
    00fd9132896d: Loading layer [==================================================>]  3.072kB/3.072kB
    Loaded image: veritas/flexsnap-mongodb:10.1.0.0.1005
    
    

    Note:

    The output is truncated to fit the page.

  5. Verify that there are no protection policy snapshots or other operations in progress and then stop Snapshot Manager by running the following command:

    For Podman

    # podman run -it --rm -u 0 -v /cloudpoint:/cloudpoint -v /run/podman/podman.sock:/run/podman/podman.sock 
    veritas/flexsnap-deploy:<current_version> stop

    For Docker

    # docker run -it --rm -u 0 -v /cloudpoint:/cloudpoint -v /run/docker/docker.sock:/run/docker/docker.sock 
    veritas/flexsnap-deploy:<current_version> stop

    Here, current_version represents the currently installed Snapshot Manager version.

    Note:

    Ensure that you enter the command without any line breaks.

    The Snapshot Manager containers are stopped one by one. Messages similar to the following appear on the command line:

    Stopping the services
    Stopping container: flexsnap-core-system-0-0 ...done
    Stopping container: flexsnap-core-indexing-0-0 ...done
    Stopping container: flexsnap-core-general-0-0 ...done
    Stopping container: flexsnap-core ...done
    Stopping container: flexsnap-nginx ...done
    Stopping container: flexsnap-core ...done
    Stopping container: flexsnap-core ...done
    Stopping container: flexsnap-scheduler ...done
    Stopping container: flexsnap-idm ...done
    Stopping container: flexsnap-core ...done
    Stopping container: flexsnap-core ...done
    Stopping container: flexsnap-core ...done
    Stopping container: flexsnap-api-gateway ...done
    Stopping container: flexsnap-certauth ...done
    Stopping container: flexsnap-rabbitmq ...done
    Stopping container: flexsnap-mongodb ...done
    Stopping container: flexsnap-fluentd ...done
    

    Wait for all the Snapshot Manager containers to be stopped and then proceed to the next step.

  6. Depending on the environment, upgrade Snapshot Manager by running the following command:
    • For Podman

      # podman run -it --rm -u 0 
      -v /cloudpoint:/cloudpoint 
      -v /run/podman/podman.sock:/run/podman/podman.sock 
      veritas/flexsnap-deploy:<new_version> install

      For an unattended installation, use the following command:

      # podman run -it --rm -u 0 
      -v /cloudpoint:/cloudpoint 
      -v /run/podman/podman.sock:/run/podman/podman.sock 
      veritas/flexsnap-deploy:<new_version> install -y
    • For Docker

      # sudo docker run -it --rm --privileged -u 0 -v /cloudpoint:/cloudpoint -v /cloudpoint:/cloudpoint 
      -v /var/run/docker.sock:/var/run/docker.sock
      veritas/flexsnap-deploy:<new_version> install

      For an unattended installation, use the following command:

      # sudo docker run -it --rm --privileged -u 0 -v /cloudpoint:/cloudpoint -v /cloudpoint:/cloudpoint 
      -v /var/run/docker.sock:/var/run/docker.sock
      veritas/flexsnap-deploy:<new_version> install -y

    Here, new_version represents the Snapshot Manager version you are upgrading to, for example '10.1.0.0.1005'

    The -y option passes an approval for all the subsequent installation prompts and allows the installer to proceed in a non-interactive mode.

    Note:

    Ensure that you enter the command without any line breaks.

  7. The installer first loads the individual service images and then launches them in their respective containers.

    The output resembles the following, here as an example the Podman environment output is provided:

    Installing the services
    Configuration started at time: Mon May  3 11:57:33 UTC 2021
    podman server version: 2.0.5 Supported: true
    This is an upgrade to NetBackup Snapshot Manager 10.1.0.0.1005
    Previous CloudPoint version: 10.0.0.0.9800
    Do you want to take a backup of the Snapshot Manager metadata prior to upgrade? 
    (y/n): y
    Taking backup of Snapshot Manager metadata...done
    Backup completed successfully.
    Backup file located at /cloudpoint/backup/cloudpoint_9.0.0.0.9234.tar.gz.
    [Storing /cloudpoint/keys/idm_store]
    [Storing /cloudpoint/keys/flexsnap-idm_store]
    Creating network: flexsnap-network ...done
    Starting container: flexsnap-fluentd ...done
    Starting container: flexsnap-mongodb ...done
    Starting container: flexsnap-rabbitmq ...done
    Starting container: flexsnap-certauth ...done
    Starting container: flexsnap-api-gateway ...done
    Starting container: flexsnap-core ...done
    Starting container: flexsnap-core ...done
    Starting container: flexsnap-core ...done
    Starting container: flexsnap-core ...done
    Starting container: flexsnap-scheduler ...done
    Starting container: flexsnap-core ...done
    Starting container: flexsnap-core ...done
    Starting container: flexsnap-idm ...done
    Starting container: flexsnap-deploy ...done
    Starting container: flexsnap-nginx ...done
    Upgrade finished at time: Mon May  3 11:58:51 UTC 2021
    Before using backups from cloud snapshots, re-register Snapshot Manager with the 
    NetBackup primary server
  8. (Optional) Run the following command to remove the previous version images.

    (For Podman) # podman rmi -f <imagename>:<oldimage_tagid>

    (For Docker) # docker rmi -f <imagename>:<oldimage_tagid>

  9. To verify that the new Snapshot Manager version is installed successfully:

    See Verifying that Snapshot Manager is installed successfully.

  10. This concludes the upgrade process. Verify that your Snapshot Manager configuration settings and data are preserved as is.