NetBackup™ Snapshot Manager Install and Upgrade Guide

Last Published:
Product(s): NetBackup (10.2)
  1. Introduction
    1.  
      About the deployment approach
    2.  
      Deciding where to run NetBackup Snapshot Manager
    3.  
      About deploying NetBackup 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.  
        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
    2. Deploying NetBackup Snapshot Manager using container images
      1.  
        Before you begin installing NetBackup Snapshot Manager
      2.  
        Installing NetBackup Snapshot Manager in the Docker/Podman environment
      3.  
        Verifying that NetBackup Snapshot Manager is installed successfully
      4.  
        Restarting NetBackup Snapshot Manager
    3. Deploying NetBackup Snapshot Manager 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 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.  
          Configuring AWS permissions for NetBackup Snapshot Manager
        3.  
          AWS permissions required by NetBackup 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 NetBackup Snapshot Manager
        2.  
          Configuring a GCP service account for NetBackup Snapshot Manager
        3.  
          Preparing the GCP service account for plug-in configuration
        4.  
          GCP cross-project restore 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. 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
          1.  
            Configuring SMB for Windows (Optional)
          2.  
            Configuring WMI security for Windows (optional)
        2.  
          Configuring the agentless feature
        3.  
          Configuring the agentless feature after upgrading NetBackup Snapshot Manager
    6. NetBackup Snapshot Manager 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.  
        Configuring VSS to store shadow copies on the originating drive
      3.  
        Additional steps required after restoring an AWS RDS database instance
    7. Volume Encryption in NetBackup Snapshot Manager
      1.  
        About volume encryption support in NetBackup 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 NetBackup Snapshot Manager
  3. Section II. NetBackup Snapshot Manager maintenance
    1. NetBackup Snapshot Manager 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
      1.  
        About NetBackup Snapshot Manager 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. Migrating and upgrading NetBackup Snapshot Manager
        1.  
          Before you begin migrating NetBackup Snapshot Manager
        2.  
          Migrate and upgrade NetBackup Snapshot Manager on RHEL 8.6 or 8.4
      8.  
        GCP configuration for migration from zone to region
      9. Post-upgrade tasks
        1.  
          Upgrading NetBackup Snapshot Manager extensions
      10.  
        Post-migration tasks
    3. Uninstalling NetBackup Snapshot Manager
      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
      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.  
        Upgrade of extension on AWS (EKS) fails when upgrading through script
      10.  
        Backup from snapshot job fails with timeout error

Upgrading NetBackup Snapshot Manager

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

To upgrade NetBackup Snapshot Manager server in Podman/Docker environment

  1. Download the NetBackup Snapshot Manager upgrade installer.

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

    The NetBackup 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 NetBackup Snapshot Manager.
  3. Un-tar the image file and list the contents:
    # ls
    NetBackup_SnapshotManager_10.2.x.x.xxxx.tar.gz
    netbackup-flexsnap-10.2.x.x.xxxx.tar.gz
    flexsnap_preinstall.sh
    
  4. Run the following command to prepare the NetBackup 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.
    
    
  5. Verify that there are no protection policy snapshots or other operations in progress and then stop NetBackup Snapshot Manager by running the following command:

    For Podman

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

    For Docker

    # docker run -it --rm --privileged 
    -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 NetBackup Snapshot Manager version.

    Note:

    Ensure that you enter the command without any line breaks.

    The NetBackup 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 NetBackup Snapshot Manager containers to be stopped and then proceed to the next step.

  6. Depending on the environment, upgrade NetBackup 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 -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 NetBackup Snapshot Manager version you are upgrading to, for example '10.2.x.x.xxxxx'

    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 (Below is an example of the Podman environment output:

    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.2.x.x.xxxxx
    Previous CloudPoint version: 10.2.x.x.xxxx
    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_10.2.x.x.xxxxx.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 NetBackup Snapshot Manager version is installed successfully:

    See Verifying that NetBackup Snapshot Manager is installed successfully.

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