rsynd program

WSupported on Windows

USupported on Unix

VSupported on OpenVMS

NSupported in Synergy .NET

The rsynd program is used by both xfServer and xfServerPlus. (Using the -w option indicates that commands apply to xfServerPlus; for additional information about xfServerPlus, see the xfNetLink & xfServerPlus User’s Guide.)

• On Windows, xfServer runs as the rsynd service SynSrv by default, and xfServerPlus runs as xfspl by default; see Windows options below and Windows usage for examples.
• On Unix, xfServer and xfServerPlus run as the rsynd daemon; see Unix options and Unix usage for examples.
• On OpenVMS, xfServer and xfServerPlus run as the rsynd detached process; see OpenVMS options.

Rsynd has the following syntax:

rsynd [option] [...]

Windows options

Do not attempt to issue rsynd commands from the command line while the Synergy Configuration Program is running.

-a

Allow an account that is a member of the administrators group as the username/password (-u) for xfServer or xfServerPlus. We do not recommend that you use this option in a production environment, as it gives remote users administrator privileges on your server. Used with -r (or -rs), -n, and -u for xfServer; used with -r (or -rs) and -w for xfServerPlus.

-c name

Specify that this rsynd request is only for the xfServer or xfServerPlus service named name. (The service name appears as a registry key in the Windows registry and is used to start and stop xfServer/xfServerPlus from the command line.) The default service name for xfServer is SynSrv; for xfServerPlus, it is xfspl. Used with -q, -r, -rs, or -x.

To run multiple instances of xfServer or xfServerPlus, each must have a different service name, display name, and port number. See example A.

-cert=filename

Specify the digital certificate file (.pem file) or the Windows Certificate Store specification to be used for data packet encryption. Used with -cipher, -encrypt, and -scl.

For a .pem file, the file may not require a pass phrase. The default filename and location is DBLDIR:rsynd.pem, which will be used if -cert is not specified. Filename may use a complete path or a logical.

For details on using the Windows Certificate Store, see Windows Certificate Store specification.

-cipher=level

This option was deprecated in Synergy/DE 11.1 because HIGH is now the only valid option for level. Setting level to LOW or MEDIUM will generate an error. Level maps to specific cipher suite names and protocols, which are determined by the version of OpenSSL being used. You can use the SLC option to the GETFA routine to see which cipher suite and protocol is being used. Used with -cert, -encrypt, and -scl.

-d name

Specify a display name to be associated with the service name. (The display name appears in the Services dialog box.) Enclose the name in quotes if it contains a space. If -d is not specified, the default display name for xfServer is Synergy/DE xfServer with the port number appended to the end. For xfServerPlus, it is Synergy/DE xfServerPlus with the port number appended to the end. Used with -r or -rs.

-encrypt

Enable data packet encryption. Used with -cert, -cipher, and -scl. (The -level option was deprecated in Synergy/DE 11.1; only master encryption is now supported.) For details on xfServer encryption, see Using client/server encryption; for xfServerPlus, see Using xfServerPlus encryption.

-export=filename

Export all settings for xfServer and xfServerPlus to a JSON file. If there is a space in the filename or path, enclose it in quotation marks. This option cannot be used with any other option. See Importing and exporting settings (Windows) for more information and examples.

-h

Display a list of rsynd options.

-import=filename [-u username/password]

Import settings that were exported with the -export option. If there is a space in the filename or path, enclose it in quotation marks. Include the -u option and username/password if the import file includes xfServerPlus services or any xfServer services running in run-as-user mode; the specified username/password will be used for all services that require a username/password. See Importing and exporting settings (Windows) for more information and examples.

-importstart=filename [-u username/password]

Import settings that were exported with the -export option and start the services. If there is a space in the filename or path, enclose it in quotation marks. Include the -u option and username/password if the import file includes xfServerPlus services or any xfServer services running in run-as-user mode; the specified username/password will be used for all services that require a username/password. See Importing and exporting settings (Windows) for more information and examples.

-invcertOK

Allow rsynd to continue when an invalid certificate is found. When encryption is enable, by default rsynd validates that the certificate file (.pem file) is valid when it starts up, and, if it’s not, rsynd reports an error to the Windows event log and terminates. Setting the -invcertOK option allows rsynd to continue running in the event of an invalid .pem file; the error is still written to the Windows event log. Note that this option applies only when a .pem file is specified for -cert, not for certificates in the Windows Certificate Store; in the latter case, rsynd will always terminate if an invalid certificate is found. Used with -cert, -encrypt, and -scl.

