Cluster Server 8.0 Bundled Agents Reference Guide - Windows

Last Published:
Product(s): InfoScale & Storage Foundation (8.0)
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.  
      AWS EBSVol agent
    11.  
      AzureDisk agent
    12.  
      GoogleDisk agent
  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
    7.  
      AzureIP agent
    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
    9.  
      GoogleIP agent
  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
  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: ServiceMonitor agent required attributes

Required Attribute

Description

ServiceOrScriptName

The name of the service to be monitored or script to be spawned for monitoring the service. You must specify the complete path of the script, including any command-line arguments.

This attribute can take localized values.

Note:

The exit code of the script must conform to VCS conventions: 110 for ONLINE and 100 for OFFLINE. For exit values outside the range 100-110, the status is considered UNKNOWN. Refer to the Cluster Server Agent Developer's Guide for more information.

Type and Dimension: string-scalar

Table: ServiceMonitor agent optional attributes

Optional Attributes

Description

Domain

The domain to which the user belongs, as specified by the attribute UserAccount. If the domain name is not specified, the agent assumes the user to belong to the local machine.

This attribute is ignored if the UserAccount attribute is not specified or if the domain name is specified in the UserAccount attribute itself.

Note:

This attribute can take localized values.

Type and Dimension: string-scalar

MonitorProgTimeout

The maximum wait time, in seconds, for the agent to receive a return value from the monitor script. This attribute is ignored if the MonitorService attribute is set to 1. Default is 30 seconds.

Type and Dimension: integer-scalar

MonitorService

Defines whether the agent monitors a service or starts a script. If set to 1, the agent monitors a service specified by the attribute ServiceOrScriptName. If set to 0 the agent starts a script specified by the attribute ServiceOrScriptName. Default is 1.

Type and Dimension: boolean-scalar

Password

The password for the user account, encrypted using the VCS Encrypt utility. This attribute is valid only if the MonitorService is set to 0 and UserAccount is not empty.

For more information about the VCS Encrypt utility, see the Cluster Server Administrator's Guide.

Type and Dimension: string-scalar

UserAccount

A valid user account in whose context the service will be monitored. Username can be of the form username@domain.com or domain.com\username.

If you do not specify a value for this attribute, then the user account of the service in the SCM is ignored. To monitor service under built-in accounts, you must provide explicit values. For example:

User Account="LocalSystem", "Local Service", or "Network Service". Domain="NT Authority".

The 'NT Authority' domain is not applicable for the 'LocalSystem' account.

Note:

This attribute can take localized values.

Type and Dimension: string-scalar