NetBackup™ Snapshot Manager for Data Center Administrator's Guide

To install NetBackup Snapshot Manager for Data Center

1. Download the NetBackup Snapshot Manager for Data Center image to the system on which you want to deploy NetBackup Snapshot Manager for Data Center from the Veritas Support Portal.

   Note:

   You must log on to the support site to download.

   From the Products drop-down, select NetBackup and select the required version from the Version drop-down. Click Explore. Click Base and upgrade installers.

   The NetBackup Snapshot Manager for Data Center image name resembles the following format for Docker and Podman environment:

   NetBackup_SnapshotManager_<version>.tar.gz

   Note:

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

2. Un-tar the image file and list the contents:

   # ls
   NetBackup_SnapshotManager_xx.x.x.x.xxxx.tar.gz
   netbackup-flexsnap-xx.x.x.x.xxxx.tar.gz
   flexsnap_preinstall.sh
   

3. Run the following command to prepare the NetBackup Snapshot Manager for Data Center host for installation:

   # sudo ./flexsnap_preinstall.sh

   (For Docker on RHEL 7.9) The output resembles as follows:

   Validate host resources                  ...  done
   Check for docker installation            ...  done
   Validate docker version support          ...  done
   Check for docker socket file             ...  done
   Checking for required packages           ...  done
   Validate required services health        ...  done
   Loading Snapshot Manager service images  ...  done
   Copying flexsnap_configure script        ...  done

   (For Docker on RHEL 8.x) The output resembles as follows:

   NetBackup Snapshot Manager for Data Center for installation:
   Validate host resources                  ...  done
   Check for docker installation            ...  done
   Validate docker version support          ...  done
   Checking for required packages           ...  done
   Validate required services health        ...  done
   Loading Snapshot Manager service images  ...  done
   Copying flexsnap_configure script        ...  done

4. Use the following command options to configure and install help:

   Configure: # flexsnap_configure -h

   Usage: flexsnap_configure [OPTIONS] <COMMAND> [CMD_OPTIONS]
    
   NetBackup Snapshot Manager (10.3.x.x.xxxx) configuration script
    
   Options:
     -h, --help
           Print this message and exit
   Command:
     backup      To create backup of Snapshot Manager metadata.
     install     To install the Snapshot Manager stack on a host.
     recover     To restore from backup copy Snapshot Manager 
                 metadata.
     renew       To renew the Snapshot Manager certificates or 
                 extension.
     restart     To restart the Snapshot Manager services on a host.
     start       To start the Snapshot Manager services on a host.
     status      To get the health status of Snapshot Manager 
                 services.
     stop        To stop the Snapshot Manager services on a host.
     serverinfo  To get the NetBackup primary and Snapshot Manager 
                 servers information.
     truststore  To list and update Snapshot Manager truststore.
     uninstall   To uninstall the Snapshot Manager stack on a host.
     updatedb    To update NetBackup details in Snapshot Manager 
                 Database.
     verify      To verify the Snapshot Manager certificates.
         
   Run flexsnap_configure <COMMAND> --help for more information

   Install: # flexsnap_configure install -h

   Usage: flexsnap_configure install [OPTIONS]

   Options	Description
   --add-host <string>	(Optional) Add a custom host-to-IP mapping (host:ip). Can be passed multiple times for each host:ip combination.
   --ca <ca>	Absolute path of root CA file.
   --chain <chain>	Absolute path of certificate chain containing all intermediate CAs and server certificate.
   --crlcheck <level>	Value can be 0 (disabled), 1 (leaf) or 2 (chain).
   --crlpath <directory>	Specify a CRL directory location for non-CDP based CRL validation. Useful if the Certificate Authority is not accessible from Snapshot Manager for Data Center host.
   --extension	For Snapshot Manager for Data Center extension installation.
   --extname <name>	Snapshot Manager for Data Center extension name identifier.
   --hostnames <IP/FQDN>	Comma separated IP/FQDNs for Snapshot Manager for Data Center.
   --http-proxy <URI>	(Optional) Pass the http proxy to deployment.
   --https-proxy <URI>	(Optional) Pass the https proxy to deployment.
   -i	For interactive installation.
   --key <key>	Server certificate private key path.
   --no-proxy <URI>	(Optional) Pass the no proxy to deployment.
   --path <install_path>	Install path for Snapshot Manager for Data Center (default: /cloudpoint).
   --passphrase <file>	Specifies the path of the file that contains the passphrase to access the keystore. The first line in the file is used as a passphrase.
   --port <port_number>	Nginx port for Snapshot Manager for Data Center(default: 443).
   --primary <IP/FQDN>	NetBackup primary IP or FQDN. In the case of Snapshot Manager for Data Center extension it must point to Snapshot Manager for Data Center host.
   --subnet4 <string>	(Optional) IPv4 subnet in CIDR format.
   --subnet6 <string>	(Optional) IPv6 subnet in CIDR format.
   --token <token>	Reissue or standard token. For the Snapshot Manager for Data Center extension it acts as a workflow token. (Mandatory) For interactive installation. (Optional) For Snapshot Manager for Data Center deployment if NetBackup primary security setting is medium or low.

