wti.remote.cpm_cellular_info module – Get Cellular runtime information and Parameters in WTI OOB and PDU devices

Note

This module is part of the wti.remote collection (version 1.0.11).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install wti.remote.

To use it in a playbook, specify: wti.remote.cpm_cellular_info.

New in wti.remote 2.10.0

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Get Cellular runtime information and Parameters from WTI OOB and PDU devices

Parameters

Parameter	Comments
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.
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)

Notes

Note

Use groups/cpm in module_defaults to set common options used between CPM modules.)

Examples

- name: Get the Cellular runtime information and Parameters of the device
  cpm_cellular_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
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"}`

Authors

Western Telematic Inc. (@wtinetworkgear)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/wti/remote/cpm_cellular_info_module.html