Technical information

RMS NetLinx Virtual Device API
137
RMS Enterprise - NetLinx Programmer’s Guide
RMS Client Configuration Query Commands
RMS Client Configuration Instruction Commands (Cont.)
Command Description
CONFIG.CLIENT.NAME-
<name>
This command will set the default system name displayed in RMS when this
system comes online.
CONFIG.CLIENT.HEARTBEAT-
<#> (# : number of seconds)
This command will set the number of seconds to wait between client pending
message retrieval requests issued to the RMS server. These requests are
also used to let the server know that the system is still alive and online.
Please be aware that the higher the frequency of these requests the greater
the load placed on the RMS server. This frequency can be adjusted higher to
optimize server performance.
Note: The default heartbeat (and the minimum heartbeat interval allowed)
interval is 15 seconds.
CONFIG.SERVER.TEST This command can be issued to perform a test connection to the RMS server.
This test can help identify if the configured server URL and access creden-
tials are configured property.
Note: This is the same function as using the TEST button on the RMS web
configuration page.
CONFIG.LOG.LEVEL.DEFAULT-<1|2|3|4>
CONFIG.LOG.LEVEL.DEFAULT-ERROR
CONFIG.LOG.LEVEL.DEFAULT-WARNING
CONFIG.LOG.LEVEL.DEFAULT-INFO
CONFIG.LOG.LEVEL.DEFAULT-DEBUG
This command will set the default logging level for the RMS client.
Note: A production system should only operate in the ERROR (4) level.
Lower logging levels will decrease the performance of the NetLinx system.
This setting is persisted across reboots and is used to set the default runtime
logging level for RMS at system startup.
Available levels:
• 1 - ERROR
• 2 - WARNING
•3 - INFO
•4 - DEBUG
RMS Client Configuration Query Commands
Query Command Description / Response Command
?CONFIG.CLIENT.ENABLED-
<true|false>
This query command determines the enabled state of the RMS client system.
Response command format:
CONFIG.CLIENT.ENABLED-<true|false>
?CONFIG.SERVER.URL This query command determines the URL used to access the RMS server.
Response command format:
CONFIG.SERVER.URL-<url>
?CONFIG.SERVER.
RETRY.INTERVAL
This query command determines the number of seconds to wait between connection attempts
to the RMS server.
This settings is used during the GREEDY connection attempt period.
Response command format:
CONFIG.SERVER.RETRY.INTERVAL-<#>
(# : number of seconds)
?CONFIG.SERVER.
RETRY.COUNT
This query command determines the number of attempts made to establish a connection to the
RMS server before the connection state switched to the SETBACK connection attempt period.
Response command format:
CONFIG.SERVER.RETRY.COUNT-<#>
(# : number of attempts)
?CONFIG.SERVER.SETBACK.
RETRY.INTERVAL
This query command determines the number of seconds to wait between connection attempts
to the RMS server while in the SETBACK connection attempt period.
This should be set to a higher delay time than the GREEDY connection attempt interval.
Response command format:
CONFIG.SERVER.SETBACK.RETRY.INTERVAL-<#>
(# : number of seconds)