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

Migrate and upgrade Snapshot Manager on RHEL 8.6 or 8.4

Perform the following steps to migrate Snapshot Manager 10.0 or 10.0.0.1 from your RHEL 7.x host to the new RHEL 8.6 or 8.4 host.

To upgrade Snapshot Manager in docker environment

  1. Download the Snapshot Manager upgrade installer.

    Example: NetBackup_SnapshotManager_<version>.tar.gz

  2. 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
  3. Run the following command to prepare the Snapshot Manager host for installation:

    # sudo ./flexsnap_preinstall.sh

  4. Upgrade Snapshot Manager by running 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

    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

    Here, new_version represents the Snapshot Manager version you are upgrading to.

    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.

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

  5. (Optional) Run the following command to remove the previous version images.

    # podman rmi -f <imagename>:<oldimage_tagid>

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

    See Verifying that Snapshot Manager is installed successfully.

To migrate Snapshot Manager in Podman environment

  1. On the RHEL 7.x host, verify that there are no protection policy snapshots or other operations in progress and then stop Snapshot Manager by running the following command:
    # sudo docker run -it --rm 
-v /cloudpoint:/cloudpoint 
-v /var/run/docker.sock:/var/run/docker.sock 
veritas/flexsnap-deploy:<current_version> stop

    Here, current_version represents the currently installed Snapshot Manager version.

    Example:

    # sudo docker run -it --rm -v /cloudpoint:/cloudpoint 
-v /var/run/docker.sock:/var/run/docker.sock 
veritas/flexsnap-deploy:9.1.0.0.9349 stop

    Note:

    This is a single command. 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.8a51aac1848c404ab61e4625d7b88703 ...done
Stopping container: flexsnap-core-long-15 ...done
Stopping container: flexsnap-core-long-14 ...done
Stopping container: flexsnap-core-long-13 ...done
Stopping container: flexsnap-core-long-12 ...done
Stopping container: flexsnap-core-long-11 ...done
Stopping container: flexsnap-core-long-10 ...done
Stopping container: flexsnap-core-long-9 ...done
Stopping container: flexsnap-core-long-8 ...done
Stopping container: flexsnap-core-long-7 ...done
Stopping container: flexsnap-core-long-6 ...done
Stopping container: flexsnap-core-long-5 ...done
Stopping container: flexsnap-core-long-4 ...done
Stopping container: flexsnap-core-long-3 ...done
Stopping container: flexsnap-core-long-2 ...done
Stopping container: flexsnap-core-long-1 ...done
Stopping container: flexsnap-core-long-0 ...done
Stopping container: flexsnap-core-15 ...done
Stopping container: flexsnap-core-14 ...done
Stopping container: flexsnap-core-13 ...done
Stopping container: flexsnap-core-12 ...done
Stopping container: flexsnap-core-11 ...done
Stopping container: flexsnap-core-10 ...done
Stopping container: flexsnap-core-9 ...done
Stopping container: flexsnap-core-8 ...done
Stopping container: flexsnap-core-7 ...done
Stopping container: flexsnap-core-6 ...done
Stopping container: flexsnap-core-5 ...done
Stopping container: flexsnap-core-4 ...done
Stopping container: flexsnap-core-3 ...done
Stopping container: flexsnap-core-2 ...done
Stopping container: flexsnap-core-1 ...done
Stopping container: flexsnap-core-0 ...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.

  2. Migrate the Snapshot Manager configuration data to the RHEL 8.6 or 8.4 host:

    • If you have created a new system with RHEL 8.6 or 8.4:

      • Run the following command to unmount /cloudpoint from the current host.

        # umount /cloudpoint

      • Detach the data disk that was mounted on /cloudpoint mountpoint.

        Note:

        For detailed instructions to detach or attach the data disks, follow the documentation provided by your cloud or storage vendor.

      • On the RHEL8.6 or 8.4 host, run the following commands to create and mount the disk:

        # mkdir /cloudpoint

        # mount /dev/<diskname> /cloudpoint

        For vendor-specific details

        See Creating and mounting a volume to store Snapshot Manager data.

    • If you have upgraded from RHEL 7.x to RHEL 8.6 or 8.4, copy the /cloudpoint mountpoint data from RHEL 7.x system and move it to the RHEL8.6 or 8.4 system under /cloudpoint folder.

    This concludes the Snapshot Manager migration process.

    After migration, install the new_version on the new host by following the steps mentioned in the To upgrade Snapshot Manager in docker environment.

  3. During migration process, if Snapshot Manager is migrated to another system or IP address is changed, then regenerate the certificates as follows:

    • Stop the Snapshot Manager services using the following command:

      [root@ip-172-31-24-178 ec2-user]# podman run -it --rm --privileged -v /cloudpoint:/cloudpoint -v /run/podman/podman.sock:/run/podman/podman.sock veritas/flexsnap-deploy:10.0.0.9818 stop

    • Regenerate the certificates using the following command:

      /cloudpoint/scripts/cp_regenerate_certs.sh -i <CP_IP_ADDRESS> -h <CP_HOSTNAME>

      Setting up certificate authority ...done
Generating certificates for servers ...done
Generating certificates for clients ...done
Adding MongoDB and RabbitMQ certificate to the trust store ...[Storing /cloudpoint/keys/idm_store]
[Storing /cloudpoint/keys/flexsnap-idm_store]
done
Creating symlinks for nginx certificates ...done

    • Start the Snapshot Manager services using the following command:

      [root@ip-172-31-24-178 ec2-user]# podman run -it --rm --privileged -v /cloudpoint:/cloudpoint -v /run/podman/podman.sock:/run/podman/podman.sock veritas/flexsnap-deploy:10.0.0.9818 start

  4. Depending on the following appropriate scenario, update the /cloudpoint/openv/netbackup/bp.conf file to update the value of CLIENT_NAME to new Snapshot Manager IP/hostname.

    • If IP address does not change, then edit the Snapshot Manager server entry and provide a reissue token generated for the Snapshot Manager host.

    • If IP address changes, then disable the previous Snapshot Manager host, and add a Snapshot Manager host with new IP address. Then perform the following steps:

      • Revoke the certificate of previous Snapshot Manager host.

      • Add the mapping of new Snapshot Manager host IP/hostname into the previous Snapshot Manager host using the host mappings.

      • Generate reissue token by selecting previous Snapshot Manager host, then use that token to edit the new Snapshot Manager host. Old Snapshot Manager host Certificate entry and Host Mapping would be replaced.

  5. After migrating Snapshot Manager to a RHEL 8.6 or 8.4 host, perform the following steps to upgrade Snapshot Manager to 10.1.

    See Upgrading Snapshot Manager.

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