10.7 mserver.properties (Management Server environment settings file)

Organization of this section
(1) Format
(2) File storage location
(3) Functionality
(4) Specifiable keys
(5) Precautions

(1) Format

The Management Agent property file has the J2SE property file format.

(2) File storage location

(3) Functionality

This file specifies the port number that will be used by the Management Server and the settings for error detection command operations. To change the port number of the Management Server without restarting it, you do so by editing this file.

(4) Specifiable keys

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

Key nameContentsSpecifiable valueDefaultVR
adminagent.connector.comm.state.cache_max_timeSpecify a numeric value from 0 to 2147483​ (units: seconds) for the maximum cache duration for the status of communication with the Administration Agent. When a value lesser than 0 is specified, the communication status is not cached.Specify the value using an integer from 0 to 2147483​.6006-50
com.cosminexus.mngsvr.agent.read_timeoutSpecify an integer (units: seconds) from 1 to 2147483​ for the Management Agent connection timeout period.Specify the value using an integer from 1 to 2147483​.18007-00
com.cosminexus.mngsvr.jp1event.alertSpecify whether to issue Alert level events.
If you specify true:
Alert level events will be issued.
If you specify false:
Alert level events will not be issued.
Specify one of the following values:
  • true
  • false
false07-00
com.cosminexus.mngsvr.jp1event.emergencySpecify whether to issue Emergency level events.
If you specify true:
Emergency level events will be issued.
If you specify false:
Emergency level events will not be issued.
Specify one of the following values:
  • true
  • false
false07-00
com.cosminexus.mngsvr.jp1event.criticalSpecify whether to issue Critical level events.
If you specify true:
Critical level events will be issued.
If you specify false:
Critical level events will not be issued.
Specify one of the following values:
  • true
  • false
false07-00
com.cosminexus.mngsvr.jp1event.enabledSpecify whether to enable the functionality for issuing system JP1 events.
If you specify true:
Enable the functionality for issuing system JP1 events.
If you specify false:
Disable the functionality for issuing JP1 events.
Specify one of the following values:
  • true
  • false
false07-00
com.cosminexus.mngsvr.jp1event.errorSpecify whether to issue Error level events.
If you specify true:
Error level events will be issued.
If you specify false:
Error level events will not be issued.
Specify one of the following values:
  • true
  • false
false07-00
com.cosminexus.mngsvr.jp1event.informationSpecify whether to issue Information level events.
If you specify true:
Information level events will be issued.
If you specify false:
Information level events will not be issued.
Specify one of the following values:
  • true
  • false
false07-00
com.cosminexus.mngsvr.jp1event.noticeSpecify whether to issue a Notice level event.
If you specify true:
Notice level events will be issued.
If you specify false:
Notice level events will not be issued.
Specify one of the following values:
  • true
  • false
false07-00
com.cosminexus.mngsvr.jp1event.warningSpecify whether to issue Warning level events.
If you specify true:
Warning level events will be issued.
If you specify false:
Warning level events will not be issued.
Specify one of the following values:
  • true
  • false
false07-00
com.cosminexus.mngsvr.log.display_numberSpecify any one of the following numbers as the maximum number of display items that the mngsvr configuration function should display as log information in the log display screen:
20, 60, 100, 200, 400
Specify 20, 60, 100, 200, or 400.10007-00
com.cosminexus.mngsvr.log.levelSpecify the level of log output for the Management Server log.
  • 0: Normal operation.
  • 10: similar to normal operation, waiting for recurrence.
  • 20: Acquire debug level information suitable for use during system building or testing phases.
  • 30: Acquire detailed error information that is suitable for use, when cause investigation is difficult
