Cluster Server 7.4.2 Bundled Agents Reference Guide - Windows

Last Published:
Product(s): InfoScale & Storage Foundation (7.4.2)
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

GoogleDisk agent

The GoogleDisk agent lets you configure data disks for HA in GCP, so that the disks can also be failed over during an application failover between instances.

To store the data of the applications that you configure for HA, InfoScale supports the following storage types with GCP VM instance:

  • Zonal persistent disks - Standard and SSD

  • Regional persistent disks - Standard and SSD

The GoogleDisk agent brings the GCP data disks online, monitors their status, and takes them offline. The GoogleDisk agent uses GCP Python SDK to determine whether the data disks are attached to the virtual machines or not.

Prerequisites
  • Your Google service accounts must have the following permissions, at the least:

    • compute.projects.get (at the project level, to fetch the project metadata)

    • compute.instances.get (at the instance level, to fetch the instance metadata)

    • compute.instances.attachDisk (at the instance level, to attach a disk to the instance)

    • compute.instances.detachDisk (at the instance level, to detach a disk from the instance)

    • compute.zoneOperations.get (to check the status of operations in the zone)

    • compute.disks.get (to fetch the list of the current users of a disk)

  • To access Google APIs, the following Python modules must be present on the InfoScale cluster nodes:

    • oauth2client

    • google-api-python-client

  • You must first create a disk before you configure a resource for it. Otherwise, the online operation fails.

  • Add dependencies in the service group as depicted in Figure: Sample service group dependency

Install Python SDK for GCP on each of the cluster nodes by running the following commands in C:\Program Files\Veritas\VRTSPython, or wherever the VRTSPython folder is installed on the node:

  • python -m pip install --upgrade pip

  • python -m pip install --upgrade google-api-python-client

  • python -m pip install --upgrade oauth2client

Figure: Sample service group dependency

os_winSample service group dependency
Agent functions

Open

Fetches the current GCP VM instance name and the zone and project to which the instance belongs, using its metadata.

Online

Attaches the GCP disk to the VM instance.

Offline

Detaches the GCP disk from the VM instance.

Monitor

Determines whether the GCP data disk is attached to the current VM instance or to any other VM instance within or outside the cluster. It also identifies the mode in which the disk is attached and accordingly returns a status value.

Clean

Detaches the GCP disk from the VM instance.

State definitions

ONLINE

Indicates that the GCP disk is attached to the current VM instance.

OFFLINE

Indicates one of the following:

  • The GCP disk is not in use by any VM instance.

  • The disk is detached from the current VM instance, but it is attached to another VM instance within the cluster in the read-write mode.

  • The disk is attached to any other VM instance within or outside the cluster in the read-only mode

FAULTED

Indicates that the GCP disk was unexpectedly detached from the VM instance outside of VCS control.

UNKNOWN

Returns UNKNOWN if:

  • The required Google Python SDKs are not installed on the current VM instance.

  • It fails to fetch the required attributes values.

  • The value of the ReadOnly attribute does not match the mode in which the GCP disk is attached to the VM instance. Such a situation may cause issues for the applications that use the disk.

  • Roles are not configured correctly or they are not correctly associated with the VM instance so as to fetch the disk information.

  • An invalid DiskName is provided.

  • The specified DiskName of a zonal disk is not found in the zone in which the VM instance exists. The zonal disk exists in some other zone.

  • The disk is attached to a VM instance outside the cluster in the read-write mode.

Attributes

Table: Required attributes

Attribute

Description

DiskName

Name of the disk.

Type and dimension: string-scalar

ReadOnly

Mode in which to attach the disk:

  • 0: READ_WRITE

  • 1: READ_ONLY

Default value: 0 (READ_WRITE)

Type and dimension: boolean-scalar

RegionalDisk

Type of the disk:

  • 0: zonal disk

  • 1: regional disk

Note:

Regional disks can fail over across zones, and they can be attached in the READ_WRITE mode only.

Default value: 0 (zonal disk)

Type and dimension: boolean-scalar

Table: Optional attribute

Attribute

Description

ProjectID

Project to which the VM instance belongs.

Type and dimension: string-scalar

Zone

Zone to which the instance belongs.

Type and dimension: string-scalar

VMName

Name of the GCP VM instance on which the agent runs.

Type and dimension: string-scalar

Resource type definition
type GoogleDisk (
	   static int FaultOnMonitorTimeouts = 0
   	static str ArgList[] = { DiskName, ReadOnly, 
      RegionalDisk, ProjectID, Zone, VMName, 
      tempProjectName, tempVMName, tempZone }
   	boolean ReadOnly = 0
   	boolean RegionalDisk = 0
   	str DiskName
   	str ProjectID
   	str Zone
   	str VMName
   	temp str tempProjectName
   	temp str tempZone
   	temp str tempVMName
)
Sample configuration
GoogleDisk VVRSG-GoogleDisk (
   	DiskName = sql-disk
)
Debug log levels

The GoogleDisk agent uses the DBG_1 and the DBG_2 debug log levels.