Cluster Server 8.0 Bundled Agents Reference Guide - Windows
- Introducing VCS bundled agents
- Storage agents
- Network agents
- FileShare agents
- Services and applications agents
- VCS infrastructure and support agents
- VCS hardware replication agent for NetApp
- Troubleshooting bundled agents
Attribute definitions
Table: Process agent required attributes
Required Attribute | Description |
|---|---|
StartProgram | The process to be monitored by the agent. You must specify the complete path of the executable, its file extension, and command-line arguments, if any. If you define the start program as a batch file or a script to launch another program, you must specify the monitor program in the configuration file. If you define the start program as a script (a perl script, or a vbs script), the start program should be the program that interprets the script (perl.exe, or cscript.exe) and the script itself should be passed as an argument. Note: This attribute can take localized values. Type and Dimension: string-scalar |
Table: Process agent optional attributes
Optional Attributes | Description |
|---|---|
CleanProgram | The full path of the clean process that is launched when the resource needs a forceful offline. If no value is specified for this attribute, for a clean operation the agent kills the process indicated by the StartProgram attribute. Note: This attribute can take localized values. Type and Dimension: string-scalar |
CleanProgramTimeout | The maximum time, in seconds, that the agent must wait before killing the process specified in the CleanProgram attribute. The default value is 30 seconds. Type and Dimension: integer-scalar |
Domain | The domain to which the user specified in the UserName attribute belongs. If the domain name is not specified, the agent assumes that the user belongs to the local machine. This attribute is ignored if the UserName attribute is not specified or if the domain name is specified in the UserName attribute itself. Note: This attribute can take localized values. Type and Dimension: string-scalar |
InteractWithDesktop | Defines whether the configured process interacts with the desktop. Enabling desktop interaction enables user intervention for the process. The value 1 indicates the process will interact with the desktop. The value 0 indicates it will not. Default is 0. Type and Dimension: boolean-scalar |
MonitorProgram | A program that monitors the process specified as the start program. You must specify the complete path of the executable, its file extension, and command-line arguments, if any. If you do not specify a value for this attribute, VCS monitors the start program. However, if the start program is a batch file or a script to launch another program, you must specify a monitor program. The Process agent supports Intelligent Monitoring Framework (IMF). However, IMF is not supported for the MonitorProgram attribute. If a script or a batch file is specified for this attribute, the Process agent does not use IMF notification to monitor the program. The agent detects the faults only during the regular monitor function. This attribute can take localized values. Note: The monitor program is spawned every monitor cycle and must return before the program specified in MonitorProgram times out. The return values for the monitor program must conform to VCS conventions: 110 for ONLINE and 100 for OFFLINE. For exit values outside the range 100-110, the status is considered UNKNOWN. Refer to the Cluster Server Agent Developer's Guide for more information. Type and Dimension: string-scalar |
MonitorProgramTimeout | The maximum wait time, in seconds, for the agent to receive a return value from the monitor routine. This attribute is ignored if the monitor program is not specified. Default is 30 seconds. Type and Dimension: integer-scalar |
Password | The encrypted password of the user specified by the UserName. Note that the password must be encrypted using the VCSEncrypt utility. See the Cluster Server Administrator's Guide for more information about the utility. This attribute is ignored if the user name is not specified. Type and Dimension: string-scalar |
StartupDirectory | The startup directory for the process indicated by the StartProgram attribute. You must enter the startup directory name in double quotes. Note: This attribute can take localized values. Type and Dimension: string-scalar |
StopProgram | A program that stops the process specified as the start program. You must specify the complete path of the program, its file extension, and command-line arguments, if any. If you do not specify a value for this attribute, VCS stops the start program. This attribute can take localized values. Note: If successful, the StopProgram returns a positive value. The agent framework calls the Monitor routine after those many seconds, as returned by StopProgram. Also, while writing a stop program, make sure to stop all the processes launched by the start program. Type and Dimension: string-scalar |
StopProgramTimeout | The maximum time, in seconds, that the agent must wait before killing the process specified in the StopProgram attribute. The default value is 30 seconds. Type and Dimension: integer-scalar |
UserName | The user name in whose context the configured process executes. Username can be of the form username@domain.com or domain.com\username. If a user name is not specified, the configured process runs in the context of the user account used by VCS High Availability Engine (HAD). Note: This attribute can take localized values. Type and Dimension: string-scalar |
LanmanResName | The name of the Lanman resource. The Process agent monitors the configured process in the context of the virtual name specified in the Lanman resource. Type and Dimension: string-scalar |
Note:
When defining the StartProgram, StopProgram, CleanProgram, or MonitorProgram attributes, enclose the path of the executable file in double quotes. Do not enclose arguments in double quotes.