-keepalive=time

(xfServer only) Sets the value for the TCP keepalive timer in seconds for xfServer connection recovery. Valid values are 1 through 7200 (2 hours). If not specified, defaults to 150 seconds (2.5 minutes). Used with -keepconnect, -keepcontext, -keeplocks, and -retrytime. See Using connection recovery (Windows) for details on this feature. (Note that this option applies only when connection recovery is enabled. See Rsynd: shutting down and timing out for general information about keepalive.)

-keepconnect=level

(xfServer only) Specify the level for connection recovery. Valid values are OFF, MASTER, and SLAVE. By default, this feature is enabled in slave mode. To disable the feature, use -keepconnect=OFF. Used with -keepalive, -keepcontext, -keeplocks, and -retrytime. See Using connection recovery (Windows) for details on this feature.

-keepcontext=time

(xfServer only) The amount of time, in seconds, that xfServer will maintain a client context after an unexpected socket disconnect has been detected. Valid values are 1 through 260000 (72 hours). If not specified, defaults to 300 seconds (5 minutes). Used with -keepalive, -keepconnect, -keeplocks, and -retrytime. See Using connection recovery (Windows) for details on this feature.

-keeplocks=time

(xfServer only) The amount of time, in seconds, that xfServer will maintain file and record locks for a client context after an unexpected socket disconnect has been detected. Valid values are 0 through 43200 (12 hours). If not specified, defaults to 300 seconds (5 minutes). Set to 0 if you want locks to be released as soon as a disconnected socket is detected. This value must be smaller than the -keepcontext value. Used with -keepalive, -keepconnect, -keepcontext, and -retrytime. See Using connection recovery (Windows) for details on this feature.

-n

(xfServer only) Run xfServer in non-secure mode. Used with -r or -rs.

-p port

Specify the port on which xfServer or xfServerPlus listens. The default port is 2330 for xfServer and 2356 for xfServerPlus. Valid ports are in the range 1024 through 65535. Used with -q, -r, -rs, or -x. Port updates the SCSPORT registry entry for the service.

-q

Stop the xfServer or xfServerPlus service specified with -c. If -c is not specified, either SynSrv is stopped or—if -w is specified—xfspl is stopped. If the service is running on a non-default port, specify the port number with -p. Existing connections are lost. See also the -x option and Stopping xfServer.

-r

Register (install) a new service using the name specified by -c. If -c is not specified, either SynSrv is registered or—if -w is specified—xfspl is registered.

-rdport[:timeout]

(xfServerPlus only) Enable remote debugging via Telnet for xfServerPlus on the specified port. Used with -r (or -rs) and -w. xfServerPlus will listen on the specified port for the Telnet client; this port number must be different than the port that xfServerPlus is running on (2356 or the port specified with -p). If desired, specify a time-out in seconds; this is the length of time that the server will wait for a connection from the Telnet client after the xfNetLink–xfServerPlus connection has been made. The default is 100 seconds. See example D.

-retrytime=time

(xfServer only) The amount of time, in seconds, that a client will continue to attempt to reconnect to an xfServer thread that has been unexpectedly disconnected when connection recovery is enabled. Valid values are 1 through 600. If not specified, defaults to 60 seconds. The client will issue a reconnect every 5 seconds for time seconds before returning a “Network problem reaching server” ($ERR_NETPROB) error. Used with -keepalive, -keepconnect, -keepcontext, and -keeplocks. See Using connection recovery (Windows) for details on this feature.

-rs

Register a new service using the name specified by -c and then start it. If -c is not specified, either SynSrv is registered and started or—if -w is specified—xfspl is registered and started. If the service is already registered, this command will start it.

-s

(xfServer only) Run xfServer in secure mode. This is the default. Used with -r or -rs.

-scl[=level]

Specify the security compliance level (that is, the available protocols). If not specified, the default is used. Valid values for level are as follows:

0 = Always use the current Synergy default

1 = (No longer valid; removed in Synergy/DE 11.1 )

2 = Use protocols TLS 1.1, TLS 1.2, and higher

3 = Use protocols TLS 1.2 and higher (default)

4 = Use protocols TLS 1.3 and higher

