Multitech MultiConnect rCell MTR-C2 Developer'S Manual Download Page 1 | Manualshive

Page: 1 / 37

background image

MultiConnect

R

rCell API

Developer Guide

1
2
3
...
»

Summary of Contents for MultiConnect rCell MTR-C2

Page 1: ...MultiConnect R rCell API Developer Guide ...

Page 2: ... 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 regi...

Page 3: ...ections 12 4 1 Commands 12 4 2 Collections 13 4 3 Collection Details 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...

Page 4: ...s 34 6 3 1 Using Curl to log in 34 6 3 2 Using Curl to enable PPP 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 4 Multi Tech Systems Inc MultiConnect R rCell AP...

Page 5: ...e 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...

Page 6: ...ould 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 1 GET https 192 168 2 1 api greTunnels MyGreTunnel remoteIp 2 3 Status 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 great...

Page 7: ...r 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 ABCDEF1234567890ABCD...

Page 8: ... 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 thr...

Page 9: ...des 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 ...

Page 10: ... 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 1 Status HTTP 1 1 200 OK 2 3 code 200 4 status success 5 result JSON Object or Array 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 ...

Page 11: ... 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 ...

Page 12: ...io 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 Def...

Page 13: ...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 cloc...

Page 14: ...ress 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 o...

Page 15: ...port 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 conf...

Page 16: ...d 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...

Page 17: ...e 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 Descript...

Page 18: ... 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 ne...

Page 19: ...de 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 ...

Page 20: ...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 netwo...

Page 21: ... TCP UDP or TCP UDP type STRING SNAT or DNAT wanIp STRING WAN ip address of rule or ANY wanPortEnd STRING WAN end port range or ANY wanPortStart STRING WAN beginning port range or ANY 4 3 17 networks Description array of networks to be used in setting filters and tunnels ARRAY Element Type Description ip STRING ip address of network mask UINT network mask 0 32 name STRING name of network type STRI...

Page 22: ...ECT modem settings apnString STRING apn connection string from service provider baudRate UINT baud rate of modem default 115200 commands ARRAY list of at commands to send to modem after successfully connecting connectString STRING string to send modem on successful connection default CONNECT dialNumber STRING number for modem to dial for connection default 99 1 dialPrefix STRING prefix to add to n...

Page 23: ...to configure HTTPS access to device port UINT set port for rcell configuration website default 443 wan BOOL enable access to rcell configuration website from wan default false icmp OBJECT settings to configure ICMP access to device enabled BOOL enable any response to icmp traffic default true respondToLan BOOL respond to lan icmp traffic default true respondToWan BOOL responsd to wan icmp traffic ...

Page 24: ...platform when the cellular link is already up default false 4 3 21 routes Description list of static routes ARRAY Element Type Description gateway STRING default gateway of route ip STRING ip address of route mask UINT network mask of route 0 32 name STRING name of route 4 3 22 serial Description settings for serial port OBJECT Element Type Description baudRate UINT default 115200 dataBits UINT de...

Page 25: ...on default false ipAddress STRING ip address of syslog server logLevel UINT level of debug output to log 20 warning 30 info 50 debug 60 trace or 100 maximum default 30 outputToFile BOOL enable or disable syslog output to file default false 4 3 25 system Description system attributes OBJECT Multi Tech Systems Inc MultiConnect R rCell API Developer Guide 25 ...

Page 26: ... device or has been reset to defaults hardwareVersion STRING hardware version of device imei STRING international mobile station equipment identity imsi STRING international mobile subscriber identity macAddress STRING mac address of ethernet port macBluetooth STRING mac address of bluetooth module macWifi STRING mac address of wifi module memory OBJECT current memory stats mode STRING system leve...

Page 27: ... TKIP AES or TKIP AES default TKIP AES mode STRING security mode for access point Valid entries are NONE WEP WPA PSK or WPA2 PSK default NONE psk STRING pre shared key for client authentication ssid STRING network SSID may only contain alpha numeric characters and symbols not in cluding and characters client OBJECT wi fi client settings enabled BOOL enable or disable the wifi client default false ...

Page 28: ...t statistics service Various service status wlan WiFi statistics Example Collecting latest PPP statistics 1 GET https 192 168 2 1 api stats ppp 2 3 Status HTTP 1 1 200 OK 4 5 code 200 6 result 7 areaCode 7D0E 8 dnsServers 222 88 33 23 9 ip 142 133 12 40 10 link PPP Link is up 11 localIp 142 133 12 40 12 mtu 1550 13 number 14831268306 14 remoteIp 192 168 202 0 15 roaming false 16 rssi 10 17 rx 18 b...

