Search <book_title>...

InfoScale™ 9.0 Cluster Server Bundled Agents Reference Guide - Linux

Last Published: 2025-08-11

Product(s): InfoScale & Storage Foundation (9.0)

Platform: Linux

Attributes for Application agent

Table: Required attributes

Required attribute	Description
StartProgram	The complete path of the executable file that starts the application. The file may be present on local storage or shared storage. Any applicable command-line arguments follow the file path and are separated by spaces. For example, the attribute for StartProgram is: /usr/sbin/vxnotify -g dg00 -m >> /var/log/vxnotify.log (and vxnotify is blocking command) set it like: /usr/sbin/vxnotify -g dg00 -m >> /var/log/vxnotify.log & Note: The agent logs the return value of the StartProgram executable. The agent does not treat a non-zero return value as failure of execution and brings the resource online. Note: Do not use the opening and closing ({ }) brace symbols in this string. Note: In the script, specify a return value that is between 0 and 255. Type and dimension: string-scalar Example: "/usr/sbin/sample_app start" In case of RHEL 7, SLES 12, and later distributions, you can choose to start the application processes under system.slice instead of user.slice. To do so, use the systemctl command in this attribute value to start the service: *"systemctl start appServiceFile"* For example: "systemctl start vcs-app1"
StopProgram	The complete path of the executable that stops the application. The file may be present on local storage or shared storage. Any applicable command-line arguments follow the file path and are separated by spaces. Note: The agent logs the return value of the StopProgram executable. The agent does not treat a non-zero return value as failure of execution and takes the resource offline. Note: Do not use the opening and closing ({ }) brace symbols in this string. Note: In the script, specify a return value that is between 0 and 255. Type and dimension: string-scalar Example: "/usr/sbin/sample_app stop"
At least one of the following attributes: MonitorProcesses MonitorProgram PidFiles	See Table: Optional attributes.

Required attribute

Description

StartProgram

The complete path of the executable file that starts the application. The file may be present on local storage or shared storage. Any applicable command-line arguments follow the file path and are separated by spaces.

For example, the attribute for StartProgram is:

/usr/sbin/vxnotify -g dg00 -m >> /var/log/vxnotify.log

(and vxnotify is blocking command) set it like:

/usr/sbin/vxnotify -g dg00 -m >> /var/log/vxnotify.log &

Note:

The agent logs the return value of the StartProgram executable. The agent does not treat a non-zero return value as failure of execution and brings the resource online.

Note:

Do not use the opening and closing ({ }) brace symbols in this string.

Note:

In the script, specify a return value that is between 0 and 255.

Type and dimension: string-scalar

Example: "/usr/sbin/sample_app start"

In case of RHEL 7, SLES 12, and later distributions, you can choose to start the application processes under system.slice instead of user.slice. To do so, use the systemctl command in this attribute value to start the service:

"systemctl start appServiceFile"

For example:

"systemctl start vcs-app1"

StopProgram

The complete path of the executable that stops the application. The file may be present on local storage or shared storage. Any applicable command-line arguments follow the file path and are separated by spaces.

Note:

The agent logs the return value of the StopProgram executable. The agent does not treat a non-zero return value as failure of execution and takes the resource offline.

Note:

Do not use the opening and closing ({ }) brace symbols in this string.

Note:

In the script, specify a return value that is between 0 and 255.

Type and dimension: string-scalar

Example: "/usr/sbin/sample_app stop"

At least one of the following attributes:

MonitorProcesses
MonitorProgram
PidFiles

See Table: Optional attributes.

Table: Optional attributes

Optional attribute	Description
StartOnly	Indicates whether the application must be monitored or not. If this attribute is set, the agent does not execute the script specified in MonitorProgram, but performs the following actions instead: If the online function is executed and the return code of StartProgram is 0, it reports the ONLINE state. Otherwise, it reports the OFFLINE state. If the offline function is executed and the return code of StopProgram is 0, it reports the OFFLINE state. Otherwise, it reports the ONLINE state. Note: If this attribute is set: You must set Critical to 0 so that VCS does not attempt to fail over or take any action if the application faults. You may increase the values of MonitorInterval and OfflineMonitorInterval, because those attributes do not have an impact. Type and dimension: boolean-scalar Default: 0
CleanProgram	The executable which forcibly stops the application. The Attribute specifies the complete path of the executable. Applicable command line arguments follow the name of the executable. The executable path and argument have spaces separating them. This executable can be on a local storage or on a shared storage. Note: Arctera recommends to have the CleanProgram on the local storage so that in case of loss of storage connectivity VCS can take appropriate action to stop the application. Note: If the CleanProgram executable returns a non-zero value, the agent treats it as a clean failure and the resource will not fault. Type and dimension: string-scalar Example: "/usr/sbin/sample_app 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 that the ps -u user -eo pid,args command displays for the process. Type and dimension: string-vector Example: "nmbd"
MonitorProgram	The complete path of the executable file that monitors the application. The file may be present on local storage or shared storage. Any applicable command-line arguments follow the file path and are separated by spaces. MonitorProgram can return the following VCSAgResState values: OFFLINE value is 100 or 1; ONLINE values range from 101 to 110 or 0 (depending on the confidence level); 110 equals confidence level of 100%. Any other value = UNKNOWN. Note: Do not use the opening and closing ({ }) brace symbols in this string. If MonitorProgram is configured and not available, then resource state will be: OFFLINE if the resource was in OFFLINE state and not waiting for any action. UNKNOWN if the resource was in any other state or waiting for some action. Type and dimension: string-scalar Example: "/usr/sbin/sample_app_monitor all"
PidFiles	A list of PID (process ID) files that contain the PID of the processes that you want monitored and cleaned. These 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 function may return an incorrect result. If incorrect results occur, increase the ToleranceLimit in the resource definition. Type and dimension: string-vector
User	The user ID for running StartProgram, StopProgram, MonitorProgram, and CleanProgram. The processes that are 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. Type and dimension: string-scalar Note: If the configured user does not exist or if the home directory is not set for a configured user, the resource state will be UNKNOWN. Default: root Example: user1 Note: Alternatively, in case of RHEL 7, SLES 12, and later distributions, you can choose to start the application processes in system.slice instead of user.slice. To do so, set the value of this attribute to `root`. To start an application in user.slice, you can continue to specify the appropriate user name instead of `root`.
EnvFile	The environment file that should get sourced before running any of the StartProgram, StopProgram, MonitorProgram or CleanProgram. Type and dimension: string-scalar Default: "" Note: Ensure that the EnvFile adheres the default shell syntax of the configured user. Example: /home/username/envfile
UseSUDash	When the value of this attribute is 0, the agent performs an su user command before it executes the StartProgram, the StopProgram, the MonitorProgram, or the CleanProgram agent functions. When the value of this attribute is 1, the agent performs an su - user command before it executes the StartProgram, the StopProgram, the MonitorProgram or the CleanProgram agent functions. Type and dimension: boolean-scalar Default: 0 Example: 1
ContainerOpts	ContainerOpts is a resource type attribute. For more information, refer to the Resource type attributes section of the Cluster Server Administrator's Guide - Linux.
DelayAfterOnline	Specifies the number of seconds that elapse after the Online entry point is complete and before the next monitor cycle is invoked. Type and dimension: integer-scalar Default: 0
DelayAfterOffline	Specifies the number of seconds that elapse after the Offline entry point is complete and before the next monitor cycle is invoked. Type and dimension: integer-scalar Default: 0