Cluster Configuration - Configurations

Table of Contents

Configuring Agents on Microsoft Cluster

The following steps are involved in configuring the agents on Microsoft Cluster:

  1. Install Software Components on Physical Nodes.
  2. Configure Cluster Group Client.

Install Software Components on Physical Nodes

If you do not wish to backup the data that resides on the physical nodes using a specific agent, you can install that agent in 'restore only' mode. Installing an agent in 'restore only' mode will prevent the consumption of an additional license per node. See Installing Restore Only Agents for more information. Alternatively, you can release license from the CommCell Console for a specific agent after installing it on the physical nodes. Refer to Releasing a License section to see the procedure for releasing a license.

Install the software on all the the physical computers that host the Cluster Group. For example, to install the Windows File System iDataAgent, follow the steps described in Getting Started - Windows File System Deployment. Make sure to review the Network TCP Port requirements prior to performing the installation. For more information, see Network TCP Port Requirements.

Configure the Cluster Group Client

After installing the software successfully on all the physical computers that host the Cluster Group, you must configure the Cluster Group Client from the CommCell Console. The following section describes the steps involved in configuring the Cluster Group Client.

  1. From the CommCell Browser, right-click the Client Computers node, point to New Client | Clustered Server and then click Windows Cluster.

  2. On the New Windows Cluster Client dialog box, specify the details of the cluster resource group that you want to protect to create the cluster group client.
    1. In the Client Name box, type a name for the resource group. The client name should have a unique name.
    2. In the Host Name box, type the fully qualified domain name of the resource group.

      The host name of the resource group should not be used by any existing client in your CommCell.

    3. Click Next.

    The following image displays an example of the fully qualified domain name of a resource group on the Failover Cluster Manager for Windows 2012.

    On Windows 2008 servers, the resource groups are located under Services and Applications on the left pane of the Failover Cluster Manager.

  3. Review the cluster group information and click Finish.

    Advanced Client Properties window is displayed now.

  4. On the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
    • All the Windows clients that are available in the CommCell will be listed in the Available list. Select the physical computers (nodes) where you installed the necessary Agents from the Available list, and then click Add > to move the client to the Selected list.
    • Click the Agents tab.
      Select the Agents you want to use in the cluster group client from the Available list and click Add > to move the Agent to the Selected list.

    If the client computer properties dialog box is not displayed automatically, then you need to open it manually: Right-click the  <Cluster Group Client>, and then click Properties. Click Advanced on the Client Computer Properties dialog box. Click the Cluster Group Configuration tab on the Advanced Client Properties dialog box.

  5. Click the Job Configuration tab.

    Type or click Browse to specify the path for the Job Results Directory in the cluster group client.

    • Ensure that the Job Results Directory resides on a shared clustered drive.
    • In the case of MediaAgent and ContinuousDataReplicator, the Job Result directory path will be used for both the Index Cache and CDR Log directories respectively unless another directory location is provided.

    Click OK.

  6. Click OK.

    The cluster group client is successfully created.

Now you can proceed to create a Subclient to define the data that you want to backup. Once a Subclient is created and a storage policy is configured for this Cluster Group client,  you can start performing backup and recovery operations.

For more information, see the corresponding Getting Started - Configuration section of the agent that you installed. Example, see Getting Started - Windows File System - Configuration to find the steps for configuring a Subclient for Windows File System agent.

Configuring Agents on Quorum Disk

The following steps are involved in configuring the agents on Microsoft Cluster:

  1. Install Software Components on Physical Nodes.
  2. Configure Cluster Group Client for Quorum Disks.

Install Software Components on Physical Nodes

If you do not wish to backup the data that resides on the physical nodes using a specific agent, you can install that agent in 'restore only' mode. Installing an agent in 'restore only' mode will prevent the consumption of an additional license per node. See Installing Restore Only Agents for more information. Alternatively, you can release license from the CommCell Console for a specific agent after installing it on the physical nodes. Refer to Releasing a License section to see the procedure for releasing a license.

Install the software on all the the physical computers that host the Cluster Group. For example, to install the Windows File System iDataAgent, follow the steps described in Getting Started - Windows File System Deployment. Make sure to review the Network TCP Port requirements prior to performing the installation. For more information, see Network TCP Port Requirements.

Configure the Cluster Group Client for Quorum Disks

  1. To back up the data on the Quorum disk, make sure that you create a virtual client in the CommCell Console with the cluster client name.

  2. From the CommCell Browser, right-click the Client Computers node, point to New Client | Clustered Server and then click Windows Cluster.

  3. On the New Windows Cluster Client dialog box, specify the details of the cluster that you want to protect to create the cluster group client.
    1. In the Client Name box, type a name for the cluster. Make sure that you provide same name as the cluster client name.
    2. In the Host Name box, type the fully qualified domain name of the cluster.

      The host name of the cluster should not be used by any existing client in your CommCell.

    3. Click Next.

  4. Review the cluster group information and click Finish.

    The Advanced Client Properties window appears.

  5. On the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
    • All the Windows clients that are available in the CommCell will be listed in the Available list. Select the physical computers (nodes) where you installed the necessary Agents from the Available list, and then click Add > to move the client to the Selected list.
    • Click the Agents tab.
      Select the Agents you want to use in the cluster group client from the Available list and click Add > to move the Agent to the Selected list.

    If the client computer properties dialog box is not displayed automatically, then you need to open it manually: Right-click the  <Cluster Group Client>, and then click Properties. Click Advanced on the Client Computer Properties dialog box. Click the Cluster Group Configuration tab on the Advanced Client Properties dialog box.

  6. Click the Job Configuration tab.

    Type or click Browse to specify the path for the Job Results Directory in the cluster group client.

    • Ensure that the Job Results Directory resides on a shared clustered drive.
    • In the case of MediaAgent and ContinuousDataReplicator, the Job Result directory path will be used for both the Index Cache and CDR Log directories respectively unless another directory location is provided.

    Click OK.

  7. Click OK.

    The cluster group client is successfully created.

    You can start performing backup and recovery operations using the default subclient for this cluster client. For more information on backing the default subclient, see Backup - Windows File System iDataAgent.

