1QMICLI(1) User Commands QMICLI(1)
2
6 qmicli - Control QMI devices
7
9 Usage:
10 lt-qmicli [OPTION?] - Control QMI devices
11 Help Options:
13 -h, --help
14 Show help options
15 --help-all
17 Show all help options
18 --help-dms
20 Show Device Management Service options
21 --help-nas
23 Show Network Access Service options
24 --help-wds
26 Show Wireless Data Service options
27 --help-pbm
29 Show Phonebook Management options
30 --help-pdc
32 Show platform device configurations options
33 --help-uim
35 Show User Identity Module options
36 --help-sar
38 Show Specific Absorption Rate options
39 --help-wms
41 Show Wireless Messaging Service options
42 --help-wda
44 Show Wireless Data Administrative options
45 --help-voice
47 Show Voice Service options
48 --help-loc
50 Show location options
51 --help-qos
53 Show Quality of Service options
54 --help-gas
56 Show General Application Service options
57 --help-gms
59 Show General Modem Service options
60 --help-dsd
62 Show Data System Determination options
63 --help-dpm
65 Show Data Port Mapper Service options
66 --help-link-management
68 Show link management specific options
69 --help-qmiwwan
71 Show qmi_wwan driver specific options
72 DMS options:
74 --dms-get-ids
75 Get IDs
76 --dms-get-capabilities
78 Get capabilities
79 --dms-get-manufacturer
81 Get manufacturer
82 --dms-get-model
84 Get model
85 --dms-get-revision
87 Get revision
88 --dms-get-msisdn
90 Get MSISDN
91 --dms-get-power-state
93 Get power state
94 --dms-uim-set-pin-protection=[(PIN|PIN2),(disable|enable),(current
96 PIN)]
97 Set PIN protection in the UIM
98 --dms-uim-verify-pin=[(PIN|PIN2),(current PIN)]
100 Verify PIN
101 --dms-uim-unblock-pin=[(PIN|PIN2),(PUK),(new PIN)]
103 Unblock PIN
104 --dms-uim-change-pin=[(PIN|PIN2),(old PIN),(new PIN)]
106 Change PIN
107 --dms-uim-get-pin-status
109 Get PIN status
110 --dms-uim-get-iccid
112 Get ICCID
113 --dms-uim-get-imsi
115 Get IMSI
116 --dms-uim-get-state
118 Get UIM State
119 --dms-uim-get-ck-status=[(pn|pu|pp|pc|pf)]
121 Get CK Status
122 --dms-uim-set-ck-protection=[(pn|pu|pp|pc|pf),(disable),(key)]
124 Disable CK protection
125 --dms-uim-unblock-ck=[(pn|pu|pp|pc|pf),(key)]
127 Unblock CK
128 --dms-get-hardware-revision
130 Get the HW revision
131 --dms-get-operating-mode
133 Get the device operating mode
134 --dms-set-operating-mode=[(Operating mode)]
136 Set the device operating mode
137 --dms-get-time
139 Get the device time
140 --dms-get-prl-version
142 Get the PRL version
143 --dms-get-activation-state
145 Get the state of the service activation
146 --dms-activate-automatic=[Activation Code]
148 Request automatic service activation
149 --dms-activate-manual=[SPC,SID,MDN,MIN]
151 Request manual service activation
152 --dms-get-user-lock-state
154 Get the state of the user lock
155 --dms-set-user-lock-state=[(disable|enable),(current lock code)]
157 Set the state of the user lock
158 --dms-set-user-lock-code=[(old lock code),(new lock code)]
160 Change the user lock code
161 --dms-read-user-data
163 Read user data
164 --dms-write-user-data=[(User data)]
166 Write user data
167 --dms-read-eri-file
169 Read ERI file
170 --dms-restore-factory-defaults=[(Service Programming Code)]
172 Restore factory defaults
173 --dms-validate-service-programming-code=[(Service Programming Code)]
175 Validate the Service Programming Code
176 --dms-set-firmware-id
178 Set firmware id
179 --dms-get-band-capabilities
181 Get band capabilities
182 --dms-get-factory-sku
184 Get factory stock keeping unit
185 --dms-list-stored-images
187 List stored images
188 --dms-select-stored-image=[modem#,pri#] where # is the index
190 Select stored image
191 --dms-delete-stored-image=[modem#|pri#] where # is the index
193 Delete stored image
194 --dms-get-firmware-preference
196 Get firmware preference
197 --dms-set-firmware-preference=["key=value,..."]
199 Set firmware preference (required keys: firmware-version, con‐
200 fig-version, carrier; optional keys: modem-storage-index, over‐
201 ride-download=yes)
202 --dms-get-boot-image-download-mode
204 Get boot image download mode
205 --dms-set-boot-image-download-mode=[normal|boot-and-recovery]
207 Set boot image download mode
208 --dms-get-software-version
210 Get software version
211 --dms-set-fcc-authentication
213 Set FCC authentication
214 --dms-get-supported-messages
216 Get supported messages
217 --dms-hp-change-device-mode=[fastboot]
219 Change device mode (HP specific)
220 --dms-swi-get-current-firmware
222 Get Current Firmware (Sierra Wireless specific)
223 --dms-swi-get-usb-composition
225 Get current and supported USB compositions (Sierra Wireless spe‐
226 cific)
227 --dms-swi-set-usb-composition=[#]
229 Set USB composition (Sierra Wireless specific)
230 --dms-foxconn-change-device-mode=[fastboot-ota|fastboot-online]
232 Change device mode (Foxconn specific)
233 --dms-foxconn-get-firmware-ver‐
235 sion=[firmware-mcfg-apps|firmware-mcfg|apps]
236 Get firmware version (Foxconn specific)
237 --dms-foxconn-set-fcc-authentication=[magic]
239 Set FCC authentication (Foxconn specific)
240 --dms-get-mac-address=[wlan|bt]
242 Get default MAC address
243 --dms-reset
245 Reset the service state
246 --dms-noop
248 Just allocate or release a DMS client. Use with `--client-no-re‐
249 lease-cid' and/or `--client-cid'
250 NAS options:
252 --nas-get-signal-strength
253 Get signal strength
254 --nas-get-signal-info
256 Get signal info
257 --nas-get-tx-rx-info=[(Radio Interface)]
259 Get TX/RX info
260 --nas-get-home-network
262 Get home network
263 --nas-get-serving-system
265 Get serving system
266 --nas-get-system-info
268 Get system info
269 --nas-get-technology-preference
271 Get technology preference
272 --nas-get-preferred-networks
274 Get preferred networks
275 --nas-set-preferred-networks=[[MCCMNC,access_tech],...]
277 Set preferred networks list
278 --nas-get-system-selection-preference
280 Get system selection preference
281 --nas-set-system-selection-prefer‐
283 ence=[cdma-1x|cdma-1xevdo|gsm|umts|lte|td-scdma][,[automatic|manual=MC‐
284 CMNC]]
285 Set system selection preference
286 --nas-network-scan
288 Scan networks
289 --nas-get-cell-location-info
291 Get Cell Location Info
292 --nas-force-network-search
294 Force network search
295 --nas-get-operator-name
297 Get operator name data
298 --nas-get-plmn-name=[mccmnc]
300 Get plmn name data
301 --nas-get-lte-cphy-ca-info
303 Get LTE Cphy CA Info
304 --nas-get-rf-band-info
306 Get RF Band Info
307 --nas-get-drx
309 Get DRX
310 --nas-get-supported-messages
312 Get supported messages
313 --nas-swi-get-status
315 Get status ((Sierra Wireless specific)
316 --nas-reset
318 Reset the service state
319 --nas-noop
321 Just allocate or release a NAS client. Use with `--client-no-re‐
322 lease-cid' and/or `--client-cid'
323 WDS options:
325 --wds-start-network=["key=value,..."]
326 Start network (allowed keys: apn, 3gpp-profile, 3gpp2-profile,
327 auth (PAP|CHAP|BOTH), username, password, autoconnect=yes,
328 ip-type (4|6))
329 --wds-follow-network
331 Follow the network status until disconnected. Use with
332 `--wds-start-network'
333 --wds-stop-network=[Packet data handle] OR [disable-autoconnect]
335 Stop network
336 --wds-get-current-settings
338 Get current settings
339 --wds-get-packet-service-status
341 Get packet service status
342 --wds-get-packet-statistics
344 Get packet statistics
345 --wds-get-data-bearer-technology
347 Get data bearer technology
348 --wds-get-current-data-bearer-technology
350 Get current data bearer technology
351 --wds-go-dormant
353 Make the active data connection go dormant
354 --wds-go-active
356 Make the active data connection go active
357 --wds-get-dormancy-status
359 Get the dormancy status of the active data connection
360 --wds-create-profile=["(3gpp|3gpp2)[,key=value,...]"]
362 Create new profile using first available profile index (optional
363 keys: name, apn, pdp-type (IP|PPP|IPV6|IPV4V6), auth
364 (NONE|PAP|CHAP|BOTH), username, password, context-num, no-roam‐
365 ing=yes, disabled=yes)
366 --wds-swi-create-profile-indexed=["(3gpp|3gpp2),#[,key=value,...]"]
368 Create new profile at specified profile index [Sierra Wireless
369 specific] (optional keys: name, apn, pdp-type
370 (IP|PPP|IPV6|IPV4V6), auth (NONE|PAP|CHAP|BOTH), username, pass‐
371 word, context-num, no-roaming=yes, disabled=yes)
372 --wds-modify-profile=["(3gpp|3gpp2),#,key=value,..."]
374 Modify existing profile (optional keys: name, apn, pdp-type
375 (IP|PPP|IPV6|IPV4V6), auth (NONE|PAP|CHAP|BOTH), username, pass‐
376 word, context-num, no-roaming=yes, disabled=yes)
377 --wds-delete-profile=[(3gpp|3gpp2),#]
379 Delete existing profile
380 --wds-get-profile-list=[3gpp|3gpp2]
382 Get profile list
383 --wds-get-default-profile-number=[3gpp|3gpp2]
385 Get default profile number
386 --wds-set-default-profile-number=[(3gpp|3gpp2),#]
388 Set default profile number
389 --wds-get-default-settings=[3gpp|3gpp2]
391 Get default settings
392 --wds-get-autoconnect-settings
394 Get autoconnect settings
395 --wds-set-autoconnect-settings=[(enabled|disabled|paused)[,(roaming-al‐
397 lowed|home-only)]]
398 Set autoconnect settings (roaming settings optional)
399 --wds-get-supported-messages
401 Get supported messages
402 --wds-reset
404 Reset the service state
405 --wds-bind-data-port=[a2-mux-rmnet0-7|#]
407 Bind data port to controller device to be used with
408 `--client-no-release-cid'
409 --wds-bind-mux-data-port=["key=value,..."]
411 Bind qmux data port to controller device (allowed keys: mux-id,
412 ep-type (undefined|hsusb|pcie|embedded|bam-dmux), ep-iface-num‐
413 ber) to be used with `--client-no-release-cid'
414 --wds-set-ip-family=[4|6]
416 Set IP family
417 --wds-get-channel-rates
419 Get channel data rates
420 --wds-get-lte-attach-parameters
422 Get LTE attach parameters
423 --wds-get-max-lte-attach-pdn-num
425 Get the maximum number of LTE attach PDN
426 --wds-get-lte-attach-pdn-list
428 Get the list of LTE attach PDN
429 --wds-set-lte-attach-pdn-list=[#,#,...]
431 Set the list of LTE attach PDN
432 --wds-noop
434 Just allocate or release a WDS client. Use with `--client-no-re‐
435 lease-cid' and/or `--client-cid'
436 PBM options:
438 --pbm-get-all-capabilities
439 Get all phonebook capabilities
440 --pbm-noop
442 Just allocate or release a PBM client. Use with `--client-no-re‐
443 lease-cid' and/or `--client-cid'
444 PDC options:
446 --pdc-list-configs=[(platform|software)]
447 List all configs
448 --pdc-delete-config=[(platform|software),ConfigId]
450 Delete config
451 --pdc-activate-config=[(platform|software),ConfigId]
453 Activate config
454 --pdc-deactivate-config=[(platform|software),ConfigId]
456 Deactivate config
457 --pdc-load-config=[Path to config]
459 Load config to device
460 --pdc-noop
462 Just allocate or release a PDC client. Use with `--client-no-re‐
463 lease-cid' and/or `--client-cid'
464 UIM options:
466 --uim-set-pin-protection=[(PIN1|PIN2|UPIN),(disable|enable),(current
467 PIN)]
468 Set PIN protection
469 --uim-verify-pin=[(PIN1|PIN2|UPIN),(current PIN)]
471 Verify PIN
472 --uim-unblock-pin=[(PIN1|PIN2|UPIN),(PUK),(new PIN)]
474 Unblock PIN
475 --uim-change-pin=[(PIN1|PIN2|UPIN),(old PIN),(new PIN)]
477 Change PIN
478 --uim-read-transparent=[0xNNNN,0xNNNN,...]
480 Read a transparent file given the file path
481 --uim-get-file-attributes=[0xNNNN,0xNNNN,...]
483 Get the attributes of a given file
484 --uim-read-record=["key=value,..."]
486 Read a record from given file (allowed keys: record-number,
487 record-length, file ([0xNNNN-0xNNNN,...])
488 --uim-get-card-status
490 Get card status
491 --uim-get-supported-messages
493 Get supported messages
494 --uim-sim-power-on=[(slot number)]
496 Power on SIM card
497 --uim-sim-power-off=[(slot number)]
499 Power off SIM card
500 --uim-change-provisioning-session=["key=value,..."]
502 Change provisioning session (allowed keys: session-type, acti‐
503 vate, slot, aid)
504 --uim-get-slot-status
506 Get slot status
507 --uim-switch-slot=[(slot number)]
509 Switch active physical slot
510 --uim-monitor-slot-status
512 Watch for slot status indications
513 --uim-reset
515 Reset the service state
516 --uim-monitor-refresh-file=[0xNNNN,0xNNNN,...]
518 Watch for REFRESH events for given file paths
519 --uim-monitor-refresh-all
521 Watch for REFRESH events for any file
522 --uim-get-configuration
524 Get personalization status of the modem
525 --uim-depersonalization=[(feature),(operation),(control key)[,(slot
527 number)]]
528 Deactivates or unblocks personalization feature
529 --uim-noop
531 Just allocate or release a UIM client. Use with `--client-no-re‐
532 lease-cid' and/or `--client-cid'
533 SAR options:
535 --sar-rf-get-state
536 Get RF state
537 --sar-rf-set-state=[(state number)]
539 Set RF state.
540 --sar-noop
542 Just allocate or release a SAR client. Use with `--client-no-re‐
543 lease-cid' and/or `--client-cid'
544 WMS options:
546 --wms-get-supported-messages
547 Get supported messages
548 --wms-get-routes
550 Get SMS route information
551 --wms-reset
553 Reset the service state
554 --wms-noop
556 Just allocate or release a WMS client. Use with `--client-no-re‐
557 lease-cid' and/or `--client-cid'
558 WDA options:
560 --wda-set-data-format=["key=value,..."]
561 Set data format (allowed keys: link-layer-protocol
562 (802-3|raw-ip), ul-protocol (dis‐
563 abled|tlp|qc-ncm|mbim|rndis|qmap|qmapv5), dl-protocol (dis‐
564 abled|tlp|qc-ncm|mbim|rndis|qmap|qmapv5), dl-datagram-max-size,
565 dl-max-datagrams, ep-type (undefined|hsusb|pcie|embedded),
566 ep-iface-number)
567 --wda-get-data-format=["key=value,..."]
569 Get data format (allowed keys: ep-type (undefined|hsusb|pcie|em‐
570 bedded), ep-iface-number); also allows empty key list
571 --wda-get-supported-messages
573 Get supported messages
574 --wda-noop
576 Just allocate or release a WDA client. Use with `--client-no-re‐
577 lease-cid' and/or `--client-cid'
578 VOICE options:
580 --voice-get-config
581 Get Voice service configuration
582 --voice-get-supported-messages
584 Get supported messages
585 --voice-noop
587 Just allocate or release a VOICE client. Use with
588 `--client-no-release-cid' and/or `--client-cid'
589 LOC options:
591 --loc-session-id=[ID]
592 Session ID for the LOC session
593 --loc-start
595 Start location gathering
596 --loc-stop
598 Stop location gathering
599 --loc-get-position-report
601 Get position reported by the location module
602 --loc-get-gnss-sv-info
604 Show GNSS space vehicle info
605 --loc-timeout=[SECS]
607 Maximum time to wait for information in `--loc-get-position-re‐
608 port' and `--loc-get-gnss-sv-info' (default 30s)
609 --loc-follow-position-report
611 Follow all position updates reported by the location module in‐
612 definitely
613 --loc-follow-gnss-sv-info
615 Follow all GNSS space vehicle info updates reported by the loca‐
616 tion module indefinitely
617 --loc-follow-nmea
619 Follow all NMEA trace updates reported by the location module
620 indefinitely
621 --loc-delete-assistance-data
623 Delete positioning assistance data
624 --loc-get-nmea-types
626 Get list of enabled NMEA traces
627 --loc-set-nmea-types=[type1|type2|type3...]
629 Set list of enabled NMEA traces
630 --loc-get-operation-mode
632 Get operation mode
633 --loc-set-operation-mode=[default|msb|msa|standalone|cellid|wwan]
635 Set operation mode
636 --loc-get-engine-lock
638 Get engine lock status
639 --loc-set-engine-lock=[none|mi|mt|all]
641 Set engine lock status
642 --loc-noop
644 Just allocate or release a LOC client. Use with `--client-no-re‐
645 lease-cid' and/or `--client-cid'
646 QoS options:
648 --qos-get-flow-status=[QoS ID]
649 Get QoS flow status
650 --qos-get-network-status
652 Gets the network status
653 --qos-swi-read-data-stats=[APN ID]
655 Read data stats (Sierra Wireless specific)
656 --qos-reset
658 Reset the service state
659 --qos-noop
661 Just allocate or release a QOS client. Use with `--client-no-re‐
662 lease-cid' and/or `--client-cid'
663 GAS options:
665 --gas-dms-get-firmware-list
666 Gets the list of stored firmware
667 --gas-dms-get-active-firmware
669 Gets the currently active firmware
670 --gas-dms-set-active-firmware=[index]
672 Sets the active firmware index
673 --gas-noop
675 Just allocate or release a GAS client. Use with `--client-no-re‐
676 lease-cid' and/or `--client-cid'
677 GMS options:
679 --gms-test-get-value
680 Gets test value
681 --gms-test-set-value=[mandatory-value][,[optional-value]]
683 Sets test value
684 --gms-noop
686 Just allocate or release a GMS client. Use with `--client-no-re‐
687 lease-cid' and/or `--client-cid'
688 DSD options:
690 --dsd-get-apn-info=[(type)]
691 Gets the settings associated to a given APN type
692 --dsd-set-apn-type=[(name), (type1|type2|type3...)]
694 Sets the types associated to a given APN name
695 --dsd-noop
697 Just allocate or release a DSD client. Use with `--client-no-re‐
698 lease-cid' and/or `--client-cid'
699 DPM options:
701 --dpm-open-port=["key=value,..."]
702 Open port (allowed-keys: ctrl-ep-type, ctrl-ep-iface-number,
703 ctrl-port-name, hw-data-ep-type, hw-data-ep-iface-number,
704 hw-data-rx-id, hw-data-tx-id, sw-data-ep-type,
705 sw-data-ep-iface-number, sw-data-port-name)
706 --dpm-close-port
708 Close port
709 --dpm-noop
711 Just allocate or release a DPM client. Use with `--client-no-re‐
712 lease-cid' and/or `--client-cid'
713 Link management options:
715 --link-list=[IFACE]
716 List links created from a given interface
717 --link-add=[iface=IFACE,prefix=PREFIX[,mux-id=N][,flags=FLAGS]]
719 Create new network interface link
720 --link-delete=[link-iface=IFACE][,[mux-id=N]]
722 Delete a given network interface link
723 --link-delete-all=[IFACE]
725 Delete all network interface links from the given interface
726 qmi_wwan specific options:
728 -w, --get-wwan-iface
729 Get the associated WWAN iface name
730 -e, --get-expected-data-format
732 Get the expected data format in the WWAN iface
733 -E, --set-expected-data-format=[802-3|raw-ip|qmap-pass-through]
735 Set the expected data format in the WWAN iface
736 Application Options:
738 -d, --device=[PATH|URI]
739 Specify device path or QRTR URI (e.g. qrtr://0)
740 --get-service-version-info
742 Get service version info
743 --device-set-instance-id=[Instance ID]
745 Set instance ID
746 --device-open-version-info
748 Run version info check when opening device
749 --device-open-sync
751 Run sync operation when opening device
752 -p, --device-open-proxy
754 Request to use the 'qmi-proxy' proxy
755 --device-open-qmi
757 Open a cdc-wdm device explicitly in QMI mode
758 --device-open-mbim
760 Open a cdc-wdm device explicitly in MBIM mode
761 --device-open-auto
763 Open a cdc-wdm device in either QMI or MBIM mode (default)
764 --de‐
766 vice-open-net=[net-802-3|net-raw-ip|net-qos-header|net-no-qos-header]
767 Open device with specific link protocol and QoS flags
768 --client-cid=[CID]
770 Use the given CID, don't allocate a new one
771 --client-no-release-cid
773 Do not release the CID when exiting
774 -v, --verbose
776 Run action with verbose logs, including the debug ones
777 --silent
779 Run action with no logs; not even the error/warning ones
780 -V, --version
782 Print version
783
785 Copyright © 2012-2021 Aleksander Morgado License GPLv2+: GNU GPL ver‐
786 sion 2 or later <http://gnu.org/licenses/gpl-2.0.html>
787 This is free software: you are free to change and redistribute it.
788 There is NO WARRANTY, to the extent permitted by law.
789
791 The full documentation for qmicli is maintained as a Texinfo manual.
792 If the info and qmicli programs are properly installed at your site,
793 the command
794 info qmicli
796 should give you access to the complete manual.
798qmicli 1.30.6 April 2022 QMICLI(1)