Register Relay Server (regRelayServer) Utility

Use regRelayServer.bat to perform multiple relay server and RSOE administrative actions. The same actions you perform with this utility can also be performed in Sybase Control Center.

This command is located in the <UnwiredPlatform_InstallDir>\Servers\UnwiredServer\bin\regRelayServer.bat directory.

Syntax

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

Parameters

config – Configure relay server or an RSOE for an Unwired Server node with a named XML file as input. Use this command syntax:
```
regRelayServer.bat config -f <filename> -sl
```
Options:
- -f <filename> – The input file and path.
- -sl – Disable all user interactive questions (run silently).
export – Export the existing RSOE configuration into a file. Use this command syntax:
```
regRelayServer.bat export -o <filename> -sl
```
Options:
- -o <filename> – The output file and path.
- -sl – Disable all user interactive questions (run silently).
exportRSconfig – Export the actual relay server configuration properties file, which could be used by the Unwired Platform administrator to configure Unwired Server farms, server nodes, for remaining relay servers that require configuration or updates. Use this command syntax:
```
regRelayServer.bat exportRSconfig -host -o <filename> -p <port> -sl
```
Options:
- -host – either the relay server host name or the host name of the load balancer (if one is used in your environment). Device clients use the host name to establish connections. Other relay servers can use the host name to identify peers if a load balancer is not used.
- -o <filename> – The output file and path.
- -p <port> – the HTTP port for relay server connections.
- -sl – Disable all user interactive questions (run silently).
migrate – Migrate the configuration values defined in the 1.5.5 version of <UnwiredPlatfrom_InstallDir>\Servers\UnwiredServer\config\relayserver.properties file and port them to the current version of the cluster database. Use this command syntax:
```
regRelayServer.bat migrate -host -o <filename> -sl
```
Options:
- -o <filename> – Store the command output into the named file to ensure that the migration is successful.
- -sl – Disable all user interactive questions (run silently).
quickconfig – Rapidly create a relay server configuration, collecting only connection property values and use system-generate defaults for the remaining properties required. RSOEs deployed with this method require manual property edits before they can be started. Export the configuration and update the properties in the file. You can then re-apply the configuration with the configure command. Use this command syntax:
```
regRelayServer.bat quickconfig -d <description> -host <name> -p <port> -s <URLsuffix> -sl -sp <port>
```
- -d <description> – description for the relay server.
- -host – either the relay server host name or the host name of the load balancer (if one is used in your environment). Device clients use the host name to establish connections. Other relay servers can use the host name to identify peers if a load balancer is not used.
- -p <port> – the HTTP port for relay server connections.
- -s <URLsuffix> – A URL suffix that allows a device application client to connect to a relay server farm. The default value for Apache on Linux is /srv/iarelayserver, and the default value for IIS on Windows is /ias_relay_server/server/rs_server.dll.
  For example, to connect a client to a relay server farm called RBSFarm1, you might use /sup_relay_server/client/rs_client.dll/RBSFarm1 as your URL suffix.
- -sl – Disable all user interactive questions (run silently).
- -sp <port> – the secure HTTP port for relay server connections.
remove – Deletes one or all RSOE process for the Unwired Server node. However, the configuration file is not deleted, because other RSOEs on the server node may require it. Supported options include:
- -f <name> – The relay server farm name.
- -host – either the relay server host name or the host name of the load balancer (if one is used in your environment). Device clients use the host name to establish connections. Other relay servers can use the host name to identify peers if a load balancer is not used.
- -p <port> – the HTTP port for relay server connections.
If you do not specify -h, -p, and -f options, all RSOEs for the Unwired Server node are removed. Otherwise, only those identified are removed.
start – Start one or all RSOE processes for the Unwired Server node. Use this command syntax:
```
regRelayServer.bat start -d <time> -f <name> -host <name> -os <size> -ot -p <port> -v <int>
```
Options:
- -d <time> – When a connection fails, how long, in seconds to wait before retrying. The default is 5 seconds.
- -f <name> –
- -host – either the relay server host name or the host name of the load balancer (if one is used in your environment). Device clients use the host name to establish connections. Other relay servers can use the host name to identify peers if a load balancer is not used.
- -os – The maximum log file output size. The default is 10240 KB.
- -ot – Truncates the log file after reaching the size specified by the maximum output size.
- -p <port> – the HTTP port for relay server connections.
- -v <int> – The output log verbosity level. Set any value in the range of 0-5. For troubleshooting and maintenance, levels 1 or 2 should be sufficient.
stop – Stop one or all RSOE processes for the Unwired Server node. Supported options include:
- -f <name> – the server farm for which the relay server manages requests. This property is case-sensitive. The configured value must match the value defined for the RSOE or the connection fails.
- -host – either the relay server host name or the host name of the load balancer (if one is used in your environment). Device clients use the host name to establish connections. Other relay servers can use the host name to identify peers if a load balancer is not used.
- -p <port> – the HTTP port for relay server connections.

Examples

Export properties then configure a new relay server – In this example, an administrator uses this utility multiple times but on different host computers:
1. The administrator exports the file for a relay server deployed in a test environment. This configuration is stable and the administrator now wishes to propagate these properties to all new relay servers in a production environment. The administrator runs this command on the test host computer:
```
regRelayServer.bat exportRSconfig -o <path>\rsconfig.xml
```
2. The administrator transfers the file to each new host. The command used to apply the file on the new host is:
```
regRelayServer.bat config -f <path>\rsconfig.xml
```
Registering a new RSOE and configuring it with rsoe.config.template.xml – In this example an administrator has copied and modified <UnwiredPlatfrom_InstallDir>\Servers\UnwiredServer\config\rsoeConfig.template.xml.. Because the XML elements do not include an ID attribute value, this utility will treat the RSOE as newly deployed, and register it in the cluster database in addition to configuring it. The administrator uses this command:
```
regRelayServer.bat config -f <path>\rsoe.config.template.xml
```
Start all RSOEs on the Unwired Server node – Once RSOEs are configured, rather than restarting the host computer, the administrator starts all newly configured RSOEs on the current machine with this command:
```
regRelayServer.bat start
```
Stop only RSOEs of a named relay server farm – An administrator needs to make a change to one of the RSOEs recently started, and uses this command:
```
regRelayServer.bat stop -f myhost.MBS.farm -h myUServerhost -p 5001
```

Usage

For all commands: ensure the Unwired Server node cluster database is running before you use this utility.
For start and stop commands: if you do not specify -host, -p, and -f options, all RSOEs for the Unwired Server node start. Otherwise, only those identified are started.
For the migrate command:
- The relayserver.properties file must exist and must use supported values for the relay server and RSOE. Ensure that no changes to the file occur while the file is being processed by this command.
- This migrate command is only available until relayserver.properties has been migrated for a specific relay server host.
- Once you migrate relayserver.properties, do not update it.