A value of 0 means the current Synergy default will be used (as indicated above). This means the available protocols may change when you upgrade to a new version of Synergy. Used with -cert, -cipher, and -encrypt. See Understanding cipher suites and protocols for more information.

-sspi

(xfServer only) Run xfServer in restricted security mode (Windows authentication only). See Understanding xfServer security on Windows for more information. Used with -r or -rs.

-text “description”

(xfServerPlus only) Add the string specified in description to the end of the xfServerPlus command line. Once the dbs process starts (which happens only after an xfNetLink client makes a connection), this string displays at the end of the command line for the dbs process in the Command Line column of the Processes tab in Windows Task Manager. (You may need to add the Command Line column to the Processes display.) If you have several xfServerPlus processes running at once, this enables you to distinguish among them. If description contains %s, it is replaced with the IP address of the xfNetLink client. (Other %letter variables should not be used.) Enclose the string in quotation marks, but do not include quotation marks within the string.

-u username/password

xfServer: Run xfServer in run-as-user mode using the specified account. If using clear text, separate the username and password with a forward slash. Optionally, you can run setruser -n and pass the encoded output. The account can be on the local machine or it can be a domain controller account. If the latter, use either user_name@domain_name/password or domain_name\user_name/password. Used with -r (or -rs), or with -import (or -importstart). See example B.

xfServerPlus: Specify the username and password under which to run xfServerPlus sessions. If using clear text, separate the username and password with a forward slash. Optionally, you can run setruser -n and pass the encoded output. The account can be on the local machine or it can be a domain controller account. If the latter, use either user_name@domain_name/password or domain_name\user_name/password. Used with -r (or -rs) and -w. The -u option is required for xfServerPlus.

-v

Display the rsynd version.

-v4

Server has an IPv4 address. This option can be used only from the command line; it is not currently available in the Synergy Configuration Program. (Default)

-v6

Server has an IPv6 address. Default is IPv4. Specifying -v6 means both IPv4 and IPv6 are supported. This option can be changed only from the command line; it is not currently available in the Synergy Configuration Program.

-w

(xfServerPlus only) Specify that this rsynd request is for xfServerPlus (rather than xfServer). Used with -q, -r, -rs, or -x. See the xfNetLink & xfServerPlus User’s Guide for information on xfServerPlus.

-x

Unregister (remove) the service specified with -c. If -c is not specified, either the default service, SynSrv, is unregistered or—if -w is specified—xfspl is unregistered. If the service is running on a non-default port, specify the port number with -p. If the service is running, -x will first stop it, which will cause any existing connections to be lost, and then unregister it. See also the -q option and Stopping xfServer.

Windows usage

For options that do not include an equal sign, you can place a space between an option and its argument if desired. When an equal sign is shown in the syntax, it is required.

A.

The example below shows how to register rsynd for xfServer and specify a non-default port (2445), service name (MyServer), and display name (My Server on 2445). The service name (also referred to as the registry key) is the name you see in the Windows registry. The display name is the name you see in the Component Services dialog box when you start and stop xfServer. No mode is specified, so this xfServer will run in secure mode.

rsynd -p 2445 -r -c MyServer -d "My Server on 2445"

B.

The following example shows how to register rsynd for xfServer and run in run-as-user mode (-u). We have specified the username and password for the account that we created for use with xfServer. The default port (2330), service name (SynSrv), and display name (Synergy/DE xfServer) will be used.

rsynd -r -u Tiger/Mickey123*

C.

The following example shows how to register and start (-rs) rsynd for xfServerPlus. It will run on the default port (2356) with the default service name (xfspl) and display name (Synergy/DE xfServerPlus).

rsynd -rs -w -u xfspAcct/Minnie123*

D.

The following example shows how to register rsynd for xfServerPlus with remote debugging via Telnet enabled. We have specified 2445 as the debug port number (the port the server will listen on for the Telnet client) and 60 seconds as the time-out value. Note that no spaces are allowed between the port number, colon, and time-out value. xfServerPlus will use the default port (2356), service name, and display name. For more information about remote debugging via Telnet, see Debugging your remote Synergy routines.

rsynd -r -rd 2445:60 -w -u xfspAcct/Minnie123*

E.

The following example shows how to register rsynd for xfServer and enable encryption and specify a .pem file and scl value.

rsynd -r -p 2445 -encrypt -cert=CERT:myFile.pem -scl=3

F.