Specify 0, 10, 20, or 30.007-00
com.cosminexus.mngsvr.log.rotateSpecify any of the following numbers, as the number of Management Server log files:
1, 2, 4, 8, 16
Specify 1, 2, 4, 8, or 16.407-00
com.cosminexus.mngsvr.log.sizeSpecify any one of the following sizes as the Management Server log file size:
4096 (4 kilobytes), 65536 (64 kilobytes), 262144 (256 kilobytes), 524288 (512 kilobytes), 1048576​ (1 megabyte), 2097152​ (2 megabytes), 4194304​ (4 megabytes), 16777216​ (16 megabytes), 67108864​ (64 megabytes)
Specify one of the following values:
  • 4096 (4 kilobytes)
  • 65536 (64 kilobytes)
  • 262144 (256 kilobytes)
  • 524288 (512 kilobytes)
  • 1048576​ (1 megabytes)
  • 2097152​ (2 megabytes)
  • 4194304​ (4 megabytes)
  • 16777216​ (16 megabytes)
  • 67108864​ (64 megabytes)
6553607-00
com.cosminexus.mngsvr.logical_server_abnormal_stop.exitSpecify the operation to be executed in case of abnormal stop status of operations of the logical server managed by Management Server (automatic restart frequency is exceeded or automatic restart frequency setting is 0).
If you specify true:
KEOS10038-I is output and Management Server stops.
If you specify false:
Management Server continues processing.
Specify one of the following values:
  • true
  • false
false08-50
com.cosminexus.mngsvr.maintenance.log.filenumSpecify an integer from 1 to 16 for the number of Management Server maintenance log files.Specify the value using an integer from 1 to 16.206-70
com.cosminexus.mngsvr.maintenance.log.filesizeSpecify an integer from 65536 to 2147483647​ for the maximum file size (units: bytes) for the Management Server maintenance log file.Specify the value using an integer from 65536 to 2147483647​.16777216​06-70
com.cosminexus.mngsvr.management.connector.enabledSpecify whether to enable an external connection to the Management Server remote management functionality.
If you specify true:
Enable an external connection to the Management Server remote management functionality.
If you specify false:
Disable an external connection to the Management Server remote management functionality.
Specify one of the following values:
  • true
  • false
false07-60
com.cosminexus.mngsvr.management.enabledSpecify whether to enable the Management Server remote management functionality.
If you specify true:
Enable the Management Server remote management functionality.
If you specify false:
Disable the Management Server remote management functionality.
Specify one of the following values:
  • true
  • false
false07-60
com.cosminexus.mngsvr.management.hostSpecify the host name, or an IP address when the host for an external connection to Management Server remote management functionality is to be specified.
You can specify the IP address as a regular expression using meta characters. When the IP address is specified as a regular expression, the available local IP address that matches the expression is used.#1
When the host is specified, add the java.rmi.server.hostname key in the mserver.properties file and specify the value similar to the java.rmi.server.hostname key. However, you cannot use the regular expression with meta characters in java.rmi.server.hostname.
When you specify a value to webserver.connector.http.bind_host, specify the similar value to this property.
Host name or IPv4 dotted notationNone07-60
com.cosminexus.mngsvr.management.listen.portSpecify an integer from 0 to 65535 for the port number for client connection created at the time of external connection to the Management Server remote management functionality. If 0 is specified, a blank port number is automatically allocated.Specify the value using an integer from 0 to 65535.007-60
com.cosminexus.mngsvr.management.portSpecify an integer from 1 to 65535 for the external connection port number of the Management Server remote management functionality.Specify the value using an integer from 1 to 65535.2809907-60
com.cosminexus.mngsvr.management.read_timeoutSpecify an integer from 1 to 2147483​ for the read timeout period (unit: second) at the time of an external connection to the Management Server remote management functionality.Specify the value using an integer from 1 to 2147483​.18007-60
com.cosminexus.mngsvr.management_user_account.enabledSpecify whether to enable the account of the Management Server user.
If you specify true:
Execute the login authentication process of Management Server.
If you specify false:
Do not execute the login authentication process of Management Server. You can log in without entering the management user account in the Login screen of management portal. You can also omit specification of -u and -p that are common arguments in the commands used by Manager.
Specify one of the following values:
  • true
  • false
