Multitech MultiConnect rCell MTR-H5 Instruction Manual

MultiConnect R
rCell API
Developer Guide

Copyright and Technical Support
MultiConnect R
rCell API Developer Guide
Models: MTR-H5, MTR-H6, MTR-G3, MTR-EV3, MTR-C2 (Software Version 3.0.9)
S000576, Version 1.0
Copyright
This publication may not be reproduced, in whole or in part, without prior expressed written permission from Multi-Tech Systems,
Inc. All rights reserved.
Copyright c 2014, by Multi-Tech Systems, Inc.
Multi-Tech Systems, Inc. makes no representations or warranties with respect to the contents hereof and specifically disclaims any
implied warranties of merchantability or fitness for any particular purpose. Furthermore, Multi-Tech Systems, Inc. reserves the right
to revise this publication and to make changes from time to time in the content hereof without obligation of Multi-Tech Systems,
Inc. to notify any person or organization of such revisions or changes. Check Multi-Techs web site for current versions of our product
documentation.
Revision History
Revision Date Author Description
0.1 1/4/13 Jason Reiss Initial Document
0.2 1/30/13 Jason Reiss Auto-Gen Script and Reference Updates
0.3 2/27/13 Jason Reiss Removed Unused Elements
0.4 3/11/13 Jason Reiss Updated Logout Instructions
0.5 6/1/13 Sean Godinez Updated Auto-Gen Scripts and Document Content
0.6 6/6/13 Sean Godinez Added Statistics and Help Section
0.7 11/21/13 Sean Godinez Updated for rCell v3.0.9
0.8 12/2/13 Sean Godinez Added ’DRAFT’ Watermark
0.9 12/4/13 Jason Reiss Updated document layout
1.0 1/15/14 Sean Godinez Release
Trademarks
Multi-Tech Registered Trademarks: MultiConnect, Multi-Tech, and the Multi-Tech logo.
All other products and technologies are the trademarks or registered trademarks of their respective holders.
Contacting Multi-Tech
Knowledge Base
The Knowledge Base provides immediate access to support information and resolutions for all Multi-Tech products.
Visit http://www.multitech.com/kb.go.
Installation Resources
To download manuals, firmware, and software, visit http://www.multitech.com/setup/product.go.
Support Portal
To create an account and submit a support case directly to our technical support team, visit: https://support.multitech.com.
Technical Support
Business Hours: M-F, 9am to 5pm CST
Country By Email By Phone
Europe, Middle East, Africa: [email protected] +(44) 118 959 7774
U.S., Canada, all others: [email protected] [phone] or [phone]
World Headquarters
Multi-Tech Systems, Inc.
2205 Woodale Drive
Mounds View, MN 55112
United States
Phone: [phone] or 763-785-3500
Fax: [phone]
Warranty
To read the warranty statement for your product, please visit: http://www.multitech.com/warranty.go.
2Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide

CONTENTS
Contents
1 Introduction 5
2 Requests 5
2.1 MakingRequests ........................................... 5
2.2 LoggingIn............................................... 6
2.3 LoggingOut.............................................. 7
2.4 WhoAmI ............................................... 7
2.5 PassingJSONData.......................................... 8
2.6 SavingChanges ............................................ 8
2.7 Selecting a Version of an API Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.8 ElementDescriptions ......................................... 8
2.9 URIParameters ............................................ 9
3 Responses 10
3.1 Success................................................. 10
3.1.1 Successresponseformat ................................... 10
3.2 Error.................................................. 10
3.2.1 Errorresponseformat..................................... 10
3.2.2 ErrorCodes .......................................... 11
4 Commands and Collections 12
4.1 Commands............................................... 12
4.2 Collections............................................... 13
4.3 CollectionDetails ........................................... 13
4.3.1 autoDialout ......................................... 13
4.3.2 autoReboot ......................................... 14
4.3.3 bluetooth........................................... 14
4.3.4 brand ............................................. 14
4.3.5 ddns ............................................. 15
4.3.6 devices ............................................ 15
4.3.7 dhcp ............................................. 16
4.3.8 dns .............................................. 16
4.3.9 filters ............................................. 16
4.3.10 gccp ............................................. 17
4.3.11 gps .............................................. 17
4.3.12 greTunnels .......................................... 18
4.3.13 ipPipes ............................................ 18
4.3.14 ipsecTunnels ......................................... 19
4.3.15 lan .............................................. 20
4.3.16 nat .............................................. 20
4.3.17 networks ........................................... 21
4.3.18 ppp .............................................. 21
4.3.19 remoteAccess ........................................ 23
4.3.20 remoteManagement ..................................... 23
4.3.21 routes ............................................ 24
4.3.22 serial ............................................. 24
4.3.23 sntp ............................................. 24
4.3.24 syslog ............................................ 25
4.3.25 system ............................................ 25
4.3.26 users ............................................. 26
4.3.27 wifi .............................................. 27
Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide 3

