Running xfServerPlus on UNIX

By default, xfServerPlus runs on port 2356.

Creating a user account for xfServerPlus

We recommend that you set up an account with limited privileges specifically for running xfServerPlus sessions. Use either a system‑level environment variable for DBLDIR or add a DBLDIR entry to the synrc file in the user directory for the new account. Clients assume the persona of the user name that is specified or assumed during start‑up; consequently, we recommend that you not give this account root access.

Note

When running 32‑bit rsynd on 64‑bit Linux, you cannot use an LDAP account to run xfServerPlus sessions. For this configuration, you must either use a local account or install nscd. See Synergex KnowledgeBase article 100002866.

You can start xfServerPlus either with or without a password.

Starting xfServerPlus with a password

This method of starting xfServerPlus requires that you supply the password for the account you created to run xfServerPlus sessions. The password must be encoded using the setruser utility; it cannot be entered in clear text. There are a couple of ways to specify a user password. For example:

rsynd ‑w ‑u `setruser` 

This command launches the setruser utility, which prompts for a user name and password. Note that setruser must be enclosed between grave accent characters (`). After you enter the user name and password, the command starts rsynd with the specified user name and the encoded password on the default port (2356). You can specify a non‑default port with the ‑p option.

You can also run setruser to generate the encoded password string, and then include it in the start‑up command. For example:

rsynd ‑w ‑u "username/\362\224c\261\351\224\374P"

Because this method does not require user input, you can put this command in a start‑up file. Note that the user name/password string must be enclosed in double quotation marks; failure to include the quotation marks may result in a “wrong username/password” error. (See setruser utility for more information.)

Starting xfServerPlus without a password

This method enables you to start xfServerPlus from an authorized account without specifying the password for the account you created to run xfServerPlus sessions. (If the password is passed, it is ignored.) The syntax is

rsynd ‑w ‑u xfspAcct

where xfspAcct is the user name of the account you created to run xfServerPlus sessions. This starts xfServerPlus on the default port (2356). You can specify a non‑default port with the ‑p option. All clients assume the persona of xfspAcct.

This command can be executed by a user signed on as xfspAcct or by any user with root privileges (uid=0). However, if the user name itself (i.e., xfspAcct) is root, xfServerPlus will return an error and will not start. If xfServerPlus starts successfully, you’ll see the message “All xfServerPlus clients will be run as user xfspAcct.”

You can also start xfServerPlus without specifying a user name. The user name defaults to that of the user signed on. (Presumably, this is the account you created to run xfServerPlus sessions.) The syntax is

rsynd ‑w

This starts xfServerPlus on the default port (2356). You can specify a non‑default port with the ‑p option. All clients assume the persona of the user who started rsynd.

This command can be executed by any user without root authority. If start‑up is successful, you’ll see the message “All xfServerPlus clients will be run as user userName.” If userName has root authority, xfServerPlus will return an error message and will not start.

Creating additional xfServerPlus sessions

You can create more than one instance of xfServerPlus by specifying a different port (the default is 2356) for the additional session in the start‑up syntax. You can use the ‑text option to add a description to help distinguish the sessions. For example:

rsynd ‑w ‑u xfspAcct ‑p 3356 ‑text "Session two: %s"   
Note

For the complete list of rsynd options, see rsynd program.

Stopping xfServerPlus

There are two methods for stopping xfServerPlus (rsynd).

rsynd ‑q ‑w

This stops xfServerPlus on the default port, 2356. If you are using a different port, omit the ‑w option and specify the port number with the ‑p option. For example:

rsynd ‑q ‑p 2445

This is the usual method for stopping xfServerPlus. Existing connections are allowed to continue, but new connections are blocked. Use this method when you need to start a new version or configuration of xfServerPlus on that port, or any time you want to prevent new access to the server without interrupting existing connections.

rsynd ‑q ‑c ‑w

This stops xfServerPlus on the default port, 2356. If you are using a different port, omit the ‑w option and specify the port number with the ‑p option.

All existing connections are terminated, new connections are blocked, and the non‑interactive runtimes (dbs.exe) started by the server are terminated. Use this method only when you need exclusive access to the server.

When you stop the server in this manner, the error returned to the client will depend on which xfNetLink you are using.