Configuring Agents on Non-Microsoft Cluster - Windows

The following steps are involved in configuring the agents on a Non-Microsoft Cluster:

  1. Install Software Components on Physical Nodes.
  2. Configure Cluster Group Client.
  3. Configure Failovers

Install the Software Components on Physical Nodes

If you do not wish to backup the data that resides on the physical nodes using a specific agent, you can install that agent in 'restore only' mode. Installing an agent in 'restore only' mode will prevent the consumption of an additional license per node. See Installing Restore Only Agents for more information. Alternatively, you can release license from the CommCell Console for a specific agent after installing it on the physical nodes. Refer to Releasing a License section to see the procedure for releasing a license.

Install the software on all the the physical computers that host the Cluster Group. For example, to install the Windows File System iDataAgent, follow the steps described in Getting Started - Windows File System Deployment. Make sure to review the Network TCP Port requirements prior to performing the installation. For more information, see Network TCP Port Requirements.

Configure Cluster Group Client

After installing the software successfully on all the physical computers that host the Cluster Group, you must configure the Cluster Group Client from the CommCell Console. The following section describes the steps involved in configuring the Cluster Group Client.

  1. From the CommCell Browser, right-click the Client Computers node, point to New Client | Clustered Server and then click Windows Cluster.

  2. In the Client Name box, type a name for the cluster group. The Client name can be any unique name.

    In the Host Name box, type the fully qualified domain name of the cluster group.

    The Host name of the cluster group client should not be used by any existing client in your CommCell.

  3. Review the cluster group information and click Finish.

    Advanced Client Properties window is displayed now.

  4. On the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
    • All the Windows clients that are available in the CommCell will be listed in the Available list. Select the physical computers (nodes) where you installed the necessary Agents from the Available list, and then click Add > to move the client to the Selected list.
    • Click the Agents tab.
      Select the Agents you want to use in the cluster group client from the Available list and click Add > to move the Agent to the Selected list.

    If the client computer properties dialog box is not displayed automatically, then you need to open it manually: Right-click the  <Cluster Group Client>, and then click Properties. Click Advanced on the Client Computer Properties dialog box. Click the Cluster Group Configuration tab on the Advanced Client Properties dialog box.

  5. Click the Job Configuration tab.

    Type or click Browse to specify the path for the Job Results Directory in the cluster group client.

    • Ensure that the Job Results Directory resides on a shared clustered drive.
    • In the case of MediaAgent and ContinuousDataReplicator, the Job Result directory path will be used for the Index Cache and CDR Log directories respectively if no directory location is provided.

    Click OK.

  6. Click OK.

    The cluster group client is successfully created.

Configure Failovers

Configure Cluster Resources

After installing the software component (s) on the physical nodes and the cluster group client is configured, you must configure the Cluster resources. Use the following steps to configure Cluster resources:

Create the Cluster Resources for Services

After configuring the Cluster group client, the services should be added as generic services. However, you must designate the <Cluster Plug-in  (Cluster Group) (Instance)> service as "critical" if you want to cause the cluster group to failover if the associated service stops.

  1. Click the Windows Start button, click Run, type services.msc and press Enter. Services window will be displayed.
  2. Locate the services for each installed cluster group. For example,  NetApp Cluster Plugin (penodevn1_netwo) (instance001))
  3. Right-click this service, select Properties, and locate the service name in the General tab (for example, GxClusPlugin (penodevn1_netwo) (Instance001))

    • The service name is case and space-sensitive, so record it exactly as it appears.
    • If you have created multiple cluster groups, you can designate each of the associated services as critical.

  4. From the Cluster Administrator, navigate to the appropriate Cluster group. Create a generic service resource for the cluster plugin service.
  5. If you want an automatic failover to occur, mark the resource as Critical and Enabled.

    If you have created multiple cluster groups, you can designate each of the services associated with the corresponding cluster group as "critical".

  6. Repeat this procedure on each physical computer hosting the cluster.
  7. Create Service Dependencies.
    1. In the Cluster Administrator, click Resources.
    2. Click Link and make the Cluster plugin resource dependent upon the Mount resource and the Lanman service.
  8. Associate Services with the Current Active Node.
    1. In the Cluster Administrator interface, navigate to the appropriate GenericService group.
    2. Right-click the cluster plugin resource.
    3. From the short-cut menu, click Online and the name of the current active node.

Add Service Dependencies

