Sending UDP commands to Transformer

Transformer includes a command-line tool that enables you to send administration commands to Transformer.

For information on the commands supported by Tranformer’s UDP interface, see UDP commands.

Contents:

Enabling Transformer’s UDP socket
Sending a UDP message to Transformer

Enabling Transformer’s UDP socket

Transformer’s UDP socket is disabled by default. To enable it, follow the steps below:

Set the port number for Transformer’s UDP socket:
global_config/overrides/servers/Transformer/etc/transformer.conf
```
udp-port       10002
```
[Optional] Bind Transformer’s UDP socket to a single network interface:
global_config/overrides/servers/Transformer/etc/transformer.conf
```
udp-interface  127.0.0.1
```
Restart Transformer:
```
./dfw start Transformer
```

For more information on the configuration items udp-interface and udp-port, see UDP configuration.

Sending a UDP message to Transformer

Use the udpsend utility, included with Transformer, to send UDP messages to Transformer.

udpsend

Issues a UDP command to Transformer.

The udpsend utility is located in the Transformer’s bin directory.

Syntax: udpsend [-s <server-ip>] [-p <server-port>] <message>

Parameter Type Default Description

Parameter	Type	Default	Description
server-ip	integer	127.0.01	[optional] The IP address of the machine to which the UDP message is to be sent. This must be an IP address, not a host name, and must match the IP address specified for Transformer’s optional configuration item udp-interface (if specified).
server-port	integer	10001	[optional] Port on which the Transformer listens for UDP messages. This must be the port number specified in the udp-port option in Transformer’s `transformer.conf` file.
message	string		Message to send. This can include spaces. Any quotation marks in the message must be escaped to prevent the shell’s interpreter from stripping them.

server-ip

integer

127.0.01

[optional] The IP address of the machine to which the UDP message is to be sent. This must be an IP address, not a host name, and must match the IP address specified for Transformer’s optional configuration item udp-interface (if specified).

server-port

integer

10001

[optional] Port on which the Transformer listens for UDP messages. This must be the port number specified in the udp-port option in Transformer’s transformer.conf file.

message

string

Message to send. This can include spaces. Any quotation marks in the message must be escaped to prevent the shell’s interpreter from stripping them.

Example: udpsend -s transformer.example.com -p 10002 memory_write

For more information on the syntax of individual UDP messages, see UDP commands.

See also: