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-link-management
65 Show link management specific options
66 --help-qmiwwan
68 Show qmi_wwan driver specific options
69 DMS options:
71 --dms-get-ids
72 Get IDs
73 --dms-get-capabilities
75 Get capabilities
76 --dms-get-manufacturer
78 Get manufacturer
79 --dms-get-model
81 Get model
82 --dms-get-revision
84 Get revision
85 --dms-get-msisdn
87 Get MSISDN
88 --dms-get-power-state
90 Get power state
91 --dms-uim-set-pin-protection=[(PIN|PIN2),(disable|enable),(current
93 PIN)]
94 Set PIN protection in the UIM
95 --dms-uim-verify-pin=[(PIN|PIN2),(current PIN)]
97 Verify PIN
98 --dms-uim-unblock-pin=[(PIN|PIN2),(PUK),(new PIN)]
100 Unblock PIN
101 --dms-uim-change-pin=[(PIN|PIN2),(old PIN),(new PIN)]
103 Change PIN
104 --dms-uim-get-pin-status
106 Get PIN status
107 --dms-uim-get-iccid
109 Get ICCID
110 --dms-uim-get-imsi
112 Get IMSI
113 --dms-uim-get-state
115 Get UIM State
116 --dms-uim-get-ck-status=[(pn|pu|pp|pc|pf)]
118 Get CK Status
119 --dms-uim-set-ck-protection=[(pn|pu|pp|pc|pf),(disable),(key)]
121 Disable CK protection
122 --dms-uim-unblock-ck=[(pn|pu|pp|pc|pf),(key)]
124 Unblock CK
125 --dms-get-hardware-revision
127 Get the HW revision
128 --dms-get-operating-mode
130 Get the device operating mode
131 --dms-set-operating-mode=[(Operating mode)]
133 Set the device operating mode
134 --dms-get-time
136 Get the device time
137 --dms-get-prl-version
139 Get the PRL version
140 --dms-get-activation-state
142 Get the state of the service activation
143 --dms-activate-automatic=[Activation Code]
145 Request automatic service activation
146 --dms-activate-manual=[SPC,SID,MDN,MIN]
148 Request manual service activation
149 --dms-get-user-lock-state
151 Get the state of the user lock
152 --dms-set-user-lock-state=[(disable|enable),(current lock code)]
154 Set the state of the user lock
155 --dms-set-user-lock-code=[(old lock code),(new lock code)]
157 Change the user lock code
158 --dms-read-user-data
160 Read user data
161 --dms-write-user-data=[(User data)]
163 Write user data
164 --dms-read-eri-file
166 Read ERI file
167 --dms-restore-factory-defaults=[(Service Programming Code)]
169 Restore factory defaults
170 --dms-validate-service-programming-code=[(Service Programming Code)]
172 Validate the Service Programming Code
173 --dms-set-firmware-id
175 Set firmware id
176 --dms-get-band-capabilities
178 Get band capabilities
179 --dms-get-factory-sku
181 Get factory stock keeping unit
182 --dms-list-stored-images
184 List stored images
185 --dms-select-stored-image=[modem#,pri#] where # is the index
187 Select stored image
188 --dms-delete-stored-image=[modem#|pri#] where # is the index
190 Delete stored image
191 --dms-get-firmware-preference
193 Get firmware preference
194 --dms-set-firmware-preference=["key=value,..."]
196 Set firmware preference (required keys: firmware-version, con‐
197 fig-version, carrier; optional keys: modem-storage-index, over‐
198 ride-download=yes)
199 --dms-get-boot-image-download-mode
201 Get boot image download mode
202 --dms-set-boot-image-download-mode=[normal|boot-and-recovery]
204 Set boot image download mode
205 --dms-get-software-version
207 Get software version
208 --dms-set-fcc-authentication
210 Set FCC authentication
211 --dms-get-supported-messages
213 Get supported messages
214 --dms-hp-change-device-mode=[fastboot]
216 Change device mode (HP specific)
217 --dms-swi-get-current-firmware
219 Get Current Firmware (Sierra Wireless specific)
220 --dms-swi-get-usb-composition
222 Get current and supported USB compositions (Sierra Wireless spe‐
223 cific)
224 --dms-swi-set-usb-composition=[#]
226 Set USB composition (Sierra Wireless specific)
227 --dms-foxconn-change-device-mode=[fastboot-ota|fastboot-online]
229 Change device mode (Foxconn specific)
230 --dms-foxconn-get-firmware-ver‐
232 sion=[firmware-mcfg-apps|firmware-mcfg|apps]
233 Get firmware version (Foxconn specific)
234 --dms-get-mac-address=[wlan|bt]
236 Get default MAC address
237 --dms-reset
239 Reset the service state
240 --dms-noop
242 Just allocate or release a DMS client. Use with `--client-no-re‐
243 lease-cid' and/or `--client-cid'
244 NAS options:
246 --nas-get-signal-strength
247 Get signal strength
248 --nas-get-signal-info
250 Get signal info
251 --nas-get-tx-rx-info=[(Radio Interface)]
253 Get TX/RX info
254 --nas-get-home-network
256 Get home network
257 --nas-get-serving-system
259 Get serving system
260 --nas-get-system-info
262 Get system info
263 --nas-get-technology-preference
265 Get technology preference
266 --nas-get-system-selection-preference
268 Get system selection preference
269 --nas-set-system-selection-prefer‐
271 ence=[cdma-1x|cdma-1xevdo|gsm|umts|lte|td-scdma][,[automatic|manual=MC‐
272 CMNC]]
273 Set system selection preference
274 --nas-network-scan
276 Scan networks
277 --nas-get-cell-location-info
279 Get Cell Location Info
280 --nas-force-network-search
282 Force network search
283 --nas-get-operator-name
285 Get operator name data
286 --nas-get-plmn-name=[mccmnc]
288 Get plmn name data
289 --nas-get-lte-cphy-ca-info
291 Get LTE Cphy CA Info
292 --nas-get-rf-band-info
294 Get RF Band Info
295 --nas-get-drx
297 Get DRX
298 --nas-get-supported-messages
300 Get supported messages
301 --nas-swi-get-status
303 Get status ((Sierra Wireless specific)
304 --nas-reset
306 Reset the service state
307 --nas-noop
309 Just allocate or release a NAS client. Use with `--client-no-re‐
310 lease-cid' and/or `--client-cid'
311 WDS options:
313 --wds-start-network=["key=value,..."]
314 Start network (allowed keys: apn, 3gpp-profile, 3gpp2-profile,
315 auth (PAP|CHAP|BOTH), username, password, autoconnect=yes,
316 ip-type (4|6))
317 --wds-follow-network
319 Follow the network status until disconnected. Use with
320 `--wds-start-network'
321 --wds-stop-network=[Packet data handle] OR [disable-autoconnect]
323 Stop network
324 --wds-get-current-settings
326 Get current settings
327 --wds-get-packet-service-status
329 Get packet service status
330 --wds-get-packet-statistics
332 Get packet statistics
333 --wds-get-data-bearer-technology
335 Get data bearer technology
336 --wds-get-current-data-bearer-technology
338 Get current data bearer technology
339 --wds-go-dormant
341 Make the active data connection go dormant
342 --wds-go-active
344 Make the active data connection go active
345 --wds-get-dormancy-status
347 Get the dormancy status of the active data connection
348 --wds-create-profile=["(3gpp|3gpp2)[,key=value,...]"]
350 Create new profile using first available profile index (optional
351 keys: name, apn, pdp-type (IP|PPP|IPV6|IPV4V6), auth
352 (NONE|PAP|CHAP|BOTH), username, password, context-num, no-roam‐
353 ing=yes, disabled=yes)
354 --wds-swi-create-profile-indexed=["(3gpp|3gpp2),#[,key=value,...]"]
356 Create new profile at specified profile index [Sierra Wireless
357 specific] (optional keys: name, apn, pdp-type
358 (IP|PPP|IPV6|IPV4V6), auth (NONE|PAP|CHAP|BOTH), username, pass‐
359 word, context-num, no-roaming=yes, disabled=yes)
360 --wds-modify-profile=["(3gpp|3gpp2),#,key=value,..."]
362 Modify existing profile (optional keys: name, apn, pdp-type
363 (IP|PPP|IPV6|IPV4V6), auth (NONE|PAP|CHAP|BOTH), username, pass‐
364 word, context-num, no-roaming=yes, disabled=yes)
365 --wds-delete-profile=[(3gpp|3gpp2),#]
367 Delete existing profile
368 --wds-get-profile-list=[3gpp|3gpp2]
370 Get profile list
371 --wds-get-default-profile-number=[3gpp|3gpp2]
373 Get default profile number
374 --wds-set-default-profile-number=[(3gpp|3gpp2),#]
376 Set default profile number
377 --wds-get-default-settings=[3gpp|3gpp2]
379 Get default settings
380 --wds-get-autoconnect-settings
382 Get autoconnect settings
383 --wds-set-autoconnect-settings=[(enabled|disabled|paused)[,(roaming-al‐
385 lowed|home-only)]]
386 Set autoconnect settings (roaming settings optional)
387 --wds-get-supported-messages
389 Get supported messages
390 --wds-reset
392 Reset the service state
393 --wds-bind-data-port=[a2-mux-rmnet0-7|#]
395 Bind data port to controller device to be used with
396 `--client-no-release-cid'
397 --wds-bind-mux-data-port=["key=value,..."]
399 Bind qmux data port to controller device (allowed keys: mux-id,
400 ep-type (undefined|hsusb|pcie|embedded), ep-iface-number) to be
401 used with `--client-no-release-cid'
402 --wds-set-ip-family=[4|6]
404 Set IP family
405 --wds-get-channel-rates
407 Get channel data rates
408 --wds-get-lte-attach-parameters
410 Get LTE attach parameters
411 --wds-get-max-lte-attach-pdn-num
413 Get the maximum number of LTE attach PDN
414 --wds-get-lte-attach-pdn-list
416 Get the list of LTE attach PDN
417 --wds-set-lte-attach-pdn-list=[#,#,...]
419 Set the list of LTE attach PDN
420 --wds-noop
422 Just allocate or release a WDS client. Use with `--client-no-re‐
423 lease-cid' and/or `--client-cid'
424 PBM options:
426 --pbm-get-all-capabilities
427 Get all phonebook capabilities
428 --pbm-noop
430 Just allocate or release a PBM client. Use with `--client-no-re‐
431 lease-cid' and/or `--client-cid'
432 PDC options:
434 --pdc-list-configs=[(platform|software)]
435 List all configs
436 --pdc-delete-config=[(platform|software),ConfigId]
438 Delete config
439 --pdc-activate-config=[(platform|software),ConfigId]
441 Activate config
442 --pdc-deactivate-config=[(platform|software),ConfigId]
444 Deactivate config
445 --pdc-load-config=[Path to config]
447 Load config to device
448 --pdc-noop
450 Just allocate or release a PDC client. Use with `--client-no-re‐
451 lease-cid' and/or `--client-cid'
452 UIM options:
454 --uim-set-pin-protection=[(PIN1|PIN2|UPIN),(disable|enable),(current
455 PIN)]
456 Set PIN protection
457 --uim-verify-pin=[(PIN1|PIN2|UPIN),(current PIN)]
459 Verify PIN
460 --uim-unblock-pin=[(PIN1|PIN2|UPIN),(PUK),(new PIN)]
462 Unblock PIN
463 --uim-change-pin=[(PIN1|PIN2|UPIN),(old PIN),(new PIN)]
465 Change PIN
466 --uim-read-transparent=[0xNNNN,0xNNNN,...]
468 Read a transparent file given the file path
469 --uim-get-file-attributes=[0xNNNN,0xNNNN,...]
471 Get the attributes of a given file
472 --uim-read-record=["key=value,..."]
474 Read a record from given file (allowed keys: record-number,
475 record-length, file ([0xNNNN-0xNNNN,...])
476 --uim-get-card-status
478 Get card status
479 --uim-get-supported-messages
481 Get supported messages
482 --uim-sim-power-on=[(slot number)]
484 Power on SIM card
485 --uim-sim-power-off=[(slot number)]
487 Power off SIM card
488 --uim-change-provisioning-session=["key=value,..."]
490 Change provisioning session (allowed keys: session-type, acti‐
491 vate, slot, aid)
492 --uim-get-slot-status
494 Get slot status
495 --uim-switch-slot=[(slot number)]
497 Switch active physical slot
498 --uim-monitor-slot-status
500 Watch for slot status indications
501 --uim-reset
503 Reset the service state
504 --uim-monitor-refresh-file=[0xNNNN,0xNNNN,...]
506 Watch for REFRESH events for given file paths
507 --uim-monitor-refresh-all
509 Watch for REFRESH events for any file
510 --uim-noop
512 Just allocate or release a UIM client. Use with `--client-no-re‐
513 lease-cid' and/or `--client-cid'
514 SAR options:
516 --sar-rf-get-state
517 Get RF state
518 --sar-rf-set-state=[(state number)]
520 Set RF state.
521 --sar-noop
523 Just allocate or release a SAR client. Use with `--client-no-re‐
524 lease-cid' and/or `--client-cid'
525 WMS options:
527 --wms-get-supported-messages
528 Get supported messages
529 --wms-reset
531 Reset the service state
532 --wms-noop
534 Just allocate or release a WMS client. Use with `--client-no-re‐
535 lease-cid' and/or `--client-cid'
536 WDA options:
538 --wda-set-data-format=["key=value,..."]
539 Set data format (allowed keys: link-layer-protocol
540 (802-3|raw-ip), ul-protocol (tlp|qc-ncm|mbim|rndis|qmap|qmapv5),
541 dl-protocol (tlp|qc-ncm|mbim|rndis|qmap|qmapv5), dl-data‐
542 gram-max-size, dl-max-datagrams, ep-type (unde‐
543 fined|hsusb|pcie|embedded), ep-iface-number)
544 --wda-get-data-format=["key=value,..."]
546 Get data format (allowed keys: ep-type (undefined|hsusb|pcie|em‐
547 bedded), ep-iface-number); also allows empty key list
548 --wda-get-supported-messages
550 Get supported messages
551 --wda-noop
553 Just allocate or release a WDA client. Use with `--client-no-re‐
554 lease-cid' and/or `--client-cid'
555 VOICE options:
557 --voice-get-config
558 Get Voice service configuration
559 --voice-get-supported-messages
561 Get supported messages
562 --voice-noop
564 Just allocate or release a VOICE client. Use with
565 `--client-no-release-cid' and/or `--client-cid'
566 LOC options:
568 --loc-session-id=[ID]
569 Session ID for the LOC session
570 --loc-start
572 Start location gathering
573 --loc-stop
575 Stop location gathering
576 --loc-get-position-report
578 Get position reported by the location module
579 --loc-get-gnss-sv-info
581 Show GNSS space vehicle info
582 --loc-timeout=[SECS]
584 Maximum time to wait for information in `--loc-get-position-re‐
585 port' and `--loc-get-gnss-sv-info' (default 30s)
586 --loc-follow-position-report
588 Follow all position updates reported by the location module in‐
589 definitely
590 --loc-follow-gnss-sv-info
592 Follow all GNSS space vehicle info updates reported by the loca‐
593 tion module indefinitely
594 --loc-follow-nmea
596 Follow all NMEA trace updates reported by the location module
597 indefinitely
598 --loc-delete-assistance-data
600 Delete positioning assistance data
601 --loc-get-nmea-types
603 Get list of enabled NMEA traces
604 --loc-set-nmea-types=[type1|type2|type3...]
606 Set list of enabled NMEA traces
607 --loc-get-operation-mode
609 Get operation mode
610 --loc-set-operation-mode=[default|msb|msa|standalone|cellid|wwan]
612 Set operation mode
613 --loc-get-engine-lock
615 Get engine lock status
616 --loc-set-engine-lock=[none|mi|mt|all]
618 Set engine lock status
619 --loc-noop
621 Just allocate or release a LOC client. Use with `--client-no-re‐
622 lease-cid' and/or `--client-cid'
623 QoS options:
625 --qos-get-flow-status=[QoS ID]
626 Get QoS flow status
627 --qos-get-network-status
629 Gets the network status
630 --qos-swi-read-data-stats=[APN ID]
632 Read data stats (Sierra Wireless specific)
633 --qos-reset
635 Reset the service state
636 --qos-noop
638 Just allocate or release a QOS client. Use with `--client-no-re‐
639 lease-cid' and/or `--client-cid'
640 GAS options:
642 --gas-dms-get-firmware-list
643 Gets the list of stored firmware
644 --gas-dms-get-active-firmware
646 Gets the currently active firmware
647 --gas-dms-set-active-firmware=[index]
649 Sets the active firmware index
650 --gas-noop
652 Just allocate or release a GAS client. Use with `--client-no-re‐
653 lease-cid' and/or `--client-cid'
654 GMS options:
656 --gms-test-get-value
657 Gets test value
658 --gms-test-set-value=[mandatory-value][,[optional-value]]
660 Sets test value
661 --gms-noop
663 Just allocate or release a GMS client. Use with `--client-no-re‐
664 lease-cid' and/or `--client-cid'
665 DSD options:
667 --dsd-get-apn-info=[(type)]
668 Gets the settings associated to a given APN type
669 --dsd-set-apn-type=[(name), (type1|type2|type3...)]
671 Sets the types associated to a given APN name
672 --dsd-noop
674 Just allocate or release a DSD client. Use with `--client-no-re‐
675 lease-cid' and/or `--client-cid'
676 Ling management options:
678 --link-list=[IFACE]
679 List links created from a given interface
680 --link-add=[mux-id=N|auto,iface=IFACE,prefix=PREFIX]
682 Create new network interface link
683 --link-delete=[link-iface=IFACE][,[mux-id=N]]
685 Delete a given network interface link
686 --link-delete-all=[IFACE]
688 Delete all network interface links from the given interface
689 qmi_wwan specific options:
691 -w, --get-wwan-iface
692 Get the associated WWAN iface name
693 -e, --get-expected-data-format
695 Get the expected data format in the WWAN iface
696 -E, --set-expected-data-format=[802-3|raw-ip|qmap-pass-through]
698 Set the expected data format in the WWAN iface
699 Application Options:
701 -d, --device=[PATH|URI]
702 Specify device path or QRTR URI (e.g. qrtr://0)
703 --get-service-version-info
705 Get service version info
706 --device-set-instance-id=[Instance ID]
708 Set instance ID
709 --device-open-version-info
711 Run version info check when opening device
712 --device-open-sync
714 Run sync operation when opening device
715 -p, --device-open-proxy
717 Request to use the 'qmi-proxy' proxy
718 --device-open-qmi
720 Open a cdc-wdm device explicitly in QMI mode
721 --device-open-mbim
723 Open a cdc-wdm device explicitly in MBIM mode
724 --device-open-auto
726 Open a cdc-wdm device in either QMI or MBIM mode (default)
727 --de‐
729 vice-open-net=[net-802-3|net-raw-ip|net-qos-header|net-no-qos-header]
730 Open device with specific link protocol and QoS flags
731 --client-cid=[CID]
733 Use the given CID, don't allocate a new one
734 --client-no-release-cid
736 Do not release the CID when exiting
737 -v, --verbose
739 Run action with verbose logs, including the debug ones
740 --silent
742 Run action with no logs; not even the error/warning ones
743 -V, --version
745 Print version
746
748 Copyright © 2012-2021 Aleksander Morgado License GPLv2+: GNU GPL ver‐
749 sion 2 or later <http://gnu.org/licenses/gpl-2.0.html>
750 This is free software: you are free to change and redistribute it.
751 There is NO WARRANTY, to the extent permitted by law.
752
754 The full documentation for qmicli is maintained as a Texinfo manual.
755 If the info and qmicli programs are properly installed at your site,
756 the command
757 info qmicli
759 should give you access to the complete manual.
761qmicli 1.28.2 March 2021 QMICLI(1)