By default, a failure of any Agent software (for example, Windows File System ) on the active node will not cause a failover to be initiated. To configure a cluster server to failover when the Agent software fails, you are required to perform the following steps on each of the physical computers configured to host the cluster group:

  1. Add the list of Services that GxClusPlugin must monitor for failures

    Configure the sServiceMonitorList additional setting with a list of services that GxClusPlugin will monitor for failure. For information about the services used by an Agent or MediaAgent, which can be listed in this additional setting, see Services.

    1. From the CommCell Browser, navigate to Client Computers | <Cluster Group Client>. Right-click the <Cluster Group Client> and then select Properties.
    2. On the Client Computer Properties dialog box, click Advanced.
    3. On the Advanced Client Properties dialog box, click the Additional Settings tab, and then click Add.
    4. In the Name box, type sServiceMonitorList. Once entered, the Category and Type details will be automatically populated. Alternatively, you can click Lookup and search for the additional setting by typing the additional setting name in the Find box or scrolling through the list. Once found, double-click the additional setting from the lookup window.
    5. In the Value box, type the services that need to be monitored by the cluster plug-in.

      Example:  GxCVD(Instance001);GxEvMgrC(Instance001)

    6. Click OK. Click OK.

  2. Configure the Monitoring Frequency

    Configure the sServiceMonitorFrequency additional setting for the frequency (in seconds) at which those services should be polled for failure. This value should be less than the service restart interval being monitored, if any.

    1. From the CommCell Browser, navigate to Client Computers | <Cluster Group Client>.Right-click the <Cluster Group Client> and select Properties.
    2. On the Client Computer Properties dialog box, click Advanced.
    3. On the Advanced Client Properties dialog box, click the Additional Settings tab, and then click Add.
    4. In the Name box, type sServiceMonitorFrequency. Once entered, the Category and Type details will be automatically populated. Alternatively, you can click Lookup and search for the additional setting by typing the additional setting name in the Find box or scrolling through the list. Once found, double-click the additional setting from the lookup window.
    5. In the Value box, type the time interval in seconds. This time interval will be the frequency at which the services will be pooled for status on the active node of a cluster.

      Default Value: 30

    6. Click OK.Click OK.
  3. Configure GxClusPlugin Properties

    Configure the properties of GxClusPlugin so that a failover will be triggered by a failure of any of the services listed in the sServiceMonitorList additional setting.

    For Windows 2008 Server:

    1. From the Failover Cluster Manager console, right-click GxClusPlugin listed under Cluster Core Resources | Other Resources, and then select Properties.
    2. Click the Policies tab and select the If restart is unsuccessful, fail over all resources in this service or application check box.
    3. Click OK.

    For Windows 2003 Server:

    1. From the Cluster Administrator, right-click GxClusPlugin listed under Other Resources, and then select Properties.
    2. Click the Advanced tab and select Restart and Affect the Group, and click OK.

Configuring Agents on Veritas Cluster - UNIX

The following steps are involved in configuring the agents on a Veritas Cluster:

  1. Install Software Components on Physical Nodes
  2. Configure Cluster Group Client

Install Software Components on Physical Nodes

If you do not wish to protect physical nodes with a specific agent, you can install that agent in 'restore only' mode, doing so will prevent the consumption of additional license per node. See Installing Restore Only Agents for more information. Alternatively, you can release license from the CommCell Console for a specific agent after installing it on the physical nodes. Refer to Releasing a License section to see the procedure for releasing a license.

Install the software on all the the physical computers that host the Cluster Group. For example, to install the Linux File System iDataAgent, follow the steps described in Getting Started - Linux File System Deployment. Make sure to review the Network TCP Port requirements prior to performing the installation. For more information, see Network TCP Port Requirements.

After you install the software components on the physical nodes and configure the cluster group client from the CommCell Console by adding the Veritas cluster (VCS) nodes, the contents of the default subclient of the default backupset are altered during backup to reflect the mount points associated with the Service Group.

Configure Cluster Group Client

After installing the software successfully on all the physical nodes that host the cluster group, you must configure the cluster group client from the CommCell Console. Use the following steps to configure the cluster group client.

  1. From the CommCell Browser, right-click the Client Computers node, point to New Client | Clustered Server and then click Unix Cluster.

  2. In the Client Name box, type a name for the cluster group. The client name can be any unique name.

    In the Host Name box, you can type either the fully qualified domain name of the cluster group or the IP address of the cluster group.

    • The Host name of the cluster group client should not be used by any existing client in your CommCell.
    • If you want to specify the IP address of the cluster group, ensure that the IP address is static.

  3. Review the cluster group information and click Finish.

    The Advanced Client Properties dialog box is displayed.

  4. On the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
    • All the Linux clients that are available in the CommCell will be listed in the Available list. Select the physical computers (nodes) where you installed the necessary agents from the Available list, and then click Add > to move the client to the Selected list.
    • Click the Agents tab.
      Select the agents you want to use in the cluster group client from the Available list and click Add > to move the Agent to the Selected list.

    If the client computer properties dialog box is not displayed automatically, then you need to open it manually: Right-click the  <Cluster Group Client>, and then click Properties. Click Advanced on the Client Computer Properties dialog box. Click Cluster Group Configuration tab on the Advanced Client Properties dialog box.

  5. Click the Agents tab.

    Select the agents you want to use in the cluster group client from the Available list and click Add > to move the agent to the Selected list.

    In order to configure a Cluster Group Client, the agents should be installed on all the clustered nodes for proper failover. If an agent is not installed on all the nodes, then the agents selection tab on the Advanced Client Properties window will display the agent name in plain text (not in bold). However, you can still configure the Cluster Group Client even when the Agents are not installed on a particular node; installation can be done later using remote install procedure.

  6. Click the Job Configuration tab.

    Type or click Browse to specify the path for the Job Results Directory in the cluster group client.

    • Ensure that the Job Results Directory resides on a shared clustered drive.
    • In the case of MediaAgent and ContinuousDataReplicator, the Job Result directory path will be used for the Index Cache and CDR Log directories respectively if no directory location is provided.

    Click OK.

  7. Click OK.

    The cluster group client is successfully created.