Page 29: ...moteIp STRING the ip address of the remote end of this tunnel rx OBJECT statistics on gre tunnel received bytes Mcasts UINT number of multicast packets received bytes UINT number of received bytes csumErrors UINT number of packets dropped because of checksum failures errors UINT number of received byte errors outOfSequence UINT number of packets dropped because they arrived out of sequence packets...

Page 30: ...itted packets queueLength STRING number of packets that can be queued for transmission ipsec1 OBJECT statistics on ipsec wan interface ip STRING the ip address assigned to this interface mtu STRING maximum transmission unit in bytes rx OBJECT statistics on ipsec lan interface received bytes bytes STRING number of received bytes dropped STRING number of received byte drops errors STRING number of r...

Page 31: ...ier STRING number of transmitted carriers collisions STRING number of transmitted collisions dropped STRING number of transmitted drops errors STRING number of transmitted errors overruns STRING number of transmitted overruns packets STRING number of transmitted packets queueLength STRING number of packets that can be queued for transmission 5 6 modbus Description statistics on modbus passthrough ...

Page 32: ...ved frames overruns STRING number of received overruns packets STRING number of received packets tower STRING tower identification number tx OBJECT statistics on ppp interface transmitted bytes bytes STRING number of transmitted bytes carrier STRING number of transmitted carriers collisions STRING number of transmitted collisions dropped STRING number of transmitted drops errors STRING number of t...

Page 33: ...thorized frequencies ip STRING the ip address assigned to this interface link STRING status of the wifi link mtu STRING maximum transmission unit in bytes rx OBJECT statistics on wifi interface received bytes bytes STRING number of received bytes dropped STRING number of received byte drops errors STRING number of received byte errors frame STRING number of received frames overruns STRING number o...

Page 34: ...rl result 1 2 code 200 3 result 4 address 192 168 2 103 5 permission admin 6 port 52222 7 timestamp 14 30 5 957 8 token 2442 CB0CB60B2EE9F5A35DF5ED8C33 9 user admin 10 11 status success 12 Verbose Curl result 1 About to connect to 192 168 2 1 port 443 0 2 Trying 192 168 2 1 connected 3 successfully set certificate verify locations 4 CAfile none 5 CApath etc ssl certs 6 SSLv3 TLS handshake Client h...

Page 35: ...rol no cache 30 Content type application json 31 Transfer Encoding chunked 32 Date Wed 15 Jan 2014 14 56 09 GMT 33 Server rcell 34 35 36 code 200 37 result 38 address 192 168 2 103 39 permission admin 40 port 43516 41 timestamp 14 56 9 363 42 token 5810 A57DF87328951FF1901027A09A74 43 user admin 44 45 status success 46 47 Connection 0 to host 192 168 2 1 left intact 48 Closing connection 0 49 SSLv...

Page 36: ...F5ED8C33 Curl result 1 2 code 200 3 status success 4 6 3 4 Using Curl to add a firewall filter rule 1 curl sslv3 k X POST H Content Type application json d 2 action ACCEPT 3 description 4 direction INGRESS 5 dstIp 192 168 2 103 6 dstMask 32 7 dstNetwork 8 dstPortEnd 21 9 dstPortStart 20 10 enabled true 11 name FTP SERVER 12 protocol TCP 13 srcIp ANY 14 srcMask 32 15 srcMac 16 srcNetwork 17 srcPort...

Page 37: ... firewall filter rule by index 1 curl sslv3 k X DELETE 2 https 192 168 2 1 api filters 0 token 2442 CB0CB60B2EE9F5A35DF5ED8C33 Curl result 1 2 code 200 3 status success 4 6 3 7 Using Curl to save current configurations and reboot 1 curl sslv3 k X POST d 2 https 192 168 2 1 api command save_restart token 2442 CB0CB60B2EE9F5A35DF5ED8C33 Curl result 1 2 code 200 3 status success 4 Multi Tech Systems ...

Reviews:

No comments

Related manuals for MultiConnect rCell MTR-C2

Brand: Panasonic Pages: 18

Brand: CAME Pages: 19

Brand: Zonet Pages: 10

Brand: Samsung Pages: 65

Brand: Cowfish Technologies Pages: 38

Brand: Techroutes Pages: 20

Brand: XtendLan Pages: 52

Brand: AMX Pages: 1

Brand: F.F. Group Pages: 56

Brand: Alcatel-Lucent Pages: 12

Brand: Planet Pages: 2

Network Scanning Unit A

Brand: Ricoh Pages: 206

Brand: Pro-Nets Technology Corporation Pages: 48

Brand: Me Pages: 28

Brand: ICP DAS USA Pages: 8

Brand: NAUTICAST Pages: 20

Brand: Atlantis Land Pages: 85

4 Channel Fan Speed Control Module CLX-1FAN4

Brand: Crestron Pages: 1

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands