Cluster Server 7.4 Bundled Agents Reference Guide - Windows

Last Published:
Product(s): InfoScale & Storage Foundation (7.4)
Platform: Windows
  1. Introducing VCS bundled agents
    1.  
      About VCS bundled agents
    2.  
      Resources and their attributes
    3.  
      Modifying agents and their resources
    4. Attributes
      1.  
        Attribute data types
      2.  
        Attribute dimensions
    5. Categories of bundled agents
      1.  
        Storage agents
      2.  
        Network agents
      3.  
        FileShare agents
      4.  
        Services and applications agents
      5.  
        VCS infrastructure and support agents
    6.  
      Which agents should I use?
  2. Storage agents
    1.  
      About Storage agents for VCS
    2. DiskReservation (DiskRes) agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    3. Mount agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Resource type definition
      5.  
        Attribute definitions
      6.  
        Sample configurations
    4. Volume Manager Diskgroup (VMDg) agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    5. MountV agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Resource type definition
      5.  
        Attribute definitions
      6.  
        Sample configuration
    6. VVRSnap agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    7. VMwareDisks agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attributes
      5.  
        Sample configuration
    8. VMNSDg agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    9. NativeDisks agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    10. AzureDisk agent
      1.  
        Prerequisites
      2.  
        Dependencies
      3.  
        Agent functions
      4.  
        State definitions
      5.  
        Attributes
      6.  
        Resource type definition
      7.  
        Sample configuration
      8.  
        Debug log levels
  3. Network agents
    1.  
      About network agents
    2. NIC agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    3. IP agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Resource type definitions
      5.  
        Attribute definitions
      6.  
        Sample configuration
    4. IPv6 agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Resource type definition
      5.  
        Attribute definitions
      6.  
        Sample configuration
    5. Lanman agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Resource type definition
      5. Attribute definitions
        1.  
          Updating manual DNS entries
        2.  
          Updating DNS servers
      6.  
        Sample configurations
    6. AWSIP agent
      1.  
        Prerequisites
      2.  
        Dependency
      3.  
        Agent functions
      4.  
        State definitions
      5.  
        Resource type definition
      6.  
        Attribute definitions
      7.  
        Sample configuration
    7. AzureIP agent
      1.  
        Prerequisites
      2.  
        Dependencies
      3.  
        Agent functions
      4.  
        State definitions
      5.  
        Attributes
      6.  
        Resource type definition
      7.  
        Sample configuration
      8.  
        Debug log levels
    8. AzureDNSZone agent
      1.  
        Prerequisites
      2.  
        Dependencies
      3.  
        Agent functions
      4.  
        State definitions
      5.  
        Attributes
      6.  
        Resource type definition
      7.  
        Samples configurations
      8.  
        Delegating a domain to Azure DNS
  4. FileShare agents
    1.  
      About FileShare agents
    2. FileShare agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        About ForceControl function
      5.  
        Resource type definition
      6.  
        Attribute definitions
      7.  
        Sample configuration
    3. CompositeFileShare agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        About ForceControl function
      5.  
        Resource type definition
      6.  
        Attribute definitions
      7.  
        Sample configuration
  5. Services and applications agents
    1.  
      About services and application agents
    2. Internet Information Services agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5. Sample configurations
        1.  
          Sample configuration I
        2.  
          Sample configuration II
    3. GenericService agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    4. ServiceMonitor agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configurations
    5. Process agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    6. MSMQ agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Resource type definition
      5.  
        Attribute definitions
      6.  
        Sample configuration
    7. AzureAuth agent
      1.  
        Prerequisites
      2.  
        Dependencies
      3.  
        Agent functions
      4.  
        State definitions
      5.  
        Attributes
      6.  
        Resource type definition
      7.  
        Sample configuration
      8.  
        Obtaining the authentication keys
  6. VCS infrastructure and support agents
    1.  
      About VCS infrastructure and support agents
    2. NotifierMngr agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    3. Registry Replication (RegRep) agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Resource type definition
      5. Attribute definitions
        1.  
          Excluding keys
        2.  
          Configuring registry keys
        3.  
          Ignoring subkeys
      6.  
        Sample configuration
    4. Proxy agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configurations
    5. Phantom agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Attribute definitions
      4.  
        Sample configuration
    6. FileNone agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    7. ElifNone agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    8. FileOnOff agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    9. FileOnOnly agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    10. RemoteGroup agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Resource type definition
      5. Attribute definitions
        1.  
          About the ControlMode attribute
      6. Sample scenario
        1.  
          Service group behavior
  7. VCS hardware replication agent for NetApp
    1.  
      About hardware replication agents for NetApp
    2. NetApp Filer agent
      1.  
        Agent function
      2.  
        Resource type definition
      3.  
        Attribute definitions
      4.  
        Sample configuration
    3. NetApp SnapDrive agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        Resource type definition
      4.  
        Attribute definitions
      5.  
        Sample configuration
    4. NetApp SnapMirror agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        Action function
      4.  
        Resource type definition
      5.  
        Attribute definitions
      6.  
        Sample configuration
  8. Troubleshooting bundled agents
    1.  
      About troubleshooting bundled agents
    2.  
      VCS logging
    3. Troubleshooting storage agents
      1.  
        Disk Reservation agent error messages
      2.  
        Mount agent error messages
      3.  
        Volume Manager (VMDg) agent error messages
      4.  
        MountV agent error messages
    4. Troubleshooting network agents
      1.  
        NIC agent error messages
      2.  
        IP agent error messages
      3.  
        Lanman agent error messages
    5. Troubleshooting FileShare agents
      1.  
        FileShare agent error messages
      2.  
        CompositeFileShare agent error messages
    6. Troubleshooting services and application agents
      1.  
        IIS agent error messages
      2.  
        GenericService agent error messages
      3.  
        ServiceMonitor agent error messages
      4.  
        Process agent error messages
      5.  
        MSMQ agent error messages
    7. Troubleshooting infrastructure and support agents
      1.  
        Notifier Manager agent error messages
      2.  
        Registry Replication agent error messages
      3.  
        Proxy agent error messages
      4.  
        Phantom agent error message
      5.  
        FileNone agent error message
      6.  
        ElifNone agent error message
      7.  
        FileOnOff agent error messages
      8.  
        FileOnOnly agent error messages
    8.  
      Troubleshooting NetApp agents

Attribute definitions

Table: RemoteGroup agent required attributes

Required Attribute

Description

IpAddress

The IP address or DNS name of a node in the remote cluster, with which the agent communicates to get the status of the remote service group. The IP address can be either physical or virtual.

If the IP address is a virtual IP address, make sure that this virtual IP address is not configured as an IP resource in the remote service group that is to be monitored.

Example: "www.example.com" or "11.183.12.214"

Type and Dimension: string-scalar

Port

The port on the remote node with which the agent communicates. This is an optional attribute, unless the remote cluster listens on another port. The default value is 14141.

Type and Dimension: integer-scalar

Username

This is the login user name for the remote cluster.

When you set the ControlMode attribute to OnOff or OnlineOnly, the Username must have administrative privileges for the remote service group that you specify in the GroupName attribute.

When you use the RemoteGroup Wizard in the Java Console to enter your username data, you need to enter your username and the domain name in separate fields. For a cluster that has the VCS Authentication Service, you do not need to enter the domain name.

Type and Dimension: string-scalar

Password

This is the password that corresponds to the user that you specify in the Username attribute. You must encrypt the password using the VCS Encrypt utility. For more information about the VCS Encrypt utility, see the Cluster Server Administrator's Guide.

Do not use the vcsencrypt utility when entering passwords from a configuration wizard or from the Cluster Management Console or the Cluster Manager (Java Console).

Type and Dimension: string-scalar

GroupName

The name of the service group on the remote cluster that you want the RemoteGroup agent to monitor or manage.

Example: "DBGrp"

Type and Dimension: string-scalar

VCSSysName

You must set this attribute to either the VCS system name or the ANY value.

  • ANY

    The RemoteGroup resource goes online if the remote service group is online on any node in the remote cluster.

  • VCSSysName

    Use the name of a VCS system in a remote cluster where you want the remote service group to be online when the RemoteGroup resource goes online. Use this to establish a one-to-one mapping between the nodes of the local and remote clusters.

Example: "vcssys1" or "ANY"

Type and Dimension: string-scalar

ControlMode

Select only one of these values to determine the mode of operation of the RemoteGroup resource: MonitorOnly, OnlineOnly, or OnOff.

  • OnOff

    The RemoteGroup resource brings the remote service group online or takes it offline.

    When you set the VCSSysName attribute to ANY, the SysList attribute of the remote service group determines the node where the remote service group comes online.

  • MonitorOnly

    The RemoteGroup resource only monitors the state of the remote service group. The RemoteGroup resource cannot bring the remote service group online or take it offline.

    Make sure that you bring the remote service group online before you bring the RemoteGroup resource online.

  • OnlineOnly

    The RemoteGroup resource only brings the remote service group online. The RemoteGroup resource cannot take the remote service group offline.

    When you set the VCSSysName attribute to ANY, the SysList attribute of the remote service group determines the node where the remote service group comes online.

Type and Dimension: string-scalar

Table: RemoteGroup agent optional attributes

Optional Attribute

Description

OfflineWaitTime

The maximum expected time in seconds that the remote service group may take to go offline. VCS calls the Clean function for the RemoteGroup resource if the remote service group takes a longer time to offline than the time that you have specified for this attribute.

The default value is 0.

Type and Dimension: integer-scalar

DomainType

Enter the domain type information for the specified user. This is for a secure remote cluster only.

For users who have the domain type unixpwd, you do not have to set this attribute.

Example: "nis", "nisplus"

Type and Dimension: string-scalar

BrokerIp

For a secure remote cluster only, if the user needs the RemoteGroup agent to communicate to a specific authentication broker, then set this attribute.

Enter the information for the specific authentication broker in the format "IP".

Example: "128.11.295.51"

Type and Dimension: string-scalar

OnlineRetryLimit

OnlineWaitLimit

ToleranceLimit

MonitorInterval

AutoFailover

In case of remote service groups that take a longer time to come online, Veritas recommends that you modify the default OnlineWaitLimit and OnlineRetryLimit attributes.

If you expect the RemoteGroup agent to tolerate sudden offlines of the remote service group, then modify the ToleranceLimit attribute.

See the Cluster Server Administrator's Guide for more information about these attributes.

Type and Dimension: integer-scalar

ReturnIntOffline

Select one of the following values for RemoteGroup to return IntentionalOffline:

  • RemotePartial.Indicates that the RemoteGroup resource returns an IntentionalOffline if the remote service group is in an ONLINE|PARTIAL state.

  • RemoteOffline.Indicates that the RemoteGroup resource returns an IntentionalOffline if the remote service group is in an OFFLINE state.

  • RemoteFaulted.Indicates that the RemoteGroup resource returns an IntentionalOffline if the remote service group is OFFLINE|FAULTED.

You can use these values in combinations with each other.

You must set the IntentionalOffline attribute of the RemoteGroup resource type to 1 for this attribute to work properly.

Default: ""

Type and Dimension: string-vector

OfflineMonitoringN ode

Defines the cluster node that performs the offline monitoring of the remote service group.

This is an internal attribute. Do not modify.