egosc_conf.xml reference

The egosc_conf.xml file contains configuration information for the EGO service controller.

Location

This file is installed with IBM® Spectrum Symphony and is located in %EGO_CONFDIR%\..\..\eservice\esc\conf\ on Windows, and in $EGO_CONFDIR/../../eservice/esc/conf/ on Linux®.

Parameters

ESC_AUDIT_MAX_ROTATE

Description: Specifies the maximum number of audit log file archives to maintain. If the value configured for this parameter is not valid, the default value is used.

Syntax: ESC_AUDIT_MAX_ROTATE=number_of_archives

Valid values: 0 to 2147483647

Default value: 20

ESC_AUDIT_MAX_SIZE

Description: Specifies the maximum file size in MB for EGOSC audit logs. When the log file reaches the specified size, the file will be archived if both ESC_AUDIT_MAX_SIZE and ESC_AUDIT_MAX_ROTATE are set to a non zero value.

If the value for this parameter is set to 0, log rotation is disabled. If the value is not valid, the default value is used.

Syntax: ESC_AUDIT_MAX_SIZE=number_of_Megabytes

Valid values: 0 to 1999

Default value: 100

ESC_ESD_REGISTER_HOSTS

Description: Specifies whether the EGO Service Controller registers host names with the internal Service Director DNS server. When this parameter is set to ON, host names and EGO service names are registered. When this parameter is set to OFF, only EGO service names are registered. For more information on using the Service Director as the DNS server, see Running IBM Spectrum Symphony without external DNS.

Syntax: ESC_ESD_REGISTER_HOSTS=ON|OFF

Valid values: ON|OFF

Default value: OFF

ESC_ESD_MAX_RETRIES

Description: Specifies the maximum number of DNS update retries by the Service Controller.

Syntax: ESC_ESD_MAX_RETRIES=number_of_retry_attempts

Valid values: Positive integer greater than 0. If the specified value is not valid, the default is used.

Default value: 3

ESC_ESD_RETRY_TIMEOUT

Description: Specifies the interval (in milliseconds) between DNS update retries, after which time the update times out.

Syntax: ESC_ESD_RETRY_TIMEOUT=interval_between_retry_attempts

Valid values: Positive integer greater than 0. If the specified value is not valid, the default is used.

Default value: 2000 (ms)

ESC_HOLD_SLOT_FOR_JOB_CONTROLLER

Description: Specifies that EGOSC will not release the slot until the service instance is terminated.

If the value for this parameter is set to "N", EGOSC cleans the service instance and releases the slots immediately when a reclaim happens or the configuration changes.

Syntax: ESC_HOLD_SLOT_FOR_JOB_CONTROLLER=Y|N

Valid values: Y | N

Default value: N

ESC_LOGDIR

Description: Specifies the directory where the EGO service controller (egosc) command logs error or debug messages.

Syntax: ESC_LOGDIR= path_to_messages_directory

Valid values: Any valid path.

Default value:

Linux: $EGO_TOP/eservice/esc/log
Windows: Installation_top\eservice\esc\log

ESC_LOG_MAX_ROTATE

Description: Specifies the maximum number of log file archives to maintain. If the value for this parameter is set to 0, log rotation is disabled. If the value is not valid, the default value is used.

Syntax: ESC_LOG_MAX_ROTATE=number_of_archives

Valid values: 0 to 2147483647

Default value: 10

ESC_LOG_MAX_SIZE

Description: Specifies the maximum file size in MB for EGOSC logs. When the log file reaches the specified size, the file will be archived if both ESC_LOG_MAX_SIZE and ESC_LOG_MAX_ROTATE are set to a non zero value.

If the value configured for this parameter is set to 0, log rotation is disabled. If the value is not valid, the default value is used.

Syntax: ESC_LOG_MAX_SIZE=number_of_Megabytes

Valid values: 0 to 1999

Default value: 100

ESC_SERVICE_START_FAIL_RETRY

Description: Specifies whether to attempt to restart a service instance that encounters errors after it starts. By default, when a service instance runs into issues after it is started, no attempt is made to restart the service or to block hosts. The service instance's activity exits and the service instance goes into ERROR state, using one of these exit codes (values) and reasoning:

Exit code	Reasoning for the code
2	Unable to create container process on the execution host. Resource is unavailable or privilege is not granted.
3	Unable to change the container process group ID,
4	Unable to set up container environment variables.
5	Unable to set container resource limits.
6	Execution username or password is incorrect. Either wrong information is provided or the execution host is not set up properly.
7	Unable to change the activity execution directory.

You can change this default behavior, by setting ESC_SERVICE_START_FAIL_RETRY to ON and also configuring values for one or both of the following service profile parameters:

If you define the MaxRestarts parameter in the service profile, and set ESC_SERVICE_START_FAIL_RETRY to ON, if a service instance encounters errors after it starts, the system tries to restart the service, up to this MaxRestarts maximum retry limit.
If you define the BlockHostExitValues parameter in the service profile, and set ESC_SERVICE_START_FAIL_RETRY to ON, if a service instance encounters errors after it starts, the system blocks the host using the corresponding exit code.

Syntax: ESC_SERVICE_START_FAIL_RETRY=ON|OFF

Valid values: ON | OFF

Default value: OFF

ESC_TS_PARAMS

Description: Specifies the security parameters specific to EGOSC. The ESC_TS_PARAMS parameters uses the same sub-parameters as the EGO_KD_TS_PARAMS parameter, but the sub-parameters apply only to EGOSC.

Syntax: ESC_TS_PARAMS="SSL[sub-parameter,...]"

Valid values: Refer to Sub-parameters for the ego.conf file for a list of applicable sub-parameters.