CONTENTS
5 Statistics 28
5.1 dns .................................................. 29
5.2 gps .................................................. 29
5.3 gre .................................................. 29
5.4 ipsec ................................................. 30
5.5 lan .................................................. 30
5.6 modbus ................................................ 31
5.7 ppp .................................................. 31
5.8 serial ................................................. 32
5.9 service ................................................ 32
5.10 wlan ................................................. 33
6 Appendix 34
6.1 RESTArchitecture .......................................... 34
6.2 JSONData .............................................. 34
6.3 Examples................................................ 34
6.3.1 UsingCurltologin...................................... 34
6.3.2 UsingCurltoenablePPP................................... 35
6.3.3 Using Curl to add a firewall DNAT rule . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.3.4 Using Curl to add a firewall filter rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.3.5 Using Curl to delete a firewall filter rule by name . . . . . . . . . . . . . . . . . . . . . . 37
6.3.6 Using Curl to delete a firewall filter rule by index . . . . . . . . . . . . . . . . . . . . . . 37
6.3.7 Using Curl to save current configurations and reboot . . . . . . . . . . . . . . . . . . . . 37
4Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide

2 REQUESTS
1 Introduction
The MultiConnect R
rCell is a cellular router that uses a RESTful JSON API for managing configurations, polling
statistics, and issuing commands. This document provides information on the design, patterns, and methods
within the rCell API. The Appendix of this document has additional information for those unfamiliar with the
REST architecture or JSON data format. For additional examples and use-cases, explore the JavaScript within
the rCell website, specifically https://[rcell ip]/js/api.js.
2 Requests
All API requests will be directed to the https://[rcell ip]/api url. The majority of requests follow the same RESTful
pattern. Following the api url will be a collection name or a command directive. For example, information on
the current DHCP settings can be found in the DHCP collection at https://[rcell ip]/api/dhcp. A full list of
collections and commands can be found in section 4. For all examples in this document, the rCell’s IP address is
192.168.2.1.
2.1 Making Requests
The RESTful interface allows users to retrieve data, add data, update data, and delete data using call methods:
GET, POST, PUT and DELETE, respectively. These methods can be set in the HTTP header, or they can be
set in the URI using the key: method. Using the URI parameter method is a useful way to execute RESTful
requests through a web browser. Additional URI parameters can be found in section 2.9 URI Parameters.
All API requests return a JSON object. The JSON response will always contain the members code and status.
The status member indicates a high-level result of the request and has two possible values: success and fail. The
code member is an HTTP response code describing the outcome of the API result. For a full list of response
code values, see section 3.2.2 Error Codes.
If an API call was successful, it may contain the member: result. This member contains data that was either
requested or data that was generated as part of the API request. If an API call was unsuccessful, the JSON
response will contain the member error. This member is a short description of the failure.
Example: Retrieving the current DHCP setting using the method URI parameter.
1GET https://192.168.2.1/api/dhcp?method=GET
2
3Status:HTTP /1.1 200 OK
4{
5" code " :200 ,
6"result" :{
7"defaultGateway" :"192.168.2.1",
8"domain" :"" ,
9"enabled" :true,
10 "fixedAddresses" :[
11 {
12 " ip " :"192.168.2.15",
13 " mac " :"00 :1 A:12 :19 :3 F :60"
14 }
15 ],
16 " le aseT ime " :86 40 0 ,
17 "leases" :[
18 {
19 " ex pirat ion " :70 35 9 ,
20 " ho stN ame " :" my - pc " ,
21 " ip " :"192.168.2.103",
Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide 5

2 REQUESTS
22 " mac " :"00 :3 a:83 :10 :24 :DC "
23 }
24 ],
25 " ma xLea ses " :200 ,
26 "options" :[" dhcp - au thorita tive " ],
27 " ra nge End " :"192.168.2.254",
28 " ra ngeSt art " :"192.168.2.100",
29 " su bnetAdd ress " :"192.168.2.0",
30 " su bnetM ask " :"255.255.255.0"
31 },
32 "status" :"success"
33 }
The API allows requests to path to specific elements or groups of embedded elements. For example, if a user
only wanted to know if DHCP was enabled, they could make the request: https://[rcell ip]/api/dhcp/enabled.
Example: Path to an element within the DHCP collection.
1GET https://192.168.2.1/api/dhcp/enabled
2
3Status:HTTP /1.1 200 OK
4{
5" code " :200 ,
6"result" :true,
7"status" :"success"
8}
Accessing objects within an array can be done using the index of the desired object in the path. Some collections
support using an object’s unique identifier in place of the object’s index; generally, this unique identifier is a member
called name or guid. For example, suppose an rCell was configured with a GRE tunnel named MyGreTunnel, and
a user wanted to know the IP address of the remote end point of that tunnel. The user could make a RESTful
GET request to https://[rcell ip]/api/greTunnels/MyGreTunnel/remoteIp.
Example: Path to an element within an object in an array using the object’s unique identifier.
1GET https://192.168.2.1/api/greTunnels/MyGreTunnel/remoteIp
2
3Status:HTTP /1.1 200 OK
4{
5" code " :200 ,
6"result" :"166.184.38.73",
7"status" :"success"
8}
2.2 Logging In
To use the API, a user must be authorized and have equal or greater privileges than the API call they are
invoking. A user can login with valid credentials by passing their username and password to the login URL (
https://192.168.2.1/api/login ) either as URI parameters or within a JSON object. The following call will
login the user admin, and return the session information including an authorized token. The API attempts to
cache the token as a cookie in the user’s web browser for authorizing future calls. As an alternative to using a
browser cookie, this token can be passed as a URI parameter using the key: token. Additional URI parameters
can be found in section 2.9 URI Parameters.
Example: Login using username ’admin’ and password ’admin’.
1GET https://192.168.2.1/api/login?username=admin&password=admin
2
3Status:HTTP /1.1 200 OK
6Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide

2 REQUESTS
4{
5" code " :200 ,
6"result" :{
7"address" :"192.168.2.103",
8" pe rmiss ion " :" ad min " ,
9" port " :"59486",
10 " ti mest amp " :"2 :58 :40 :389",
11 " to ke n " :"B7083A0B14C0F0BEFFBED89B99EFBC",
12 " user " :" admi n "
13 },
14 "status" :"success"
15 }
A token may timeout due to inactivity. The timeout configuration is in the rCell’s Remote Access collection (
api/remoteAccess/timeoutSeconds ). There are two authorizers, one for website access and one for non-web
browser usage, such as command line utilities like wget and curl. The same user can not be logged in through the
same authorizer from more than one IP address. If a user is already logged in and attempts to login from another
IP address, a conflict error will be returned. A user can logout from any IP address with the proper credentials.
2.3 Logging Out
The logout call requires that the caller has equal or greater permissions than the user they are logging out. If a
user wants to logout, they can pass their authorized token in the following call:
Example:.https://192.168.2.1/api/logout?token=ABCDEF1234567890ABCDEF12345678
To logout another user (guest), a user with equal or greater permissions can use their token to authorize the call:
Example: https://192.168.2.1/api/logout?logoutUser=guest&token=ABCDEF1234567890ABCDEF12345678
Credentials can also be passed with the logout command to authorize the logout call of another user:
Example: https://192.168.2.1/api/logout?username=admin&password=admin&logoutUser=guest
2.4 Who Am I
At any point, a user can retrieve their session information using the following API call:
Example:
1GET https://192.168.2.1/api/whoami
2
3Status:HTTP /1.1 200 OK
4{
5" code " :200 ,
6"result" :{
7"address" :"192.168.2.103",
8" pe rmiss ion " :" ad min " ,
9" port " :"59486",
10 " ti mest amp " :"2 :58 :40 :389",
11 " to ke n " :"B7083A0B14C0F0BEFFBED89B99EFBC",
12 " user " :" admi n "
13 },
14 "status" :"success"
15 }
Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide 7

2 REQUESTS
2.5 Passing JSON Data
Data can be sent to the rCell by passing a JSON object as the request content or by passing a JSON object in
the URI parameter: data. As an example, the following request uses a RESTful PUT call to edit the current
DHCP configurations by passing in a JSON object with the enabled member set to false
Example: To disable DHCP, send the following request:
https://192.168.2.1/apidhcp?data={"enabled":false}&method=PUT
2.6 Saving Changes
A call to save ( https://[rcell ip]/command/save ) will write current changes to the device settings. Commands
are executed using RESTful POST requests. A full list of commands can be found in section 4.1 Commands.
Example: To save the current changes, send a request to:
https://192.168.2.1/api/command/save?method=POST
2.7 Selecting a Version of an API Call
As the rCell API evolves and new features are added, backwards compatibility can be maintained by setting the
desired API version within the request. The API version can be set through the version URI parameter, or through
the URL path by subscripting the version number with the letter ’v’. If a request has only one version, this value
is ignored.
Example: To use version 1 of the API, all API requests would be made through https://[rcell ip]/api/v1/[request path]
or https://[rcell ip]/api/[request path]?version=1. If a version is not specified, the request will be executed using
the latest API version.
2.8 Element Descriptions
The API provides documentation on collections and elements through https://[rcell ip]/api/help. For a description
of an element or group of elements, use the path to retrieve the data and prepend help to the collection component.
For example, if a user wanted information on the DHCP element enabled ( https://[rcell ip]/api/dhcp/enabled
), they could submit a RESTful GET request to https://[rcell ip]/api/help/dhcp/enabled.
Example: Retrieving a description of the DHCP member enabled.
1GET https://192.168.2.1/api/help/dhcp/enabled
2
3Status:HTTP /1.1 200 OK
4{
5" code " :200 ,
6"result" :{
7"dhcp_enabled" :" en ab le or d is abl e DHCP ser ver ( de fa ult :true) :BOOL"
8},
9"status" :"success"
10 }
The API also provides a separate set of help descriptions that are used by the rCell website for context-sensitive
help-on-hover content. The path to each description follows the menu and category embedding of the rCell
website.
8Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide

2 REQUESTS
Example: Retrieving a more human-readable description of the DHCP member enabled.
1GET https://192.168.2.1/api/help/Setup/DHCP/Settings/Enabled
2
3Status:HTTP /1.1 200 OK
4{
5" code " :200 ,
6"result" :{
7"Setup_DHCP_Settings_Enabled" :" Che ck to use a DHCP s erv er on ne tw ork "
8},
9"status" :"success"
10 }
2.9 URI Parameters
URI parameters are reserved keys that are used to modify the functionality of API calls, override HTTP header
values, and bundle multiple API requests together. Below is a list of available URI keys and descriptions of their
functionality.
URI Key Description
fields Applies a RESTful action to multiple collections/elements. Each request path is separated by a comma. Requested
data within a field is returned using the path by replacing ’/’ characters with ’ ’ characters.
Example:
1GET https://192.168.2.1/api?fields=lan/ip,serial/client/enabled&method=GET
2
3Status:HTTP /1.1 200 OK
4{
5" code " :200 ,
6"result" :{
7"lan_ip" :"192.168.2.1",
8"serial_client_enabled" :false
9},
10 "status" :"success"
11 }
method Allows passing RESTful action (GET, PUT, POST, & DELETE) in URI. This overrides the HTTP header method.
See section 2.1
apply Allows the request to be applied at the given timestamp without restarting. Currently, only apply=now is
supported.
token Authorized Login Token. This can be passed to authorize an API call. A token is returned upon a successful
login. If a user is logged in, the whoami request will return the users current token. See section 2.2
inactivity Allows requests to be made without bumping the user’s token expiration date. This is useful for automated polling
loops that still want to allow a user to timeout due to inactivity (inactivity=true)
session Reserved for internal use. This member will be overwritten.
data Allows passing a JSON Object in the URI.
default This option will retrieve the factory defaults of a collection when using a RESTful GET request, and set a collection
to its factory defaults when using a RESTful PUT request. (default=true)
version Sets the API version to use during the request. See section 2.7
username User’s login name. Used for logging into the API. See section 2.2
password User’s login password. Used for logging into the API. See section 2.2
logoutUser User to be logged out. Only used on api/logout request. See section 2.3
Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide 9

3 RESPONSES
3 Responses
All API requests return a JSON object. The JSON response will always contain the members code and status.
The status member indicates a high-level result of the request and has two possible values: success and fail. The
code member is a HTTP response code describing the outcome of the API result. Certain actions or events in
the API may result in a URL redirect, such as trying to access API methods when a user is not logged in. In these
situations, the JSON response may contain the member referrer.
3.1 Success
In the event of a successful request a success message will be returned with the member status set to success
and code set to 200. If data is sent in the response it will be found in the result field.
3.1.1 Success response format
1Status:HTTP /1.1 200 OK
2{
3" code " :200 ,
4"status":"success",
5"result":{[JSON Obj ect or Arr ay ]}
6}
3.2 Error
An error response will always contain the members: code,status, and error. If an error is encountered during a
request, the API will halt processing and return an error message. This means that a request with multiple errors
will receive a response containing error information on only the first error that the API finds during the processing
of that request.
3.2.1 Error response format
1Status:HTTP/1.1 [Er ro r Cod e ] [ Er ror M es sag e ]
2{
3" code " :[Err or Co de ],
4"status":" fai l ",
5" er ro r ":"[Error Me ss age ]"
6}
10 Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide

3 RESPONSES
3.2.2 Error Codes
Code Error
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
405 Method Not Allowed
406 Not Acceptable
408 Request Timeout
409 Conflict
500 Internal Server Error
501 Not Implemented
Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide 11

4 COMMANDS AND COLLECTIONS
4 Commands and Collections
4.1 Commands
The API supports a set of special actions through the Command URL ( api/command ). To execute a command,
the call method must be a POST request. A RESTful GET request will return an array of all of the commands.
Command Description Parameters
firmware upgrade Upgrades rCell firmware upgrade file
legacy sync Synchronizes legacy configurations
restart Restarts rCell device
revert Reverts all changes since the last save
save Saves the current configurations
ddns update Pushes DDNS information to the configured DDNS server
download config Downloads the current configurations
loglvl debug Sets the API’s logging level to DEBUG
loglvl info Sets the API’s logging level to INFO
loglvl trace Sets the API’s logging level to TRACE
loglvl warning Sets the API’s logging level to WARNING
radio cmd Send a string directly to the cellular radio
1{
2" at " :[AT COMMAND],
3"timeout":[milliseconds]
4}
JSON Data
remove icon Deletes user-supplied icon
remove image Deletes user-supplied image
remove logo Deletes user-supplied logo
reset bluetooth Resets the Bluetooth hardware
reset modem Resets the cellular radio hardware
reset wifi Resets the WiFi hardware
restore defaults Resets the rCell with User-Defined defaults if set, otherwise factory
restore factory Resets the rCell with factory defaults
clean oem Clears User-Defined default configurations returning factory default
save oem Saves current configurations as factory/OEM defaults
save restart Saves the current configurations and restarts the rCell
telit upgrade Upgrades the Telit radio firmware upgrade file
upload config Uploads and sets new configurations configuration file
upload icon Uploads and sets new icon icon file
upload image Uploads and sets new image image file
upload logo Uploads and sets new logo logo file
12 Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide

4 COMMANDS AND COLLECTIONS
4.2 Collections
Collections are groups of related elements used to configure a service or capability. There are four main actions
that can be performed on a collection: get, edit, add, and delete. These actions align with RESTful calls: GET,
PUT, POST, and DELETE.
Collection Type Description
autoDialout OBJECT allow use of cellular modem directly from serial port
autoReboot OBJECT cause the device to automatically reboot
bluetooth OBJECT allow a device to connect via Bluetooth
brand OBJECT customize icons, images and support information for re-branded rCell
ddns OBJECT dynamic domain name server update remote server when ip address changes
devices ARRAY list of saved devices
dhcp OBJECT DHCP settings
dns OBJECT dns forwarding feature
filters ARRAY list of firewall filters
gccp OBJECT settings for gccp application
gps OBJECT gps service settings
greTunnels ARRAY list of GRE tunnels
ipPipes ARRAY list of configured IP Pipes
ipsecTunnels ARRAY list of IPsec tunnels
lan OBJECT lan interface settings
nat ARRAY list of NAT rules for advanced firewall settings
networks ARRAY list of networks to be used in setting filters and tunnels
ppp OBJECT PPP settings
remoteAccess OBJECT settings to configure remote access of device
remoteManagement OBJECT remote management settings
routes ARRAY list of static routes
serial OBJECT settings for serial port
sntp OBJECT settings for clock synchronization between computer systems
syslog OBJECT settings for syslog support
system OBJECT system attributes
users ARRAY users collection for authentication
wifi OBJECT settings for wi-fi services
4.3 Collection Details
4.3.1 autoDialout
Description: allow use of cellular modem directly from serial port : OBJECT
Element Type Description
eia BOOL enable or disable EIA standard signal characteristics (default:false)
enabled BOOL enable or disable this feature (default:true)
inactivity UINT set inactivity timeout in seconds set to 0 to disable (default:0)
login BOOL enable or disable login requirement (default:true)
port UINT configure port to use when connecting to rCell (default:5000)
raw BOOL enable or disable raw mode (default:false)
Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide 13

4 COMMANDS AND COLLECTIONS
4.3.2 autoReboot
Description: cause the device to automatically reboot : OBJECT
Element Type Description
hour UINT based on the mode as either Hour of Day or Hours from Boot
mode STRING DISABLED, TIME, or TIMER (default: DISABLED)
4.3.3 bluetooth
Description: allow a device to connect via Bluetooth : OBJECT
Element Type Description
device OBJECT bluetooth settings of connected device
address STRING mac address of bluetooth device
name STRING name of bluetooth device
devices ARRAY list of bluetooth devices found during last scan
address STRING mac address of device
name STRING label for device
enabled BOOL enable or disable bluetooth feature (default:false)
savedDevices ARRAY list of saved bluetooth devices
address STRING mac address of device
friendlyName STRING user defined name of device
name STRING scanned name of device
4.3.4 brand
Description: customize icons, images and support information for rebranded rCell : OBJECT
14 Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide

4 COMMANDS AND COLLECTIONS
Element Type Description
address1 STRING address of company for support contact
address2 STRING address of company for support contact
city STRING city of company for support contact
companyName STRING company name for support contact
country STRING country of company for support contact
fax STRING fax number of company for support contact
icon STRING image file name for custom favicon in browser
image STRING image file name for custom image on support page
links ARRAY list of web links for customer support
label STRING label for hyperlink
text STRING text of hyperlink
url STRING url of hyperlink
logo STRING image file name for custom logo in header and on login page
phoneNumbers ARRAY list of phone numbers for customer support
label STRING phone number label
number STRING phone number
showOnDashboard BOOL enable or disable display of brand information on support page (default:false)
state STRING state or province of company for support contact
website STRING website of company for support contact
zipCode STRING zipCode of company for support contact
4.3.5 ddns
Description: dynamic domain name server update remote server when ip address changes : OBJECT
Element Type Description
authentication OBJECT authentication information
password STRING password for ddns account
username STRING username for ddns account
checkIp OBJECT configure remote server to connect to
enabled BOOL enable or disable check IP feature (default:true)
port UINT port on remote server (default:80)
server STRING domain name of remote server (default:’checkip.dyndns.org’)
domain STRING registered domain name
enabled BOOL enable or disable DDNS feature (default:false)
port UINT servers port number (default:80)
retriesMax UINT maximum number of tries to connect before failing (default:5)
server STRING name of server with currently assigned IP address (default:’members.dyndns.org’)
system STRING system registration type, DYNAMIC or CUSTOM (default:DYNAMIC)
updateInterval UINT number of days between forced update (default:28)
4.3.6 devices
Description: list of saved devices : ARRAY
Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide 15

4 COMMANDS AND COLLECTIONS
Element Type Description
friendlyName STRING friendly name to associate with device
mac STRING mac address of device
name STRING name of device
4.3.7 dhcp
Description: DHCP settings : OBJECT
Element Type Description
defaultGateway STRING default gateway of network (default:’192.168.2.1’)
domain STRING network domain name
enabled BOOL enable or disable DHCP server (default:true)
fixedAddresses ARRAY list of fixed addresses
ip STRING ip address to assign to client
mac STRING mac address of client
leaseTime UINT number of seconds leases are issued for (default:86400)
leases ARRAY current leases issued by DHCP server
maxLeases UINT maximum number of leases that can be issued (default:200)
options ARRAY an array of additional dhcp options
rangeEnd STRING end ip address of dhcp lease range (default:’192.168.2.254’)
rangeStart STRING start ip address of dhcp lease range (default:’192.168.2.100’)
subnetAddress STRING subnet of network (default:’192.168.2.0’)
subnetMask STRING mask of network (default:’255.255.255.0’)
4.3.8 dns
Description: dns forwarding feature : OBJECT
Element Type Description
enabled BOOL enable or disable dns server (default:true)
options ARRAY an array of additional dns options
primary STRING static ip address of primary dns server
secondary STRING static ip address of secondary dns server
4.3.9 filters
Description: array of firewall filters : ARRAY
16 Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide

4 COMMANDS AND COLLECTIONS
Element Type Description
action STRING action of filter: ACCEPT, REJECT, LOG or DROP
description STRING filter description
direction STRING direction of traffic: INGRESS or EGRESS
dstIp STRING ip address of destination or ’ANY’
dstMask UINT network mask of destination (0-32)
dstPortEnd STRING end of destination port range or ’ANY’
dstPortStart STRING beginning of destination port range or ’ANY’
enabled BOOL enable or disable this filter
name STRING name of filter
protocol STRING filter protocol, TCP, UDP or TCP/UDP
srcIp STRING ip address of source or ’ANY’
srcMac STRING mac address of source
srcMask UINT network mask of source (0-32)
srcPortEnd STRING end of source port range or ’ANY’
srcPortStart STRING beginning of source port range or ’ANY’
4.3.10 gccp
Description: settings for gccp application : OBJECT
Element Type Description
enabled BOOL enable or disable gccp feature (default:false)
port UINT port to open on rCell for gccp connection (default:5000)
4.3.11 gps
Description: gps service settings : OBJECT
Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide 17

4 COMMANDS AND COLLECTIONS
Element Type Description
client OBJECT settings for gps client
enabled BOOL enable or disable gps client (default:false)
password STRING password to use when connecting to remote server
port UINT port to connect on remote server (default:5445)
protocol STRING protocol to when making connection, UDP or TCP (default:TCP)
remoteHost STRING ip address of remote server (default:’192.168.2.3’)
nmea OBJECT specify what nmea sentences to send and how often to send them
gga BOOL global positioning system fix data (default:true)
gll BOOL geographic position, latitude/longitude (default:true)
gsa BOOL GPS DOP and active satellites (default:true)
gsv BOOL GPS Satellites in view (default:true)
id STRING optional id to attach to messages
idPrefix STRING optional prefix to attach to messages
interval UINT interval in seconds to send gps information (default:10)
rmc BOOL recommended minimum specific GPS/Transit data (default:true)
vtg BOOL track made good and ground speed (default:true)
server settings for gps server
dumpSerialPort BOOL output gps information to serial port (default:false)
enabled BOOL enable or disable gps server on rCell (default:false)
password STRING password needed for client to connect to server
port UINT port to for server to listen on (default:5445)
4.3.12 greTunnels
Description: list of gre tunnels : ARRAY
Element Type Description
description STRING description for gre tunnel
enabled BOOL enable or disable this tunnel
name STRING name of tunnel
remoteIP STRING remote ip of tunnel
routes ARRAY list or tunnel routes
ip STRING ip address of route
mask STRING network mask of route (0-32)
ttl UINT time to live (0-255)
4.3.13 ipPipes
Description: list of configured IP Pipes : ARRAY
18 Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide

4 COMMANDS AND COLLECTIONS
Element Type Description
activation STRING signal to start connection
description STRING summary of the pipe
enabled BOOL enable or disable this pipe
ip STRING ip address of the remote end of the pipe
mode STRING determines whether local end point is a client or server or both
name STRING label of the pipe
port UINT port number of the remote end point when in CLIENT mode, or listening port
when in SERVER mode
protocol STRING the internet protocol to use (UDP or TCP)
secondaryIp STRING ip address of the second server to try if a connection can not be made to the
first. Requires CLIENT mode
secondaryPort STRING port of the second server to try if a connection can not be made to the first.
Requires CLIENT mode
sequence STRING the character or stream of characters that signal the pipe to terminate. Requires
termination mode to be SEQUENCE
source STRING the source defines the local device to convert data to and from ip communication
termination STRING the mode for terminating the pipe
timeoutSeconds UINT the amount of seconds of inactivity allowed before the pipe will close. Requires
termination mode to be TIMEOUT
type STRING the type of pipe. currently only serial-to-ip and bluetooth-to-ip are supported
4.3.14 ipsecTunnels
Description: array of IPsec tunnels : ARRAY
Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide 19

4 COMMANDS AND COLLECTIONS
Element Type Description
authMethod STRING how the two security gateways should authenticate each other
compression BOOL whether IPComp compression of content is proposed on the connection
description STRING a note about the tunnel
enabled BOOL enable or disable this tunnel
encryptMethod STRING IKE encryption/authentication algorithm to be used for phase 1 and phase 2 of
the connection
ikelife UINT how long the keying channel of a connection should last before being renegotiated
(hours)
keylife UINT how long a particular instance of a connection should last, from successful nego-
tiation to expiry (hours)
localId STRING how the local participant should be identified for authentication
name STRING label of tunnel
perfectForwardSecrecy BOOL whether Perfect Forward Secrecy of keys is desired on the connection’s keying
channel
phase1 STRING [OPTIONAL] specific algorithms to use for phase 1. Format: cipher-hash;group.
Example: aes128-sha1;modp1024
phase2 STRING [OPTIONAL] specific algorithms to use for phase 2. Format: cipher-hash;group.
Example: aes128-sha1;modp1024
psk STRING pre-shared key
remoteId STRING how the remote participant should be identified for authentication
remoteNetwork STRING saved network of remote end of tunnel
remoteNetworkIp STRING network at the remote end of tunnel
remoteNetworkMask UINT network mask at the remote end of tunnel
remoteWanIp STRING public ip of remote end of tunnel
retries UINT number of attempts that should be made to negotiate a connection, or a replace-
ment for one, before giving up
type STRING type of ipsec tunnel: Internet Key Exchange is currently the only type supported
uid BOOL whether or not tunnel end points should be identified for authentication
4.3.15 lan
Description: lan interface settings : OBJECT
Element Type Description
gateway STRING default gateway (default:192.168.2.1)
ip STRING ip address (default:192.168.2.1)
mask STRING subnet mask (default:255.255.255.0)
4.3.16 nat
Description: list of NAT rules for advanced firewall settings : ARRAY
20 Multi-Tech Systems, Inc. MultiConnect R
rCell API Developer Guide