wti.remote.cpm_cellular_config module – Set Cellular runtime information and Parameters of the WTI device.

apn

string

APN for the cellular modem in the WTI device.

cellenable

integer

If the cellular modem is enabled in the WTI device.

Choices:

• 0
• 1

cpm_password

string / required

This is the Password of the WTI device to send the module.

cpm_url

string / required

This is the URL of the WTI device to send the module.

cpm_username

string / required

This is the Username of the WTI device to send the module.

ipthru_enabled

integer

Enables/disables the IP Passthrough feature.

Choices:

• 0
• 1

ipthru_httpsterm

integer

When IP Passthrough is enabled, the Cellular HTTPS Port will be incremented by 5000.

ipthru_httpstermenable

integer

Enables/disables HTTPS.

ipthru_httpterm

integer

When IP Passthrough is enabled, the Cellular HTTP Port will be incremented by 5000.

ipthru_httptermenable

integer

Enables/disables HTTP.

ipthru_interfacemon

integer

Selects the interface that your downstream device/router will be connected to.

ipthru_mac

string

The MAC address of your downstream device/router.

ipthru_sshterm

integer

When IP Passthrough is enabled, the Cellular SSH Port will be incremented by 5000.

ipthru_sshtermenable

integer

Enables/disables SSH.

use_https

boolean

Designates to use an https connection or http connection.

Choices:

• false
• true ← (default)

use_proxy

boolean

Flag to control if the lookup will observe HTTP proxy environment variables when present.

Choices:

• false ← (default)
• true

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used

on personally controlled sites using self-signed certificates.

Choices:

• false
• true ← (default)

wof_afppinginter1

integer

Determines how often the Ping command will be sent after a previous Ping command receives no response.

wof_autorecov

integer

When enabled, the cellular modem will automatically be put back into sleep state when failure is resolved.

wof_conscfail1

integer

Determines how many consecutive failures pings must be detected in order to initiate a Wakeup on Failure..

wof_enabled

integer

Enables/disables the Wakeup on Failure feature.

Choices:

• 0
• 1

wof_gatewayaddr

string

When the cellular modem is defined as the default gateway, this determines which interface will be the default gateway.

wof_gatewayport

integer

The Ethernet port that will be used as the default gateway when the cellular modem is in the sleep state.

wof_host1

string

Selects the primary host that will be pinged in order to test for failures.

wof_host2

string

Selects the secondary host that will be pinged in order to test for failures.

wof_interfacemon

integer

Selects the Ethernet interface(s) that will be monitored for failed ping responses.

wof_pinginter1

integer

Determines how often the selected IP Address will be pinged.

wof_singlepingaddfail

integer

After an Ethernet failure has triggered a Wakeup, this feature is used to manually re-enable Wakeup On Failure.

wof_sleepmode

integer

Determines whether the cell modem will be attached or detached from the cell tower when sleep mode is active.

data

complex

The output JSON returned from the commands sent

Returned: always

apn

string

APN for the cellular modem in the WTI device.

Returned: success

Sample: "MA44.VZWSTATIC"

cellenable

string

If the cellular modem is enabled in the WTI device.

Returned: success

Sample: "1"

cellstatus

dictionary

Current k/v pairs of Cellular status of the WTI device.

Returned: always

Sample: {"IMEI": "240324263004458", "attached": "1", "band": "4G/LTE", "carrier": "Verizon", "phonenumber": "+19495551212", "sessionest": "1", "signalquality": "31"}

modresp

dictionary

Current k/v pairs of Cellular Modem Response info of the WTI device.

Returned: always

Sample: {"APN_CEREG": "", "APN_CGREG": "", "APN_CREG": "", "CALLDISA": "0,0", "CEMODE": "2", "CGATT": "1", "CGDCONT": "OK", "CGMI": "Telit", "CGMM": "LE910C4-NF", "CGMR": "M0F.660006", "CGREG": "0,1", "CGSN": "250322873004469", "CNUM": "'Line 1','+19495753478',145", "COPS": "0,0,'Verizon ',7", "COPSCARRIER": "Verizon", "COPSSERVICE": "4G/LTE", "CSQ": "31,3", "FWSWITCH": "1,1", "GCAP": "+CGSM,+DS,+MS", "ICCID": "89038000004428783156", "QCPDPP": ""}

passth

dictionary

Current k/v pairs of IP Passthrough of the WTI device.

Returned: always

Sample: {"active": "0", "enabled": "0", "host2": "", "httpsterm": "443", "httpstermenable": "0", "httpterm": "80", "httptermenable": "0", "interfacemon": "0", "mac": "", "sshterm": "22", "sshtermenable": "0"}

signal

dictionary

Current k/v pairs of CEllular Signal info of the WTI device.

Returned: always

Sample: {"band": "4", "bandclass": "EUTRAN-4", "channel": "2100", "frequency": "1700", "radiointerface": "LTE", "rsrp": "-96 dBm", "rsrq": "-12 dB", "rssi": "-62 dBm", "snr": "6.6 dB"}

wof

dictionary

Current k/v pairs of Wake up on Failure info of the WTI device.

Returned: always

Sample: {"active": "0", "afppinginter1": "10", "autorecov": "0", "conscfail1": "5", "enabled": "0", "gatewayaddr": "", "gatewayport": "0", "host1": "", "host2": "", "interfacemon": "0", "pinginter1": "60", "singlepingaddfail": "0", "sleepmode": "0"}