Attributes | VMwareDisks agent | Storage agents | Cluster Server 8.0 Bundled Agents Reference Guide - Windows | Veritas™

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

Attributes

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

Table: VMwareDisks agent required attributes

Required attribute

Description

ESXDetails

The list of host names and credentials of the ESX hosts or vCenter servers on which the virtual machines are configured.

This attribute takes input in the format Key=Value.

Key is the ESX or vCenter host name or IP address.

Value takes the user credentials in the format User name=Encrypted password.

Note:

Do not specify the password in clear text. You must specify an encrypted password for the user. This password is used to connect to the ESX/ESXi host or vCenter server. For more information, see the Encrypting agent passwords section in the Cluster Server Administrator's Guide.

Type and dimension: string-association

DiskPaths

The list of disk paths to be managed by the VMwareDisks resource.

Specify this attribute value in the format Key=Value.

Key is of the form [Data store name] Disk path.

Value is of the form SCSI controller key: Target ID (unit number of the disk). For example, 0:2.

For RDM, add prefix RDM: to the disk path.

Alternatively, the key can be of the form Disk_UUID: [Data store name] Disk_path. In case of RDM, RDM:Disk_UUID:[Data store name] Disk_path. If the disk UUID is not provided, the agent discovers the UUID and modifies the attribute value to include UUID of the disk.

Type and dimension: string-association

Table: VMwareDisks agent optional attributes

Optional attribute

Description

HAInfoDetails

Determines whether or not vSphere HA is enabled.

This attribute uses the vCenter Server hostname or IP address to determine the status of vSphereHA.

The value must be specified in the format: Key=Value.

Where,

Key= vCenter Server hostname or IP address

Value= vCenter Server logon user credentials. This must be specified in the format: User name=Encrypted password.

If you do not specify a value for this attribute, the agent considers the vSphereHA setting based on IsVMHAEnabled attribute value.

Type and dimension: string-association

IsVMHAEnabled

Defines whether vSphere HA is enabled. The value 1 indicates that vSphere HA is enabled.

This attribute value should match the vSphere HA settings in the VMware vSphere HA cluster. If vSphere HA is turned on, set this attribute value to 1 (True). If vSphere HA is turned off, set this attribute value to 0 (False).

vSphereHA settings are considered based on this attribute only if the HAInfoDetails attribute is not set, or if the agent fails to retrieve the vSphere HA details based on the HAInfoDetails attribute.

Default is 1 (True).

Type and dimension: boolean-scalar

VMRegisterWait

The specified time interval, in seconds, during which VMware HA registers the virtual machine on any other ESX host when an ESX host fails. This is applicable only if IsVMHAEnabled is set to true.

Default value is 120 seconds.

Type and dimension: integer-scalar

VirtualDiskMode

Specifies the mode to be used when the disk is attached, and takes one of the following values:

  • persistent

  • independent_persistent

  • independent_nonpersistent

You must modify the value after you configure application monitoring.

Note:

The VMwareDisks agent does not detect the mode in which the disk is configured. After a failover, the disk is attached in the mode that is defined in the attribute value. For details about the disk modes, refer to the VMware documentation.

Default value: persistent

Type and dimension: string-scalar

DeleteSnapshot

Specifies the action to take when the agent detects that the disk is part of a NetBackup or a user-initiated snapshot.

The agent takes one of the following actions depending on the value of this attribute:

  • When set to 0, the agent logs a warning when it detects the presence of snapshots. It takes no action on the snapshots and proceeds with the detach operation. It also provides recommendations about further actions that can be taken on the snapshots.

  • When set to 1, the agent assumes that the snapshots are initiated - but not managed - by a user, and calls the appropriate VMware APIs to delete the snapshots. If a subset of the snapshots belong to NetBackup, it logs an error and takes no further action.

  • When set to 2, the agent assumes that the snapshots are created by an underlying backup solution, and calls the corresponding APIs or functions to discover and delete them. Currently, the agent supports only NetBackup snapshots. If a subset of the snapshots does not belong to NetBackup, it logs an error and takes no further action.

  • When set to 3, the agent deletes all the snapshots that are associated with the disk. It calls NetBackup APIs to delete NetBackup snapshots and VMware APIs to delete other types of snapshots.

Default value: 0

Type and dimension: integer-scalar

SnapshotRemovalRetry

Specifies the number of times to retry the snapshot removal task as part of the disk detach operation.

  • In case of NetBackup snapshots, the agent waits for any ongoing backup jobs to complete. The snapshots are eventually deleted as part of the backup job completion. The remaining snapshots are then assumed to be user-initiated ones.

  • In case of user-initiated snapshots, if a removal task fails, the agent attempts the task again for the number of times specified by this value.

Default value: 3

Type and dimension: integer-scalar

Note:

The acceptable range of values is 0 through 3. If a value outside this range is set, the agent disregards it and proceeds with the default value.

NBUPrimaryDetails

Specifies the details required to make NetBackup API calls to manage snapshots.

This value must be specified in the format:

{ "NetBackup_primary_server" = " APIKey: "api_key_value", CACert: "CA_certificate_filename_with_path", VMID: "virtual_machine_ID" }

  • NetBackup_primary_server is the master server from which the backup job was invoked.

  • API_key is the value that needs to be provided in the authorization HTTP header to make API calls. You can use either the NetBackup CLI or the WebUI to generate the key. You must encrypt this key using the vcsencrypt -agent command; the agent decrypts it before use.

  • CA_certificate_filename_with_path is to be provided if the expected PEM file is not present at the default location, which is /var/VRTSvcs/vcsauth/data/NBU/root/.VRTSat/profile/certstore/cacert.pem.

  • Providing the virtual_machine_ID is optional. If this value is not provided, VMInstanceUUID is used by default. The permitted values are: VMBIOSUUID, VMDisplayName, VMDNSName, VMInstanceUUID, and VMHostName.

    Note:

    If you provide an incorrect VMID value, the corresponding backup jobs may not get cancelled, further delaying the failover operation.

The agent uses these values to continuously monitor the connection with NetBackup server. If any of these values is incorrect, the VMwareDisks resource goes into the UNKNOWN state.

Default value: None

Type and dimension: string-association