8.2.10 maction.properties (Property file for execution of Management actions)

Organization of this subsection

(1) Format
(2) File storage location
(3) Functionality
(4) Specifiable keys
(5) Examples of settings
(6) Precautions

(1) Format

This file is a Management Server property file and has the J2SE property file format.

To Page Top

(2) File storage location

In Windows

Cosminexus-installation-directory\manager\config\
In UNIX

/opt/Cosminexus/manager/config/

To Page Top

(3) Functionality

Define the Management action corresponding to the message ID reported in the Management event.

To Page Top

(4) Specifiable keys

The following table describes the keys that you can specify, their contents, and the default values used when the specification is omitted:

Key name	Contents	Classification	Default value
`maction.Management-action-ID.command`	Specify the command to be executed as Management action, as an absolute path.^#1	Management action definition	None
`maction.Management-action-ID.timeout`	Specify an integer from 0 to 86400 (units: seconds) for the timeout for the command process to be executed. If you specify 0, a timeout will not occur.	Management action definition	10
`maction.Management-action-ID.timeout.forced_stop`	Specify the operations to be performed for the executed command process, when a time out occurs. If you specify `true`: Command is terminated forcefully. If you specify `false`: No action occurs. In the case of forced termination, there is no guarantee for the sub processes created by the command process.	Management action definition	false
`maction.Management-action-ID.exclusive_time`	Specify an integer from 0 to 86400 for the time interval (units: seconds) of preventing execution of Management actions with the same Management action ID, after a Management action starts. If you specify 0, the execution is not prevented.	Management action definition	0
`maction.Management-action-ID.max_executable_actions`	Specify an integer from 0 to 1000 for the maximum number of concurrently executing Management actions with the same Management action ID. If you specify 0, there are no restrictions on the concurrently executing number of Management actions.	Management action definition	0
`maction.message.Message-ID.mactions`	Specify the Management action ID for the message ID reported in the Management event. You can use alphanumeric characters and a comma (,) as a delimiter.^#2 In the case of multiple specifications, demarcate using commas (,). When no command is set for the specified Management action, the Management action is not executed.	Mapping between message ID and Management action	None
`maction.server.logical-server-name.mactions`	Specify the Management action ID corresponding to the logical server. You can use alphanumeric characters and a comma (,) as a delimiter.^#2 In the case of multiple specifications, demarcate using commas (,). In the logical-server-name part of the key name, you can specify a J2EE server, a J2EE server cluster, and a member of the J2EE server cluster. When no command is set for the specified Management action, the Management action is not executed.	Mapping between logical server and Management action	None
`maction.tier.web-system-name.physical-tier-typename.mactions`	Specify the Management action ID corresponding to the physical tier. You can use alphanumeric characters and a comma (,) as a delimiter.^#2 To specify multiple values, specify them as a comma-separated list. When no command is set for the specified Management action, the Management action is not executed.	Mapping between logical server and Management action	None
`maction.unit.web-system-name.service-unit-name.mactions`	Specify the Management action ID corresponding to the service unit. You can use alphanumeric characters and a comma (,) as a delimiter.^#2 To specify multiple values, specify them as a comma-separated list. When no command is set for the specified Management action, the Management action is not executed.	Mapping between logical server and Management action	None
`maction.mevent.receiving_info.keep_size.max`	Specify an integer from 0 to 2147483647 for the maximum number of Management event receipt information to be maintained. If you specify 0, the Management event receipt information is not maintained. High network load or failure may cause duplicate execution of Management actions. You can prevent such duplicate execution of Management actions by maintaining the Management event receipt information. When the maximum number of Management event receipt information maintenance cases is exceeded, the information received earliest is deleted. Management event receipt information is destroyed in the following cases: On receiving a Management event, whose receipt information has exceeded the resend time limit. All the information received is destroyed, when the Management Server terminates.	Settings when a Management event is received	100

#1

The commands to be executed as Management action are executed by the Management Server. Note that the environment variables that are set in the Management Server are used.

For details on the command file sample, see 9.4.6 Settings of Management Action Execution Commands in the manual uCosminexus Application Server Operation, Monitoring, and Linkage Guide.

#2

Any whitespaces specified before and after a comma (,), are ignored.

To Page Top

(5) Examples of settings

The contents of the maction.properties file are as follows:

In Windows

# Management-action-definition
maction.restart.command=c\: \\tmp\\command1.bat
maction.restart.timeout=12
maction.restart.timeout.forced_stop=true
maction.restart.exclusive_time=60
maction.restart.max_executable_actions=1
 
# Mapping-between-message-ID-and-Management-action
maction.message.KDJE11111-E.mactions=restart
maction.message.KDJE22222-E.mactions=restart
 
# Mapping-between-Logical-server-and-Management-action
maction.server.j2ee1.mactions=restart
maction.server.j2ee2.mactions=restart
maction.server.j2eeClstr1.mactions=restart

In UNIX

# Management-action-definition
maction.restart.command=/tmp/command1.sh
maction.restart.timeout=12
maction.restart.timeout.forced_stop=true
maction.restart.exclusive_time=60
maction.restart.max_executable_actions=1
 
# Mapping-between-message-ID-and-Management-action
maction.message.KDJE11111-E.mactions=restart
maction.message.KDJE22222-E.mactions=restart
 
# Mapping-between-Logical-server-and-Management-action
maction.server.j2ee1.mactions=restart
maction.server.j2ee2.mactions=restart
maction.server.j2eeClstr1.mactions=restart

To Page Top

(6) Precautions

Priorities in the case of duplicate specifications of a Management action:

For the following property keys, the logical server, service unit, and physical tier have an inclusive relationship such as:

J2EE server < J2EE server cluster < service unit <physical tier.
- maction.server. logical-server-name.mactions
- maction.unit.Web-system-name.service-unit-name.mactions
- maction.tier.Web-system-name.physical-tier-type-name.mactions
Therefore, when different Management actions are specified for each logical server having an inclusive relationship (for example, J2EE cluster and a J2EE server that is an element of the J2EE cluster), only one of the specified Management actions is performed based on the following order of priority:
1. The J2EE server that issued the Management event
2. The J2EE server cluster that includes the J2EE server that issued the Management event
3. The service unit that includes the J2EE server that issued the Management event
4. The physical tier that includes the J2EE server that issued the Management event
Moreover, if the orders of the Management actions specified in the mapping between message ID and Management action and specified in the mapping between logical server and Management action, are different, priority is decided by the order of Management action ID specified in the mapping between message ID and Management action (maction.message.message-ID.mactions key).

Example: Example of prioritizing act1

maction.message.KDJE99999-E.mactions=act1,act2

maction.server.J2EE01.mactions=act3,act2,act1

Note that in this example, KDJE99999-E is the message ID and J2EE01 is the logical server.
Standard output or standard error output

The Management Server does not collect the standard output or standard error output from the command that is executed as Management action. Therefore, when acquiring the standard output or standard error output information of the commands, you need to output that information to a file, as a part of the command.

To Page Top