After the Cluster Group client is configured...

  • A new application called GxClusterPlugin_service_group_name is created in the Veritas cluster, and dependency links will be set up from this newly created application to all of the resources in the group of type IP, mount point and disk group. This ensures that the plug-in is started after all of the other resources have come online or is stopped before any other resource goes offline during failovers.
  • The plug-in must be able to read the main.cmd file, which is typically located under /etc/VRTSvcs/conf/config. If the file is not present, it will be created with the following command:

    hacf -cftocmd directory_path

    After the command is ran, the main.cmd file is created with the same ownership as that of SnapProtect processes.

  • During the service group failover, the plug-in performs the following tasks:
    1. Turns off firewall on the service group, and enables it on the active node.
    2. Notifies the CommServe database where the service group is active for effective resource allocation.
    3. If archiving/OnePass operations are configured, the plug-in switches the monitoring mount points to the active node to handle stub recalls.

Configuring Agents on Non-Veritas Cluster - UNIX

The following steps are involved in configuring the agents on a Non-Veritas Cluster:

  1. Install Software Components on Physical Nodes
  2. Configure Cluster Group Client
  3. Configure Failovers

Install the Software Components on Physical Nodes

If you do not wish to protect physical nodes with a specific agent, you can install that agent in 'restore only' mode, doing so will prevent the consumption of additional license per node. See Installing Restore Only Agents for more information. Alternatively, you can release license from the CommCell Console for a specific agent after installing it on the physical nodes. Refer to Releasing a License section to see the procedure for releasing a license.

Install the software on all the the physical computers that host the Cluster Group. For example, to install the Linux File System iDataAgent, follow the steps described in Getting Started - Linux File System Deployment. Make sure to review the Network TCP Port requirements prior to performing the installation. For more information, see Network TCP Port Requirements.

Configure Cluster Group Client

After installing the software successfully on all the physical nodes that host the cluster group, you must configure the cluster group client from the CommCell Console. Use the following steps to configure the cluster group client.

  1. From the CommCell Browser, right-click the Client Computers node, point to New Client | Clustered Server and then click Unix Cluster.

  2. In the Client Name box, type a name for the cluster group. The client name can be any unique name.

    In the Host Name box, you can type either the fully qualified domain name of the cluster group or the IP address of the cluster group.

    • The Host name of the cluster group client should not be used by any existing client in your CommCell.
    • If you want to specify the IP address of the cluster group, ensure that the IP address is static.

  3. Review the cluster group information and click Finish.

    The Advanced Client Properties dialog box is displayed.

  4. On the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
    • All the Linux clients that are available in the CommCell will be listed in the Available list. Select the physical computers (nodes) where you installed the necessary agents from the Available list, and then click Add > to move the client to the Selected list.
    • Click the Agents tab.
      Select the agents you want to use in the cluster group client from the Available list and click Add > to move the Agent to the Selected list.

    If the client computer properties dialog box is not displayed automatically, then you need to open it manually: Right-click the  <Cluster Group Client>, and then click Properties. Click Advanced on the Client Computer Properties dialog box. Click Cluster Group Configuration tab on the Advanced Client Properties dialog box.

  5. Click the Agents tab.

    Select the agents you want to use in the cluster group client from the Available list and click Add > to move the agent to the Selected list.

    In order to configure a Cluster Group Client, the agents should be installed on all the clustered nodes for proper failover. If an agent is not installed on all the nodes, then the agents selection tab on the Advanced Client Properties window will display the agent name in plain text (not in bold). However, you can still configure the Cluster Group Client even when the Agents are not installed on a particular node; installation can be done later using remote install procedure.

  6. Click the Job Configuration tab.

    Type or click Browse to specify the path for the Job Results Directory in the cluster group client.

    • Ensure that the Job Results Directory resides on a shared clustered drive.
    • In the case of MediaAgent and ContinuousDataReplicator, the Job Result directory path will be used for the Index Cache and CDR Log directories respectively if no directory location is provided.

    Click OK.

  7. Click OK.

    The cluster group client is successfully created.

Configure Failovers

  1. Configure cvclusternotify Script
  2. Add Service Dependencies

Configure cvclusternotify Script

After installing the software component (s) on the physical nodes and the cluster group client is configured, you must configure the cvclusternotify script.

A failure of any Agent software on the active node in a UNIX cluster will not cause a failover to be initiated.

The cvclusternotify script should be added as part of the normal cluster startup/shutdown procedure. The script is provided as a generic template, and it must be run at the beginning of node shutdown and at the end of new active node startup. In both cases, data protection services must be up and running.

Run the following command to notify SnapProtect that the specified "Cluster Group" is going up or down because of a cluster failover:

Usage:

cvclusternotify -inst <Instance> -cn <Client Name> -start|-shutdown

Where:

cvclusternotify - Program to notify SnapProtect of cluster failovers

Example:

For a two-node cluster, if the cluster group client name is "ClusterGroup1" and the application instance is "Instance001", run the following command:

  • To shutdown:

    cvclusternotify -inst Instance001 -cn "ClusterGroup1" -shutdown

  • To start up:

    cvclusternotify -inst Instance001 -cn "ClusterGroup1" -start

Add Service Dependencies

Add the following service dependencies:

  • Add dependencies to IP Resource.
  • Add dependencies to Disk Resource.

Configuring Agents on a HP Scalable NAS/PolyServe Cluster - Windows

