Install the File System NDMP Restore Enabler (Unix)


Click on a link below to go to a specific section of the software installation:

Related Topics:

Install Requirements

  • You must also install the File System iDataAgent on the computer on which you plan to install any application iDataAgents.
  • Verify that the computer in which you wish to install the software satisfies the minimum requirements specified in System Requirements - Unix File System iDataAgent.
  • The CommServe must be running.
  • You must have an available license for the NDMP Remote Server. See License Administration for more information.
  • If your network does not have DNS lookup or some other name resolution facility, you may be asked to enter the IP address of the CommServe computer.
  • Perform the following if the CommServe, MediaAgent and/or Client are communicating across firewall(s):
    • Ensure that port 8400 and one additional port is open for connections through the firewall. Depending on the direction of the firewall, this additional port must be provided either on MediaAgent/CommServe using the Firewall Configuration utility or on the client during installation.
    • In addition a range of ports must also be allowed connections through the firewall.

     For information on calculating the range of ports, see Firewall Requirements.

  • If you choose to install multiple components simultaneously, refer to Installation for procedures specific to each component.

Before You Begin

  • Log on to the client as root.

Install Procedure

Getting Started

1. Place the software installation disc for the Unix platform into the disc drive.

You can also install the product using a disc drive mounted on another computer on the network.

  • On Solaris, double-click the cvpkgadd program from the File Manager window.
  • On other Unix platforms, open the Terminal window, navigate to the software installation disc and then enter cvpkgadd
 
2. The product banner and other information is displayed.

Press Enter to continue.

 
3. Read the license agreement. Type y and press Enter to continue.  
4. This prompt is displayed only when you are installing on AIX, HP-UX, Linux, or Solaris computers.

Press Enter to continue

NOTES

  • When you install on non-clustered computer, you must select the number associated with the option Install on a physical machine.
Certain Calypso packages can be associated with a virtual IP, or in other words, installed on a "virtual machine" belonging to some cluster. At any given time the virtual machine's services and IP address are active on only one of the cluster's servers. The virtual machine can "fail-over" from one server to another, which includes stopping services and deactivating IP address on the first server and activating the IP address/services on the other server.

You now have a choice of performing a regular Calypso install on the physical host or installing Calypso on a virtual machine for operation within a cluster.

Most users should select "Install on a physical machine" here.

1) Install on a physical machine

2) Install on a virtual machine

3) Exit

Your choice: [1]

5. If you have only one network interface, press Enter to accept the default network interface name and continue.

If you have multiple network interfaces, enter the number corresponding to the network interface that you wish to use as default, and then press Enter to continue.

NOTES

  • The interface name and IP addresses depend on the computer in which the software is installed and may be different from the example shown.
Network interface with the following IPs have been found available on your system. One of these interfaces should be associated with the physical machine being installed. It will also be used by the CommServe to initiate connections to the physical machine. Note that you will be able to additionally customize Datapipe Interface Pairs used for the backup data traffic later in the Calypso Java GUI.

Please select the correct network interface below.
1) client (201.42.33.598)
2) hk97::489:9glg:hk8d:9490
3) client.company.com (hr90:8842:2:78:013:8ghh:hg8k:9x54)

Interface number: [1]

  Verify the default network interface name.

Press Enter to accept the default network interface name and continue, or
Type the default network interface name, and then press Enter to continue.

NOTES

  • This prompt will be displayed only when you have multiple network interfaces for the computer.
Please verify the physical machine interface name below. Make it as complete (with fully qualified domain name) as possible:

Physical Machine Host Name: [angel.company.com]

6. Specify the client name for the computer.

Press Enter to accept the default name and continue, or
Enter a new client name for the computer and then press Enter to continue.

Please specify the client name for this machine. It does not have to be the network host name: you can enter any word here without spaces. The only requirement is that it must be unique on the CommServe.

Client name: [angel]

Select Components for Installation

7. Enter the number corresponding to the CVGxNRE module.

NOTES

  • Your screen may look different from the example shown.
  • Components that either have already been installed, or which cannot be installed, will not be shown.
  • In addition, the list of modules that appear depends on the specific Unix File System in which the package is installed. (e.g., CVGxWA will appear only when the installation package is run on a Solaris computer.)

Press Enter to continue.

Install Calypso on physical machine client.company.com

Select the Calypso module that you would like to install

1) Media Agent             <= CVGxMA
2) FileSystem iDataAgent   <= CVGxIDA
3) Exit this menu

Module number: [1]

Base Software Installation

8. Select from the following:
  • If this is the first package to be installed on the computer, press Enter to continue.
  • If this is NOT the first package to be installed on the computer, this screen will not be displayed. Skip to Setup Complete.
