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-foxconn-set-fcc-authentication-v2=[magic-string,magic-number]
242 Set FCC authentication (Foxconn specific, v2)
243 --dms-get-mac-address=[wlan|bt]
245 Get default MAC address
246 --dms-reset
248 Reset the service state
249 --dms-noop
251 Just allocate or release a DMS client. Use with `--client-no-re‐
252 lease-cid' and/or `--client-cid'
253 NAS options:
255 --nas-get-signal-strength
256 Get signal strength
257 --nas-get-signal-info
259 Get signal info
260 --nas-get-tx-rx-info=[(Radio Interface)]
262 Get TX/RX info
263 --nas-get-home-network
265 Get home network
266 --nas-get-serving-system
268 Get serving system
269 --nas-get-system-info
271 Get system info
272 --nas-get-technology-preference
274 Get technology preference
275 --nas-get-preferred-networks
277 Get preferred networks
278 --nas-set-preferred-networks=[[MCCMNC,access_tech],...]
280 Set preferred networks list
281 --nas-get-system-selection-preference
283 Get system selection preference
284 --nas-set-system-selection-prefer‐
286 ence=[cdma-1x|cdma-1xevdo|gsm|umts|lte|td-scdma][,[automatic|manual=MC‐
287 CMNC]]
288 Set system selection preference
289 --nas-network-scan
291 Scan networks
292 --nas-get-cell-location-info
294 Get Cell Location Info
295 --nas-force-network-search
297 Force network search
298 --nas-get-operator-name
300 Get operator name data
301 --nas-get-plmn-name=[mccmnc]
303 Get plmn name data
304 --nas-get-lte-cphy-ca-info
306 Get LTE Cphy CA Info
307 --nas-get-rf-band-info
309 Get RF Band Info
310 --nas-get-drx
312 Get DRX
313 --nas-get-supported-messages
315 Get supported messages
316 --nas-swi-get-status
318 Get status ((Sierra Wireless specific)
319 --nas-reset
321 Reset the service state
322 --nas-noop
324 Just allocate or release a NAS client. Use with `--client-no-re‐
325 lease-cid' and/or `--client-cid'
326 WDS options:
328 --wds-start-network=["key=value,..."]
329 Start network (allowed keys: apn, 3gpp-profile, 3gpp2-profile,
330 auth (PAP|CHAP|BOTH), username, password, autoconnect=yes,
331 ip-type (4|6))
332 --wds-follow-network
334 Follow the network status until disconnected. Use with
335 `--wds-start-network'
336 --wds-stop-network=[Packet data handle] OR [disable-autoconnect]
338 Stop network
339 --wds-get-current-settings
341 Get current settings
342 --wds-get-packet-service-status
344 Get packet service status
345 --wds-get-packet-statistics
347 Get packet statistics
348 --wds-get-data-bearer-technology
350 Get data bearer technology
351 --wds-get-current-data-bearer-technology
353 Get current data bearer technology
354 --wds-go-dormant
356 Make the active data connection go dormant
357 --wds-go-active
359 Make the active data connection go active
360 --wds-get-dormancy-status
362 Get the dormancy status of the active data connection
363 --wds-create-profile=["(3gpp|3gpp2)[,key=value,...]"]
365 Create new profile using first available profile index (optional
366 keys: name, apn, pdp-type (IP|PPP|IPV6|IPV4V6), auth
367 (NONE|PAP|CHAP|BOTH), username, password, context-num, no-roam‐
368 ing=yes, disabled=yes)
369 --wds-swi-create-profile-indexed=["(3gpp|3gpp2),#[,key=value,...]"]
371 Create new profile at specified profile index [Sierra Wireless
372 specific] (optional keys: name, apn, pdp-type
373 (IP|PPP|IPV6|IPV4V6), auth (NONE|PAP|CHAP|BOTH), username, pass‐
374 word, context-num, no-roaming=yes, disabled=yes)
375 --wds-modify-profile=["(3gpp|3gpp2),#,key=value,..."]
377 Modify existing profile (optional keys: name, apn, pdp-type
378 (IP|PPP|IPV6|IPV4V6), auth (NONE|PAP|CHAP|BOTH), username, pass‐
379 word, context-num, no-roaming=yes, disabled=yes)
380 --wds-delete-profile=[(3gpp|3gpp2),#]
382 Delete existing profile
383 --wds-get-profile-list=[3gpp|3gpp2]
385 Get profile list
386 --wds-get-default-profile-number=[3gpp|3gpp2]
388 Get default profile number
389 --wds-set-default-profile-number=[(3gpp|3gpp2),#]
391 Set default profile number
392 --wds-get-default-settings=[3gpp|3gpp2]
394 Get default settings
395 --wds-get-autoconnect-settings
397 Get autoconnect settings
398 --wds-set-autoconnect-settings=[(enabled|disabled|paused)[,(roaming-al‐
400 lowed|home-only)]]
401 Set autoconnect settings (roaming settings optional)
402 --wds-get-supported-messages
404 Get supported messages
405 --wds-reset
407 Reset the service state
408 --wds-bind-data-port=[a2-mux-rmnet0-7|#]
410 Bind data port to controller device to be used with
411 `--client-no-release-cid'
412 --wds-bind-mux-data-port=["key=value,..."]
414 Bind qmux data port to controller device (allowed keys: mux-id,
415 ep-type (undefined|hsusb|pcie|embedded|bam-dmux), ep-iface-num‐
416 ber) to be used with `--client-no-release-cid'
417 --wds-set-ip-family=[4|6]
419 Set IP family
420 --wds-get-channel-rates
422 Get channel data rates
423 --wds-get-lte-attach-parameters
425 Get LTE attach parameters
426 --wds-get-max-lte-attach-pdn-num
428 Get the maximum number of LTE attach PDN
429 --wds-get-lte-attach-pdn-list
431 Get the list of LTE attach PDN
432 --wds-set-lte-attach-pdn-list=[#,#,...]
434 Set the list of LTE attach PDN
435 --wds-noop
437 Just allocate or release a WDS client. Use with `--client-no-re‐
438 lease-cid' and/or `--client-cid'
439 PBM options:
441 --pbm-get-all-capabilities
442 Get all phonebook capabilities
443 --pbm-noop
445 Just allocate or release a PBM client. Use with `--client-no-re‐
446 lease-cid' and/or `--client-cid'
447 PDC options:
449 --pdc-list-configs=[(platform|software)]
450 List all configs
451 --pdc-delete-config=[(platform|software),ConfigId]
453 Delete config
454 --pdc-activate-config=[(platform|software),ConfigId]
456 Activate config
457 --pdc-deactivate-config=[(platform|software),ConfigId]
459 Deactivate config
460 --pdc-load-config=[Path to config]
462 Load config to device
463 --pdc-noop
465 Just allocate or release a PDC client. Use with `--client-no-re‐
466 lease-cid' and/or `--client-cid'
467 UIM options:
469 --uim-set-pin-protection=[(PIN1|PIN2|UPIN),(disable|enable),(current
470 PIN)]
471 Set PIN protection
472 --uim-verify-pin=[(PIN1|PIN2|UPIN),(current PIN)]
474 Verify PIN
475 --uim-unblock-pin=[(PIN1|PIN2|UPIN),(PUK),(new PIN)]
477 Unblock PIN
478 --uim-change-pin=[(PIN1|PIN2|UPIN),(old PIN),(new PIN)]
480 Change PIN
481 --uim-read-transparent=[0xNNNN,0xNNNN,...]
483 Read a transparent file given the file path
484 --uim-get-file-attributes=[0xNNNN,0xNNNN,...]
486 Get the attributes of a given file
487 --uim-read-record=["key=value,..."]
489 Read a record from given file (allowed keys: record-number,
490 record-length, file ([0xNNNN-0xNNNN,...])
491 --uim-get-card-status
493 Get card status
494 --uim-get-supported-messages
496 Get supported messages
497 --uim-sim-power-on=[(slot number)]
499 Power on SIM card
500 --uim-sim-power-off=[(slot number)]
502 Power off SIM card
503 --uim-change-provisioning-session=["key=value,..."]
505 Change provisioning session (allowed keys: session-type, acti‐
506 vate, slot, aid)
507 --uim-get-slot-status
509 Get slot status
510 --uim-switch-slot=[(slot number)]
512 Switch active physical slot
513 --uim-monitor-slot-status
515 Watch for slot status indications
516 --uim-reset
518 Reset the service state
519 --uim-monitor-refresh-file=[0xNNNN,0xNNNN,...]
521 Watch for REFRESH events for given file paths
522 --uim-monitor-refresh-all
524 Watch for REFRESH events for any file
525 --uim-get-configuration
527 Get personalization status of the modem
528 --uim-depersonalization=[(feature),(operation),(control key)[,(slot
530 number)]]
531 Deactivates or unblocks personalization feature
532 --uim-noop
534 Just allocate or release a UIM client. Use with `--client-no-re‐
535 lease-cid' and/or `--client-cid'
536 SAR options:
538 --sar-rf-get-state
539 Get RF state
540 --sar-rf-set-state=[(state number)]
542 Set RF state.
543 --sar-noop
545 Just allocate or release a SAR client. Use with `--client-no-re‐
546 lease-cid' and/or `--client-cid'
547 WMS options:
549 --wms-get-supported-messages
550 Get supported messages
551 --wms-get-routes
553 Get SMS route information
554 --wms-reset
556 Reset the service state
557 --wms-noop
559 Just allocate or release a WMS client. Use with `--client-no-re‐
560 lease-cid' and/or `--client-cid'
561 WDA options:
563 --wda-set-data-format=["key=value,..."]
564 Set data format (allowed keys: link-layer-protocol
565 (802-3|raw-ip), ul-protocol (dis‐
566 abled|tlp|qc-ncm|mbim|rndis|qmap|qmapv5), dl-protocol (dis‐
567 abled|tlp|qc-ncm|mbim|rndis|qmap|qmapv5), dl-datagram-max-size,
568 dl-max-datagrams, ep-type (undefined|hsusb|pcie|embedded),
569 ep-iface-number)
570 --wda-get-data-format=["key=value,..."]
572 Get data format (allowed keys: ep-type (undefined|hsusb|pcie|em‐
573 bedded), ep-iface-number); also allows empty key list
574 --wda-get-supported-messages
576 Get supported messages
577 --wda-noop
579 Just allocate or release a WDA client. Use with `--client-no-re‐
580 lease-cid' and/or `--client-cid'
581 VOICE options:
583 --voice-get-config
584 Get Voice service configuration
585 --voice-get-supported-messages
587 Get supported messages
588 --voice-noop
590 Just allocate or release a VOICE client. Use with
591 `--client-no-release-cid' and/or `--client-cid'
592 LOC options:
594 --loc-session-id=[ID]
595 Session ID for the LOC session
596 --loc-start
598 Start location gathering
599 --loc-stop
601 Stop location gathering
602 --loc-get-position-report
604 Get position reported by the location module
605 --loc-get-gnss-sv-info
607 Show GNSS space vehicle info
608 --loc-timeout=[SECS]
610 Maximum time to wait for information in `--loc-get-position-re‐
611 port' and `--loc-get-gnss-sv-info' (default 30s)
612 --loc-follow-position-report
614 Follow all position updates reported by the location module in‐
615 definitely
616 --loc-follow-gnss-sv-info
618 Follow all GNSS space vehicle info updates reported by the loca‐
619 tion module indefinitely
620 --loc-follow-nmea
622 Follow all NMEA trace updates reported by the location module
623 indefinitely
624 --loc-delete-assistance-data
626 Delete positioning assistance data
627 --loc-get-nmea-types
629 Get list of enabled NMEA traces
630 --loc-set-nmea-types=[type1|type2|type3...]
632 Set list of enabled NMEA traces
633 --loc-get-operation-mode
635 Get operation mode
636 --loc-set-operation-mode=[default|msb|msa|standalone|cellid|wwan]
638 Set operation mode
639 --loc-get-engine-lock
641 Get engine lock status
642 --loc-set-engine-lock=[none|mi|mt|all]
644 Set engine lock status
645 --loc-noop
647 Just allocate or release a LOC client. Use with `--client-no-re‐
648 lease-cid' and/or `--client-cid'
649 QoS options:
651 --qos-get-flow-status=[QoS ID]
652 Get QoS flow status
653 --qos-get-network-status
655 Gets the network status
656 --qos-swi-read-data-stats=[APN ID]
658 Read data stats (Sierra Wireless specific)
659 --qos-reset
661 Reset the service state
662 --qos-noop
664 Just allocate or release a QOS client. Use with `--client-no-re‐
665 lease-cid' and/or `--client-cid'
666 GAS options:
668 --gas-dms-get-firmware-list
669 Gets the list of stored firmware
670 --gas-dms-get-active-firmware
672 Gets the currently active firmware
673 --gas-dms-set-active-firmware=[index]
675 Sets the active firmware index
676 --gas-noop
678 Just allocate or release a GAS client. Use with `--client-no-re‐
679 lease-cid' and/or `--client-cid'
680 GMS options:
682 --gms-test-get-value
683 Gets test value
684 --gms-test-set-value=[mandatory-value][,[optional-value]]
686 Sets test value
687 --gms-noop
689 Just allocate or release a GMS client. Use with `--client-no-re‐
690 lease-cid' and/or `--client-cid'
691 DSD options:
693 --dsd-get-apn-info=[(type)]
694 Gets the settings associated to a given APN type
695 --dsd-set-apn-type=[(name), (type1|type2|type3...)]
697 Sets the types associated to a given APN name
698 --dsd-noop
700 Just allocate or release a DSD client. Use with `--client-no-re‐
701 lease-cid' and/or `--client-cid'
702 DPM options:
704 --dpm-open-port=["key=value,..."]
705 Open port (allowed-keys: ctrl-ep-type, ctrl-ep-iface-number,
706 ctrl-port-name, hw-data-ep-type, hw-data-ep-iface-number,
707 hw-data-rx-id, hw-data-tx-id, sw-data-ep-type,
708 sw-data-ep-iface-number, sw-data-port-name)
709 --dpm-close-port
711 Close port
712 --dpm-noop
714 Just allocate or release a DPM client. Use with `--client-no-re‐
715 lease-cid' and/or `--client-cid'
716 Link management options:
718 --link-list=[IFACE]
719 List links created from a given interface
720 --link-add=[iface=IFACE,prefix=PREFIX[,mux-id=N][,flags=FLAGS]]
722 Create new network interface link
723 --link-delete=[link-iface=IFACE][,[mux-id=N]]
725 Delete a given network interface link
726 --link-delete-all=[IFACE]
728 Delete all network interface links from the given interface
729 qmi_wwan specific options:
731 -w, --get-wwan-iface
732 Get the associated WWAN iface name
733 -e, --get-expected-data-format
735 Get the expected data format in the WWAN iface
736 -E, --set-expected-data-format=[802-3|raw-ip|qmap-pass-through]
738 Set the expected data format in the WWAN iface
739 Application Options:
741 -d, --device=[PATH|URI]
742 Specify device path or QRTR URI (e.g. qrtr://0)
743 --get-service-version-info
745 Get service version info
746 --device-set-instance-id=[Instance ID]
748 Set instance ID
749 --device-open-version-info
751 Run version info check when opening device
752 --device-open-sync
754 Run sync operation when opening device
755 -p, --device-open-proxy
757 Request to use the 'qmi-proxy' proxy
758 --device-open-qmi
760 Open a cdc-wdm device explicitly in QMI mode
761 --device-open-mbim
763 Open a cdc-wdm device explicitly in MBIM mode
764 --device-open-auto
766 Open a cdc-wdm device in either QMI or MBIM mode (default)
767 --de‐
769 vice-open-net=[net-802-3|net-raw-ip|net-qos-header|net-no-qos-header]
770 Open device with specific link protocol and QoS flags
771 --client-cid=[CID]
773 Use the given CID, don't allocate a new one
774 --client-no-release-cid
776 Do not release the CID when exiting
777 -v, --verbose
779 Run action with verbose logs, including the debug ones
780 --silent
782 Run action with no logs; not even the error/warning ones
783 -V, --version
785 Print version
786
788 Copyright © 2012-2021 Aleksander Morgado License GPLv2+: GNU GPL ver‐
789 sion 2 or later <http://gnu.org/licenses/gpl-2.0.html>
790 This is free software: you are free to change and redistribute it.
791 There is NO WARRANTY, to the extent permitted by law.
792
794 The full documentation for qmicli is maintained as a Texinfo manual.
795 If the info and qmicli programs are properly installed at your site,
796 the command
797 info qmicli
799 should give you access to the complete manual.
801qmicli 1.30.8 June 2022 QMICLI(1)