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: FileShare agent required attributes

Required Attributes

Description

LanmanResName

The name of the Lanman resource on which the FileShare resource depends.

If this attribute is not specified, the agent ignores this attribute and uses localhost.

Type and Dimension: string-scalar

MountResName

The name of the MountV resource on which the FileShare resource depends.

For NetApp storage, this is the NetAppSnapDrive resource name.

In case of Logical Disk Management, this is the Mount resource name.

Type and Dimension: string-scalar

PathName

The path of the folder to be shared.

To share a drive, specify the PathName as \. For example, to share drive X:, the PathName is \.

To share a folder on a mounted drive, specify the PathName as \directoryname.

Note:

This attribute can take localized values.

Type and Dimension: string-scalar

ShareName

The name by which the share is known to clients.

Note:

This attribute can take localized values.

Type and Dimension: string-scalar

Table: FileShare agent optional attributes

Optional Attributes

Description

AutoControl

Defines the agent behavior when share properties are modified (either within or from outside VCS) when the FileShare resource is online.

The value 1 indicates that the agent synchronizes the changes made to the share properties with those that were defined while configuring the file share service group in the cluster.

The value 0 indicates that the agent does not synchronize the share properties as per what is defined in the cluster configuration.

If this attribute is set to 0 and the share properties are modified (either within or from outside VCS), the FileShare resource goes into the UNKNOWN state. The changes made to the share properties remain in effect until the resource is in the UNKNOWN state.

To restore the state, you have to take the FileShare resource offline and bring it online again. When the resource is brought online, the agent restores the share properties as per what is defined in the cluster configuration.

Default is 1.

To make an existing share highly available, the share name and the share permissions in the configuration file must be the same as those for the file share.

Type and Dimension: boolean-scalar

AutoShare

Defines agent behavior when a folder with shared subfolders is added to a VCS file share. The value 1 indicates the agent automatically shares the newly added subfolder in its next monitor cycle. The value 0 indicates the agent does not.

Default is 1.

This attribute is considered only if the attribute ShareSubdirectories is set to 1.

Type and Dimension: boolean-scalar

ClientCacheType

A string that specifies whether the files and programs in the shared folder are cached locally on the client computer when accessed by users. It also specifies how the files are cached. The cached files are then available offline even if users are not connected to the share.

Note:

The agent does not cache the files or programs itself. It sets the value so that the server and client interfaces do the needful.

This attribute can have the following values:

  • MANUAL: Indicates that only the files and programs specified by the users are cached.

  • NONE: Indicates that files and programs from the share are not cached.

  • DOCS: Indicates that all the files and programs that the users open from the share are automatically cached. Files and programs that are not opened are not available offline.

  • PROGRAMS: Indicates that all files and programs that the users open from the share are automatically cached and are optimized for performance. The next time the user accesses the executable files, they are launched from the local cache.

    Files and programs that are not accessed are not available offline.

Default is MANUAL.

Type and Dimension: string-scalar

HiddenShare

Defines whether the agent hides the file share. The value 1 indicates the agent hides the file share. The value 0 indicates it does not.

Default is 0.

Note:

To create a hidden share, set the HiddenShare attribute to 1. Do not append the share name with a $ (dollar) sign.

Type and Dimension: boolean-scalar

HideChildShares

Defines whether the agent hides the subfolder shares. The value 1 indicates the agent hides the subfolder shares. The value 0 indicates it does not.

Default is 0.

This attribute is considered only if the attribute ShareSubdirectories is set to 1.

Type and Dimension: boolean-scalar

IgnorePermissions

This attribute has been deprecated.

Please use AutoControl attribute instead.

Type and Dimension: boolean-scalar

MaxUsers

The maximum number of users that can access the file share. Default is null, which indicates access is granted to maximum users allowed on Windows.

If this attribute is set to zero or greater than the maximum users allowed on Windows, access is granted to the maximum users allowed on Windows.

Type and Dimension: string-scalar

ShareSubdirectories

Defines whether the agent shares the subfolders of the file shares defined in the attribute PathName and ShareName. Subfolders are shared with their own names, that is, the share name of a subfolder is the same as the subfolder name. If a share with the same name exists, the subfolder will not be shared. However, this does not affect the state of the resource.

The value 1 indicates the agent shares the subfolders. The value 0 indicates it does not.

Default is 0.

Note:

Sharing a folder with a large number of subfolders and enabling the ShareSubdirectories attribute may cause increased failover time and high CPU and memory utilization.

Type and Dimension: boolean-scalar

UserPermissions

The permissions with which the folders are shared for users.

The following permissions are associated with the FileShare resource:

  • FULL_CONTROL: Permission to read, write, create, execute, and delete the resource, and to modify its attributes and permissions.

  • READ_ACCESS: Permission to read, and execute the resource.

  • CHANGE_ACCESS: Permission to read, write, execute, and delete the resource.

  • NO_ACCESS: No access to the resource.

The UserPermissions are specified in the format

'Domain_Name\Username'=Permission.

For example, to give full control to user John who belongs to the domain vcs_domain, the syntax is 'VCS_DOMAIN\John'=FULL_CONTROL.

The domain name and the user name must be enclosed in quotation marks.

Default is {'Everyone' = READ_ACCESS}.

A maximum of 50 users can be configured for each file share. To configure more than 50 users for a file share, configure user groups.

Note that the agent monitors only the users and the permissions that are defined in the VCS configuration.

Note:

This attribute can take localized values.

Type and Dimension: string-association

AccessBasedEnumeration

Defines whether the agent enables the Windows Access-based Enumeration option for the specified file share. The value 1 indicates that the agent enables it and the value 0 indicates that the agent does not.

Default is 0.

Type and Dimension: boolean-scalar

ShareComment

A string that describes the share. Use this attribute to add comments to the file share resource.

If this attribute is blank, the agent uses the default VCS comment.

Type and Dimension: string-scalar