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

AzureIP agent

The AzureIP agent manages the following networking resources in an Azure environment:

  • Private IP - A private IP is a private numerical address that networked devices use to communicate with one another. It is used for communication between an Azure virtual network (VNet) and an on-premises network. To extend an on-premises network to Azure, you use a VPN gateway or an ExpressRoute circuit.

  • Public IP - A public IP is a numerical address that is used for communication over the internet, including Azure public-facing services.

  • Overlay IP - An overlay IP provides IP failover functionality for nodes spread across subnets. It allows you to redirect IP address traffic to another cluster node belonging to different subnet within the same VNet. An overlay IP must be defined outside the VNet Classless Inter-Domain Routing (CIDR) block.

    Note:

    An overlay IP cannot be used to provide failover across Regions if VNet-to-VNet tunneling is used.

The AzureIP agent performs the following activities:

  • Gets the NIC details, creates the IP configuration, and associates and disassociates the private IP address

  • Associates and disassociates the Public IP address with the Private IP address

  • Manages route table entries of Overlay IP for failover across subnets

The AzureIP agent uses Azure Python APIs to associate IP resources with an Azure VM.

An InfoScale deployment in Azure does not support IPv6 because of the following limitations:

  • Existing virtual machines (VMs) that are configured with IPv4 addresses cannot use IPv6 addresses; you must deploy new VMs and configure them with IPv6 addresses.

  • Public IPv6 addresses cannot be assigned to a VM.

  • VMs with IPv6 addresses cannot be members of an Azure cloud service. However, they can communicate with each other over their respective IPv4 addresses.

Prerequisites
  • Configure the AzureAuth agent.

    See AzureAuth agent.

  • To configure a public IP, create a static public IP resource in the Azure portal.

  • To configure an overlay IP, create a route table, and associate the subnets where the overlay IP fails over with the route table.

    Note:

    The subnets can be associated with a single route table.

Dependencies

The AzureIP resources depend on the AzureAuth resources.

Figure: Sample service group dependency

os_winSample service group dependency
Agent functions

Online

  • Private IP: Creates the IP configuration with the private IP and associates it with the Network Interface.

  • Public IP: Creates the IP configuration with the private and public IP. Associates the IP configuration with the Network Interface.

  • Overlay IP: Creates a route in the Azure route table given in the RouteTableResourceIds attribute with Address Prefix as the OverlayIP and next hop as the private IP of the primary NIC.

  • Offline

  • Clean

  • Private IP: Deletes the IP configuration to disassociate Private IP from the Network Interface.

  • Public IP: Deletes the IP configuration to disassociate the Public IP along with the Private IP from the Network Interface.

  • Overlay IP: Deletes the route from the route table.

Monitor

  • Private IP: Monitors the associations between IP configuration and Network Interface.

  • Public IP: Monitors the association between IP configuration and Network Interface.

  • Overlay IP: Monitors the routing information and checks whether the route table entry exists for the overlay IP.

State definitions

ONLINE

  • Private IP: Indicates that the Private IP is assigned to the NIC.

  • Public IP: Indicates that the Private IP is assigned and Public IP is associated with the private IP.

  • Overlay IP: Indicates that Route table entry exists for the overlay IP.

OFFLINE

  • Private IP: Indicates that the Private IP is not assigned to the NIC.

  • Public IP: Indicates that the Private IP is not assigned or Public IP is not associated with the private IP.

  • Overlay IP: Indicates that Route table entry does not exist for the overlay IP.

UNKNOWN

One of the following could be true:

  • Azure Python SDK is not installed.

  • Required privileges are not present to perform operations on Azure NIC and Virtual Machine.

  • Private IP, Public IP, or Overlay IP is specified in wrong format.

  • Private IP, Public IP, or Overlay IP is already in use.

  • MACAddress attribute value is invalid.

  • In case of Overlay IP, route table id(s) are invalid.

  • IP Configuration has invalid details on NIC.

  • Both or none of the Overlay IP and Private IP are set. Only one should be set.

FAULTED

Indicates that the IP resources could not be brought online or abruptly stopped outside of VCS control.

Attributes

Table: Required attributes

Attribute

Description

PrivateIP

Secondary private IP address of the Azure VM.

This value is mandatory if OverlayIP is not provided.

Type and dimension: string-scalar

MACAddress

The physical address of the network interface to which the virtual IP address to be monitored is assigned. Note that this attribute is always local, that is, it is different for each system.

Use the ipconfig -all command to retrieve the physical address of a NIC.

Example: 00-60-08-08-BA-C4

Type and Dimension: string-scalar

OverlayIP

Overlay IP provides IP failover functionality for nodes spread across subnets.

Overlay IP must be outside of the VNet CIDR block in which the nodes are present.

This value is mandatory if PrivateIP is not provided.

Type and dimension: string-scalar

RouteTableResourceIds

Describes all route tables.

You can add one or more route table IDs separated by a space.

Type and dimension: string-vector

AzureAuthResName

Name of the authentication agent resource that handles Azure related authentication.

Type and dimension: string-scalar

Table: Optional attributes

Attribute

Description

PublicIP

Static public IP created from the Azure Portal.

This IP is used in IP configuration to map the Public IP address to a secondary private IP address.

Type and dimension: string-scalar

AzureVMName

Name of the VM in Azure on which agent is running.

Type and dimension: string-scalar

VMResourceGroup

Azure resource group where the Azure VM resides.

Type and dimension: string-scalar

Resource type definition
type AzureIP (
    static i18nstr ArgList[] = { tempVMName, PrivateIP, MACAddress, 
      PublicIP, tempPublicIPResourceId, AzureVMName, VMResourceGroup, 
      OverlayIP, RouteTableResourceIds, "AzureAuthResName:SubscriptionId", 
						"AzureAuthResName:ClientId", "AzureAuthResName:SecretKey", 
						"AzureAuthResName:TenantId", tempVMResourceGroupName }
    str PrivateIP
    str MACAddress
    str PublicIP
    temp str tempPublicIPResourceId
    str AzureVMName
    str VMResourceGroup
    str OverlayIP
    str RouteTableResourceIds[]
    str AzureAuthResName
    temp str tempVMName
    temp str tempVMResourceGroupName
)
Sample configurations

Sample configuration with Private IP:

AzureIP azure-ip-res (
    PrivateIP = "10.1.5.42"
    MACAddress @cloudvm1 = 00-0D-3A-91-09-87
    MACAddress @cloudvm2 = 12-0D-3B-87-19-67
    AzureAuthResName = Auth_Res
)

Sample configuration with Public IP:

AzureIP azure-ip-res (
    PrivateIP = "10.1.5.52"
    MACAddress @cloudvm1 = 00-0D-3A-91-09-87
    MACAddress @cloudvm2 = 12-0D-3B-87-19-67
    PublicIP = "52.173.243.126"
    AzureAuthResName = Auth_Res
)

Sample configuration with Overlay IP:

AzureIP overlay-ip-res (
    MACAddress @cloudvm1 = 00-0D-3A-91-09-87
    MACAddress @cloudvm2 = 12-0D-3B-87-19-67
    OverlayIP = "192.168.3.88"
    RouteTableResourceIds = {
      "/subscriptions/6940a326-abc6-40dd-b616-d3f9bbdf1d63/
      resourceGroups/azureRG/providers/Microsoft.Network/
      routeTables/azureroute1",
      "/subscriptions/6940a326-abc6-40dd-b616-d3f9bbdf1d63/
      resourceGroups/azureRG/providers/Microsoft.Network/
      routeTables/azureroute2"}
    AzureAuthResName = Auth_Res
)
Debug log levels

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