true08-50
com.cosminexus.mngsvr.on_startSpecify whether to perform batch startup of the logical servers, when the Management Server starts.
If you specify true:
Batch startup of logical servers is performed.
If you specify false:
Batch startup of logical servers is not performed.
Specify one of the following values:
  • true
  • false
false07-00
com.cosminexus.mngsvr.snapshot.auto_collect.enabledSpecify whether to collect snapshot log when an error occurs or when batch restart is performed.
If you specify true:
Snapshot log will be collected.
If you specify false:
Snapshot log will not be collected.
Specify one of the following values:
  • true
  • false
true06-50
com.cosminexus.mngsvr.snapshot.collect.pointSpecify the timing for snapshot log collection.
If you specify before_stop:
Snapshot log will be collected before stopping the logical server.
If you specify j2ee_restart:
Snapshot log will be collected before re-starting the J2EE server.
Specify one of the following values: Note that the value is not case sensitive.
  • before_stop
  • j2ee_restart
before_stop06-50
com.cosminexus.mngsvr.sys_cmd.abnormal_end.enabledSpecify whether to use the functionality for executing error detection command by the system.
If you specify true:
The functionality for executing error detection command is enabled.
If you specify false:
The functionality for executing error detection command is disabled.
Specify one of the following values:
  • true
  • false
true06-50
com.cosminexus.mngsvr.sys_cmd.abnormal_end.timeoutSpecify an integer from -1 to 2147483647​ (in seconds) for the waiting time for completion of the following processings:
  • Commands executed during error detection by the system
  • Collection of performance analysis trace
When the command or the collection of performance analysis trace does not complete even after the specified time has elapsed, the executed command or collection is ignored and the processing is continued.
When you specify -1, the processing will wait for execution of the command or collection to complete.
If a value outside the range of -1 to 2147483647​ is specified, the default value is used.
Specify the value using an integer from -1 to 2147483647​.60006-50
com.cosminexus.mngsvr.traceSpecify any one of the following numbers as the maximum number of performance analysis trace files maintained in the Management Server:
1, 2, 4, 8, 16
Specify 1, 2, 4, 8, or 16.207-00
com.cosminexus.mngsvr.usr_cmd.abnormal_end.enabledSpecify whether to use the functionality for executing user-created error detection command.
If you specify true:
The functionality for executing error detection command is enabled.
If you specify false:
The functionality for executing error detection command is disabled.
Specify one of the following values:
  • true
  • false
false06-50
com.cosminexus.mngsvr.usr_cmd.abnormal_end.timeoutSpecify an integer from -1 to 2147483647​ (units: seconds) for the period of awaiting completion of execution of the user-created error detection command.
When the command does not complete even after the specified time has elapsed, ignore the executed command, and continue the processing.
When you specifty 0, the processing will continue without waiting for the completion of the command.
When you specify -1, the processing will wait for the command execution to complete.
If a value outside the range of -1 to 2147483647​ is specified, the default value is used.
Specify the value using an integer from -1 to 2147483647​.6006-50
com.cosminexus.mngsvr.vmx.enabledSpecifies whether to operate the Management Server as a virtual server manager in the 08-50 mode.
If you specify true:
The Management Server operates as the virtual server manager in the 08-50 mode. Note that the logical server using Management Server must not be built or operated. If a function other than virtual server manager in the 08-50 mode is used when true is specified, the operation is not guaranteed.
If you specify false:
The Management Server does not operate as the virtual server manager in the 08-50 mode.
Specify one of the following values:
  • true
  • false
false08-50
com.cosminexus.mngsvr.vmi.enabledSpecify whether Management Server must function as a virtual server manager.
If you specify true:
Management Server functions as the virtual server manager. Note that the logical server using Management Server must not be built or operated. If a function other than virtual server manager is used when true is specified, the operation is not guaranteed.
If you specify false:
The Management Server operates as the Management Server, or as the virtual server manager in the 08-50 mode (if true is specified in com.cosminexus.mngsvr.vmx.enabled).
Specify one of the following values:
  • true
  • false
