{"id":13282,"date":"2016-06-22T10:35:42","date_gmt":"2016-06-22T15:35:42","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=13282"},"modified":"2022-05-04T14:52:28","modified_gmt":"2022-05-04T19:52:28","slug":"ppp","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/collection-endpoints\/ppp\/","title":{"rendered":"ppp"},"content":{"rendered":"

Description: PPP settings : OBJECT<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
authentication<\/td>\nOBJECT<\/td>\nSpecifies the PPP authentication settings<\/td>\n<\/tr>\n
\u00a0\u00a0 password<\/td>\nSTRING<\/td>\nSpecifies the password of the PPP account<\/td>\n<\/tr>\n
\u00a0\u00a0 type<\/td>\nSTRING<\/td>\nSpecifies the type of authentication to use when connecting to PPP: PAP, CHAP or PAP-CHAP (default:’PAP-CHAP’)<\/td>\n<\/tr>\n
\u00a0\u00a0 username<\/td>\nSTRING<\/td>\nSpecifies the username of PPP account<\/td>\n<\/tr>\n
cellularMode<\/td>\nSTRING<\/td>\nSpecify how the device should connect to available cellular networks. Select ‘2g’ or ‘3g’ or ‘4g’ to exclusively connect to a chosen network and do not fallback to any other network mode in case of no coverage. Select ‘2g,3g,4g’ to connect to the preferable network and fallback to other network in case
\nno coverage. Options: [2g,3g,4g] : (default: auto)<\/td>\n<\/tr>\n
connectTimeout<\/td>\nUINT<\/td>\nSpecifies the amount of time in seconds to wait for a connection while in receive mode (default:90)<\/td>\n<\/tr>\n
dialOnDemand<\/td>\nBOOL<\/td>\nEnables or disables dial on demand : (default:false)<\/td>\n<\/tr>\n
diversity<\/td>\nBOOL<\/td>\nEnables or disables\u00a0antenna diversity\u00a0: (default:true)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nEnables or disables\u00a0PPP connection\u00a0: (default:false)<\/td>\n<\/tr>\n
idleTimeout<\/td>\nUINT<\/td>\nSpecifies the amount of time in seconds before a connection is considered idle and is disconnected (default:180)<\/td>\n<\/tr>\n
keepAlive<\/td>\nOBJECT<\/td>\nSpecifies the PPP keep alive settings<\/td>\n<\/tr>\n
\u00a0\u00a0 dataRecv<\/td>\nOBJECT<\/td>\nKeeps the PPP connection alive as long as data is being received<\/td>\n<\/tr>\n
\u00a0\u00a0\u00a0\u00a0\u00a0 enabled<\/td>\nBOOL<\/td>\nEnables or disables the data receive monitor (default:false)<\/td>\n<\/tr>\n
\u00a0\u00a0\u00a0\u00a0\u00a0 window<\/td>\nUINT<\/td>\nSpecifies the size of the connection window in minutes (default:0)<\/td>\n<\/tr>\n
\u00a0\u00a0 enabled<\/td>\nOBJECT<\/td>\nEnables or disables the keep alive feature<\/td>\n<\/tr>\n
\u00a0\u00a0 hostname<\/td>\nSTRING<\/td>\nSpecifies the name of a host that can accept a PPP connection<\/td>\n<\/tr>\n
\u00a0\u00a0 icmpCount<\/td>\nUINT<\/td>\nSpecifies the number of pings to send (default:4)<\/td>\n<\/tr>\n
\u00a0 \u00a0packetSize<\/td>\nUINT<\/td>\nSpecifies the packet size of pings to send (default:56)<\/td>\n<\/tr>\n
\u00a0\u00a0 pingInterval<\/td>\nUINT<\/td>\nSpecifies the interval to send pings, in seconds (default:60)<\/td>\n<\/tr>\n
radioReboot<\/td>\nOBJECT<\/td>\nReboot the radio in addition to restarting pppd after back-off<\/td>\n<\/tr>\n
\u00a0 \u00a0enabled<\/td>\nBOOL<\/td>\nEnables or disables radio reboot functionality (default:false)<\/td>\n<\/tr>\n
\u00a0\u00a0 tcpPort<\/td>\nUINT<\/td>\nSpecifies the connection port on a host (default:0)<\/td>\n<\/tr>\n
\u00a0\u00a0 type<\/td>\nSTRING<\/td>\nSpecifies the method used for keep alive, ICMP or TCP (default:ICMP)<\/td>\n<\/tr>\n
maxRetries<\/td>\nUINT<\/td>\nSpecifies the maximum acceptable number of retries before failure (default:0)<\/td>\n<\/tr>\n
modem<\/td>\nOBJECT<\/td>\nSpecifies the modem settings<\/td>\n<\/tr>\n
\u00a0\u00a0 apnString<\/td>\nSTRING<\/td>\nSpecifies the APN connection string designated by the service provider<\/td>\n<\/tr>\n
\u00a0\u00a0 baudRate<\/td>\nUINT<\/td>\nSpecifies the baud rate of the modem (default:115200)<\/td>\n<\/tr>\n
\u00a0\u00a0 commands<\/td>\nARRAY<\/td>\nContains a list of AT commands to send to the modem after a successfully connection<\/td>\n<\/tr>\n
\u00a0 \u00a0contextId<\/td>\nUINT<\/td>\nSpecifies context definition id used with AT+CGDCONT<\/td>\n<\/tr>\n
\u00a0 \u00a0contextIpMode<\/td>\nSTRING<\/td>\nSpecifies PDP type, the type of IP address assigned to the PDP Context (AT+CGDCONT command). Options are IP, IPV6, IPV4V6, AUTO (default:auto)<\/td>\n<\/tr>\n
\u00a0\u00a0 connectString<\/td>\nSTRING<\/td>\nSpecifies the string to send to the modem after successful connection (default:’CONNECT’)<\/td>\n<\/tr>\n
\u00a0\u00a0 dialNumber<\/td>\nSTRING<\/td>\nSpecifies the number the modem should dial for connection (default:’*99***1#’)<\/td>\n<\/tr>\n
\u00a0\u00a0 dialPrefix<\/td>\nSTRING<\/td>\nSpecifies the prefix to add to the number being dialed (default:’ATDT’)<\/td>\n<\/tr>\n
\u00a0 \u00a0fwSwitch<\/td>\nSTRING<\/td>\nSpecifies a specific firmware image to use on radios embedding 2 different firmware images: ‘0’ for automatic, ‘vz’ for Verizon, ‘att’ for AT&T compatible (default:’0′)<\/td>\n<\/tr>\n
\u00a0\u00a0 initStrings<\/td>\nARRAY<\/td>\nContains a list of init strings to send to the modem (default:[‘AT+CSQ’])<\/td>\n<\/tr>\n
\u00a0\u00a0 simPin<\/td>\nSTRING<\/td>\nSpecifies the PIN used to unlock the SIM<\/td>\n<\/tr>\n
mru<\/td>\nUINT<\/td>\nSpecifies the maximum receive unit. The value must be between 128 and 16384. Note that for the IPv6 protocol, the MRU must be at least 1280 (default:1500)<\/td>\n<\/tr>\n
mtu<\/td>\nUINT<\/td>\nSpecifies the maximum transmit unit. The value must be between 128 and 16384. Note that for the IPv6 protocol, the MTU must be at least 1280 (default:1500)<\/td>\n<\/tr>\n
nat<\/td>\nBOOL<\/td>\nEnables or disables the NAT feature (default:true)<\/td>\n<\/tr>\n
netreg<\/td>\nOBJECT<\/td>\nSpecifies network registration settings<\/td>\n<\/tr>\n
\u00a0 \u00a0\u00a0enabled<\/td>\nBOOL<\/td>\nIf true, radio will reset after the netreg timeout, if false, radio will not reset<\/td>\n<\/tr>\n
\u00a0 \u00a0\u00a0timeout<\/td>\nUINT<\/td>\nSpecifies the number of minutes the API will wait for a network registration to occur before resetting the radio (if enabled) (range 10 – 1440)<\/td>\n<\/tr>\n
powerOnInitString<\/td>\nSTRING<\/td>\nSpecifies the string to send to the radio on boot up<\/td>\n<\/tr>\n
protocol<\/td>\nSTRING<\/td>\nSpecifies the protocol to use when connecting to the modem, PPP or WWAN (default:’PPP’)<\/td>\n<\/tr>\n
wakeUpOnCall<\/td>\nOBJECT<\/td>\nDetermines the wake-up behavior of radio when a call comes in<\/td>\n<\/tr>\n
\u00a0\u00a0 ackString<\/td>\nSTRING<\/td>\nSpecifies the string used to acknowledge the receipt of an SMS to the delivering SMSC<\/td>\n<\/tr>\n
\u00a0\u00a0 callerIds<\/td>\nOBJECT<\/td>\nContains a list of valid caller IDs for wake-up<\/td>\n<\/tr>\n
\u00a0\u00a0\u00a0\u00a0\u00a0 action<\/td>\nSTRING<\/td>\nSpecifies the action to perform on wake-up<\/td>\n<\/tr>\n
\u00a0\u00a0\u00a0\u00a0\u00a0 text<\/td>\nSTRING<\/td>\nSpecifies the text of a wake-up SMS message or caller-ID value<\/td>\n<\/tr>\n
\u00a0\u00a0\u00a0\u00a0\u00a0 type<\/td>\nSTRING<\/td>\nSpecifies the type of call, CALLER or SMS<\/td>\n<\/tr>\n
\u00a0\u00a0 delay<\/td>\nUINT<\/td>\nSpecifies the amount of time to wait after call before reconnecting in seconds (default:10)<\/td>\n<\/tr>\n
\u00a0\u00a0 enabled<\/td>\nBOOL<\/td>\nEnables or disables the wake-up on call feature (default:false)<\/td>\n<\/tr>\n
\u00a0\u00a0 fromLan<\/td>\nBOOL<\/td>\nEnables or disables wake-up on LAN activity (default:false)<\/td>\n<\/tr>\n
\u00a0\u00a0 initStrings<\/td>\nARRAY<\/td>\nContains a list of cellular radio AT init strings<\/td>\n<\/tr>\n
\u00a0\u00a0 onCallerId<\/td>\nBOOL<\/td>\nEnables or disables wake-up on caller ID (default:false)<\/td>\n<\/tr>\n
\u00a0\u00a0 onRing<\/td>\nBOOL<\/td>\nEnables or disables wake-up on\u00a0ring (default:false)<\/td>\n<\/tr>\n
\u00a0\u00a0 onSms<\/td>\nBOOL<\/td>\nEnables or disables wake-up on\u00a0SMS (default:false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

Description: PPP settings : OBJECT Element Type Description authentication OBJECT Specifies the PPP authentication settings \u00a0\u00a0 password STRING Specifies the password of the PPP account \u00a0\u00a0 type STRING Specifies the type of authentication to use when connecting to PPP: PAP, CHAP or PAP-CHAP (default:’PAP-CHAP’) \u00a0\u00a0 username STRING Specifies the username of PPP account cellularMode STRING […]<\/p>\n","protected":false},"author":1872,"featured_media":0,"parent":13129,"menu_order":45,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-13282","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13282","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1872"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=13282"}],"version-history":[{"count":13,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13282\/revisions"}],"predecessor-version":[{"id":18451,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13282\/revisions\/18451"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13129"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=13282"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}