The following steps are involved in installing the software components in a HP Scalable NAS/PolyServe Clustered environment:

  1. Install Software Components on Physical Nodes
  2. Configure Cluster Group Client
  3. Configure Failovers

Install Software Components on Physical Nodes

If you do not wish to backup the data that resides on the physical nodes using a specific agent, you can install that agent in 'restore only' mode. Installing an agent in 'restore only' mode will prevent the consumption of an additional license per node. See Installing Restore Only Agents for more information. Alternatively, you can release license from the CommCell Console for a specific agent after installing it on the physical nodes. Refer to Releasing a License section to see the procedure for releasing a license.

Install the software on all the the physical computers that host the Cluster Group. For example, to install the Windows File System iDataAgent, follow the steps described in Getting Started - Windows File System Deployment. Make sure to review the Network TCP Port requirements prior to performing the installation. For more information, see Network TCP Port Requirements.

Configure Cluster Group Client

  1. From the CommCell Browser, right-click the Client Computers node, point to New Client | Clustered Server and then click Windows Cluster.

  2. In the Client Name box, type a name for the cluster group. The Client name can be any unique name.

    In the Host Name box, type the fully qualified domain name of the cluster group.

    The Host name of the cluster group client should not be used by any existing client in your CommCell.

  3. Review the cluster group information and click Finish.

    Advanced Client Properties window is displayed now.

  4. On the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
    • All the Windows clients that are available in the CommCell will be listed in the Available list. Select the physical computers (nodes) where you installed the necessary Agents from the Available list, and then click Add > to move the client to the Selected list.
    • Click the Agents tab.
      Select the Agents you want to use in the cluster group client from the Available list and click Add > to move the Agent to the Selected list.

    If the client computer properties dialog box is not displayed automatically, then you need to open it manually: Right-click the  <Cluster Group Client>, and then click Properties. Click Advanced on the Client Computer Properties dialog box. Click the Cluster Group Configuration tab on the Advanced Client Properties dialog box.

  5. Click the Job Configuration tab.

    Type or click Browse to specify the path for the Job Results Directory in the cluster group client.

    • Ensure that the Job Results Directory resides on a shared clustered drive.
    • In the case of MediaAgent and ContinuousDataReplicator, the Job Result directory path will be used for the Index Cache and CDR Log directories respectively if no directory location is provided.

    Click OK.

  6. Click OK.

    The cluster group client is successfully created.

Configure Failovers

  1. Configure Cluster Resources
  2. Add Service Dependencies

Configure Cluster Resources

Use the following steps to configure HP Scalable NAS/PolyServe Cluster resources:

  1. Create and Use Scripts to Administer Virtual Machine Services

    You should create and use three scripts to administer virtual machine services:

    • Probe script is used to reveal the state of the specified services - This is done by using the GxSCMCmd.exe utility.
    • Start script is used to start services.
    • Stop script is used to stop services.

    Create a probe script to have the status of both the NetApp Communications Service (GxCVD) and the NetApp Event Manager Service (GxEvMgrC) checked.

    In the probe script, include the GxSCMCmd.exe utility by name in the appropriate command. (This utility is available from the Resource Pack. See Tools and Utilities for more information.) Create a folder (for example, m:\GxSCMCmd) on a shared disk that the virtual host you created has access to.

    Copy the GxSCMCmd.exe utility and the script files you created (probe.bat, start.bat, stop.bat) to this folder. The utility will return the state of the specified services:

     '0' if the services are running

    '1' if services are stopped

    '-1' is returned for an error condition.

    Note that the service name includes the name of the client and the name of the instance. To avoid error in providing the vhost name and instance name in the path of scripts, copy the key name from here: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\GXClusPlugIn (vhostname) (Instance00x)

    These examples provide sample script names, locations and virtual host name as suggested names not requirements.

    The command syntax is:

    GxSCMCmd.exe -IsRunning <list of service name>

    For example, your probe script (for example, m:\GxSCMCmd\gxprobe.bat) may appear as follows:

    @echo off

    if'%MX_ACTIVE_STATE%'='INACTIVE' exit 0

    m:\GxSCMCmd\GxSCMCmd.exe -IsRunning "GxClusPlugIn (virtualpolyserve) (Instance001)"

    if ERRORLEVEL 0 exit 0

    exit 1

    Be sure to copy the GxSCMCmd.exe utility to the shared disk resource. Also, be sure to include the probe script on the shared disk.

    The stop and start scripts must also contain the registry entry for the virtual machine service names. Your start script (for example, m:\GxSCMCmd\gxstart.bat) may appear as follows:

    @echo off

    C:\WINDOWS\system32\net.exe start "GxClusPlugIn (virtualpolyserve) (Instance001)"

    exit 0

    Your stop script (for example, m:\GxSCMCmd\gxstart.bat) may appear as follows:

    @echo off

    C:\WINDOWS\system32\net.exe stop GxClusPlugIn (virtualpolyserve) (Instance001)

    exit 0

  2. Add the Customer Service Monitor

    Add the custom service monitor to the virtual host configuration in the PolyServe Matrix Server console. Ensure that the virtual host name <virtualpolyserve> is online.

    1. From the Services MMC snap-in, verify or manually start the cluster plugin service, "NetApp Cluster Plugin (virtualpolyserve) (Instance00x)", on the active primary node for the Vhost virtualpolyserve
    2. From the PolyServe Matrix Server, click the Virtual Hosts tab.
    3. Right click Virtual Host <virtualpolyserve> and then Add Service Monitor.
    4. For the Monitor Type field in the Add Service Monitor dialog box, click CUSTOM.
    5. Assign a name to the service monitor by typing the name in the Name field.
    6. In the User probe script field, type the path to the probe script that calls the GxSCMCmd.exe command (on the share disk)
    7. Click Advanced.
    8. From the Advanced Service Configuration dialog box, click the Scripts tab.
    9. In the Script pathname: Start field, type the path to the start script (shared disk). In the corresponding Timeout (seconds) field, type a timeout value greater than 60 seconds.
    10. In the Script pathname: Stop field, type the path to the stop script (shared disk). In the corresponding Timeout (seconds) field, type a timeout value greater than 60 seconds.
    11. Click OK.