Here is a list and status of the dependent modules:

     1) Calypso Base0 Module                     NOT installed

    2) Calypso Base Module                      NOT installed

 If there are any modules listed as NOT installed/upgraded, they will be installed/upgraded first.

 Press <ENTER> to proceed ...

9. Specify the location where you want to install the software.

NOTES

  • The amount of free space required depends on the components selected for install, and may look different from the example shown.

Press Enter to accept the default path and continue, or
Enter a path and then press Enter to continue.

Press Enter again to confirm the path.

Please specify where you want us to install Calypso binaries.

It must be a local directory and there should be at least 176MB of free space available. All files will be installed in a "calypso" subdirectory, so if you enter "/opt", the files will actually be placed into "/opt/calypso".

Installation Directory: [/opt]

..

Calypso will be installed in /opt/calypso.
Press ENTER to continue ...

10. Specify the location for the log files.

NOTES

  • All the modules installed on the computer will store the log files in this directory.
  • The amount of free space required depends on the components selected for install, and may look different from the example shown.

Press Enter to accept the default path and continue, or
Enter a path and then press Enter to continue.

Press Enter again to confirm the path.

Please specify where you want to keep Calypso log files.

It must be a local directory and there should be at least 100MB of free space available. All log files will be created in a "calypso/Log_Files" subdirectory, so if you enter "/var/log", the logs will actually be placed into "/var/log/calypso/Log_Files".

Log Directory: [/var/log]

..

Calypso log files will be created in /var/log/calypso/Log_Files.
Press ENTER to continue ...

11. Type a network TCP port number for the Communications Service (CVD) and press Enter.

Type a network TCP port number for the Client Event Manager Service (EvMgrC) and press Enter.

NOTES

Every instance of Calypso should use a unique set of network ports to avoid interfering with other instances running on the same machine.
The port numbers selected must be from the reserved port number range and have not been registered by another application on this machine.

Please enter the port numbers.

Port Number for CVD : [8400]

Port Number for EvMgrC: [8402]

Firewall Configuration

12. If this computer communicates with the CommServe, MediaAgent and/or other clients across a firewall, type Yes, and then press Enter to continue. Proceed to the next Step.

Press Enter, if you do not wish to configure the firewall services. Proceed to the next section.

Various Calypso components need to communicate with each other: iDataAgents and MediaAgents establish connections to CommServe and talk to each other as well. If any of the involved parties are situated on the opposite sides of a firewall, Calypso should be made aware of it so that it could bind its pipeline sockets to open ports and could establish tunnels for control traffic.

You must configure Calypso firewall services if there are other Calypso machines, which are expected to communicate with this one.

Do you want to configure Calypso firewall services? [no]
13. Enter the port range(s), and then press Enter to continue.

NOTES

Calypso needs to know which TCP ports of this machine are available for connections initiated by machines on the other side of the firewall.

If this machine is not reachable from the other side of the firewall at all (because the FW is one-way and allows only outgoing connections), enter any unused port number here (e.g. 8600).
Otherwise please consult your FW configuration for the list of open incoming ports and enter all of them here (with the exception of port 8400).

Currently there are no ports configured. Please enter a single port number or a port range (like 8600-8620) to be added to the FW configuration:

Port range: [8600-8620]

14. Enter the number corresponding to the option you wish to perform.

NOTES

  • If you choose option 1, refer the previous step.
  • If you choose option 3, proceed to the next step.
What would you like to do:

  1) Add another open port or a range of ports

  2) Delete an existing port or a range of ports

  3) Continue with the firewalled host setup

Your choice: [3]
15. Enter the host name(s) of the computers that will need to be contacted through a firewall, and then press Enter to continue. We need to know which Calypso hosts are located on the other side of the firewall, and whether the firewall will allow direct or reverse connections to/from those hosts.

You can specify hosts by either entering their names, IP addresses or name/IP wildcards. The wildcards are available only if the firewall is symmetrical, i.e. allows to open connections to certain ports both ways.

Currently there are no firewall hosts configured.

Please enter the name or IP address of a host on the other side of the firewall. If the firewall is symmetrical, you are allowed to use wildcards, i.e. things like 192.168.* or *.firewall.company.com:

Firewalled Host: lavender.company.com

16. Choose the option associated with type of firewall configuration based on the firewall setup in your environment.

NOTES

  • Choose Two-way (symmetrical) firewall if you can open certain ports as bi-directional ports.
  • Choose One-way firewall; <port> is reachable from here if this computer communicates with MediaAgent/Client on the other side of the firewall.
  • Choose One-way firewall; this machine is reachable from <port> when the CommServe and any Clients/MediaAgents) communicates with this computer.
Please specify the type of the firewall separating this machine from 172.19.61.89.

  1) Two-way (symmetrical) firewall

  2) One-way firewall, 172.19.61.89 is reachable from here

  3) One-way firewall, this machine is reachable from 172.19.61.89