If you want encryption, and you have used either the -cert option or the deprecated -cipher option, you are not required to include the -encrypt option. For example, the following command will register xfServerPlus and enable encryption using the specified .pem filename and the default security compliance level.

rsynd -r -w -u xfspAcct/Minnie123* -p 2445 -cert=CERT:myFile.pem

G.

The following example shows how to register rsynd for xfServer and enable master connection recovery and specify values for KeepContext and KeepLocks. Defaults will be used for the ‑keepalive and -retrytime options.

rsynd -r -p 2445 -keepconnect=master -keepcontext=600 -keeplocks=600

H.

If you want slave connection recovery, and you have used any of the related time options (-keepalive, -keepcontext, -keeplocks, -retrytime), you are not required to include the -keepconnect option. For example, the following command will register xfServer and enable slave connection recovery using default settings for all the times except retrytime:

rsynd -r -p 2445 -retrytime=90 

The above examples show only how to register the service. You’ll still need to start it from the command line, the Synergy Configuration Program, or the Windows Services console. See Starting xfServer for details. If you prefer, you can use the -rs option to register and start rsynd in one step.

I.

The following example shows how to stop the MyServer service running on port 2445:

rsynd -c MyServer -p 2445 -q

Unix options

<none>

Start xfServer in trusted mode. (When a mode is not specified with -n or -s, xfServer runs in trusted mode. See Understanding security modes on Unix for more information.)

-a

Allow super user as the persona of the default user account or as the client for xfServer, or allow super user as the persona under which to run xfServerPlus sessions. We do not recommend that you use this option in a production environment, as it gives remote users root access on your server. Used with -n and -u for xfServer; used with -w for xfServerPlus.

-c

Stop xfServer or xfServerPlus and kill all existing connections. Used with -q. If -p is not specified, the xfServer process on port 2330 will be stopped or—if -w is specified—the xfServerPlus process on 2356 will be stopped. See also the -q option and Stopping xfServer.

-cert=filename

Specify the digital certificate file (SSL .pem file) to be used for data packet encryption. The file may require a pass phrase; if it does, the message “Enter PEM pass phrase” will be displayed on start-up. The default filename and location is DBLDIR:rsynd.pem, which will be used if -cert is not specified. Filename may use a complete path or a logical. Used with -cipher, -encrypt, and -scl.

-cipher=level

This option was deprecated in Synergy/DE 11 because HIGH is now the only valid option for level. Setting level to LOW or MEDIUM will generate an error. Level maps to specific cipher suite names and protocols, which are determined by the version of OpenSSL being used. You can use the SLC option to the GETFA routine to see which cipher suite and protocol is being used. Used with -cert,-encrypt, and -scl.

-encrypt

Enable data packet encryption for xfServer or—if -w is specified—for xfServerPlus. Used with -cert, -cipher, and -scl. (The optional level argument was deprecated in Synergy/DE 11.1; only master encryption is now supported.) For details on xfServer encryption, see Using client/server encryption; for xfServerPlus, see Using xfServerPlus encryption.

-h

Display a list of rsynd options.

-i address

(xfServer only) Bind the specified IP address to xfServer. Used when the machine has more than one IP address.

-invcertOK

Allow rsynd to continue when an invalid certificate is found. When encryption is enable, by default rsynd validates that the certificate file (.pem file) is valid when it starts up, and, if it’s not, rsynd reports an error and terminates. Setting the -invcertOK option allows rsynd to continue running in the event of an invalid .pem file; a warning is reported to rsynd.log and syslog. Used with -cert, -encrypt, and -scl.

-l filename

(xfServer only) Specify the monitor log filename. Used with -m.

-m

(xfServer only) Start the monitor utility for xfServer. See Monitor utility for Unix for information about running the monitor.

-n

(xfServer only) Run xfServer in non-secure mode. See also the -u option.

-p port

Specify the port on which xfServer or xfServerPlus listens. The default port is 2330 for xfServer and 2356 for xfServerPlus. Port overrides the SCSPORT environment variable.

-q

Stop xfServer or xfServerPlus without killing existing connections. If -p is not specified, the xfServer process on port 2330 will be stopped or—if -w is specified—the xfServerPlus process on 2356 will be stopped. To stop rsynd and kill all existing connections, see the -c option. See also Stopping xfServer.

-rdport[:timeout]