false08-53
com.cosminexus.mngsvr.upload_app.enabledSpecifies whether to enable the functionality for uploading the application files from the management portal to the host on which the Management Server is running.
If you specify true:
Enables the functionality for uploading the application files from the management portal to the host on which the Management Server is running.
If you specify false:
Disables the functionality for uploading the application files from the management portal to the host on which the Management Server is running.
Specify one of the following values:
  • true
  • false
true08-70
com.cosminexus.mngsvr.upload_app.directorySpecifies the directory for uploading the application files from the management portal to the host on which the Management Server is running.You specify the directory name as an absolute path.Cosminexus-installation-directory/manager/apps08-70
com.cosminexus.mngsvr.upload_app.maxsizeSpecifies the maximum size (unit: bytes) of application files that can be uploaded from the management portal to the host on which the Management Server is running.
Specify a size of 1024 bytes (1 KB) or more.
If you specify 0, the size of files that can be uploaded is not restricted.
0 to 9223372036854775807​314572800​ (300MB)08-70
com.cosminexus.mngsvr.snapshot.auto_collect.timeoutSpecifies the timeout value (unit: seconds) until the primarily sent data and secondarily sent data of the snapshot log is completely collected when an error is detected in the logical server.
If 0 is specified
Timeout will not occur.
If a value between 1 and 2147483​ is specified
If the collection of the snapshot log is not completed even after the elapse of specified number of seconds, the Management Server cancels snapshot log collection.
0 to 2147483​008-70
ejbserver.naming.portSpecifies the port number used for internal communication of the Management Server, when the Management Server is used from HCSC-Manager.
The port number is enabled only when the Management Server is used from HCSC-Manager.
1 to 655352890009-00
ejbserver.server.edition.settingforceSpecifies whether to use the Management Server from HCSC-Manager.
When the Management Server is not used from HCSC-Manager, either specify Smart in this key or omit the specification of this key.
When this key is omitted, it is assumed that Smart is specified.
  • When Smart is specified:
    The Management Server is not used from HCSC-Manager. Note that if you specify Smart, the ejbserver.naming.port key settings are ignored.
  • No value is specified: The Management Server is used from HCSC-Manager.
Note
When nothing is specified, it is assumed that only key is specified and value is not specified.
Specification example:
  • ejbserver.server.edition.settingforce=
SmartSmart09-00
java.rmi.server.hostnameSpecify the host name or an IP address when the host for an external connection to Management Server remote management functionality is to be specified.
For details about the settings for this property, see com.cosminexus.mngsvr.management.host.
Also, in an environment in which the global IP address and local IP address are converted, such as the NAT (IP masquerade), specify the host name (not the IP address) regardless of whether com.cosminexus.mngsvr.management.host is specified. In this case, if the IP address is specified in com.cosminexus.mngsvr.management.host, you must specify the host name indicating that IP address.
Host name or IPv4 dotted notationNone07-60
mngsvr.jp1event.event_server_nameSpecify a value same as the address set for the ports key in the event server settings file (conf) of the JP1/Base event service that is being used. If multiple addresses are specified for the ports key, choose any one of the specified addresses.
When using an event service that has the value '0.0.0.0' (default value) specified for the ports key address, either omit this key or specify the host name of the local machine or localhost.
Host name or IPv4 dotted notationlocalhost06-70
mngsvr.myhost.nameSpecify the IP address accessible from the host to which the logical server is allocated, or specify the host name indicating that IP address in the name of the host to which the logical server is allocated.
Specify this key when the host that operates Management Server has multiple IP addresses and the host name might not be converted to the intended IP address.
When omitted or when blank characters are specified, the loopback address gets converted into the local host name that can be acquired, and the local host name is used. If the local host name cannot be acquired, the loopback address is used.
You can specify the IP address as a regular expression using meta characters. When the IP address is specified as a regular expression, the available local IP address that matches the expression is used.#1
Precautions
When you specify a value to webserver.connector.http.bind_host, specify the similar value to this property.
Host name or IPv4 dotted notationNone06-50
webserver.connector.ajp13.portSpecify the port number used for Management Server internal communication.
The value set during installation is 28009.
If the port number is not specified, an attempt to start the Management Server fails.
Specify the value using an integer from 1 to 65535.None05-00
webserver.connector.http.bind_hostYou can select an optional IP address when using the Management Server on a host having multiple physical network interfaces or a host that allocates multiple logical IP addresses to one physical network interface. However, you cannot specify the loopback address.
If a value is not specified, connections are received for all the local addresses.
You can specify the IP address as a regular expression using meta characters. When the IP address is specified as a regular expression, the available local IP address that matches the expression is used.#1
Specify one of the following values:
  • IPv4 address
  • Host name (String within 255 characters specified using single byte alphanumeric characters or symbols (_.-))
