RSM Configuration File Keywords

Services > Service Configuration Files > Service Configuration File Keywords > RSM Configuration File Keywords

RSM Configuration File Keywords

For more information about modifying the RSM configuration file, see Service Configuration Files.

The RSM keywords are listed in the tables below:

Service Info Keywords
Associated Services Keywords
Logging Keywords
Security Keywords
Backup Keywords
Auditing Keywords
Other Keywords

Note: An asterisk in the Options column ( * ) denotes a user-defined option.

Service Info Keywords

Keyword	Required	Description	Default	Options
SERVICE	Yes	The name of the service in Site.Service format.	None	8 chars max each for site and service name; no spaces; must be unique to the system. Valid characters are: A-Z, 0-9, !, $, _
RSM_NAME	Yes	Specifies the name for the RSM. Used to locate the RSM data subdirectory underneath the base data directory. It allows the executable subdirectory and the data subdirectory to be named differently.	RSM	RSM
RSM_BASE_DIR	Yes	Base directory (and path) of the CygNet service folders. Path can be relative or absolute.	None	* (path) For example, \CygNet \Services
RSM_BASE_DATA_DIR	No	Directory (and path) of the CygNet user base directory. Path can be relative or absolute. This keyword specifies the path of the base data directory of the RSM, which it uses to find the SvcDef.rsx and data directories for other services.	None	* (path)
RSM_PASSWORD	Yes	Case-sensitive password to perform security events when the ACS is out of service. See Remote Service Manager for more information. Note: This keyword is obfuscated using a password hashing algorithm. The encrypted keyword can be changed (but not decrypted) using the Config File Manager. See the note under PIN_WORK_FACTOR for more information about password hashing. Also see Encrypted Keywords for more information.	CYGNET	*
SVC_PORT	Yes	The UDP port number for this service. Each service on the computer must have a unique port number. Use the Config File Manager to ensure that all ports for all services on a given server are unique.	6000	5001 to 32767 (5410 can be used only by the ARS)
DOMAIN	No	The name of a domain ID for an RSM from a source other than the ambient domain. Use this setting to automatically start an RSM under another domain. Alternately you can start an RSM using a command-line parameter `/DOMAIN:nnnnn`. Note: This option will only change the domain when running the RSM as a user process from the command line and you do not explicitly specify a domain to run on using the command-line parameter.	The host’s default domain ID.	Any valid domain ID between 5001 and 32767.
REDUNDANT	No	Indicates whether Redundancy is enabled for this service and it is part of a redundant set with other services. Set to TRUE to enable Redundancy for this service and indicate that it is in a redundant relationship with another service within the redundancy environment. Set to FALSE or commented out to disable Redundancy for this service. See Redundancy for more configuration details. A redundancy definition for your CygNet environment is configured in the CygNet Redundancy Editor. Note: A redundant RSM cannot be managed by another RSM in your redundancy environment. CygNet won’t allow an RSM to start an owned RSM if that RSM has the REDUNDANT keyword set to TRUE. The IN_REDUNDANT_SET (Service in redundant set) info item will report whether this service is part of a redundant relationship.	FALSE	TRUE, FALSE

Associated Services Keywords

Keyword	Required	Description	Default	Options
ACS	Yes	The Site and Service name of the service’s ACS, in Site.Service format.	SITE.ACS	Any valid service name of the corresponding type.
AUD	No	The Site and Service name of the service’s AUD, in Site.Service format.	SITE.AUD
ELS	Yes	The Site and Service name of the service’s ELS, in Site.Service format.	SITE.ELS
MSS	Yes	The Site and Service name of the MSS service from which commands will be accepted, in Site.Service format.	SITE.MSS

Logging Keywords

