Register Relay Server (regRelayServer) Utility

Use regRelayServer to perform Outbound Enabler (RSOE) administrative actions. The actions you perform with this utility can also be performed in Sybase Control Center.

This utility is located in the <UnwiredPlatform_InstallDir>\Servers\UnwiredServer\bin\ directory.

Note: The cluster database service must be running when you use this utility.

Syntax

regRelayServer [config | export | exportRSconfig | quickconfig | remove | start | stop]

Parameters

config – Configure an RSOE for an Unwired Server, with an existing RSOE configuration file as input.
```
regRelayServer config -f <filename> -sl
```
Options:
- -f <filename> – Input RSOE configuration file
- -sl – Silent mode (no interactive prompts)
export – Export the current RSOE configuration to a file.
```
regRelayServer export -o <filename> -sl
```
Options:
- -o <filename> – Output RSOE configuration file
- -sl – Silent mode (no interactive prompts)
exportRSconfig – Export a Relay Server configuration file.
```
regRelayServer exportRSconfig -host -o <filename> -p <port> -sl
```
Options:
- -host – Host name of the Relay Server, or host name of the load balancer (if any)
- -o <filename> – Output Relay Server configuration file
- -p <port> – Relay Server HTTP port
- -sl – Silent mode (no interactive prompts)
quickconfig – Create a simple RSOE configuration, specifying only connection property values, and using system-generated defaults for all other properties required.
```
regRelayServer quickconfig -d <description> -host <name> -p <port> -s <URLsuffix> -sl -sp <port>
```
Options:
- -d <description> – User-definable description of the Relay Server
- -host – Host name of the Relay Server, or host name of the load balancer (if any)
- -p <port> – Relay Server HTTP port
- -s <URLsuffix> – URL suffix used by the RSOE to connect to the Relay Server
- -sl – Silent mode (no interactive prompts)
- -sp <port> – Relay Server HTTPS port
remove – Removes one or all RSOE processes in the Unwired Server cluster. However, the RSOE configuration file is not deleted, because other RSOEs in the cluster may need it.
```
regRelayServer remove -f <name> -host <name> -p <port>
```
Options:
- -f <name> – Relay Server farm name
- -host <name> – Host name of the Relay Server, or host name of the load balancer (if any)
- -p <port> – Relay Server HTTP port
Note: If you do not specify the -h, -p, and -f options, all RSOEs in the Unwired Server cluster are removed.
start – Start one or all RSOE processes in the Unwired Server cluster.
```
regRelayServer start -d <time> -f <name> -host <name> -os <size> -ot -p <port> -v <int>
```
Options:
- -d <time> – Connection retry timeout (default 5 seconds)
- -f <name> – Relay Server farm name
- -host – Host name of the Relay Server, or host name of the load balancer (if any)
- -os – Maximum RSOE log file size (default 10240KB)
- -ot – Truncate the log file upon reaching maximum size
- -p <port> – Relay Server HTTP port
- -v <int> – RSOE log verbosity
  - 0 – Errors only
  - 1 – Session-level logging
  - 2 – Request-level logging
  - 3 - 5 – Detailed logging (used primarily for technical support)
Note: If you do not specify the -h, -p, and -f options, all RSOEs in the Unwired Server cluster are started.
stop – Stop one or all RSOE processes in the Unwired Server cluster.
```
regRelayServer stop -f <name> -host <name> -p <port>
```
Options:
- -f <name> – Relay Server farm name
- -host <name> – Host name of the Relay Server, or host name of the load balancer (if any)
- -p <port> – Relay Server HTTP port
Note: If you do not specify the -h, -p, and -f options, all RSOEs in the Unwired Server cluster are stopped.