The monitor should now start, and the primary node should now be active. Failover will occur if services are disabled on the primary node, and services in such a case will move to a secondary node.

Add Service Dependencies

By default, a failure of any Agent software (for example, Windows File System ) on the active node will not cause a failover to be initiated. To configure a cluster server to failover when the Agent software fails, you are required to perform the following steps on each of the physical computers configured to host the cluster group:

  1. Add the list of Services that GxClusPlugin must monitor for failures

    Configure the sServiceMonitorList additional setting with a list of services that GxClusPlugin will monitor for failure. For information about the services used by an Agent or MediaAgent, which can be listed in this additional setting, see Services.

    • From the CommCell Browser, navigate to Client Computers | <Cluster Group Client>. Right-click the <Cluster Group Client> and then select Properties.
    • On the Client Computer Properties dialog box, click Advanced.
    • On the Advanced Client Properties dialog box, click the Additional Settings tab, and then click Add.
    • In the Name box, type sServiceMonitorList.Once entered, the Category and Type details will be automatically populated. Alternatively, you can click Lookup and search for the additional setting by typing the additional setting name in the Find box or scrolling through the list. Once found, double-click the additional setting from the lookup window.
    • In the Value box, type the services that need to be monitored by the cluster plug-in.

      Example:  GxCVD(Instance001);GxEvMgrC(Instance001)

    • Click OK.Click OK.

  2. Configure the Monitoring Frequency

    Configure the sServiceMonitorFrequency additional setting for the frequency (in seconds) at which those services should be polled for failure. This value should be less than the service restart interval being monitored, if any.

    • From the CommCell Browser, navigate to Client Computers | <Cluster Group Client>.Right-click the <Cluster Group Client> and select Properties.
    • On the Client Computer Properties dialog box, click Advanced.
    • On the Advanced Client Properties dialog box, click the Additional Settings tab, and then click Add.
    • In the Name box, type sServiceMonitorFrequency. Once entered, the Category and Type details will be automatically populated. Alternatively, you can click Lookup and search for the additional setting by typing the additional setting name in the Find box or scrolling through the list. Once found, double-click the additional setting from the lookup window.
    • In the Value box, type the time interval in seconds. This time interval will be the frequency at which the services will be pooled for status on the active node of a cluster.

      Default Value: 30

    • Click OK.Click OK.
  3. Configure GxClusPlugin Properties

    Configure the properties of GxClusPlugin so that a failover will be triggered by a failure of any of the services listed in the sServiceMonitorList additional setting.

    For Windows 2008 Server:

    • From the Failover Cluster Manager console, right-click GxClusPlugin listed under Cluster Core Resources | Other Resources, and then select Properties.
    • Click the Policies tab and select the If restart is unsuccessful, fail over all resources in this service or application check box.
    • Click OK.

    For Windows 2003 Server:

    • From the Cluster Administrator, right-click GxClusPlugin listed under Other Resources, and then select Properties.
    • Click the Advanced tab and select Restart and Affect the Group, and click OK.

Managing Clients in the Cluster Group Client

The following sections describe the steps to add or remove physical computers in the cluster group client.

Add a New Client

  1. Install the software on the new physical computer.

    For example, to install the Windows File System iDataAgent, follow the steps described in Getting Started - Windows File System Deployment.

  2. From the CommCell Browser, navigate to Client Computers | <Cluster Group Client>.
  3. Right-click the <Cluster Group Client> and select Properties.
  4. On the Client Computer Properties dialog box, click Advanced.
  5. On the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
  6. Select the client computer from the Available list and click Add > to move the client to the Selected list.

    New Agents will be available for selection from the Agents tab.

  7. Click OK.
  8. Click OK on the Information dialog box.

The client is successfully updated with the cluster group configuration.

Remove a Client (Deconfigure a Client)

  1. From the CommCell Browser, navigate to Client Computers | <Cluster Group Client>.
  2. Right-click the <Cluster Group Client> and select Properties.
  1. On the Client Computer Properties dialog box, click Advanced.
  2. On the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
  3. Select the client computer from the Selected list and click < Remove.
  4. Click OK.
  5. Click OK on the Information dialog box.

The client is successfully deconfigured from the cluster group.

Managing Agents in the Cluster Group Client

The following sections describe the steps to add or remove Agents in the cluster group client.

Add an Agent

Use the following steps to add an agent that is already installed on the physical computer:

  1. From the CommCell Browser, navigate to Client Computers | <Cluster Group Client>.
  2. Right-click the <Cluster Group Client> and select Properties.
  1. On the Client Computer Properties dialog box, click Advanced.
  2. On the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
  3. Click the Agents tab.
  4. Select an Agent from the Available list and click Add > to move the Agent to the Selected list.
  5. Click OK.
  6. Click OK on the Information dialog box.

Add an Agent that is not Installed on a Physical Node