Your choice: [1]

17. Enter the number corresponding to the option you wish to perform.

NOTES

  • If you choose option 1, refer the previous two steps.
  • If you choose option 3, proceed to the next step.
What would you like to do:

 1) Configure another host

 2) Delete an existing host

 3) Continue with the firewall keep-alive setup

Your choice: [3] 1

18. If desired, modify the Keep Alive interval, and then press Enter to continue, or
Press Enter to accept the default.
Please specify Keep Alive interval for Calypso firewall services.

Many firewalls disconnect idle Network connections after some period of time. Some of the Calypso Services need continuous connections. Calypso keeps such connections active by sending periodic "keep-alive" packets.
Consult your firewall documentation, or contact your Network Administrator, for the exact value after which idle connections will be closed (snip time). Then enter a value, which is at least one minute less than the snip time.

Keep-alive interval, minutes [5]

19. To configure advanced firewall settings, type Yes, and then press Enter. Proceed to the next Step.

If you do not want to configure advanced firewall settings, type No, and then press Enter. Proceed to the next section.

The Generic part of the Calypso Firewall Config has been completed successfully. There are some additional advanced settings that you may want to review now. All of them can be customized later by editing the .properties file under /etc/CommVaultRegistry/Galaxy/Instance003/Firewall.

Would you like to review the advanced settings now? [no]

20. To bind the local end of tunnel connections to a specified interface, type Yes, and then press Enter. Proceed to the next Step.

If you do not want to bind the local end of tunnel connections to a specified interface, type No, and then press Enter. Skip the next Step.

Normally Calypso Firewall code doesn't bind local end of TCP/IP sockets when establishing outgoing tunnel connections relying on the OS to pick correct interface and arbitrary port automatically. Usually this doesn't cause connectivity problems because we require that the firewall must allow connections for as long as 1meither source or destination socket end is bound to one of the ports in the open range.

Sometimes, however, on hosts with several NICs it's important to force the OS to bind the local socket end to a specific network interface. There is a Calypso setting called 1mnBIND_BEFORE_CONNECT_IFACEm, which enables this behavior. If present, Calypso will bind the local end of tunnel connections to the specified interface.

Would you like to configure nBIND_BEFORE_CONNECT_IFACE? [no]

21. Type a number corresponding to one of the listed network interfaces, to use for outgoing tunnel connections through the firewall.

Press Enter to continue.

Please select network interface that should be used for all outgoing tunnel connections:

1) <ip_address>

Interface number: [1]

22. If desired, modify the Tunnel Initialization interval by typing a number.

Press Enter to continue.

When tunnel to a destination machine cannot be established because the machine is down or is not accepting connections, Calypso will retry the connection after some time. Tunnels piercing one-way firewalls are 1mPERSISTENTm meaning that Calypso will keep on trying to initialize them until success. These attempts can generate a lot of network traffic if a central machine (e.g. CommServe) suddenly goes down.

Here you can adjust the interval (called 1mnTUNNEL_INIT_INTERVALm in registry) between tunnel init attempts.

Tunnel Init Interval, seconds, [5]

Base Software Installation (continued)

23. Specify the location of the job results directory.

NOTES

  • All the agent modules installed on the computer uses the job results directory to store the backup and restore job results.
  • The amount of free space required depends on the components selected for install, and may look different from the example shown.

Press Enter to accept the default path and continue, or
Enter a path and then press Enter to continue.

Please specify the name for the JobResults directory.

It must be a local directory and there should be at least 20MB of free space available. It will be used to store intermediate data that should be passed from one backup phase to another.

JobResults Directory: [/test1]

Setup Complete

24. Press Enter to continue.

Successfully installed CVGxNRE.

Press ENTER to continue ...

25. Enter the appropriate value to exit the install program. Install Calypso on physical machine client.company.com

Select the Calypso module that you would like to install

1) Media Agent             <= CVGxMA
2) FileSystem iDataAgent   <= CVGxIDA
3) Exit this menu

Module number: [1]

26. Enter Yes to download and install the latest service packs and post packs from the software provider.

NOTES

  • Internet connectivity is required to download updates.
  • This step is applicable for multi instancing.

Press Enter to continue.

Download and Install Latest Service Pack

If you choose to download the latest service pack from the software provider website now, please make sure you have internet connectivity at this time. This process may take some time depending on the internet connectivity.

Do you want to download the latest service pack now ? [no]

Press <ENTER> to continue ...

Post-Install Considerations

Restore Data with File System NDMP Restore Enabler

  • Restoring data with the File System NDMP Restore Enabler works in the same manner as any other restore operation. Refer to the online Help or Perform a File System NDMP Restore for details.