Keyword	Required	Description	Default	Options
LOGMASK_ELS	Yes	Specifies the types of service events to be logged to the associated ELS (specified in the ELS keyword). To disable logging to the ELS, comment out the ELS keyword for the selected service. See the Note below this table for more information about the keyword values. See LOGMASK_ELS in the Logging section of this Help for more information. The LOGMASK_ELS ( LMask ELS) info item will report the value of this keyword.	CONTROL EXCEPTIONS	LOG_ALL or any combination of: CONTROL EXCEPTIONS WARNING PROG_STAT MIN_TRACE
LOGMASK_FILE	Yes	Specifies the type(s) of service events to be logged to the service’s log file ([file name].log). During the current session of the service, data is written to the current log file. Log file names follow the naming convention of the selected logging mode (as set by the LOGFILE_MODE keyword value). See the Note below this table for more information about the keyword values. See LOGMASK_FILE in the Logging section of this Help for more information. The LOGMASK_FILE (LMask File) info item will report the value of this keyword.	CONTROL EXCEPTIONS WARNING	LOG_ALL or any combination of: CONTROL EXCEPTIONS WARNING PROG_STAT MIN_TRACE MAX_TRACE ENTER_EXIT
LOGFILE_FILE_COUNT	Yes	Specifies the maximum number of log files that a service will create before it starts re-using log files. For example, a count of two will produce SVC001.log, then SVC002.log, and then start back at SVC001.log, where SVC is the name of the service. Specify any value from 2 to 100. See LOGFILE_FILE_COUNT in the Logging section of this Help for more information. The LOGFILE_FILE_COUNT (File Cnt) info item will report the value of this keyword.	2	2 to 100
LOGFILE_LINE_COUNT	Yes	When the value of the LOGFILE_LIMIT_MODE keyword is LINE, this keyword specifies the maximum number of lines per log file. When the specified line count is reached, the log file is truncated at the limit point, and logging is resumed using the next available log file. Specify any value from 1000 to 1000000. See LOGFILE_LINE_COUNT in the Logging section of this Help for more information. The LOGFILE_LINE_COUNT (Line Cnt) info item will report the value of this keyword.	100000	1000 to 1000000
LOGFILE_MODE	Yes	Specifies the operational mode for the log file, that is, how log files are maintained. Options are LEGACY or EXTENDED. The default value is LEGACY. See LOGFILE_MODE in the Logging section of this Help for more information. The LOGFILE_MODE (Logging Mode) info item will report the value of this keyword.	LEGACY	EXTENDED LEGACY
LOGFILE_LIMIT_MODE	Yes	Specifies how to limit the size of each individual log file. Options are LINE (maximum line count is determined by the LOGFILE_LINE_COUNT keyword) or SIZE (maximum file size in megabytes) determined by the LOGFILE_FILE_SIZE keyword). The default value is LINE. See LOGFILE_LIMIT_MODE in the Logging section of this Help for more information. The LOGFILE_LIMIT_MODE (Limit Mode) info item will report the value of this keyword.	LINE	LINE SIZE
LOGFILE_FILE_SIZE	Yes	When the value of the LOGFILE_LIMIT_MODE keyword is set to SIZE, this keyword specifies the maximum size (in megabytes) allowed for a log file, before logging will be continued using the next log file. Possible maximum size values are user-determined, respecting the limits of your specific system configuration. The default value is 100 megabytes. When the specified limit is reached, the log finishes the current line, closes the current file, and then continues logging in the next available log file. See LOGFILE_FILE_SIZE in the Logging section of this Help for more information. The LOGFILE_FILE_SIZE (File Size) info item will report the value of this keyword.	100 megabytes	Depends on user system configuration

Note: Use the following keyword values to set logging options for the LOGMASK_ keywords.

LOG_ALL - logs all options. This is the highest level of logging and will log everything the service is programmed to log.
CONTROL - logs control operations, such as startups, shutdowns and UIS operational events, etc.
ENTER_EXIT - logs every entry and exit through functions. This is used primarily by a programmer to debug code, and is too verbose for the ELS (not applicable for LOGMASK_ELS).
EXCEPTIONS - logs all exceptions thrown, not all of which are severe. An exception is an unexpected event occurring during execution of the service. It could be the result of a configuration error, an invalid command parameter, a bug, etc.
MAX_TRACE - more verbose logging than MIN_TRACE. This is used primarily by a programmer to debug code, and is too verbose for the ELS (not applicable for LOGMASK_ELS).
MIN_TRACE - used primarily by a programmer to debug code.
PROG_STAT - typically used to monitor the progress of the code through some logical steps. Some services, like the GNS, use it to add to the logging of the notifications, acknowledgments, and operations.
STATISTICS - enables gathering and reporting of message processing statistics.
WARNING - logs anomalies, not as serious as exceptions.

Example

A value for LOGMASK_ELS might be CONTROL + EXCEPTIONS.

A value for LOGMASK_FILE might be CONTROL + EXCEPTIONS + WARNING + PROG_STAT.

Security Keywords

Keyword	Required	Description	Default	Options
ACS_ID	Yes	The User ID of the service. This keyword is required for performing security events.	RSM	*
ACS_APPLICATION	Yes	The service’s application name for security.	RSM	Any valid security application ID

Backup Keywords

Keyword	Required	Description	Default	Options
BACKUP_PATH	No	Specifies the path to the backup directory for the service files. The path can be relative or absolute. If the path contains spaces it must be enclosed in quotation marks. The service will create the backup folder if it does not exist. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.	None	* (path)
BACKUP_TIME	No	Specifies the time for the daily backup to run (24-hour format 0000 to 2359, do not use a colon). If this keyword is not enabled for a service or no time is specified, the automatic backup will not occur. Service backup will only occur if manually initiated or scheduled via the MSS. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.	None	0000 to 2359
COPY_BACKUP_TO	No	Enables copying of the backup service files to the specified directory once the backup process is complete. The path can be relative or absolute. If the directory does not exist the service will create it. If the path or directory name contains spaces, the parameter must be enclosed in quotation marks. If you specify a network drive and are running the CygNet services as system services, you must use the Universal Naming Convention (UNC) (\\Workstation\Path) to specify the path. The backup file can be copied to a network drive only if the drive is mapped to the local machine. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.	None	* (path)

Keyword

Required

Description

Default

Options

BACKUP_PATH

Specifies the path to the backup directory for the service files. The path can be relative or absolute. If the path contains spaces it must be enclosed in quotation marks. The service will create the backup folder if it does not exist. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

* (path)

BACKUP_TIME

Specifies the time for the daily backup to run (24-hour format 0000 to 2359, do not use a colon). If this keyword is not enabled for a service or no time is specified, the automatic backup will not occur. Service backup will only occur if manually initiated or scheduled via the MSS. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

0000 to 2359

COPY_BACKUP_TO

Enables copying of the backup service files to the specified directory once the backup process is complete. The path can be relative or absolute. If the directory does not exist the service will create it. If the path or directory name contains spaces, the parameter must be enclosed in quotation marks. If you specify a network drive and are running the CygNet services as system services, you must use the Universal Naming Convention (UNC) (\\Workstation\Path) to specify the path. The backup file can be copied to a network drive only if the drive is mapped to the local machine. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

* (path)

Auditing Keywords

See RSM Audit Levels for more information.

Keyword	Required	Description	Default	Options
AUDIT_LEVEL	No	Sets auditing level of messages written to the AUD service. When set to 0, auditing is off.	1	0, 1, 2
AUDIT_LEVEL_REDUNDANCY	No	Sets the audit level for changes made to the redundancy relationship definition. When set to 0, auditing is off.	1	0, 1

Other Keywords

Keyword	Required	Description	Default	Options
RSM_MINIMIZED	Yes	Switch to start services minimized. Applicable only if services are running as processes.	N/A	N/A
RSM_HIDDEN	No	Switch to hide service screens. Applicable only if services are running as processes.	N/A	N/A
STATUS_CVS	No	Stores the recovered CVS status points. When this keyword is set, the RSM updates the points using the current point status from each service.	Site.Service	None
RECOVERY_PRI_ID	No	The primary machine name for the Windows OS computer. The recovery-shutdown-process will only work if the current machine is the primary machine. This will work if the machine name matches, or the specified machine name is blank. This is used for doing a cluster failover.	Valid Windows primary machine name	None