To add an Agent to the cluster group client, you need to install the Agent on a physical computer associated with the cluster client. Use the steps below to accomplish this operation.

  1. Install the Agent software on the physical computers.
  2. From the CommCell Browser, navigate to Client Computers | <Cluster Group Client>.
  3. Right-click the <Cluster Group Client> and select Properties.
  4. On the Client Computer Properties dialog box, click Advanced.
  5. On the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
  6. Click the Agents tab.
  7. Select the Agent you installed in Step 1 from the Available list and click Add > to move it to the Selected list.
  8. Click OK.
  9. Click OK on the Information dialog box.

The new Agent in the cluster group is ready for backup and restore operations.

Remove an Agent

  1. From the CommCell Browser, navigate to Client Computers | <Cluster Group Client>.
  2. Right-click the <Cluster Group Client> and select Properties.
  1. On the Client Computer Properties dialog box, click Advanced.
  2. On the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
  3. Click the Cluster Group Configuration tab and then click the Agents tab.
  4. Select an Agent from the Selected list and click < Remove.
  5. Click OK.
  6. Click OK on the Information dialog box.

Network TCP Port Requirements

For a given cluster server, the MediaAgent, Agent, or other software component installed on every physical node in a cluster which is configured to host that cluster server must have the same port numbers configured. Thus, if you have a cluster server VS1, and three physical computers configured to host VS1, then all the three computers must have the same Network TCP port numbers configured for the network interface used by VS1. For greater detail, consider this example:

  • Node A is configured to host cluster server VS1. Instance001 has the an Agent installed to protect application data on VS1; during install, Port 8502 was specified for the Communications Service (CVD) and Port 8503 was specified for the Client Event Manager Service (EvMgrC).
  • Node B is also configured to host VS1. Instance001 has the same Agent installed to protect the application data on VS1; during the Agent install, Port 8502 must be specified for the Communications Service (CVD) and Port 8503 must be specified for the Client Event Manager Service (EvMgrC) to match the Network TCP port number configuration of Node A.

License Requirements

Depending on the cluster type (Windows or Unix), the following table shows the file system and cluster licenses needed for the physical computer associated with the cluster group client:

Agent/Component License Type

AIX

IBM AIX File System Server File System
  • IBM PowerHA for AIX (formerly HACMP) Cluster
  • VERITAS Cluster for IBM AIX
Cluster Group

HP-UX

HP-UX File System Server File System
VERITAS Cluster for HP-UX Cluster Group

Linux

Linux File System Server File System
  • Red Hat Linux Cluster
  • VERITAS Cluster for Linux
Cluster Group

Solaris

Sun Solaris File System Server File System
  • Solaris Sun Cluster
  • VERITAS Cluster for Solaris
Cluster Group

Windows

Microsoft Windows File System (Server Class) Server File system
Microsoft Windows File System (Cluster) Cluster Group

MediaAgent

You must have a license for each physical and virtual node where the MediaAgent is installed. If you do not plan to use the MediaAgent on the physical nodes, install the MediaAgent as a Restore Only Agent, which does not consume a license.

MediaAgent (Windows or UNIX) MediaAgents

SAP HANA

If you have a cluster environment configured with the SAP HANA application, you must obtain the following license:

SAP HANA Application Class 3

Uninstalling Components from a Cluster

The following section describes the steps involved in uninstalling the agents and removing the associated physical nodes of a Cluster Group client:

Uninstall an Agent from the Cluster Group Client

  1. From the CommCell Browser, navigate to Client Computers | <Cluster Group Client>.
  2. Right-click the <Cluster Group Client> and select Properties.
  1. On the Client Computer Properties dialog box, click Advanced.
  2. On the Advanced Client Properties dialog box, click  Cluster Group Configuration tab.
  3. Click the Agents tab.
  4. Select the Agent you want to uninstall from the Selected list and click < Remove.
  5. If no other Agent is being used from the same physical computer, you can proceed to deconfigure the physical computer from the cluster group client:
    • Click the Nodes tab.
    • Select the physical computer from the Selected list and click < Remove.
  6. Click OK.
  7. Click OK from the Information dialog box.
  8. Proceed to uninstall the software from the physical computer. Refer to Uninstalling Components for more information.

After removing all the physical nodes associated with the Cluster Group client, it is recommended to deconfigure the cluster group client as it will become a non-active client. See FAQ for more information.

Command Line Operations

You can add, configure and deconfigure a cluster group client from the command line. This is useful in the following scenarios:

  • You can reuse the scripts to configure new cluster groups by replacing the appropriate attribute values in the script.
  • Additional physical computers and Agents can be added to an existing cluster group client.

Create a Cluster Group

The following sections describe the steps to create a cluster group client.

Generating Command Line Script to Create Cluster Group Client

In order to create a cluster group client from the command line, you need to select the required options from the CommCell Console and save it as a script file. This script can be modified as required and then executed from the command line using the 'qoperation execute' command.

Follow the steps given below to generate the script:

  1. From the CommCell Browser, right-click the Client Computers node and click New Client | Clustered Server | <Windows/Unix> Cluster.
  2. In the Configure Client dialog box, complete the following steps:
    1. In the Client Name box, enter a name for the cluster group client
    2. In the Host Name box, enter the host name of the computer that will host your cluster group client in the Host Name box.
    3. Click Next.
  3. In the Summary dialog box, click Save as Script.
  4. In the Save as Script dialog box, complete the following steps:

    1. From the Client list, select the client computer where you want to save the script.
    2. In the File Path box, enter the location where you want to save the script, or click Browse and navigate to the location.
    3. By default, the user account that you used to log on to CommCell Console is used to perform the operation. However, if the user account does not have the sufficient privileges, click Use a different user account to enter the username and password for the account.
    4. Click OK.

    The script will be saved as a .xml file and a .bat file is created.

    If a file with the same name already exists in the specified location, the .xml file will be created with a timestamp. However, the .bat file will overwrite the existing file.