5. Interactive and non-interactive installation of NetBackup Snapshot Manager for Data Center:

   Interactive installation of NetBackup Snapshot Manager for Data Center (NBCA/ECA)

   • NetBackup Snapshot Manager for Data Center host is behind a proxy server:

     # flexsnap_configure install -i --no-proxy <no_proxy_value> --http-proxy <http_proxy_value> --https-proxy <https_proxy_value>

   • NetBackup Snapshot Manager for Data Center/Primary server is configured with private host name:

     # flexsnap_configure install -i --add-host <nbsm_hostname>:<IP> --add-host <primary_hostname>:<IP>

   • NetBackup Snapshot Manager for Data Center installation on custom path:

     # flexsnap_configure install -i --path <installation_path>

     Note:

     The flexsnap_configure CLI uses privilege flag implicitly (-u 0).

     The installer displays messages similar to the following for interactive CLI (NBCA):

     # flexsnap_configure install -i
     Configuration started at time: Sat Jul 29 14:34:08 UTC 2023
     Docker server version: 20.10.7
     This is a fresh install of NetBackup Snapshot Manager 10.3.x.x.xxxx
     
     Please provide NetBackup Primary details:
     NetBackup primary server IP Address or FQDN: <nbu_primary_fqdn>
     Start configuring with NetBackup CA certificate.
     Provide NetBackup authentication token: <security_token>
     Host names for TLS certificate (space or comma separated and 64 char FQDN limit): <snapshot_manager_fqdn>
     Port (default:443): 
     Creating network: flexsnap-network ...done
     Starting container: flexsnap-fluentd ...done
     Starting container: flexsnap-ipv6config ...done
     Creating container: flexsnap-postgresql ...done
     Creating container: flexsnap-rabbitmq ...done
     Creating container: flexsnap-certauth ...done
     Creating container: flexsnap-api-gateway ...done
     Creating container: flexsnap-coordinator ...done
     Creating container: flexsnap-listener ...done
     Creating container: flexsnap-agent ...done
     Creating container: flexsnap-onhostagent ...done
     Creating container: flexsnap-scheduler ...done
     Creating container: flexsnap-policy ...done
     Creating container: flexsnap-notification ...done
     Creating container: flexsnap-nginx ...done
     Configuring admin credentials ...done
     Waiting for Snapshot Manager configuration to complete (21/21) ...done
     Configuration complete at time Sat Jul 29 14:39:59 UTC 2023!
     Please register Snapshot Manager with NetBackup primary server
     
     

     The installer displays messages similar to the following for interactive CLI under ECA:

     # flexsnap_configure install -i
     Configuration started at time: Sat Jul 29 10:43:06 UTC 2023
     Docker server version: 24.0.2
     This is a fresh install of NetBackup Snapshot Manager 10.3.x.x.xxxx
     
     Please provide NetBackup Primary details:
     NetBackup primary server IP Address or FQDN: <nbu_primary_fqdn>
     Start configuring external CA certificate.
     Absolute path of the root CA certificate file: <root_ca_file>
     Absolute path of server private key file: <server_key_file>
     Absolute path of server certificate chain: <server_chain_file>
     Absolute path of key passphrase file (Press ENTER if keyfile is non encrypted): <server_passphrase_file>
     Absolute path of CRL directory (Press ENTER for CDP based CRL check): <crl_path>
     CRL check level, Press ENTER for default 1 i.e. LEAF (0: DISABLE, 1: LEAF and 2:CHAIN): <crl_level>
     Host names for TLS certificate (space or comma separated and 64 char FQDN limit): <snapshot_manager_fqdn>
     Port (default:443): <snapshot_manager_port>
     Creating network: flexsnap-network ...done
     Starting container: flexsnap-fluentd ...done
     Starting container: flexsnap-ipv6config ...done
     Creating container: flexsnap-postgresql ...done
     Creating container: flexsnap-rabbitmq ...done
     Creating container: flexsnap-certauth ...done
     Creating container: flexsnap-api-gateway ...done
     Creating container: flexsnap-coordinator ...done
     Creating container: flexsnap-listener ...done
     Creating container: flexsnap-agent ...done
     Creating container: flexsnap-onhostagent ...done
     Creating container: flexsnap-scheduler ...done
     Creating container: flexsnap-policy ...done
     Creating container: flexsnap-notification ...done
     Creating container: flexsnap-nginx ...done
     Configuring admin credentials ...done
     Waiting for Snapshot Manager configuration to complete (21/21) ...done
     Configuration complete at time Sat Jul 29 10:48:12 UTC 2023!
     Please register Snapshot Manager with NetBackup primary server

   Non interactive installation of NetBackup Snapshot Manager for Data Center with NetBackup CA (NBCA)

   • NetBackup primary server security level is MEDIUM or Snapshot Manager for Data Center host name is know to primary server:

     # flexsnap_configure install --primary <primary> --hostnames <nbsm_ip_or_fqdn>

   • NetBackup primary server security level is HIGH or VERY HIGH:

     # flexsnap_configure install --primary <primary> --token <standard_token> --hostnames <nbsm_ip_or_fqdn>

   • NetBackup Snapshot Manager for Data Center host is behind a proxy server:

     # flexsnap_configure install --primary <primary> --token <standard_token> --hostnames <nbsm_ip_or_fqdn> --no-proxy <no_proxy_value> --http-proxy <http_proxy_value> --https-proxy <https_proxy_value>

   • NetBackup Snapshot Manager for Data Center/Primary server is configured with private host name:

     # flexsnap_configure install --primary <primary> --token <standard_token> --hostnames <nbsm_ip_or_fqdn> --add-host <nbsm_hostname:IP> --add-host <primary_hostname:IP>

   • NetBackup Snapshot Manager for Data Center installation on custom path or port:

     # flexsnap_configure install --primary <primary> --token <standard_token> --hostnames <nbsm_ip_or_fqdn> --path <installation_path> --port <port>

     The installer displays messages similar to the following for non-interactive CLI (NBCA):

     # flexsnap_configure install --primary <nbu_primary_fqdn> --token <security_token>  --hostnames <snapshot_manager_fqdn>
     
     Configuration started at time: Sat Jul 29 15:03:19 UTC 2023
     Docker server version: 20.10.7
     This is a fresh install of NetBackup Snapshot Manager 10.3.x.x.xxxx
     Starting container: flexsnap-fluentd ...done
     Starting container: flexsnap-ipv6config ...done
     Creating container: flexsnap-postgresql ...done
     Creating container: flexsnap-rabbitmq ...done
     Creating container: flexsnap-certauth ...done
     Creating container: flexsnap-api-gateway ...done
     Creating container: flexsnap-coordinator ...done
     Creating container: flexsnap-listener ...done
     Creating container: flexsnap-agent ...done
     Creating container: flexsnap-onhostagent ...done
     Creating container: flexsnap-scheduler ...done
     Creating container: flexsnap-policy ...done
     Creating container: flexsnap-notification ...done
     Creating container: flexsnap-nginx ...done
     Waiting for Snapshot Manager configuration to complete (21/21) ...done
     Configuration complete at time Sat Jul 29 15:07:34 UTC 2023!
     Please register Snapshot Manager with NetBackup primary server

   Non-interactive installation of NetBackup Snapshot Manager for Data Center with external CA (ECA)

   • Encrypted private key:

     # flexsnap_configure install --primary <primary> --hostnames <nbsm_ip_or_fqdn> --ca <path_of_root_CA> --key <path_of_private_key_file> --chain <server_chain_file> --passphrase <file>

   • Non-encrypted private key:

     # flexsnap_configure install --primary <primary> --hostnames <nbsm_ip_or_fqdn> --ca <path_of_root_CA> --key <path_of_private_key_file> --chain <server_chain_file>

   • With user provided CRL path/CRL check:

     # flexsnap_configure install --primary <primary> --hostnames <nbsm_ip_or_fqdn> --ca <path_of_root_CA> --key <path_of_private_key_file> --chain <server_chain_file> --crlpath <directory> --crlcheck <level>

   • NetBackup Snapshot Manager for Data Center host is behind a proxy server:

     # flexsnap_configure install --primary <primary> --hostnames <nbsm_ip_or_fqdn> --ca <path_of_root_CA> --key <path_of_private_key_file> --chain <server_chain_file> --no-proxy <no_proxy_value> --http-proxy <http_proxy_value> --https-proxy <https_proxy_value>

   • NetBackup Snapshot Manager for Data Center/Primary server is configured with private host name:

     # flexsnap_configure install --primary <primary> --hostnames <nbsm_ip_or_fqdn> --ca <path_of_root_CA> --key <path_of_private_key_file> --chain <server_chain_file> --add-host <nbsm_hostname:IP> --add-host <primary_hostname:IP>

   • NetBackup Snapshot Manager for Data Center installation on custom path/port:

     # flexsnap_configure install --primary <primary> --hostnames <nbsm_ip_or_fqdn> --ca <path_of_root_CA> --key <path_of_private_key_file> --chain <server_chain_file> --path <installation_path> --port <port>

     The installer displays messages similar to the following for non-interactive CLI (ECA):

     # flexsnap_configure install --primary <nbu_primary_fqdn> --hostnames <snapshot_manager_fqdn> --ca <root_ca_file> --key <server_key_file> --passphrase <server_passphrase_file> --chain <server_chain_file> --crlpath <crl_path> --crlcheck <level>
     
     Configuration started at time: Sat Jul 29 10:28:25 UTC 2023
     Docker server version: 24.0.2
     This is a fresh install of NetBackup Snapshot Manager 10.3.x.x.xxxx
     Creating network: flexsnap-network ...done
     Starting container: flexsnap-fluentd ...done
     Starting container: flexsnap-ipv6config ...done
     Creating container: flexsnap-postgresql ...done
     Creating container: flexsnap-rabbitmq ...done
     Creating container: flexsnap-certauth ...done
     Creating container: flexsnap-api-gateway ...done
     Creating container: flexsnap-coordinator ...done
     Creating container: flexsnap-listener ...done
     Creating container: flexsnap-agent ...done
     Creating container: flexsnap-onhostagent ...done
     Creating container: flexsnap-scheduler ...done
     Creating container: flexsnap-policy ...done
     Creating container: flexsnap-notification ...done
     Creating container: flexsnap-nginx ...done
     Waiting for Snapshot Manager configuration to complete (21/21) ...done
     Configuration complete at time Sat Jul 29 10:32:19 UTC 2023!
     Please register Snapshot Manager with NetBackup primary server

