Syntax: Interface Tools
AddHTTPInterface
Tool name:
AddHTTPInterface
Description:
Adds a HTTP interface on the specified adapter and port,
on the specified realm.
Usage:
runUMTool AddHTTPInterface -rname=<rname> -adapter=<adapter> -port=<port>
[optional_args]
Examples:
AddHTTPInterface -rname=nsp://localhost:8080 -adapter=0.0.0.0 -port=9090
-usewebsockets=true
Required arguments:
rname :
URL of the realm to which the realm node, on which the interface
will be created, is connected.
adapter :
Adapter (network card) to which interface will bind.
port : Port on which the interface will listen.
Optional Parameters:
usehttp1.1 :
Whether to use HTTP1.1.
usewebsockets :
Whether WebSockets are used.
ajaxactivedelay :
Time to wait (for additional events) before delivering to
Long Poll style subscribers.
ajaxidledelay :
Time to wait before returning from a Long Poll call if no events
have been received.
isnativecomet :
Whether JavaScript is enabled on the interface.
allowedorigins :
Set the Allowed Origins for CORS as a comma-separated list of origins
(use '*' to allow all), e.g. origin1,origin2,origin3
crossorigincredentials :
Whether to allow credentials header to be sent with CORS requests.
enablegzip :
Whether or not GZIP compression is enabled for javascript Long Poll
connections.
minimumbytes :
Set the minimum number of bytes in a packet before GZIP
is enabled (default 1000).
autostart :
Whether this interface will automatically be started when
the realm server starts.
advertise :
Set the current advertise status for this interface.
allowinterrealm :
Whether this interface is allowed to be used in
inter realm/cluster communication.
allowclientconnections :
Whether this interface can accept client connections or not.
allownio :
Whether NIO is enabled on the interface. Non-NIO support is deprecated.
authtimeout :
Set the number of milliseconds that the remote client
has to authenticate with the server.
backlog :
Set the number of connections to queue before the Operating System
will send rejects to the remote client.
threads :
Set the thread pool size handling the client connections.
selectthreads :
Set the number of select threads used by NIO.
adapteralias :
Set the interface's alias.
receivebuffersize :
Set the socket buffer size in bytes used by this
interface when receiving data.
sendbuffersize :
Set the socket buffer size in bytes used by this
interface when sending data.
username :
Your Universal Messaging server username.
password :
Your Universal Messaging server password.
AddHTTPSInterface
Tool name:
AddHTTPSInterface
Description:
Adds a HTTPS interface on the specified adapter and port,
on the specified server.
Usage:
runUMTool AddHTTPSInterface -rname=<rname> -adapter=<adapter> -port=<port>
[optional_args]
Examples:
AddHTTPSInterface -rname=nsp://localhost:8080 -adapter=0.0.0.0 -port=9090
-alias=myAlias
Required arguments:
rname :
URL of the realm to which the realm node, on which the interface
will be created, is connected.
adapter :
Adapter (network card) to which interface will bind.
port :
Port on which the interface will listen.
Optional Parameters:
alias :
Set the certificate name/alias that this interface will use to
select its certificate from a keystore with multiple entries.
keystore :
Set the keystore file that this interface uses to load the certificate.
kspassword :
Set the keystore password that this interface will use to
access the keystore file specified.
truststore :
Set the truststore file against which this interface will
validate the client certificate.
tspassword :
Sets the truststore password that the server uses to access the
trust store.
privatepassword :
Private key password; used so that the key can be loaded
from the key store.
ciphers :
Names of the ciphers enabled for use by this interface, as a
comma-separated list of ciphers, e.g. cipher1,cipher2,cipher3.
rndalg :
Set the SecureRandom algorithm to use for this interface.
rndprov :
Set the SecureRandom provider to use for this interface.
clientcertrequired :
Whether this interface requires SSL client authentication.
crl :
Set the certificate revocation list file name that the interface
should use to check incoming SSL connections.
crlclassname :
Name of the class used to validate a client connection.
provider :
Name of the JSSE provider to use for the interface.
usehttp1.1 :
Whether to use HTTP1.1.
usewebsockets :
Whether WebSockets are used.
ajaxactivedelay :
Time to wait (for additional events) before delivering
to Long Poll style subscribers.
ajaxidledelay :
Time to wait before returning from a Long Poll call if
no events have been received.
isnativecomet :
Whether JavaScript is enabled on the interface.
allowedorigins :
Set the Allowed Origins for CORS as a comma-separated list of origins
(use '*' to allow all), e.g. origin1,origin2,origin3.
crossorigincredentials :
Whether to allow credentials header to be sent with CORS requests.
enablegzip :
Whether or not GZIP compression is enabled for javascript
Long Poll connections.
minimumbytes :
Set the minimum number of bytes in a packet before GZIP
is enabled (default 1000).
autostart :
Whether this interface will automatically be started when
the realm server starts.
advertise :
Set the current advertise status for this interface.
allowinterrealm :
Whether this interface is allowed to be used in
inter realm/cluster communication.
allowclientconnections :
Whether this interface can accept client connections.
allownio :
Whether NIO is enabled on the interface. Non-NIO support is deprecated.
authtimeout :
Set the number of milliseconds that the remote client
has to authenticate with the server.
backlog :
Set the number of connections to queue before the Operating System
will send rejects to the remote client.
threads :
Set the thread pool size handling the client connections.
selectthreads :
Set the number of select threads used by NIO.
adapteralias :
Set the interface's alias.
receivebuffersize :
Set the socket buffer size in bytes used by this
interface when receiving data.
sendbuffersize :
Set the socket buffer size in bytes used by this interface
when sending data.
username :
Your Universal Messaging server username.
password :
Your Universal Messaging server password. AddSHMInterface
Tool name:
AddSHMInterface
Description:
Adds a shared memory interface with the specified path, buffer size and
timeout, on the specified server.
Usage:
runUMTool AddSHMInterface -rname=<rname> -path=<path> [optional_args]
Examples:
AddSHMInterface -rname=nsp://localhost:11000 -path=/dev/shm -buffer=1024
-timeout=2000 -autostart=true
Required arguments:
rname :
URL of the realm to which the realm node, on which the interface
will be created, is connected.
path :
The path where the shared memory files will be stored.
Optional Parameters:
buffer :
The size of the shared memory buffer which will be used. If not
provided a default value of 1024000 will be used.
timeout :
The timeout value that will be used for read / write. If not
provided a default value of 20000 will be used.
autostart :
Whether this interface will be automatically started when
the Realm Server starts. Default is set to true.
interrealmallow :
Sets whether this interface is allowed to be used
in inter realm / cluster communication. Default is set to false.
username :
Your Universal Messaging server username.
password :
Your Universal Messaging server password.AddSSLInterface
Tool name:
AddSSLInterface
Description:
Adds a SSL interface on the specified adapter and port,
on the specified server.
Usage:
runUMTool AddSSLInterface -rname=<rname> -adapter=<adapter> -port=<port>
[optional_args]
Examples:
AddSSLInterface -rname=nsp://localhost:8080 -adapter=0.0.0.0 -port=9090
-alias=myAlias
Required arguments:
rname :
URL of the realm to which the realm node, on which the interface
will be created, is connected.
adapter :
Adapter (network card) to which interface will bind.
port :
Port on which the interface will listen.
Optional Parameters:
alias :
Set the certificate name/alias that this interface will use to
select its certificate from a keystore with multiple entries.
keystore :
Set the keystore file that this interface uses to load the
certificate.
kspassword :
Set the keystore password that this interface will use to
access the keystore file specified.
truststore :
Set the truststore file against which this interface will
validate the client certificate.
tspassword :
Sets the truststore password that the server uses to access
the trust store.
privatepassword :
Private key password; used so that the key can be loaded
from the key store.
ciphers :
Names of the ciphers enabled for use by this interface,
as a comma-separated list of ciphers, e.g. cipher1,cipher2,cipher3.
rndalg :
Set the SecureRandom algorithm to use for this interface.
rndprov :
Set the SecureRandom provider to use for this interface.
clientcertrequired :
Whether this interface requires SSL client authentication.
crl :
Set the certificate revocation list file name that the interface
should use to check incoming SSL connections.
crlclassname :
Name of the class used to validate a client connection.
provider :
Name of the JSSE provider to use for the interface.
autostart :
Whether this interface will automatically be started when the
realm server starts.
advertise :
Set the current advertise status for this interface.
allowinterrealm :
Whether this interface is allowed to be used in
inter realm/cluster communication.
allowclientconnections :
Whether this interface can accept client connections.
allownio :
Whether NIO is enabled on the interface. Non-NIO support is deprecated.
authtimeout :
Set the number of milliseconds that the remote client has to
authenticate with the server.
backlog :
Set the number of connections to queue before the Operating System
will send rejects to the remote client.
threads :
Set the thread pool size handling the client connections.
selectthreads :
Set the number of select threads used by NIO.
adapteralias :
Set the interface's alias.
receivebuffersize :
Set the socket buffer size in bytes used by this
interface when receiving data.
sendbuffersize :
Set the socket buffer size in bytes used by this interface
when sending data.
username :
Your Universal Messaging server username.
password :
Your Universal Messaging server password. AddSocketInterface
Tool name:
AddSocketInterface
Description:
Adds a socket interface on the specified adapter and port,
on the specified server.
Usage:
runUMTool AddSocketInterface -rname=<rname> -adapter=<adapter> -port=<port>
[optional_args]
Examples:
AddSocketInterface -rname=nsp://localhost:8080 -adapter=0.0.0.0 -port=9090
-autostart=true
Required arguments:
rname :
URL of the realm to which the realm node, on which the interface
will be created, is connected.
adapter :
Adapter (network card) to which interface will bind.
port :
Port on which the interface will listen.
Optional Parameters:
autostart :
Whether this interface will automatically be started when the
realm server starts.
advertise :
Set the current advertise status for this interface.
allowinterrealm :
Whether this interface is allowed to be used in
inter realm/cluster communication.
allowclientconnections :
Whether this interface can accept client connections.
allownio :
Whether NIO is enabled on the interface. Non-NIO support is deprecated.
authtimeout :
Set the number of milliseconds that the remote client has
to authenticate with the server.
backlog :
Set the number of connections to queue before the Operating System
will send rejects to the remote client.
threads :
Set the thread pool size handling the client connections.
selectthreads :
Set the number of select threads used by NIO.
adapteralias :
Set the interface's alias.
receivebuffersize :
Set the socket buffer size in bytes used by this
interface when receiving data.
sendbuffersize :
Set the socket buffer size in bytes used by this interface
when sending data.
username :
Your Universal Messaging server username.
password :
Your Universal Messaging server password.DeleteInterface
Tool name:
DeleteInterface
Description:
Deletes the specified interface from the specified server.
Usage:
runUMTool DeleteInterface -rname=<rname> -interface=<interface>
[optional_args]
Examples:
DeleteInterface -rname=nsp://localhost:8080 -interface=interface0
Required arguments:
rname :
URL of the realm to which the realm node, from which the interface
will be deleted, is connected.
interface :
Name of the interface to be deleted.
Optional Parameters:
username :
Your Universal Messaging server username.
password :
Your Universal Messaging server password.ListInterfaces
Note: If you have only the Universal Messaging template applications installed, this tool
can print output in plaintext and xml format. To print output in json format, you must
have the realm server component installed.
Tool name:
ListInterfaces
Description:
Lists details of the interfaces on the specified server.
Usage:
runUMTool ListInterfaces -rname=<rname> [optional_args]
Examples:
ListInterfaces -rname=nsp://localhost:9000
Required arguments:
rname:
URL of the realm for which the details of all the interfaces will be listed.
Optional Parameters:
format:
Format to print output in (plaintext/xml/json).ModifyInterface
Tool name:
ModifyInterface
Description:
Modifies the specified interface on the specified server .
Usage:
runUMTool ModifyInterface -rname=<rname> -interface=<interface>
-command=<command> [optional_args]
Examples:
ModifyInterface -rname=nsp://localhost:9000 -interface=interface0
-command=modify -usewebsockets=true
Required arguments:
rname :
URL of the realm to which the realm node, on which the interface
will be modified, is connected.
interface :
Name of the interface to be modified.
command :
Whether the interface is to be stopped (STOP), started (START),
or have its fields modified (MODIFY).
Optional Parameters:
usehttp1.1 :
Whether to use HTTP1.1.
usewebsockets :
Whether WebSockets are used.
ajaxactivedelay :
Time to wait (for additional events) before delivering
to Long Poll style subscribers.
ajaxidledelay :
Time to wait before returning from a Long Poll call if no
events have been received.
isnativecomet :
Whether JavaScript is enabled on the interface.
allowedorigins :
Set the Allowed Origins for CORS as a comma-separated list of origins
(use '*' to allow all), e.g. origin1,origin2,origin3.
crossorigincredentials :
Whether to allow credentials header to be sent with CORS requests.
enablegzip :
Whether or not GZIP compression is enabled for javascript
Long Poll connections.
minimumbytes :
Set the minimum number of bytes in a packet before GZIP is
enabled (default 1000).
alias :
Set the certificate name/alias that this interface will use to
select its certificate from a keystore with multiple entries.
keystore :
Set the keystore file that this interface uses to load the certificate.
kspassword :
Set the keystore password that this interface will use to
access the keystore file specified.
truststore :
Set the truststore file against which this interface will
validate the client certificate.
tspassword :
Sets the truststore password that the server uses to access
the trust store.
privatepassword :
Private key password; used so that the key can be loaded
from the key store.
ciphers :
Names of the ciphers enabled for use by this interface,
as a comma-separated list of ciphers, e.g. cipher1,cipher2,cipher3.
rndalg :
Set the SecureRandom algorithm to use for this interface.
rndprov :
Set the SecureRandom provider to use for this interface.
clientcertrequired :
Whether this interface requires SSL client authentication.
crl :
Set the certificate revocation list file name that the interface
should use to check incoming SSL connections.
crlclassname :
Name of the class used to validate a client connection.
provider :
Name of the JSSE provider to use for the interface.
autostart :
Whether this interface will automatically be started when the
realm server starts.
advertise :
Set the current advertise status for this interface.
allowinterrealm :
Whether this interface is allowed to be used in
inter realm/cluster communication.
allowclientconnections :
Whether this interface can accept client connections.
allownio :
Whether NIO is enabled on the interface. Non-NIO support is deprecated.
authtimeout :
Set the number of milliseconds that the remote client has
to authenticate with the server.
backlog :
Set the number of connections to queue before the Operating System
will send rejects to the remote client.
threads :
Set the thread pool size handling the client connections.
selectthreads :
Set the number of select threads used by NIO.
adapteralias :
Set the interface's alias.
receivebuffersize :
Set the socket buffer size in bytes used by this
interface when receiving data.
sendbuffersize :
Set the socket buffer size in bytes used by this interface
when sending data.
username :
Your Universal Messaging server username.
password :
Your Universal Messaging server password.