Creating the Cluster Group Client

  1. Log on to the client computer where the XML file was saved during the Save as Script operation.
  2. From the command prompt, navigate to Software_Installation_Directory/Base and run the following command:

    qlogin -cs commserve_host_name -u user_name

  3. Execute the XML file using the qoperation execute command.

    qoperation execute -af XML_File_Location

  4. To configure the cluster group client using the command line, see Configure a Cluster Group.

To reuse the XML file, provide a valid value for the following parameters in the XML file:

Parameter Description
clientType Cluster type. Valid values are
  • WINDOWS_CLUSTER_CLIENT, to create a Windows cluster group.
  • UNIX_CLUSTER_CLIENT, to create a Unix cluster group.
clientName Name of the cluster group client.
hostName Name of the cluster group client host. This can be a fully qualified domain name or IP address.

Configure a Cluster Group

The following sections describe the steps to configure a cluster group client once it is created.

Generating Command Line Script to Configure Cluster Group Client

In order to configure a cluster group client from the command line, you need to select the required options from the CommCell Console and save it as a script file. This script can be modified as required and then executed from the command line using the 'qoperation execute' command.

Follow the steps given below to generate the script:

  1. From the CommCell Browser, navigate to Client Computers | <Cluster Group Client>.
  2. Right-click the <Cluster Group Client> and select Properties.
  1. In the Client Computer Properties dialog box, click Advanced.
  2. In the Advanced Client Properties dialog box, click the Cluster Group Configuration tab, and select the physical computer and agents that you want to include in the cluster group client.
  3. Click the Job Configuration tab, specify the path in the Job Results Directory box, and then click OK.
  4. In the Client Computer Properties dialog box, click Save as Script.
  5. In the Save as Script dialog box, complete the following steps:

    1. From the Client list, select the client computer where you want to save the script.
    2. In the File Path box, enter the location where you want to save the script, or click Browse and navigate to the location.
    3. By default, the user account that you used to log on to CommCell Console is used to perform the operation. However, if the user account does not have the sufficient privileges, click Use a different user account to enter the username and password for the account.
    4. Click OK.

    The script will be saved as a .xml file and a .bat file is created.

    If a file with the same name already exists in the specified location, the .xml file will be created with a timestamp. However, the .bat file will overwrite the existing file.

Configuring Cluster Group Client Properties

  1. Log on to the client computer where the XML file was saved during the Save as Script operation.
  2. From Command prompt, navigate to Software_Installation_Directory/Base and run the following command:

    qlogin -cs commserve_host_name -u user_name

  3. Execute the XML file using the qoperation execute command.

    qoperation execute -af XML_File_Location

  4. Log out from the CommServe using the qlogout command.

    qlogout [-cs <commserve_host_name>] [-all] [-tf <tokenfile>] [-tk <token>] [-h]

To reuse the XML file, provide a valid value for the following parameters in the XML file:

Parameter Description
<client> node
clientName Name of the cluster group client.
CommCellName Name of the CommCell computer.
hostName Name of the cluster group client host. This can be a fully qualified domain name or IP address.
path Path to the Job Results directory.
<clusterClientProperties> node
configureClusterClient Option to enable the cluster group configuration. The value for this option must be 'true'.

Valid values are true/false.

clientName Name of the client computer to be associated with the cluster group.
ComponentName Name of the Agent to be associated with the cluster group.
osType Operating system running on the associated Agent. For example, MediaAgent is the associated component and Windows is the operating system.
forceSyncConfigOnRemoteNodes

 

 

If the CommServe is unable to update a client computer with the cluster configuration, this option creates an update request for the client in the CommServe database.

Valid values are true/false.

Deconfigure a Cluster Group

Use the following steps to deconfigure a cluster group. If you are using a Veritas cluster, follow the steps described in Deconfguring a Veritas Cluster Group to deconfigure a Veritas cluster group.

  1. Download the deconfigure_cluster_group_template.xml file and save it on the computer from where the command will be executed.
  2. From Command prompt, navigate to Software_Installation_Directory/Base and run the following command:

    qlogin -cs commserve_host_name -u user_name

  3. Execute the saved .xml script using qoperation execute command.

    qoperation execute -af XML_File_Location -clientName client_name

  4. Logout from the CommServe using the qlogout command.

    qlogout [-cs <commserve_host_name>] [-all] [-tf <tokenfile>] [-tk <token>] [-h]

Deconfiguring a Veritas Cluster Group

Use the following steps to deconfigure a Veritas cluster group:

  1. Download the deconfigure_vcs_cluster_group_template.xml file and save it on the computer from where the command will be executed.
  2. From the Command prompt, navigate to Software_Installation_Directory/Base and run the following command:

    qlogin -cs commserve_host_name -u user_name

  3. Execute the saved .xml script using qoperation execute command.

    qoperation execute -af XML_File_Location -entity/clientName client_name -clientEntity/clientName client_name -clusterGroupAssociationOperationType "CLEAR"

  4. Logout from the CommServe using the qlogout command.

    qlogout [-cs <commserve_host_name>] [-all] [-tf <tokenfile>] [-tk <token>] [-h]