InfoScale™ 9.0 Cluster Server Bundled Agents Reference Guide - Solaris

Last Published:
Product(s): InfoScale & Storage Foundation (9.0)
Platform: Solaris
  1. Introducing bundled agents
    1.  
      About bundled agents
    2.  
      Resources and their attributes
    3.  
      Modifying agents and their resources
    4.  
      Attributes
    5.  
      Zone-aware agents
    6.  
      IMF-aware agents
    7.  
      Enabling debug log messages
    8.  
      VCS support for multi-pathing solutions
  2. Storage agents
    1.  
      About the storage agents
    2. DiskGroup agent
      1.  
        IMF awareness
      2.  
        Dependencies for DiskGroup agent
      3.  
        Agent functions for DiskGroup agent
      4.  
        State definitions for DiskGroup agent
      5.  
        Attributes for DiskGroup agent
      6.  
        Resource type definition for DiskGroup agent
      7. Notes for DiskGroup agent
        1.  
          High availability fire drill
        2.  
          Using volume sets
        3. Setting the noautoimport flag for a disk group
          1.  
            VxVM noautoimport flag usage
        4.  
          Configuring the Fiber Channel adapter
        5.  
          Using the DiskGroup agent with IMF
        6.  
          Using the DiskGroup agent with NFS
      8. Sample configurations for DiskGroup agent
        1.  
          DiskGroup resource configuration
      9.  
        Debug log levels for DiskGroup agent
    3. DiskGroupSnap agent
      1.  
        Dependencies for DiskGroupSnap agent
      2.  
        Agent functions for DiskGroupSnap agent
      3.  
        State definitions for DiskGroupSnap agent
      4.  
        Attributes for DiskGroupSnap agent
      5. Notes for DiskGroupSnap agent
        1.  
          Fire drill configuration after upgrading VCS
        2.  
          Configuring the SystemZones attribute for the fire drill service group
        3.  
          Configuring the FireDrill service group
        4.  
          Adding the ReuseMntPt attribute to the ArgList attribute for the Mount agent type
        5.  
          Configuration considerations
        6.  
          Agent limitations
      6.  
        Resource type definition for DiskGroupSnap agent
      7. Sample configurations for DiskGroupSnap agent
        1.  
          Typical main.cf configuration for DiskGroupSnap agent
        2.  
          Sample main.cf of DiskGroupSnap with Oracle resource
      8.  
        Debug log levels for DiskGroupSnap agent
    4. Disk agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6.  
        Debug log levels
    5. Volume agent
      1.  
        Dependencies for Volume agent
      2.  
        Agent functions for Volume agent
      3.  
        State definitions for Volume agent
      4.  
        Attributes for Volume agent
      5.  
        Resource type definition for Volume agent
      6.  
        Sample configuration for Volume agent
      7.  
        Debug log levels for Volume agent
    6. VolumeSet agent
      1.  
        Dependencies for VolumeSet agent
      2.  
        Agent functions for VolumeSet agent
      3.  
        State definitions for VolumeSet agent
      4.  
        Attributes for VolumeSet agent
      5.  
        Resource type definition for VolumeSet agent
      6. Sample configurations for VolumeSet agent
        1.  
          A configured VolumeSet that is dependent on a DiskGroup resource
      7.  
        Agent notes for VolumeSet agent
      8.  
        Inaccessible volumes prevent the VolumeSet agent from coming online
      9.  
        Debug log levels for VolumeSet agent
    7. Mount agent
      1.  
        IMF awareness
      2.  
        Dependencies for Mount agent
      3.  
        Agent functions for Mount agent
      4.  
        State definitions for Mount agent
      5.  
        Attributes for Mount agent
      6.  
        Resource type definition for Mount agent
      7.  
        Notes for Mount agent
      8.  
        High availability fire drill
      9.  
        VxFS file system lock
      10.  
        IMF usage notes
      11.  
        IPv6 usage notes
      12.  
        Support for loopback file system
      13.  
        Enabling Level two monitoring for the Mount agent
      14.  
        ZFS file system and pool creation example
      15.  
        Support for VxFS direct mount inside non-global zones
      16. Sample configurations for Mount agent
        1.  
          VxFS configuration example for Mount agent
      17.  
        Debug log levels for Mount agent
    8. Zpool agent
      1.  
        Limitations for Zpool agent
      2.  
        Dependencies for Zpool agent
      3.  
        Agent functions for Zpool agent
      4.  
        State definitions for Zpool agent
      5.  
        Attributes for Zpool agent
      6.  
        Resource type definition for Zpool agent
      7.  
        Sample configurations for Zpool agent
      8.  
        Debug log levels for Zpool agent
    9. VMwareDisks agent
      1.  
        Agent functions
      2.  
        State definitions
      3.  
        Attributes
      4.  
        Resource type definition
      5.  
        Sample configurations
    10. SFCache agent
      1.  
        Resource dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6. Notes for SFCache agent
        1.  
          Configuring SFCache resource with CVM/CFS
      7.  
        Debug log levels
  3. Network agents
    1. About the network agents
      1. Agent comparisons
        1.  
          IP and NIC agents
        2.  
          IPMultiNICB and MultiNICB agents
        3.  
          802.1Q trunking
        4.  
          Link aggregation support
    2. IP agent
      1.  
        High availability fire drill for IP agent
      2.  
        Dependencies for IP agent
      3.  
        Agent functions for IP agent
      4.  
        State definitions for IP agent
      5.  
        Attributes for IP agent
      6.  
        Resource type definition for IP agent
      7. Sample configurations for IP agent
        1.  
          Configuration 1
        2.  
          NetMask in decimal (base 10)
        3.  
          Configuration of NetMask in hexadecimal (base 16)
      8.  
        Debug log levels for IP agent
    3. NIC agent
      1.  
        Dependencies for NIC agent
      2.  
        Agent functions for NIC agent
      3.  
        State definitions for NIC agent
      4.  
        Attributes for NIC agent
      5.  
        Resource type definition for NIC agent
      6. Notes for the NIC agent
        1.  
          High availability fire drill for NIC agent
        2.  
          Solaris 11: Change of behavior in IPv4 and IPv6 interface state
      7. Sample configurations for NIC agent
        1.  
          Configuration without network hosts (using default ping mechanism) for NIC agent
        2.  
          Configuration with network hosts for NIC agent
        3.  
          IPv6 configuration for NIC agent
      8.  
        Exclusive IP Zone configuration for NIC agent
      9.  
        Debug log levels for NIC agent
    4. About the IPMultiNICB and MultiNICB agents
      1.  
        Checklist to ensure the proper operation of MultiNICB
    5. IPMultiNICB agent
      1.  
        Dependencies for IPMultiNICB agent
      2.  
        Requirements for IPMultiNICB
      3.  
        Agent functions for IPMultiNICB agent
      4.  
        State definitions for IPMultiNICB agent
      5.  
        Attributes for IPMultiNICB agent
      6.  
        Resource type definition for IPMultiNICB agent
      7.  
        Manually migrating a logical IP address for IPMultiNICB agent
      8. Sample configurations for IPMultiNICB agent
        1.  
          Other sample configurations for IPMultiNICB and MultiNICB
      9.  
        Debug log levels for IPMultiNICB agent
    6. MultiNICB agent
      1.  
        Base and Multi-pathing modes for MultiNICB agent
      2.  
        Oracle trunking for MultiNICB agent
      3.  
        The haping utility for MultiNICB agent
      4.  
        Dependencies for MultiNICB agent
      5.  
        Agent functions for MultiNICB agent
      6.  
        State definitions for MultiNICB agent
      7.  
        Attributes for MultiNICB agent
      8.  
        Optional attributes for Base and Mpathd modes for MultiNICB agent
      9.  
        Optional attributes for Base mode for MultiNICB agent
      10.  
        Optional attributes for Multi-pathing mode for MultiNICB agent
      11.  
        Resource type definition for MultiNICB agent
      12.  
        Solaris operating modes: Base and Multi-Pathing for MultiNICB agent
      13.  
        Base mode for MultiNICB agent
      14.  
        Failover and failback for MultiNICB agent
      15.  
        Multi-Pathing mode for MultiNICB agent
      16.  
        Configuring MultiNICB and IPMultiNICB agents on Solaris 11
      17.  
        Trigger script for MultiNICB agent
      18. Sample configurations for MultiNICB agent
        1.  
          Interface configuration for MultiNICB agent on Solaris
        2.  
          Setting up test IP addresses for Base Mode
        3.  
          IPMultiNICB and MultiNICB configuration for MultiNICB agent
        4.  
          IPv6 configuration for MultiNICB agent
      19.  
        Debug log levels for MultiNICB agent
    7. DNS agent
      1.  
        Dependencies for DNS agent
      2.  
        Agent functions for DNS agent
      3.  
        State definitions for DNS agent
      4.  
        Attributes for DNS agent
      5.  
        Resource type definition for DNS agent
      6. Agent notes for DNS agent
        1. About using the VCS DNS agent on UNIX with a secure Windows DNS server
          1.  
            Software requirement for DNS agent
          2.  
            Configuration requirement for DNS agent
        2.  
          High availability fire drill for DNS agent
        3.  
          Monitor scenarios for DNS agent
        4.  
          Sample Web server configuration for DNS agent
        5.  
          Secure DNS update for BIND 9 for DNS agent
        6.  
          Setting up secure updates using TSIG keys for BIND 9 for DNS agent
      7. Sample configurations for DNS agent
        1.  
          Basic IPv6 configuration for DNS agent
        2.  
          IPv6 CNAME sample configuration for DNS agent
        3.  
          IPv4 A sample configuration for DNS agent
      8.  
        Debug log levels for DNS agent
  4. File share agents
    1.  
      About the file service agents
    2. NFS agent
      1.  
        Dependencies for NFS agent
      2.  
        Agent functions for NFS agent
      3.  
        State definitions for NFS agent
      4.  
        Attributes for NFS agent
      5.  
        Resource type definition for NFS agent
      6.  
        Sample configurations for NFS agent
      7.  
        Debug log levels for NFS agent
    3. NFSRestart agent
      1.  
        Dependencies for NFSRestart agent
      2.  
        Agent functions for NFSRestart agent
      3.  
        State definitions
      4.  
        Attributes for NFSRestart agent
      5.  
        Resource type definition for NFSRestart agent
      6. Notes for NFSRestart agent
        1.  
          About high availability fire drill
        2.  
          Mounting NFS export with the -vers options can cause lock failure
        3.  
          Providing a fully qualified host name
        4.  
          Service Management Facility
      7. Sample configurations for NFSRestart agent
        1.  
          Basic agent configurations
      8.  
        Debug log levels for NFSRestart agent
    4. Share agent
      1.  
        Dependencies for Share agent
      2.  
        Agent functions for Share agent
      3.  
        State definitions for Share agent
      4.  
        Attributes for Share agent
      5.  
        Resource type definition for Share agent
      6. Notes for Share agent
        1.  
          High availability fire drill
      7.  
        Sample configurations for Share agent
      8.  
        Debug log levels for Share agent
    5. About the Samba agents
      1.  
        The Samba agents
      2.  
        Before using the Samba agents
      3.  
        Supported versions for Samba agents
      4. Notes for configuring the Samba agents
        1.  
          Configuring multiple SambaServer resources
        2.  
          Configuring Samba for non-standard configuration files or non-standard lock directories
      5. SambaServer agent
        1.  
          Dependencies for SambaServer agent
        2.  
          Agent functions for SambaServer agent
        3.  
          State definitions for SambaServer agent
        4.  
          Attributes for SambaServer agent
        5.  
          Resource type definitions for SambaServer agent
        6.  
          Sample configurations for SambaServer agent
        7.  
          Debug log levels for SambaServer agent
      6. SambaShare agent
        1.  
          Dependencies for SambaShare agent
        2.  
          Agent functions for SambaShare agent
        3.  
          State definitions for SambaShare agent
        4.  
          Attributes for SambaShare agent
        5.  
          Resource type definition for SambaShare agent
        6.  
          Sample configuration for SambaShare agent
        7.  
          Debug log levels for SambaShare agent
    6. NetBios agent
      1.  
        Dependencies for NetBios agent
      2.  
        Agent functions for NetBios agent
      3.  
        State definitions for NetBios agent
      4.  
        Attributes for NetBios agent
      5.  
        Resource type definition for NetBios agent
      6.  
        Sample configuration for NetBios agent
      7.  
        Debug log levels for NetBios agent
  5. Service and application agents
    1.  
      About the services and applications agents
    2. AlternateIO agent
      1.  
        Dependencies for AlternateIO agent
      2.  
        Agent functions for AlternateIO agent
      3.  
        State definitions for AlternateIO agent
      4.  
        Attributes for AlternateIO agent
      5.  
        Resource type definition for AlternateIO agent
      6.  
        Sample configurations for AlternateIO agent
      7.  
        Debug log levels for AlternateIO agent
    3. Apache HTTP server agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6. Apache HTTP server notes
        1.  
          Tasks to perform before you use the Apache HTTP server agent
        2.  
          About detecting application failure
        3.  
          About bringing an Apache HTTP server online outside of VCS control
        4.  
          About high Availability fire drill
        5.  
          Using Apache agent with IMF
        6.  
          Troubleshooting Apache service group issue
      7. Sample configurations
        1.  
          Basic configuration for Solaris
        2.  
          Basic IPv6 configuration
        3.  
          Sample output of the amfstat command
      8.  
        Debug log level
    4. Application agent
      1.  
        IMF awareness
      2.  
        High availability fire drill for Application agent
      3.  
        Dependencies for Application agent
      4.  
        Agent functions
      5.  
        State definitions for Application agent
      6.  
        Attributes for Application agent
      7.  
        Resource type definition for Application agent
      8. Notes for Application agent
        1.  
          Using Application agent with IMF
        2.  
          Level two monitoring through MonitorProgram
        3.  
          Using Application agent with ProPCV
        4.  
          Requirement for programs
        5.  
          Requirement for default profile
        6.  
          Support for cloned Application agent
      9. Sample configurations for Application agent
        1.  
          Configuration 1 for Application agent
        2.  
          Configuration 2 for Application agent
        3.  
          Configuration 3 for Application agent
      10.  
        Debug log levels for Application agent
    5. CoordPoint agent
      1.  
        Coordination Point server as a coordination point
      2.  
        SCSI-3 based disk as a coordination point
      3.  
        Dependencies
      4.  
        Agent functions
      5.  
        State definitions
      6.  
        Attributes
      7.  
        Resource type definition
      8. Notes for the CoordPoint agent
        1.  
          CoordPoint agent I/O fencing reporting activities
        2.  
          AutoStartList attribute
        3.  
          Detailed monitoring for the Coordpoint resource
        4.  
          The ActionOnCoordPointFault attribute set to RefreshRegistrations
      9.  
        Sample configuration
      10.  
        Debug log levels
    6. LDom agent
      1.  
        Configuring primary and logical domain dependencies and failure policy
      2.  
        IMF awareness
      3. Dependencies
        1.  
          Network resources
        2.  
          Storage resources
      4.  
        Agent functions
      5.  
        State definitions
      6.  
        Attributes
      7.  
        Resource type definition
      8.  
        LDom agent notes
      9.  
        About the auto-boot? variable
      10.  
        Notes for the DomainFailurePolicy attribute
      11.  
        Using VCS to migrate a logical domain
      12.  
        Configuring the LDom agent for DR in a Global Cluster environment
      13.  
        Using the LDom agent with IMF
      14.  
        Sample configuration 1
      15.  
        Sample configuration 2
      16.  
        Configuration to support user-initiated LDom migration
      17.  
        Configuration for VCS-initiated migration
      18.  
        Sample configuration (Dynamic virtual machine service group failover)
      19.  
        Debug log levels
    7. Process agent
      1.  
        IMF awareness
      2.  
        High availability fire drill for Process agent
      3.  
        Dependencies for Process agent
      4.  
        Agent functions for Process agent
      5.  
        State definitions for Process agent
      6.  
        Attributes for Process agent
      7.  
        Resource type definition for Process agent
      8. Usage notes for Process agent
        1.  
          Prerequisites for processes
      9. Sample configurations for Process agent
        1.  
          Configuration 1 for Process agent
        2.  
          Configuration 2 for Process agent
      10.  
        Debug log levels for Process agent
    8. ProcessOnOnly agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6. ProcessOnOnly agent usage notes
        1.  
          Requirement for programs
      7.  
        Sample configurations
      8.  
        Debug log levels
    9. Project agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        Attributes
      4.  
        Resource type definition
      5.  
        Sample configuration
      6.  
        Debug log levels
    10. RestServer agent
      1.  
        Service group resource dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6.  
        Sample configuration
      7.  
        Troubleshooting information
    11. Zone agent
      1.  
        IMF awareness
      2.  
        Dependencies
      3.  
        Agent functions
      4.  
        Attributes
      5.  
        Configuring the Zone agent for DR in a Global Cluster environment
      6.  
        Resource type definition
      7.  
        Zone agent notes
      8.  
        Using the Zone agent with IMF
      9.  
        Debug log levels
  6. Infrastructure and support agents
    1.  
      About the infrastructure and support agents
    2. NotifierMngr agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6. Sample configuration
        1.  
          Configuration
      7.  
        Debug log levels
    3. Proxy agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        Attributes
      4.  
        Resource type definition
      5. Sample configurations
        1.  
          Configuration 1
        2.  
          Configuration 2
        3.  
          Configuration 3
      6.  
        Debug log levels
    4. Phantom agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        Resource type definition
      4. Sample configurations
        1.  
          Configuration 1
        2.  
          Configuration 2
    5. RemoteGroup agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6.  
        Debug log levels
  7. Testing agents
    1.  
      About the testing agents
    2. ElifNone agent
      1.  
        Dependencies for ElifNone agent
      2.  
        Agent function for ElifNone agent
      3.  
        State definitions for ElifNone agent
      4.  
        Attributes for ElifNone agent
      5.  
        Resource type definition for ElifNone agent
      6.  
        Sample configuration for ElifNone agent
      7.  
        Debug log levels for ElifNone agent
    3. FileNone agent
      1.  
        Dependencies for FileNone agent
      2.  
        Agent functions for FileNone agent
      3.  
        State definitions for FileNone agent
      4.  
        Attribute for FileNone agent
      5.  
        Resource type definition for FileNone agent
      6.  
        Sample configuration for FileNone agent
      7.  
        Debug log levels for FileNone agent
    4. FileOnOff agent
      1.  
        Dependencies for FileOnOff agent
      2.  
        Agent functions for FileOnOff agent
      3.  
        State definitions for FileOnOff agent
      4.  
        Attribute for FileOnOff agent
      5.  
        Resource type definition for FileOnOff agent
      6.  
        Sample configuration for FileOnOff agent
      7.  
        Debug log levels for FileOnOff agent
    5. FileOnOnly agent
      1.  
        Dependencies for FileOnOnly agent
      2.  
        Agent functions for FileOnOnly agent
      3.  
        State definitions for FileOnOnly agent
      4.  
        Attribute for FileOnOnly agent
      5.  
        Resource type definition for FileOnOnly agent
      6.  
        Sample configuration for FileOnOnly agent
      7.  
        Debug log levels for FileOnOnly agent
  8. Replication agents
    1.  
      About the replication agents
    2. RVG agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        Sample configurations
    3. RVGPrimary agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        Sample configurations
    4. RVGSnapshot
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        Sample configurations
    5. RVGShared agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        Sample configurations
    6. RVGLogowner agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        RVGLogowner agent notes
      7.  
        Sample configurations
    7. RVGSharedPri agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        Sample configuration

Attributes

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

Table: Required attributes

Required attribute

Description

ESXDetails

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

The key is ESX or vCenter hostname or IP address. The value must be in the format:

  • ESX or IP address - 'User name'='Encrypted password'

  • vCenter hostname - 'Domain\User Name'='Encrypted password'

Example - IPv6:

ESXDetails = { "[2620:128:f0a2:900d::150]" = "root=28:af:ab:3e:e4:71:ca:6b:99:9d:e3:dd:b1:bc:bc:50:d0:f2:f2:8c:36:9f:11:dc:63:93:5f:2c:e1:e7:14:25" }

Example - IPv4:

ESXDetails = { "192.168.0.100" = "root=28:af:ab:3e:e4:71:ca:6b:99:9d:e3:dd:b1:bc:bc:50:d0:f2:f2:8c:36:9f:11:dc:63:93:5f:2c:e1:e7:14:25" }

Type and dimension: string-association

DiskPaths

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

The key is of the form '[Data store name] Disk path'. The 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 will discover the UUID and modify the attribute to have UUID of the disk.

Type and dimension: string-association

Table: 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 vSphere HA.

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: 'Domain\User Name'='Encrypted password'

Example - IPv6:

HAInfoDetails = {"[2001::15]" = "Administrator@IAG=JPLvPXoVNvQVo"}

Example - IPv4:

HAInfoDetails = {"192.168.0.100" = "Administrator@IAG=JPLvPXoVNvQVo"}

If you do not specify a value for this attribute, the agent considers the vSphere HA setting based on the 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). vSphere HA 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: 1 (True)

Type and dimension: boolean-scalar

PanicVMOnESXLoss

Set this attribute value to 1 (True) to trigger panic on the virtual machine when the ESX host loses network connectivity.

Default: 0 (False)

Type and dimension: boolean-scalar

ForceRegister

For internal use only.

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: 120 seconds

Type and dimension: integer

VirtualDiskMode

Specifies the mode to be used when the disk is attached.

You can set the value of this attribute to one of the following:

  • 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-association

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