(xfServerPlus only) Enable remote debugging via Telnet for xfServerPlus on the specified port. Used with -w. xfServerPlus will listen on the specified port for the Telnet client; this port number must be different than the port that xfServerPlus is running on (2356 or the port specified with -p). If desired, specify a time-out in seconds; this is the length of time that the server will wait for a connection from the Telnet client after the xfNetLink–xfServerPlus connection has been made. The default is 100 seconds. See example D.

-s

(xfServer only) Run xfServer in secure mode.

-scl[=level]

Specify the security compliance level (that is, the available protocols). If not specified, the default is used. Valid values for level are as follows:

0 = Always use the current Synergy default

1 = (No longer valid; removed in Synergy/DE 11.1 )

2 = Use protocols TLS 1.1, TLS 1.2, and higher

3 = Use protocols TLS 1.2 and higher (default)

4 = Use protocols TLS 1.3 and higher

A value of 0 means the current Synergy default will be used (as indicated above). This means the available protocols may change when you upgrade to a new version of Synergy. Used with -cert, -cipher, and -encrypt. See Understanding cipher suites and protocols for more information.

-t time

(xfServer only) Specify the time interval for monitoring. Used with -m.

-text “description”

Add the string specified in description to the end of the command line when rsynd is started. If description contains %s, it is replaced with the IP address of the xfNetLink or xfServer client. (Other %letter variables should not be used.) Enclose the string in quotation marks but do not include quotation marks within the string. This description displays in the list of currently running processes (e.g., ps -ef command) and enables you to distinguish among rsynd processes when several are running.

-u username[/password]

xfServer: Specify the default username or username and password when running xfServer in non-secure mode (-n). Enclose the string in quotation marks. If you include the password, separate the username and password with a forward slash. The password must be encoded. See the usage examples below. This option is required when -encrypt is used in non-secure mode. See Understanding security modes on Unix for more information.

xfServerPlus: Specify the username or username and password under which to run children launched by xfServerPlus. Enclose the string in quotation marks. If you include the password, separate the username and password with a forward slash. The password must be encoded. See the usage examples below. If -u is not specified, the account of the user starting rsynd is used.

-v

Display the rsynd version.

-v4

Server has an IPv4 address. (Default)

-v6

Server has an IPv6 address. Default is IPv4. Specifying -v6 means both IPv4 and IPv6 are supported.

-w

(xfServerPlus only) Enable xfServerPlus. See the xfNetLink & xfServerPlus User’s Guide for more information on xfServerPlus.

Unix usage

You can place a space between an option and its argument if desired.

A.

The following example shows how to start xfServer on port 2445 in secure mode:

rsynd -p 2445 -s

B.

The following example shows how to start xfServer in non-secure mode with a default user account on the default port (2330). We ran setruser to get the encoded password string. Note that the username/password string should be enclosed in quotation marks.

rsynd -n -u "Tiger/\331\247B\200\320\247A\343\027\270R"

C.

