6.3.4 Monitoring condition definition file

In the monitoring condition definition file, define the conditions for monitoring the processes or services of applications.

Organization of this subsection

(1) Format
(2) Details of definitions of servers and applications to be monitored
(3) Details of definitions of processes to be monitored
(4) Details of definitions of child processes to be monitored
(5) Details of definitions of services to be monitored
(6) Example

(1) Format

In a monitoring condition definition file, you can define multiple sets of monitoring conditions. The format of a monitoring condition definition file is as follows:

[Figure]

To Page Top

(2) Details of definitions of servers and applications to be monitored

Define the conditions for monitoring servers and applications. You must write a monitoring server/application definition for each pair consisting of a server to be monitored and an application to be monitored. The next table lists the items that constitute a monitoring server/application definition.

Key name	Value
`target`	Specify a monitoring server name, application name, and symbol display setting, separate these items with semicolons (;). Specify a host name or IP address of up to 255 bytes as the monitoring server name. Specify the application name in up to 128 bytes. To display symbols, specify `Y`. If you do not wish to display symbols, specify `N`.^#
`ssocommandNW`	If the application state changes, specify whether to execute commands on the SSO side and the names of the commands to be executed. Specify the command names, separated with semicolons (;). To execute a command, specify `Y`. If you do not wish to execute a command, specify `N`. Specify a command name in up to 160 bytes.
`ssocommandWN`
`ssocommandWC`
`ssocommandCW`
`ssocommandNC`
`ssocommandCN`
`ssocommandNU`
`ssocommandUN`
`ssocommandWU`
`ssocommandUW`
`ssocommandCU`
`ssocommandUC`
`apmcommandNW`	If the application state changes, specify the names of the remote command to be executed on the APM side. You can specify multiple commands. To specify multiple commands, write the corresponding key name for each command to be executed on multiple lines as follows: Example: `apmcommandNW=cmd /q /c C:\abc.bat` `apmcommandNW=cmd /q /c C:\def.bat` `apmcommandNW=cmd /q /c C:\ghi.bat` Specify a command name in up to 160 bytes.
`apmcommandWN`
`apmcommandWC`
`apmcommandCW`
`apmcommandNC`
`apmcommandCN`
`apmcommandNU`
`apmcommandUN`
`apmcommandWU`
`apmcommandUW`
`apmcommandCU`
`apmcommandUC`
`psnumber` ((integer of 1 or above))	Specify the number of the processes to be registered in the application.
`svcnumber` ((integer of 1 or above))	Specify the number of the services to be registered in the application.

#: Because this item is intended to maintain compatibility with earlier versions, this item is ignored regardless of whether Y or N is specified.

When defining server and process monitoring conditions, note the following:

When you omit an optional definition item, you can only omit the value; you must write the key name and an equal sign (=).
If a single definition file contains more than one definition with the same value of target, only the first process definition will be regarded as valid and the other process definitions will be ignored.
If two or more identical values are assigned to an item that accepts multiple specifications, only the first specification will be regarded as valid and the other specifications will be ignored.
You cannot specify psnumber and svcnumber together under a single target key.
For automated actions and remote commands, see 2.5.2(4) Automated actions and remote commands.

To Page Top

(3) Details of definitions of processes to be monitored

Define process monitoring conditions. The next table lists the items to be specified as process monitoring conditions. For information on process types, see 2.5 Process and service monitoring function.

Key name	Value
`psname`	Specify a semicolon-separated pair consisting of the type and name of the process to be monitored. If the process type is a command line name, specify `C`. If it is an executable file name, specify `E`. Specify the process name in up to 60 bytes.
`pscommandNC`	Specify the command to be executed via automated action when the process status changes. Specify a command name in up to 160 bytes. You can specify multiple commands. To specify multiple commands, write the corresponding key name for each command to be executed on multiple lines as follows: Example: `pscommandNC=cmd /q /c C:\abc.bat` `pscommandNC=cmd /q /c C:\def.bat` `pscommandNC=cmd /q /c C:\ghi.bat`
`pscommandCN`
`pscommandNU`
`pscommandUN`
`pscommandCU`
`pscommandUC`
`cpsnumber` ((integer of 0 or above))	Specify the number of child processes to be registered in the process. If you specify `0`, you need not define the child process to be monitored.