6. Use the following docker command to view the docker images that are loaded on the host:

   • (For Docker) # sudo docker images

   • (For Podman) # sudo podman images

   The output resembles as follows:

   REPOSITORY             TAG            IMAGE ID       CREATED       SIZE
   veritas/flexsnap-deploy       10.3.x.xxxxx   5260748d9eab   18 minutes ago   586MB
   veritas/flexsnap-rabbitmq     10.3.x.xxxxx   cff89dc78a2f   18 minutes ago   546MB
   veritas/flexsnap-postgresql   10.3.x.xxxxx   0b87fe88cf94   18 minutes ago   537MB
   veritas/flexsnap-nginx        10.3.x.xxxxx   ee1cf2a3159e   18 minutes ago   649MB
   veritas/flexsnap-fluentd      10.3.x.xxxxx   a384e3fc4167   19 minutes ago   681MB
   veritas/flexsnap-core         10.3.x.xxxxx   2393b221bf19   20 minutes ago   916MB
   veritas/flexsnap-datamover    10.3.x.xxxxx   8254c537bdb4   38 hours ago     1.18GB

7. Provide the following details when prompted on the command prompt:

   Parameter	Description
   Authorization token	If NetBackup Certificate Authority is used, the installer requires an authorization token to successfully deploy security certificates.
   Host name for TLS certificate	Specify the IP address or the Fully Qualified Domain Name (FQDN) of the NetBackup Snapshot Manager for Data Center host. The specified name or IP address is added to the list of host names to use for configuring NetBackup Snapshot Manager for Data Center. The installer uses this name to generate a server certificate for the NetBackup Snapshot Manager for Data Center host.
   Port	Specify the port through which the NetBackup Snapshot Manager for Data Center can communicate. Default is port 443.

   The installer then displays messages similar to the following:

   Configuring admin credentials ...done
   Waiting for Snapshot Manager configuration to complete (22/22) ...done
   Configuration complete at time Thu Jun 9 06:15:43 UTC 2022!

   Note:

   After the deployment of NetBackup Snapshot Manager for Data Center, ensure that the IPv6 interface on the system is not disabled.

8. This concludes the NetBackup Snapshot Manager for Data Center deployment process. The next step is to register the NetBackup Snapshot Manager for Data Center with the Veritas NetBackup primary server.