None07-10
webserver.connector.http.permitted.hostsSpecify the IP address or host name of the hosts that will be allowed access to the Management Server and the host that executes the Administration Agent. This property applies to the access from a management portal (Web browser), Management Server remote management function, or management command (mngsvrutil). Moreover, you must also specify the IP address or host name of the hosts that are to be managed by the Management Server. If you operate a logical server of a host that is not specified in this property, problems like a timeout or incomplete operations may occur.
Note that when the key is omitted, there are no access restrictions. When omitting the values or when entered values are invalid, only local host can be accessed.
When specifying multiple hosts, demarcate the IP addresses or the host names with a comma (,). If there are no access restrictions, specify only an asterisk (*). The single-byte space before and after the IP address or the host name is ignored.
Specify one of the following values:
  • IPv4 address or host name
    If you want to specify multiple addresses or names, separate with a comma (,).
    Specify a string within 255 characters specified using alphanumeric characters or symbols (_.-) for the host name.
  • * (asterisk)
  • Undefined: *
  • Not set: localhost
06-00
webserver.connector.http.portSpecify the HTTP port number for connecting to the Management Server.
The value set during installation is 28080.
If the port number is not specified, an attempt to start the Management Server fails.
Specify the value using an integer from 1 to 65535.None05-00
webserver.shutdown.portSpecify the port number for receiving the Management Server termination request.
The value set during installation is 28005.
If the port number is not specified, an attempt to start the Management Server fails.
Specify the value using an integer from 1 to 65535.None05-00
com.cosminexus.mngsvr.compat.operation_appSpecify how the applications will be managed. Note that this item is for compatibility.
If you specify true:
V7 compatibility mode
If you specify false:
V8 mode
The following strings can be specified:
  • true
  • false
  • Default#2: true
  • Initial value#2: false
08-00
#1
If the IP address subnet used in the communication with the Administration Agent in the management domain is fixed, and if the IP address to be specified is coded as 192\\.168\\.0\\..+, the IP address matches with the IP address starting with 192.168.0. (for example, 192.168.0.32 or 192.168.0.128), so the setup file can be distributed to all the hosts and can be used without modifications. For details on the regular expressions, check the specifications for the java.util.regex.Pattern class in Java.
However, as "\\" is replaced with the single character "\", when specifying "\", specify two characters in succession. If multiple IP addresses matching with the specified regular expression are detected, the IP address with the smallest value is used. For example, if 192.168.0.32 and 192.168.0.128 are detected, 192.168.0.32 will be used. In this case, the used IP address is not always the intended IP address, therefore, make sure to code a regular expression such as 192\\.168\\.0\\.1.. to match with only one IP address.
#2
If an application is installed from Application Server V7 or earlier, the com.cosminexus.mngsvr.compat.operation_app key does not exist, so the default (true) V7 compatibility mode is used. When Application Server V8 or later is installed, false (initial value) is set up for this key.

(5) Precautions

After starting Management Server, you can also change the port number from Network settings of Cosminexus Management Server settings in the management portal. However, when changing the port number, the comment written in the mserver.properties file is deleted.