mbimcli(1)

1MBIMCLI(1)                       User Commands                      MBIMCLI(1)
2
3
4

NAME

6       mbimcli - Control MBIM devices
7

DESCRIPTION

9   Usage:
10              mbimcli [OPTIONâ.¦] - Control MBIM devices
11
12   Help Options:
13       -h, --help
14              Show help options
15
16       --help-all
17              Show all help options
18
19       --help-basic-connect
20              Show Basic Connect Service options
21
22       --help-phonebook
23              Show Phonebook Service options
24
25       --help-dss
26              Show Device Service Stream options
27
28       --help-ms-firmware-id
29              Show Microsoft Firmware ID Service options
30
31       --help-ms-host-shutdown
32              Show Microsoft Host Shutdown Service options
33
34       --help-ms-sar
35              Show Microsoft SAR Service options
36
37       --help-atds
38              Show AT&T Device Service options
39
40       --help-intel-firmware-update
41              Show Intel Firmware Update Service options
42
43       --help-ms-basic-connect-extensions
44              Show Microsoft Basic Connect Extensions Service options
45
46       --help-quectel
47              Show Quectel Service options
48
49       --help-link-management
50              Show link management specific options
51
52       --help-intel-thermal-rf
53              Show Intel Thermal RF Service options
54
55       --help-ms-voice-extensions
56              Show Microsoft Voice Extensions Service options
57
58       --help-ms-uicc-low-level-access
59              Show Microsoft UICC Low Level Access Service options
60
61       --help-intel-mutual-authentication
62              Show Intel mutual authentication Service options
63
64       --help-intel-tools
65              Show Intel 5G tools options
66
67   Basic Connect options:
68       --query-device-caps
69              Query device capabilities
70
71       --query-subscriber-ready-status
72              Query subscriber ready status
73
74       --query-radio-state
75              Query radio state
76
77       --set-radio-state=[(on|off)]
78              Set radio state
79
80       --query-device-services
81              Query device services
82
83       --query-pin-state
84              Query PIN state
85
86       --enter-pin=[(PIN type),(current PIN)]
87              Enter  PIN  (PIN type is optional, defaults to PIN1, allowed op‐
88              tions:                 (pin1,network-pin,network-subset-pin,ser‐
89              vice-provider-pin,corporate-pin)
90
91       --change-pin=[(current PIN),(new PIN)]
92              Change PIN
93
94       --enable-pin=[(current PIN)]
95              Enable PIN
96
97       --disable-pin=[(PIN type),(current PIN)]
98              Disable PIN (PIN type is optional, see enter-pin for details)
99
100       --enter-puk=[(PUK type),(PUK),(new PIN)]
101              Enter  PUK  (PUK type is optional, defaults to PUK1, allowed op‐
102              tions:                 (puk1,network-puk,network-subset-puk,ser‐
103              vice-provider-puk,corporate-puk)
104
105       --query-pin-list
106              Query PIN list
107
108       --query-home-provider
109              Query home provider
110
111       --query-preferred-providers
112              Query preferred providers
113
114       --query-visible-providers
115              Query visible providers
116
117       --query-registration-state
118              Query registration state
119
120       --register-automatic
121              Launch automatic registration
122
123       --query-signal-state
124              Query signal state
125
126       --query-packet-service-state
127              Query packet service state
128
129       --attach-packet-service
130              Attach to the packet service
131
132       --detach-packet-service
133              Detach from the packet service
134
135       --query-connection-state=[SessionID]
136              Query connection state (SessionID is optional, defaults to 0)
137
138       --connect=["key=value,..."]
139              Connect (allowed keys: session-id, access-string, ip-type, auth,
140              username, password, compression, context-type)
141
142       --query-ip-configuration=[SessionID]
143              Query IP configuration (SessionID is optional, defaults to 0)
144
145       --disconnect=[SessionID]
146              Disconnect (SessionID is optional, defaults to 0)
147
148       --query-packet-statistics
149              Query packet statistics
150
151       --query-ip-packet-filters=[SessionID]
152              Query IP packet filters (SessionID is optional, defaults to 0)
153
154       --set-ip-packet-filters=["key=value,..."]
155              Set IP packet filters (allowed keys: session-id,  packet-filter,
156              packet-mask, filter-id)
157
158       --query-provisioned-contexts
159              Query provisioned contexts
160
161       --set-provisioned-contexts=["key=value,..."]
162              Set   provisioned   contexts  (allowed  keys:  context-id,  con‐
163              text-type, auth, compression, username, password, access-string,
164              provider-id)
165
166       --set-signal-state=["key=value,..."]
167              Set   signal   state  (allowed  keys:  signal-strength-interval,
168              rssi-threshold, error-rate-threshold)
169
170       --set-network-idle-hint=[(enabled|disabled)]
171              Set network idle hint
172
173       --query-network-idle-hint
174              Query network idle hint
175
176       --set-emergency-mode=[(on|off)]
177              Set emergency mode
178
179       --query-emergency-mode
180              Query emergency mode
181
182       --set-service-activation=[Data]
183              Set service activation
184
185   Phonebook options:
186       --phonebook-query-configuration
187              Query the phonebook configuration
188
189       --phonebook-read=[(Phonebook index)]
190              Read phonebook entry with given index
191
192       --phonebook-read-all
193              Read all phonebook entries
194
195       --phonebook-write=[(Name),(Number)[,(Index)]]
196              Add new phonebook entry or update an existing one
197
198       --phonebook-delete=[(Phonebook index)]
199              Delete phonebook entry with given index
200
201       --phonebook-delete-all
202              Delete all phonebook entries
203
204   Device Service Stream options:
205       --dss-connect=[(UUID),(Session ID)]
206              Connect DSS session
207
208       --dss-disconnect=[(UUID),(Session ID)]
209              Disconnect DSS session
210
211   Microsoft Firmware ID options:
212       --ms-query-firmware-id
213              Query firmware ID
214
215   Microsoft Host Shutdown options:
216       --ms-notify-host-shutdown
217              Notify that host is shutting down
218
219   Microsoft SAR options:
220       --ms-set-sar-config=[(device|os),(enabled|disabled)[,[{antenna_in‐
221       dex,backoff_index}...]]]
222              Set SAR config
223
224       --ms-query-sar-config
225              Query SAR config
226
227       --ms-set-transmission-status=[(enabled|disabled),(timer)]
228              Set transmission status and hysteresis timer (in seconds)
229
230       --ms-query-transmission-status
231              Query transmission status
232
233   AT&T Device Service options:
234       --atds-query-signal
235              Query signal info
236
237       --atds-query-location
238              Query cell location
239
240   Intel Firmware Update Service options:
241       --intel-modem-reboot=[(Boot Mode),(Timeout)]
242              Reboot  modem.  Boot mode and timeout arguments only required if
243              MBIMEx >= 2.0.
244
245   Microsoft Basic Connect Extensions options:
246       --ms-query-pco=[SessionID]
247              Query PCO value (SessionID is optional, defaults to 0)
248
249       --ms-query-lte-attach-configuration
250              Query LTE attach configuration
251
252       --ms-query-lte-attach-info
253              Query LTE attach status information
254
255       --ms-query-sys-caps
256              Query system capabilities
257
258       --ms-query-device-caps
259              Query device capabilities
260
261       --ms-query-slot-info-status=[SlotIndex]
262              Query slot information status
263
264       --ms-set-device-slot-mappings=[(SlotIndex)[,(SlotIndex)[,...]]]
265              Set device slot mappings for each executor
266
267       --ms-query-device-slot-mappings
268              Query device slot mappings
269
270       --ms-query-location-info-status
271              Query location info status
272
273       --ms-set-provisioned-contexts=["key=value,..."]
274              Set provisioned contexts (allowed keys: operation, context-type,
275              ip-type,  state, roaming-control, media-type, source, auth, com‐
276              pression, username, password, access-string)
277
278       --ms-query-provisioned-contexts
279              Query provisioned contexts
280
281       --ms-query-base-stations-info
282              Query base stations info
283
284       --ms-query-version=[(MBIM version),(MBIM extended version)]
285              Exchange supported version information. Since MBIMEx v2.0.
286
287       --ms-query-registration-parameters
288              Query registration parameters. Since MBIMEx v3.0.
289
290       --ms-set-registration-parameters=["key=value,..."]
291              Set registration parameters (required keys:  mico-mode,  drx-cy‐
292              cle,     ladn-info,    default-pdu-activation-hint,    re-regis‐
293              ter-if-needed). Since MBIMEx v3.0.
294
295       --ms-query-modem-configuration
296              Query modem configuration. Since MBIMEx v3.0.
297
298       --ms-query-wake-reason
299              Query wake reason. Since MBIMEx v3.0.
300
301   Quectel options:
302       --quectel-query-radio-state
303              Query radio state
304
305       --quectel-set-radio-state=[(on)]
306              Set radio state
307
308   Link management options:
309       --link-list=[IFACE]
310              List links created from a given interface
311
312       --link-add=[iface=IFACE,prefix=PREFIX[,session-id=N]]
313              Create new network interface link
314
315       --link-delete=IFACE
316              Delete a given network interface link
317
318       --link-delete-all=[IFACE]
319              Delete all network interface links from the given interface
320
321   Intel Thermal RF Service options:
322       --intel-query-rfim
323              Query RFIM frequency information
324
325       --intel-set-rfim=[(on|off)]
326              Enable or disable RFIM (disabled by default)
327
328   Microsoft Voice Extensions Service options:
329       --ms-query-nitz
330              Query network identity and time zone
331
332   Microsoft UICC Low Level Access Service options:
333       --ms-query-uicc-application-list
334              Query UICC application list
335
336       --ms-query-uicc-file-status=["key=value,..."]
337              Query UICC file status (allowed keys: application-id, file-path)
338
339       --ms-query-uicc-read-binary=["key=value,..."]
340              Read UICC binary file (allowed keys: application-id,  file-path,
341              read-offset, read-size, local-pin and data)
342
343       --ms-query-uicc-read-record=["key=value,..."]
344              Read  UICC record file (allowed keys: application-id, file-path,
345              record-number, local-pin and data)
346
347       --ms-set-uicc-open-channel=["key=value,..."]
348              Set  UICC  open  channel  (allowed  keys:  application-id,   se‐
349              lectp2arg, channel-group)
350
351       --ms-set-uicc-close-channel=["key=value,..."]
352              Set UICC close channel (allowed keys: channel, channel-group)
353
354       --ms-query-uicc-atr
355              Query UICC atr
356
357       --ms-set-uicc-apdu=["key=value,..."]
358              Set  UICC  apdu  (allowed  keys: channel, secure-message, class‐
359              byte-type, command)
360
361       --ms-set-uicc-reset=[(Pass Through Action)]
362              Set UICC reset
363
364       --ms-query-uicc-reset
365              Query UICC reset
366
367       --ms-set-uicc-terminal-capability=["key=value,..."]
368              Set UICC terminal capability (allowed keys: terminal-capability)
369
370       --ms-query-uicc-terminal-capability
371              Query UICC terminal capability
372
373   Intel mutual authentication Service options:
374       --query-fcc-lock
375              Query FCC lock information
376
377       --set-fcc-lock=[(ResponsePresent),(Response)]
378              Set FCC lock information
379
380       Intel 5G tools options
381
382       --set-trace-config=[(TraceCmd)|(TraceValue)]
383              Set trace configuration
384
385       --query-trace-config=[(TraceCmd)]
386              Query trace configuration
387
388   Application Options:
389       -d, --device=[PATH]
390              Specify device path
391
392       -p, --device-open-proxy
393              Request to use the 'mbim-proxy' proxy
394
395       --device-open-ms-mbimex-v2
396              Request to enable Microsoft MBIMEx v2.0 support
397
398       --device-open-ms-mbimex-v3
399              Request to enable Microsoft MBIMEx v3.0 support
400
401       --no-open=[Transaction ID]
402              Do not explicitly open the MBIM device before running  the  com‐
403              mand
404
405       --no-close
406              Do not close the MBIM device after running the command
407
408       --noop Don't run any command
409
410       -v, --verbose
411              Run action with verbose logs, including the debug ones
412
413       --verbose-full
414              Run  action with verbose logs, including the debug ones and per‐
415              sonal info
416
417       --silent
418              Run action with no logs; not even the error/warning ones
419
420       -V, --version
421              Print version
422

COPYRIGHT

424       Copyright © 2013-2021 Aleksander Morgado License GPLv2+: GNU  GPL  ver‐
425       sion 2 or later <http://gnu.org/licenses/gpl-2.0.html>
426       This  is  free  software:  you  are free to change and redistribute it.
427       There is NO WARRANTY, to the extent permitted by law.
428

NAME

DESCRIPTION

COPYRIGHT

SEE ALSO