1QMICLI(1) User Commands QMICLI(1)
2
6 qmicli - Control QMI devices
7
9 Usage:
10 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-fox
68 Show Foxconn Modem Service options
69 --help-link-management
71 Show link management specific options
72 --help-qmiwwan
74 Show qmi_wwan driver specific options
75 DMS options:
77 --dms-get-ids
78 Get IDs
79 --dms-get-capabilities
81 Get capabilities
82 --dms-get-manufacturer
84 Get manufacturer
85 --dms-get-model
87 Get model
88 --dms-get-revision
90 Get revision
91 --dms-get-msisdn
93 Get MSISDN
94 --dms-get-power-state
96 Get power state
97 --dms-uim-set-pin-protection=[(PIN|PIN2),(disable|enable),(current
99 PIN)]
100 Set PIN protection in the UIM
101 --dms-uim-verify-pin=[(PIN|PIN2),(current PIN)]
103 Verify PIN
104 --dms-uim-unblock-pin=[(PIN|PIN2),(PUK),(new PIN)]
106 Unblock PIN
107 --dms-uim-change-pin=[(PIN|PIN2),(old PIN),(new PIN)]
109 Change PIN
110 --dms-uim-get-pin-status
112 Get PIN status
113 --dms-uim-get-iccid
115 Get ICCID
116 --dms-uim-get-imsi
118 Get IMSI
119 --dms-uim-get-state
121 Get UIM State
122 --dms-uim-get-ck-status=[(pn|pu|pp|pc|pf)]
124 Get CK Status
125 --dms-uim-set-ck-protection=[(pn|pu|pp|pc|pf),(disable),(key)]
127 Disable CK protection
128 --dms-uim-unblock-ck=[(pn|pu|pp|pc|pf),(key)]
130 Unblock CK
131 --dms-get-hardware-revision
133 Get the HW revision
134 --dms-get-operating-mode
136 Get the device operating mode
137 --dms-set-operating-mode=[(Operating mode)]
139 Set the device operating mode
140 --dms-get-time
142 Get the device time
143 --dms-get-prl-version
145 Get the PRL version
146 --dms-get-activation-state
148 Get the state of the service activation
149 --dms-activate-automatic=[Activation Code]
151 Request automatic service activation
152 --dms-activate-manual=[SPC,SID,MDN,MIN]
154 Request manual service activation
155 --dms-get-user-lock-state
157 Get the state of the user lock
158 --dms-set-user-lock-state=[(disable|enable),(current lock code)]
160 Set the state of the user lock
161 --dms-set-user-lock-code=[(old lock code),(new lock code)]
163 Change the user lock code
164 --dms-read-user-data
166 Read user data
167 --dms-write-user-data=[(User data)]
169 Write user data
170 --dms-read-eri-file
172 Read ERI file
173 --dms-restore-factory-defaults=[(Service Programming Code)]
175 Restore factory defaults
176 --dms-validate-service-programming-code=[(Service Programming Code)]
178 Validate the Service Programming Code
179 --dms-set-firmware-id
181 Set firmware id
182 --dms-get-band-capabilities
184 Get band capabilities
185 --dms-get-factory-sku
187 Get factory stock keeping unit
188 --dms-list-stored-images
190 List stored images
191 --dms-select-stored-image=[modem#,pri#] where # is the index
193 Select stored image
194 --dms-delete-stored-image=[modem#|pri#] where # is the index
196 Delete stored image
197 --dms-get-firmware-preference
199 Get firmware preference
200 --dms-set-firmware-preference=["key=value,..."]
202 Set firmware preference (required keys: firmware-version, con‐
203 fig-version, carrier; optional keys: modem-storage-index, over‐
204 ride-download=yes)
205 --dms-get-boot-image-download-mode
207 Get boot image download mode
208 --dms-set-boot-image-download-mode=[normal|boot-and-recovery]
210 Set boot image download mode
211 --dms-get-software-version
213 Get software version
214 --dms-set-fcc-authentication
216 Set FCC authentication
217 --dms-get-supported-messages
219 Get supported messages
220 --dms-hp-change-device-mode=[fastboot]
222 Change device mode (HP specific)
223 --dms-swi-get-current-firmware
225 Get Current Firmware (Sierra Wireless specific)
226 --dms-swi-get-usb-composition
228 Get current and supported USB compositions (Sierra Wireless spe‐
229 cific)
230 --dms-swi-set-usb-composition=[#]
232 Set USB composition (Sierra Wireless specific)
233 --dms-foxconn-change-device-mode=[fastboot-ota|fastboot-online]
235 Change device mode (Foxconn specific)
236 --dms-foxconn-get-firmware-ver‐
238 sion=[firmware-mcfg-apps|firmware-mcfg|apps]
239 Get firmware version (Foxconn specific)
240 --dms-foxconn-set-fcc-authentication=[magic]
242 Set FCC authentication (Foxconn specific)
243 --dms-foxconn-set-fcc-authentication-v2=[magic-string,magic-number]
245 Set FCC authentication (Foxconn specific, v2)
246 --dms-get-mac-address=[wlan|bt]
248 Get default MAC address
249 --dms-reset
251 Reset the service state
252 --dms-noop
254 Just allocate or release a DMS client. Use with `--client-no-re‐
255 lease-cid' and/or `--client-cid'
256 NAS options:
258 --nas-get-signal-strength
259 Get signal strength
260 --nas-get-signal-info
262 Get signal info
263 --nas-get-tx-rx-info=[(Radio Interface)]
265 Get TX/RX info
266 --nas-get-home-network
268 Get home network
269 --nas-get-serving-system
271 Get serving system
272 --nas-get-system-info
274 Get system info
275 --nas-get-technology-preference
277 Get technology preference
278 --nas-get-preferred-networks
280 Get preferred networks
281 --nas-set-preferred-networks=[[MCCMNC,access_tech],...]
283 Set preferred networks list
284 --nas-get-system-selection-preference
286 Get system selection preference
287 --nas-set-system-selection-prefer‐
289 ence=[cdma-1x|cdma-1xevdo|gsm|umts|lte|td-scdma][,[automatic|manual=MC‐
290 CMNC]]
291 Set system selection preference
292 --nas-network-scan
294 Scan networks
295 --nas-get-cell-location-info
297 Get Cell Location Info
298 --nas-force-network-search
300 Force network search
301 --nas-get-operator-name
303 Get operator name data
304 --nas-get-plmn-name=[mccmnc]
306 Get plmn name data
307 --nas-get-lte-cphy-ca-info
309 Get LTE Cphy CA Info
310 --nas-get-rf-band-info
312 Get RF Band Info
313 --nas-get-drx
315 Get DRX
316 --nas-get-supported-messages
318 Get supported messages
319 --nas-swi-get-status
321 Get status ((Sierra Wireless specific)
322 --nas-reset
324 Reset the service state
325 --nas-noop
327 Just allocate or release a NAS client. Use with `--client-no-re‐
328 lease-cid' and/or `--client-cid'
329 WDS options:
331 --wds-start-network=["key=value,..."]
332 Start network (allowed keys: apn, 3gpp-profile, 3gpp2-profile,
333 auth (PAP|CHAP|BOTH), username, password, autoconnect=yes,
334 ip-type (4|6))
335 --wds-follow-network
337 Follow the network status until disconnected. Use with
338 `--wds-start-network'
339 --wds-stop-network=[Packet data handle] OR [disable-autoconnect]
341 Stop network
342 --wds-get-current-settings
344 Get current settings
345 --wds-get-packet-service-status
347 Get packet service status
348 --wds-get-packet-statistics
350 Get packet statistics
351 --wds-get-data-bearer-technology
353 Get data bearer technology
354 --wds-get-current-data-bearer-technology
356 Get current data bearer technology
357 --wds-go-dormant
359 Make the active data connection go dormant
360 --wds-go-active
362 Make the active data connection go active
363 --wds-get-dormancy-status
365 Get the dormancy status of the active data connection
366 --wds-create-profile=["(3gpp|3gpp2)[,key=value,...]"]
368 Create new profile using first available profile index (optional
369 keys: name, apn, pdp-type (IP|PPP|IPV6|IPV4V6), auth
370 (NONE|PAP|CHAP|BOTH), username, password, context-num, no-roam‐
371 ing=yes, disabled=yes)
372 --wds-swi-create-profile-indexed=["(3gpp|3gpp2),#[,key=value,...]"]
374 Create new profile at specified profile index [Sierra Wireless
375 specific] (optional keys: name, apn, pdp-type
376 (IP|PPP|IPV6|IPV4V6), auth (NONE|PAP|CHAP|BOTH), username, pass‐
377 word, context-num, no-roaming=yes, disabled=yes)
378 --wds-modify-profile=["(3gpp|3gpp2),#,key=value,..."]
380 Modify existing profile (optional keys: name, apn, pdp-type
381 (IP|PPP|IPV6|IPV4V6), auth (NONE|PAP|CHAP|BOTH), username, pass‐
382 word, context-num, no-roaming=yes, disabled=yes)
383 --wds-delete-profile=[(3gpp|3gpp2),#]
385 Delete existing profile
386 --wds-get-profile-list=[3gpp|3gpp2]
388 Get profile list
389 --wds-get-default-profile-number=[3gpp|3gpp2]
391 Get default profile number
392 --wds-set-default-profile-number=[(3gpp|3gpp2),#]
394 Set default profile number
395 --wds-get-default-settings=[3gpp|3gpp2]
397 Get default settings
398 --wds-get-autoconnect-settings
400 Get autoconnect settings
401 --wds-set-autoconnect-settings=[(enabled|disabled|paused)[,(roaming-al‐
403 lowed|home-only)]]
404 Set autoconnect settings (roaming settings optional)
405 --wds-get-supported-messages
407 Get supported messages
408 --wds-reset
410 Reset the service state
411 --wds-bind-data-port=[a2-mux-rmnet0-7|#]
413 Bind data port to controller device to be used with
414 `--client-no-release-cid'
415 --wds-bind-mux-data-port=["key=value,..."]
417 Bind qmux data port to controller device (allowed keys: mux-id,
418 ep-type (undefined|hsusb|pcie|embedded|bam-dmux), ep-iface-num‐
419 ber) to be used with `--client-no-release-cid'
420 --wds-set-ip-family=[4|6]
422 Set IP family
423 --wds-get-channel-rates
425 Get channel data rates
426 --wds-get-lte-attach-parameters
428 Get LTE attach parameters
429 --wds-get-max-lte-attach-pdn-num
431 Get the maximum number of LTE attach PDN
432 --wds-get-lte-attach-pdn-list
434 Get the list of LTE attach PDN
435 --wds-set-lte-attach-pdn-list=[#,#,...]
437 Set the list of LTE attach PDN
438 --wds-noop
440 Just allocate or release a WDS client. Use with `--client-no-re‐
441 lease-cid' and/or `--client-cid'
442 PBM options:
444 --pbm-get-all-capabilities
445 Get all phonebook capabilities
446 --pbm-noop
448 Just allocate or release a PBM client. Use with `--client-no-re‐
449 lease-cid' and/or `--client-cid'
450 PDC options:
452 --pdc-list-configs=[(platform|software)]
453 List all configs
454 --pdc-delete-config=[(platform|software),ConfigId]
456 Delete config
457 --pdc-activate-config=[(platform|software),ConfigId]
459 Activate config
460 --pdc-deactivate-config=[(platform|software),ConfigId]
462 Deactivate config
463 --pdc-load-config=[Path to config]
465 Load config to device
466 --pdc-monitor-refresh
468 Watch for refresh indications
469 --pdc-noop
471 Just allocate or release a PDC client. Use with `--client-no-re‐
472 lease-cid' and/or `--client-cid'
473 UIM options:
475 --uim-set-pin-protection=[(PIN1|PIN2|UPIN),(disable|enable),(current
476 PIN)]
477 Set PIN protection
478 --uim-verify-pin=[(PIN1|PIN2|UPIN),(current PIN)]
480 Verify PIN
481 --uim-unblock-pin=[(PIN1|PIN2|UPIN),(PUK),(new PIN)]
483 Unblock PIN
484 --uim-change-pin=[(PIN1|PIN2|UPIN),(old PIN),(new PIN)]
486 Change PIN
487 --uim-read-transparent=[0xNNNN,0xNNNN,...]
489 Read a transparent file given the file path
490 --uim-get-file-attributes=[0xNNNN,0xNNNN,...]
492 Get the attributes of a given file
493 --uim-read-record=["key=value,..."]
495 Read a record from given file (allowed keys: record-number,
496 record-length, file ([0xNNNN-0xNNNN,...])
497 --uim-get-card-status
499 Get card status
500 --uim-get-supported-messages
502 Get supported messages
503 --uim-sim-power-on=[(slot number)]
505 Power on SIM card
506 --uim-sim-power-off=[(slot number)]
508 Power off SIM card
509 --uim-change-provisioning-session=["key=value,..."]
511 Change provisioning session (allowed keys: session-type, acti‐
512 vate, slot, aid)
513 --uim-get-slot-status
515 Get slot status
516 --uim-switch-slot=[(slot number)]
518 Switch active physical slot
519 --uim-monitor-slot-status
521 Watch for slot status indications
522 --uim-reset
524 Reset the service state
525 --uim-monitor-refresh-file=[0xNNNN,0xNNNN,...]
527 Watch for REFRESH events for given file paths
528 --uim-monitor-refresh-all
530 Watch for REFRESH events for any file
531 --uim-get-configuration
533 Get personalization status of the modem
534 --uim-depersonalization=[(feature),(operation),(control key)[,(slot
536 number)]]
537 Deactivates or unblocks personalization feature
538 --uim-noop
540 Just allocate or release a UIM client. Use with `--client-no-re‐
541 lease-cid' and/or `--client-cid'
542 SAR options:
544 --sar-rf-get-state
545 Get RF state
546 --sar-rf-set-state=[(state number)]
548 Set RF state.
549 --sar-noop
551 Just allocate or release a SAR client. Use with `--client-no-re‐
552 lease-cid' and/or `--client-cid'
553 WMS options:
555 --wms-get-supported-messages
556 Get supported messages
557 --wms-get-routes
559 Get SMS route information
560 --wms-set-routes=["key=value,..."]
562 Set SMS route information (keys: type, class, storage, re‐
563 ceipt-action)
564 --wms-reset
566 Reset the service state
567 --wms-noop
569 Just allocate or release a WMS client. Use with `--client-no-re‐
570 lease-cid' and/or `--client-cid'
571 WDA options:
573 --wda-set-data-format=["key=value,..."]
574 Set data format (allowed keys: link-layer-protocol
575 (802-3|raw-ip), ul-protocol (dis‐
576 abled|tlp|qc-ncm|mbim|rndis|qmap|qmapv5), dl-protocol (dis‐
577 abled|tlp|qc-ncm|mbim|rndis|qmap|qmapv5), dl-datagram-max-size,
578 dl-max-datagrams, ep-type (undefined|hsusb|pcie|embedded),
579 ep-iface-number, ul-datagram-max-size, ul-max-datagrams)
580 --wda-get-data-format=["key=value,..."]
582 Get data format (allowed keys: ep-type (undefined|hsusb|pcie|em‐
583 bedded), ep-iface-number); also allows empty key list
584 --wda-get-supported-messages
586 Get supported messages
587 --wda-noop
589 Just allocate or release a WDA client. Use with `--client-no-re‐
590 lease-cid' and/or `--client-cid'
591 VOICE options:
593 --voice-get-config
594 Get Voice service configuration
595 --voice-get-supported-messages
597 Get supported messages
598 --voice-noop
600 Just allocate or release a VOICE client. Use with
601 `--client-no-release-cid' and/or `--client-cid'
602 LOC options:
604 --loc-session-id=[ID]
605 Session ID for the LOC session
606 --loc-start
608 Start location gathering
609 --loc-stop
611 Stop location gathering
612 --loc-get-position-report
614 Get position reported by the location module
615 --loc-get-gnss-sv-info
617 Show GNSS space vehicle info
618 --loc-timeout=[SECS]
620 Maximum time to wait for information in `--loc-get-position-re‐
621 port' and `--loc-get-gnss-sv-info' (default 30s)
622 --loc-follow-position-report
624 Follow all position updates reported by the location module in‐
625 definitely
626 --loc-follow-gnss-sv-info
628 Follow all GNSS space vehicle info updates reported by the loca‐
629 tion module indefinitely
630 --loc-follow-nmea
632 Follow all NMEA trace updates reported by the location module
633 indefinitely
634 --loc-delete-assistance-data
636 Delete positioning assistance data
637 --loc-get-nmea-types
639 Get list of enabled NMEA traces
640 --loc-set-nmea-types=[type1|type2|type3...]
642 Set list of enabled NMEA traces
643 --loc-get-operation-mode
645 Get operation mode
646 --loc-set-operation-mode=[default|msb|msa|standalone|cellid|wwan]
648 Set operation mode
649 --loc-get-engine-lock
651 Get engine lock status
652 --loc-set-engine-lock=[none|mi|mt|all]
654 Set engine lock status
655 --loc-noop
657 Just allocate or release a LOC client. Use with `--client-no-re‐
658 lease-cid' and/or `--client-cid'
659 QoS options:
661 --qos-get-flow-status=[QoS ID]
662 Get QoS flow status
663 --qos-get-network-status
665 Gets the network status
666 --qos-swi-read-data-stats=[APN ID]
668 Read data stats (Sierra Wireless specific)
669 --qos-reset
671 Reset the service state
672 --qos-noop
674 Just allocate or release a QOS client. Use with `--client-no-re‐
675 lease-cid' and/or `--client-cid'
676 GAS options:
678 --gas-dms-set-usb-composition=[pid]
679 Sets the USB composition
680 --gas-dms-get-usb-composition
682 Gets the current USB composition
683 --gas-dms-get-firmware-list
685 Gets the list of stored firmware
686 --gas-dms-get-active-firmware
688 Gets the currently active firmware
689 --gas-dms-set-active-firmware=[index]
691 Sets the active firmware index
692 --gas-noop
694 Just allocate or release a GAS client. Use with `--client-no-re‐
695 lease-cid' and/or `--client-cid'
696 GMS options:
698 --gms-test-get-value
699 Gets test value
700 --gms-test-set-value=[mandatory-value][,[optional-value]]
702 Sets test value
703 --gms-noop
705 Just allocate or release a GMS client. Use with `--client-no-re‐
706 lease-cid' and/or `--client-cid'
707 DSD options:
709 --dsd-get-apn-info=[(type)]
710 Gets the settings associated to a given APN type
711 --dsd-set-apn-type=[(name), (type1|type2|type3...)]
713 Sets the types associated to a given APN name
714 --dsd-get-system-status
716 Gets system status
717 --dsd-noop
719 Just allocate or release a DSD client. Use with `--client-no-re‐
720 lease-cid' and/or `--client-cid'
721 DPM options:
723 --dpm-open-port=["key=value,..."]
724 Open port (allowed-keys: ctrl-ep-type, ctrl-ep-iface-number,
725 ctrl-port-name, hw-data-ep-type, hw-data-ep-iface-number,
726 hw-data-rx-id, hw-data-tx-id, sw-data-ep-type,
727 sw-data-ep-iface-number, sw-data-port-name)
728 --dpm-close-port
730 Close port
731 --dpm-noop
733 Just allocate or release a DPM client. Use with `--client-no-re‐
734 lease-cid' and/or `--client-cid'
735 FOX options:
737 --fox-get-firmware-version=[firmware-mcfg-apps|firmware-mcfg|apps]
738 Get firmware version
739 --fox-noop
741 Just allocate or release a FOX client. Use with `--client-no-re‐
742 lease-cid' and/or `--client-cid'
743 Link management options:
745 --link-list=[IFACE]
746 List links created from a given interface
747 --link-add=[iface=IFACE,prefix=PREFIX[,mux-id=N][,flags=FLAGS]]
749 Create new network interface link
750 --link-delete=[link-iface=IFACE][,[mux-id=N]]
752 Delete a given network interface link
753 --link-delete-all=[IFACE]
755 Delete all network interface links from the given interface
756 qmi_wwan specific options:
758 -w, --get-wwan-iface
759 Get the associated WWAN iface name
760 -e, --get-expected-data-format
762 Get the expected data format in the WWAN iface
763 -E, --set-expected-data-format=[802-3|raw-ip|qmap-pass-through]
765 Set the expected data format in the WWAN iface
766 Application Options:
768 -d, --device=[PATH|URI]
769 Specify device path or QRTR URI (e.g. qrtr://0)
770 --get-service-version-info
772 Get service version info
773 --device-set-instance-id=[Instance ID]
775 Set instance ID
776 --device-open-version-info
778 Run version info check when opening device
779 --device-open-sync
781 Run sync operation when opening device
782 -p, --device-open-proxy
784 Request to use the 'qmi-proxy' proxy
785 --device-open-qmi
787 Open a cdc-wdm device explicitly in QMI mode
788 --device-open-mbim
790 Open a cdc-wdm device explicitly in MBIM mode
791 --device-open-auto
793 Open a cdc-wdm device in either QMI or MBIM mode (default)
794 --de‐
796 vice-open-net=[net-802-3|net-raw-ip|net-qos-header|net-no-qos-header]
797 Open device with specific link protocol and QoS flags
798 --client-cid=[CID]
800 Use the given CID, don't allocate a new one
801 --client-no-release-cid
803 Do not release the CID when exiting
804 -v, --verbose
806 Run action with verbose logs, including the debug ones
807 --verbose-full
809 Run action with verbose logs, including the debug ones and per‐
810 sonal info
811 --silent
813 Run action with no logs; not even the error/warning ones
814 -V, --version
816 Print version
817
819 Copyright © 2012-2022 Aleksander Morgado License GPLv2+: GNU GPL ver‐
820 sion 2 or later <http://gnu.org/licenses/gpl-2.0.html>
821 This is free software: you are free to change and redistribute it.
822 There is NO WARRANTY, to the extent permitted by law.
823
825 The full documentation for qmicli is maintained as a Texinfo manual.
826 If the info and qmicli programs are properly installed at your site,
827 the command
828 info qmicli
830 should give you access to the complete manual.
832qmicli 1.32.4 March 2023 QMICLI(1)