The following example shows how to start xfServerPlus. Because we did not specify a port, xfServerPlus will run on the default port (2356). This command launches the setruser utility, which prompts for a username and password. After you enter the username and password, the command starts rsynd with the specified username and the encoded password. (Note that setruser must be enclosed between accent grave characters (`) as shown.) This technique can also be used to start xfServer in non-secure mode with a default user account.

rsynd -w -u `setruser`

D.

The following example shows how to start xfServerPlus with remote debugging via Telnet enabled. We have specified 2445 as the debug port number (the port the server will listen on for the Telnet client) and 60 seconds as the time-out value. Note that no spaces are allowed between the port number, the colon, and the time-out value. xfServerPlus will use the default port (2356). For more information about debugging via Telnet, see Debugging your remote Synergy routines.

rsynd -rd 2445:60 -w -u `setruser`

E.

The following example shows how to start xfServer in secure mode on the default port and enable encryption, specifying a .pem file and scl value.

rsynd -s -encrypt -cert=CERT:myCertFile.pem -scl=3

F.

If you want encryption, and you have used either the -cert option or the deprecated -cipher option, you are not required to include the -encrypt option. For example, the following command will start xfServer and enable encryption using the specified .pem filename and the default security compliance level.

rsynd -s -cert=CERT:myCertFile.pem 

G.

The following example shows how to stop xfServer running on port 2445:

rsynd -p 2445 -q

OpenVMS options

/ALLOW_PRIVILEGED

Specify that usernames that possess system-level privileges may be used as the default user account for xfServer or as the username under which xfServerPlus server processes run. We do not recommend that you use elevated privileges in a production environment.

/CERTIFICATE=filename

Specify the digital certificate file (SSL .pem file) to be used for data packet encryption. The file may not require a pass phrase. The default filename and location is DBLDIR:rsynd.pem, which will be used if /CERTIFICATE is not specified. Filename may use a complete path or a logical. Used with /CIPHER, /ENCRYPT, and /SCL.

/CIPHER=(LOW | MEDIUM | HIGH)

Specify the desired level of encryption. If /CIPHER is not specified, MEDIUM will be used. These values map to specific cipher suite names and protocols, which are determined by the version of OpenSSL being used. If MEDIUM or LOW are specified, /SCL must be set to 1. You can use the SLC option to the GETFA routine to see which cipher suite and protocol is being used. Used with /CERTIFICATE, /ENCRYPT, and /SCL.

/CLIENT_LOGFILE

(xfServer only) Create a log file for each client in the form DBLDIR:node_SRVR_pid.log. This file logs errors as well as start-up and shutdown information. If not specified (or if /NOCLIENT_LOGFILE is specified), a log is created only when there is an error.

/DEFAULT_USER=user_name

Specify the default user account for anonymous access to xfServer when it is running in non-secure mode. Used with /NOSECURE. User_name must be a valid account on the local machine. This option is required when /ENCRYPT is used in non-secure mode. (See Understanding security modes on OpenVMS for more information.)

/ENCRYPT

Enable data packet encryption for xfServer or—if /XFPL_ENABLE is specified—for xfServerPlus. Used with /CERTIFICATE, /CIPHER and /SCL. (The level of encryption [MASTER or SLAVE] was deprecated in Synergy/DE 11.1; only master encryption is now supported.) For details on xfServer encryption, see Using client/server encryption; for xfServerPlus, see Using xfServerPlus encryption.

/FREE_POOL=nnn

Specify the number of xfServer file servers to be maintained as a free pool of servers to allow immediate connection of clients. Default value is 2; minimum value is 1. The number of servers created on start-up is the larger of the /FREE_POOL value and the /MIN_POOL value.

/INACTIVE_LIMIT=“nn:nn:nn”

Specify how long an xfServer process is allowed to persist in an unused state while the free pool is above the free pool limit. Put the value in double quotation marks. The default is 30 minutes (“0:30:00”).

/LOG_LEVEL=(ENABLE | FULL | NONE | OPERATOR)

Set the logging level and indicate whether messages should be sent to the console. ENABLE, which logs errors and some status messages, is the program default and is in effect even when /LOG_LEVEL is not specified. FULL logs start and stop messages in addition to errors and status messages. NONE indicates no logging will take place. For FULL or ENABLE, specify a log file with /OUTPUT. If OPERATOR is also specified, messages are sent to the console in addition to a log file. See Logging for additional information.

/MIN_POOL=nnn

Specify the combined minimum number of xfServer or xfServerPlus servers that are either serving or in the free pool. By default this value is not set. If the number of servers in use plus the number in the free pool drops below the /MIN_POOL value, the number in the free pool will be increased until the total equals the /MIN_POOL value. The number of servers created on start-up is the larger of the /MIN_POOL value and the /FREE_POOL (or /XFPL_FREE_POOL) value.

/NOCLIENT_LOGFILE

(xfServer only) Log only errors for clients. The log file name will be DBLDIR:node_SRVR_pid.log. Specifying this option is the same as simply not specifying /CLIENT_LOGFILE.

/NOSECURE

(xfServer only) Specify that the server should run in non-secure mode. This is the default. See also /SECURE.

/NOUSE_SYNRC

Specify that the xfServer file servers not use the file SYNRC.COM in the default directory of the client’s username to set up process-local logical names. See also /USE_SYNRC.

/OUTPUT=log_file

Specify the filename to which messages are logged. If this qualifier is omitted, a log file is not produced. By default, messages are logged to the file node_rsynd_port.log in DBLDIR. See Logging for additional information.

/PORT=nnnn

Specify the IP port on which xfServer or xfServerPlus listens. The default port is 2330 for xfServer and 2356 for xfServerPlus.

/SCL=level

Specify the security compliance level (that is, the available protocols). Valid values are 0, 2, 3, and 4. If not specified, the default is used.

0 = Always use the current Synergy default

1 = (No longer valid; removed in Synergy/DE 11.1 )

2 = Use protocols TLS 1.1, TLS 1.2, and higher

3 = Use protocols TLS 1.2 and higher (default)

4 = Use protocols TLS 1.3 and higher

A value of 0 means the current Synergy default will be used (as indicated above). This means the available protocols may change when you upgrade to a new version of Synergy. Setting /SCL=2 requires that /CIPHER be set to HIGH. Used with /CERTIFICATE, /CIPHER, and /ENCRYPT. See Understanding cipher suites and protocols for more information.

/SECURE

(xfServer only) Specify that the server requires an encrypted password to be passed along with the username of the client requesting service from xfServer. The default is /NOSECURE.

/SHUTDOWN[=ALL]

Stop xfServer or xfServerPlus without killing existing connections. For xfServer, if ALL is specified, existing connections are stopped as well. For more information, see Stopping xfServer.

/USE_SYNRC

Specify that the xfServer file servers use the file SYNRC.COM in the default directory of the client’s username to set up process-local logical names. See also /NOUSE_SYNRC.

/XFPL_ENABLE=user_name

Enable xfServerPlus and run xfServerPlus server processes under the specified username. See the xfNetLink & xfServerPlus User’s Guide for more information on xfServerPlus.

/XFPL_FREE_POOL=nnn

Specify the number of xfServerPlus logic servers to be maintained as a free pool of processes to allow immediate connection of a client. Default value is 2; minimum value is 1. The number of servers created on start-up is the larger of the /XFPL_FREE_POOL value and the /MIN_POOL value.

xfServer and xfServerPlus quotas

The following options are the same as those used by the OpenVMS RUN command. (The corresponding OpenVMS names are shown in parentheses below.) Because rsynd is a detached process, the defaults for these options would normally come from the PQL_D* SYSGEN parameters; however, we override those defaults during installation. The PQL_M* SYSGEN parameters, if larger, supersede any that we set. Any options not specifically mentioned below still use the PQL_D* SYSGEN parameters.

The installation sets the default values for these options (except for /PAGE_FILE and /PRIORITY) in the RSYND section of the SYNERGY_STARTUP.COM file. If you specify a value lower than the default, the default will be used instead. Note that if you upgrade from a version with different (likely lower) values, the installation will copy those values to the new SYNERGY_STARTUP.COM instead of setting the current defaults. But it will still enforce the defaults as the minimum values. (/PAGE_FILE and /PRIORITY do not get copied to the new file on an upgrade.)

To see these quotas and the current amount free, run the command SHOW PROC/CONT/ID=rsynd_process_id and press Q. For more information on quotas, see Synergex KnowledgeBase article 1477.

/BUFFER_LIMIT=nnn

(BYTLM) Specify the maximum amount of memory in bytes that an xfServer/xfServerPlus process tree can use for buffered I/O operations. The default is 262144 on Itanium and 131072 on Alpha.

/ENQUEUE_LIMIT=nnn

(ENQLM) Specify the maximum number of locks that an xfServer/xfServerPlus process tree can have outstanding at any one time. The default is 4000 on both Itanium and Alpha.

/EXTENT=nnn

(WSEXTENT) Specify the maximum to which an xfServer/xfServerPlus process tree may increase its physical memory. For xfServer, the default is 131072 on Itanium and 65536 on Alpha. For xfServerPlus, 2000 is added to either the default value (resulting in, 133072 on Itanium and 67536 on Alpha) or to the user-specified value.

/FILE_LIMIT=nnn

(FILLM) Specify the maximum number of files that an xfServer/xfServerPlus process tree can have open at any one time. The default is 256 on both Itanium and Alpha. The CHANNELCNT SYSGEN parameter may need to be increased. We recommend using MIN_CHANNELCNT in MODPARAMS.DAT in conjunction with AUTOGEN to set this.

/MAXIMUM_WORKING_SET=nnn

(WSQUOTA) Specify the maximum to which an xfServer/xfServerPlus process tree may increase its working set size. The default is 65536 on Itanium and 32767 on Alpha.

/PAGE_FILE=nnn

(PGFLQUOTA) Specify the maximum number of pages of virtual memory that an xfServer/xfServerPlus process tree can allocate. The default is 700000 on Itanium and 131072 on Alpha.

/PRIORITY=nnn

Specify the priority level at which an xfServer/xfServerPlus process tree runs. The default is 5.