Register Relay Server (regRelayServer) Utility

Use <UnwiredPlatform_InstallDir>\Servers\UnwiredServer\bin\regRelayServer.bat to perform multiple relay server and RSOE administrative actions that can also be performed in Sybase Control Center.

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. Supported options include:
- -f <filename> – The input file and path.
export – Export the existing RSOE configuration into a file. Supported options include:
- -o <filename> – The output file and path.
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. Supported options include:
- -o <filename> – The output file and path.
- -h <name> – (Required) The name of the host.
- -p <port> – (Required) The port number used by the relay server.
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 1.6 rsconfig.xml file. Be aware that:
- 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 command is only valid until relayserver.properties has been migrated for a specific relay server host.
- Once you migrate relayserver.properties, do not update it.
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.
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.
- -h <name> – The name of the relay server host.
- -p <port> – (Required) The port number used by the relay server.
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. Supported options include:
- -f <name> – The relay server farm name.
- -h <name> – The name of the relay server host.
- -p <port> – (Required) The port number used by the relay server.
If you do not specify -h, -p, and -f options, all RSOEs for the Unwired Server node start. Otherwise, only those identified are started.
stop – Stop one or all RSOE processes for the Unwired Server node. Supported options include:
- -f <name> – The relay server farm name.
- -h <name> – The name of the Unwired Server host.
- -p <port> – (Required) The port number used by the Unwired Server.
If you do not specify -h, -p, and -f options, all RSOEs for the Unwired Server node stop. Otherwise, only those identified are stopped.

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 with the on the test host computer:
```
regrelayserver.bat exportRSconfig -o <path>\rsconfig.xml
```
2. The administrator transfers the file to the 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

Ensure the Unwired Server node cluster database is running before you use this utility.