Required Attributes
Required Attribute
|
Description, Type and Dimension, Default, and Example
|
StartProgram
|
The executable, created locally on each node, which starts the application. Specify the complete path of the executable. Applicable command-line arguments follow the name of the executable and are separated by spaces.
- Type and dimension: string-scalar
- Example: "/usr/sbin/sample_app start"
|
StopProgram
|
The executable, created locally on each node, that stops the application. Specify the complete path of the executable. Applicable command-line arguments follow the name of the executable and are separated by spaces.
- Type and dimension: string-scalar
- Example: "/usr/sbin/sample_app stop"
|
At least one of the following attributes:
|
See Optional Attributes.
|
Optional Attributes
Optional Attribute
|
Description, Type and Dimension, Default, and Example
|
CleanProgram
|
The executable, created locally on each node, which forcibly stops the application. Specify the complete path of the executable. Applicable command-line arguments follow the name of the executable and are separated by spaces.
- Type and dimension: string-scalar
- Example: "/usr/sbin/sample_app force stop"
|
MonitorProcesses
|
A list of processes that you want monitored and cleaned. Each process name is the name of an executable. Qualify the executable name with its complete path if the path starts the executable.
The process name must be the full command line argument displayed by the ps -u <user> -o args | more command for the process.
- Type and dimension: string-vector
- Example: { "sample_app_process" }
|
MonitorProgram
|
The executable, created locally on each node, which monitors the application. Specify the complete path of the executable. Applicable command-line arguments follow the name of the executable and are separated by spaces.
MonitorProgram can return the following VCSAgResState values: OFFLINE value is 100; ONLINE values range from 101 to 110 (depending on the confidence level); 110 equals confidence level of 100%. Any other value = UNKNOWN.
- Type and dimension: string-scalar
- Example: "/usr/sbin/sample_app_monitor all"
|
PidFiles
|
A list of PID files that contain the process ID (PID) of the processes that you want monitored and cleaned. These files are application-generated files. Each PID file contains one monitored PID. Specify the complete path of each PID file in the list.
The process ID can change when the process restarts. If the application takes time to update the PID file, the agent's monitor script may return an incorrect result. If this occurs, increase the ToleranceLimit in the resource definition.
- Type and dimension: string-vector
- Example: "/etc/sample/sample_app.pid"
|
User
|
The user ID for running StartProgram, StopProgram, MonitorProgram, and CleanProgram. The processes specified in the MonitorProcesses list must run in the context of the specified user. Monitor checks the processes to make sure they run in this context.
|
|