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

This section summarizes the required and optional attributes of the MountV agent.

Table: MountV agent required attributes

Required Attributes

Description

MountPath

The drive letter or path to an empty NTFS folder that will be assigned to the volume being mounted.

When configuring a directory to host the mount, verify the following conditions:

  • The configured path exists.

  • The directory is empty.

  • The volume on which the directory resides is NTFS-formatted.

  • The directory is not a system directory.

The attribute can be specified as X, X:, X:\, X:\Directory, or X:\Directory\.

These options are valid only if editing the attribute from Cluster Manager (Java Console). If editing the configuration file main.cf directly, you must specify two slashes (\\) instead of one; for example, X:\\Directory\\.

Note:

This attribute can take localized values.

Type and Dimension: string-scalar

VolumeName

The name of the volume to be mounted. For example, the name could be Raid1, Stripe2, Volume01, etc. Use the VMGetDrive utility to retrieve the volume name. See the description of the VMGetDrive utility in the Cluster Server Administrator's Guide for instructions.

Type and Dimension: string-scalar

VMDGResName

The name of the Volume Manager Diskgroup (VMDg) resource on which the MountV resource depends.

Type and Dimension: string-scalar

Table: MountV agent optional attributes

Optional Attributes

Description

AutoFSClean

If the agent detects corruption, this attribute defines whether the agent automatically cleans the file system by running Chkdsk /X on the volume being brought online. The value 1 indicates the agent cleans the file system. The value 0 indicates it does not.

Default is 1.

The output of the Chkdsk /x command is stored at %vcs_home%\log\Chkdsk_<MountVres name>.txt.

Here, %vcs_home% is the default product installation directory, typically C:\Program Files\Veritas\Cluster Server.

Type and Dimension: boolean-scalar

ForceUnmount

Defines whether or not the agent unmounts the volume (gracefully or forcibly) when it is being used by other applications.

The attribute can take the following values:

  • NONE: The agent does not unmount the volume if an application is accessing it.

  • READ_ONLY: The agent tries to enumerate the open handles in READ_ONLY mode to the configured mount points and then gracefully unmounts the mount points even if applications are accessing it in READ_ONLY mode.

  • ALL: The agent forcefully unmounts the volume irrespective of the type of access an application has. The agent first tries to obtain exclusive access to the configured mount point. The agent makes this attempt twice, with half a second delay between each unsuccessful attempt. If it fails to lock the volume even after 2 attempts, it proceeds with the unmount operation.

  • CLOSE_FORCE: The agent does not try to lock the configured mount points and proceeds directly with the forceful unmount operation.

    Note:

    Forceful unmount may potentially cause a data corruption. When you use ForceUnmount with CLOSE_FORCE, then before you switch or take the MountV resources offline, verify that none of the applications are accessing the configured mount points.

Default is READ_ONLY.

If you have enabled Intelligent Monitoring Framework (IMF) and fast failover in your cluster environment, Veritas recommends that you set this attribute value to ALL.

This reduces the failover time as the agent does not require additional time to gracefully close the read-only handles on the volume.

Type and Dimension: string-scalar

ListApplications

Defines whether the agent lists the applications accessing the volume while unmounting. The value 1 indicates that the agent lists the applications; the value 0 indicates that it does not.

Default is 0.

If you have enabled Intelligent Monitoring Framework (IMF) and fast failover in your cluster environment, Veritas recommends that you set this attribute value to 0.

This reduces the failover time as the agent does not enumerate the applications that are accessing the volume.

Type and Dimension: boolean-scalar

PurgeStaleMountPoints

This attribute is applicable to a global cluster configuration. In case of a global fail over, this attribute defines whether the agent purges volume mount point (NTFS folder mounts) properties before bringing the folder mount points online on the remote cluster.

The default value is 1, which means that the agent purges the volume mount point properties.

Type and Dimension: boolean-scalar

CheckFSAccess

Defines whether or not the agent performs file system access monitoring on volumes mounted using SFW.

The default value is 0 (False), which means that the file system check is disabled.

Note:

This attribute replaces the MountV agent's CheckFSAccess function. The CheckFSAccess function is deprecated.

Type and Dimension: boolean-scalar

BlockMountPointAccess

This attribute defines whether the agent blocks access to the NTFS folder that is used as a folder mount point after the mount point is unmounted.

For example, if C:\temp is used as a folder mount for a volume and BlockMountPointAccess attribute for the corresponding resource is set to 1, then after the mount point is unmounted, the agent blocks access to the folder C:\temp.

The value 1 indicates that the folder is not accessible. The default value 0 indicates that the folder is accessible.

In DR configuration, set this attribute to False if the volume is mounted on other volume which is a part of an application service group.

Note:

This attribute is applicable only for volumes mounted as folder mounts and not for drive letter mounts.

Type and Dimension: boolean-scalar

ForFireDrill

Defines whether the volume being monitored by the agent belongs to the fire drill disk group.

The value 1 indicates that the volume being monitored belongs to the fire drill disk group.

Default is 0, which means that the volume being monitored does not belong to the fire drill disk group.

Type and Dimension: boolean-scalar