When defining monitoring conditions for a monitored process, note the following:

When you omit an optional definition item, you can only omit the value; you must write the key name and an equal sign (=).
If a single definition file contains more than one definition with the same value of psname, only the first process definition will be regarded as valid and the other process definitions will be ignored.
If two or more identical values are assigned to an item that accepts multiple specifications, only the first specification will be regarded as valid and the other specifications will be ignored.
For automated actions and remote commands, see 2.5.2(4) Automated actions and remote commands.

To Page Top

(4) Details of definitions of child processes to be monitored

Define monitoring conditions for the child processes to be monitored. The next table lists the items to be specified as child process monitoring conditions. For child process types, see 2.5 Process and service monitoring function.

Key name	Value
`cpsname`	Specify a semicolon-separated pair consisting of the type and name of the child process to be monitored. If the child process type is a command line name, specify `C`. If it is an executable file name, specify `E`. Specify the name of the child process to be monitored in up to 60 bytes.
`cpscommandNC`	Specify the command to be executed via automated action when the child process status changes. Specify a command name in up to 160 bytes. You can specify multiple commands. To specify multiple commands, write the corresponding key name for each command to be executed on multiple lines as follows: Example: `cpscommandNC=cmd /q /c C:\abc.bat` `cpscommandNC=cmd /q /c C:\def.bat` `cpscommandNC=cmd /q /c C:\ghi.bat`
`cpscommandCN`
`cpscommandNU`
`cpscommandUN`
`cpscommandCU`
`cpscommandUC`

When coding a monitored child process definition, note the following:

When you omit an optional definition item, you can only omit the value; you must write the key name and an equal sign (=).
If a single definition file contains more than one definition with the same value of cpsname, only the first child process definition will be regarded as valid and the other child process definitions will be ignored.
If two or more identical values are assigned to an item that accepts multiple specifications, only the first specification will be regarded as valid and the other specifications will be ignored.
For automated actions and remote commands, see 2.5.2(4) Automated actions and remote commands.

To Page Top

(5) Details of definitions of services to be monitored

The next table lists the items to be specified as service monitoring conditions.

Key name	Value
`svcname`	Specify a service name. Specify a service name in up to 160 bytes. You cannot use a semicolon (`;`) in the service name.
`svccommandNC`	Specify the command to be executed via automated action when the service status changes. Specify a command name in up to 160 bytes. You can specify multiple commands. To specify multiple commands, write the corresponding key name for each command to be executed on multiple lines as follows: Example: `svccommandNC=cmd /q /c C:\abc.bat` `svccommandNC=cmd /q /c C:\def.bat` `svccommandNC=cmd /q /c C:\ghi.bat`
`svccommandCN`
`svccommandNU`
`svccommandUN`
`svccommandCU`
`svccommandUC`

The next table lists the items to be specified as service monitoring conditions.

When you omit an optional definition item, you can only omit the value; you must write the key name and an equal sign (=).
If the same value is written in more than one instance of a field multiple entries of which are allowed, the field defined first is assumed to be valid, and the fields defined subsequently are assumed to be invalid.
If multiple svcname key values (service names) are specified for the same monitoring service in one monitoring server and monitoring application definition, only the first specified value is valid, and the other values are invalid.
Write the same number of service definitions as the value assigned to svcnumber in the definitions for the monitoring server and monitoring application.
For automated actions and remote commands, see 2.5.2(4) Automated actions and remote commands.

To Page Top

(6) Example

The following gives an example of a monitoring condition definition file.

[Figure]

To Page Top