.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.1.
.TH MBIMCLI "1" "November 2022" "mbimcli 1.28.0" "User Commands"
.SH NAME
mbimcli \- Control MBIM devices
.SH DESCRIPTION
.SS "Usage:"
.IP
mbimcli [OPTION?] \- Control MBIM devices
.SS "Help Options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help options
.TP
\fB\-\-help\-all\fR
Show all help options
.TP
\fB\-\-help\-basic\-connect\fR
Show Basic Connect Service options
.TP
\fB\-\-help\-phonebook\fR
Show Phonebook Service options
.TP
\fB\-\-help\-dss\fR
Show Device Service Stream options
.TP
\fB\-\-help\-ms\-firmware\-id\fR
Show Microsoft Firmware ID Service options
.TP
\fB\-\-help\-ms\-host\-shutdown\fR
Show Microsoft Host Shutdown Service options
.TP
\fB\-\-help\-ms\-sar\fR
Show Microsoft SAR Service options
.TP
\fB\-\-help\-atds\fR
Show AT&T Device Service options
.TP
\fB\-\-help\-intel\-firmware\-update\fR
Show Intel Firmware Update Service options
.TP
\fB\-\-help\-ms\-basic\-connect\-extensions\fR
Show Microsoft Basic Connect Extensions Service options
.TP
\fB\-\-help\-quectel\fR
Show Quectel Service options
.TP
\fB\-\-help\-link\-management\fR
Show link management specific options
.TP
\fB\-\-help\-intel\-thermal\-rf\fR
Show Intel Thermal RF Service options
.TP
\fB\-\-help\-ms\-voice\-extensions\fR
Show Microsoft Voice Extensions Service options
.TP
\fB\-\-help\-ms\-uicc\-low\-level\-access\fR
Show Microsoft UICC Low Level Access Service options
.SS "Basic Connect options:"
.TP
\fB\-\-query\-device\-caps\fR
Query device capabilities
.TP
\fB\-\-query\-subscriber\-ready\-status\fR
Query subscriber ready status
.TP
\fB\-\-query\-radio\-state\fR
Query radio state
.TP
\fB\-\-set\-radio\-state\fR=\fI\,[\/\fR(on|off)]
Set radio state
.TP
\fB\-\-query\-device\-services\fR
Query device services
.TP
\fB\-\-query\-pin\-state\fR
Query PIN state
.TP
\fB\-\-enter\-pin\fR=\fI\,[\/\fR(PIN type),(current PIN)]
Enter PIN (PIN type is optional, defaults to PIN1, allowed options: (pin1,network\-pin,network\-subset\-pin,service\-provider\-pin,corporate\-pin)
.TP
\fB\-\-change\-pin\fR=\fI\,[\/\fR(current PIN),(new PIN)]
Change PIN
.TP
\fB\-\-enable\-pin\fR=\fI\,[\/\fR(current PIN)]
Enable PIN
.TP
\fB\-\-disable\-pin\fR=\fI\,[\/\fR(PIN type),(current PIN)]
Disable PIN (PIN type is optional, see enter\-pin for details)
.TP
\fB\-\-enter\-puk\fR=\fI\,[\/\fR(PUK type),(PUK),(new PIN)]
Enter PUK (PUK type is optional, defaults to PUK1, allowed options: (puk1,network\-puk,network\-subset\-puk,service\-provider\-puk,corporate\-puk)
.TP
\fB\-\-query\-pin\-list\fR
Query PIN list
.TP
\fB\-\-query\-home\-provider\fR
Query home provider
.TP
\fB\-\-query\-preferred\-providers\fR
Query preferred providers
.TP
\fB\-\-query\-visible\-providers\fR
Query visible providers
.TP
\fB\-\-query\-registration\-state\fR
Query registration state
.TP
\fB\-\-register\-automatic\fR
Launch automatic registration
.TP
\fB\-\-query\-signal\-state\fR
Query signal state
.TP
\fB\-\-query\-packet\-service\-state\fR
Query packet service state
.TP
\fB\-\-attach\-packet\-service\fR
Attach to the packet service
.TP
\fB\-\-detach\-packet\-service\fR
Detach from the packet service
.TP
\fB\-\-query\-connection\-state\fR=\fI\,[SessionID]\/\fR
Query connection state (SessionID is optional, defaults to 0)
.TP
\fB\-\-connect\fR=\fI\,[\/\fR"key=value,..."]
Connect (allowed keys: session\-id, access\-string, ip\-type, auth, username, password, compression, context\-type)
.TP
\fB\-\-query\-ip\-configuration\fR=\fI\,[SessionID]\/\fR
Query IP configuration (SessionID is optional, defaults to 0)
.TP
\fB\-\-disconnect\fR=\fI\,[SessionID]\/\fR
Disconnect (SessionID is optional, defaults to 0)
.TP
\fB\-\-query\-packet\-statistics\fR
Query packet statistics
.TP
\fB\-\-query\-ip\-packet\-filters\fR=\fI\,[SessionID]\/\fR
Query IP packet filters (SessionID is optional, defaults to 0)
.TP
\fB\-\-set\-ip\-packet\-filters\fR=\fI\,[\/\fR"key=value,..."]
Set IP packet filters (allowed keys: session\-id, packet\-filter, packet\-mask, filter\-id)
.TP
\fB\-\-query\-provisioned\-contexts\fR
Query provisioned contexts
.TP
\fB\-\-set\-provisioned\-contexts\fR=\fI\,[\/\fR"key=value,..."]
Set provisioned contexts (allowed keys: context\-id, context\-type, auth, compression, username, password, access\-string, provider\-id)
.TP
\fB\-\-set\-signal\-state\fR=\fI\,[\/\fR"key=value,..."]
Set signal state (allowed keys: signal\-strength\-interval, rssi\-threshold, error\-rate\-threshold)
.TP
\fB\-\-set\-network\-idle\-hint\fR=\fI\,[\/\fR(enabled|disabled)]
Set network idle hint
.TP
\fB\-\-query\-network\-idle\-hint\fR
Query network idle hint
.TP
\fB\-\-set\-emergency\-mode\fR=\fI\,[\/\fR(on|off)]
Set emergency mode
.TP
\fB\-\-query\-emergency\-mode\fR
Query emergency mode
.TP
\fB\-\-set\-service\-activation\fR=\fI\,[Data]\/\fR
Set service activation
.SS "Phonebook options:"
.TP
\fB\-\-phonebook\-query\-configuration\fR
Query the phonebook configuration
.TP
\fB\-\-phonebook\-read\fR=\fI\,[\/\fR(Phonebook index)]
Read phonebook entry with given index
.TP
\fB\-\-phonebook\-read\-all\fR
Read all phonebook entries
.TP
\fB\-\-phonebook\-write\fR=\fI\,[\/\fR(Name),(Number)[,(Index)]]
Add new phonebook entry or update an existing one
.TP
\fB\-\-phonebook\-delete\fR=\fI\,[\/\fR(Phonebook index)]
Delete phonebook entry with given index
.TP
\fB\-\-phonebook\-delete\-all\fR
Delete all phonebook entries
.SS "Device Service Stream options:"
.TP
\fB\-\-dss\-connect\fR=\fI\,[\/\fR(UUID),(Session ID)]
Connect DSS session
.TP
\fB\-\-dss\-disconnect\fR=\fI\,[\/\fR(UUID),(Session ID)]
Disconnect DSS session
.SS "Microsoft Firmware ID options:"
.TP
\fB\-\-ms\-query\-firmware\-id\fR
Query firmware ID
.SS "Microsoft Host Shutdown options:"
.TP
\fB\-\-ms\-notify\-host\-shutdown\fR
Notify that host is shutting down
.SS "Microsoft SAR options:"
.TP
\fB\-\-ms\-set\-sar\-config\fR=\fI\,[\/\fR(device|os),(enabled|disabled)[,[{antenna_index,backoff_index}...]]]
Set SAR config
.TP
\fB\-\-ms\-query\-sar\-config\fR
Query SAR config
.TP
\fB\-\-ms\-set\-transmission\-status\fR=\fI\,[\/\fR(enabled|disabled),(timer)]
Set transmission status and hysteresis timer (in seconds)
.TP
\fB\-\-ms\-query\-transmission\-status\fR
Query transmission status
.SS "AT&T Device Service options:"
.TP
\fB\-\-atds\-query\-signal\fR
Query signal info
.TP
\fB\-\-atds\-query\-location\fR
Query cell location
.SS "Intel Firmware Update Service options:"
.TP
\fB\-\-intel\-modem\-reboot\fR=\fI\,[\/\fR(Boot Mode),(Timeout)]
Reboot modem. Boot mode and timeout arguments only required if MBIMEx >= 2.0.
.SS "Microsoft Basic Connect Extensions options:"
.TP
\fB\-\-ms\-query\-pco\fR=\fI\,[SessionID]\/\fR
Query PCO value (SessionID is optional, defaults to 0)
.TP
\fB\-\-ms\-query\-lte\-attach\-configuration\fR
Query LTE attach configuration
.TP
\fB\-\-ms\-query\-lte\-attach\-info\fR
Query LTE attach status information
.TP
\fB\-\-ms\-query\-sys\-caps\fR
Query system capabilities
.TP
\fB\-\-ms\-query\-device\-caps\fR
Query device capabilities
.TP
\fB\-\-ms\-query\-slot\-info\-status\fR=\fI\,[SlotIndex]\/\fR
Query slot information status
.TP
\fB\-\-ms\-set\-device\-slot\-mappings\fR=\fI\,[\/\fR(SlotIndex)[,(SlotIndex)[,...]]]
Set device slot mappings for each executor
.TP
\fB\-\-ms\-query\-device\-slot\-mappings\fR
Query device slot mappings
.TP
\fB\-\-ms\-query\-location\-info\-status\fR
Query location info status
.TP
\fB\-\-ms\-set\-provisioned\-contexts\fR=\fI\,[\/\fR"key=value,..."]
Set provisioned contexts (allowed keys: operation, context\-type, ip\-type, state, roaming\-control, media\-type, source, auth, compression, username, password, access\-string)
.TP
\fB\-\-ms\-query\-provisioned\-contexts\fR
Query provisioned contexts
.TP
\fB\-\-ms\-query\-base\-stations\-info\fR
Query base stations info
.TP
\fB\-\-ms\-query\-version\fR=\fI\,[\/\fR(MBIM version),(MBIM extended version)]
Exchange supported version information. Since MBIMEx v2.0.
.TP
\fB\-\-ms\-query\-registration\-parameters\fR
Query registration parameters. Since MBIMEx v3.0.
.TP
\fB\-\-ms\-set\-registration\-parameters\fR=\fI\,[\/\fR"key=value,..."]
Set registration parameters (required keys: mico\-mode, drx\-cycle, ladn\-info, default\-pdu\-activation\-hint, re\-register\-if\-needed). Since MBIMEx v3.0.
.TP
\fB\-\-ms\-query\-modem\-configuration\fR
Query modem configuration. Since MBIMEx v3.0.
.TP
\fB\-\-ms\-query\-wake\-reason\fR
Query wake reason. Since MBIMEx v3.0.
.SS "Quectel options:"
.TP
\fB\-\-quectel\-query\-radio\-state\fR
Query radio state
.TP
\fB\-\-quectel\-set\-radio\-state\fR=\fI\,[\/\fR(on)]
Set radio state
.SS "Link management options:"
.TP
\fB\-\-link\-list\fR=\fI\,[IFACE]\/\fR
List links created from a given interface
.TP
\fB\-\-link\-add\fR=\fI\,[iface=IFACE\/\fR,prefix=PREFIX[,session\-id=N]]
Create new network interface link
.TP
\fB\-\-link\-delete\fR=\fI\,IFACE\/\fR
Delete a given network interface link
.TP
\fB\-\-link\-delete\-all\fR=\fI\,[IFACE]\/\fR
Delete all network interface links from the given interface
.SS "Intel Thermal RF Service options:"
.TP
\fB\-\-intel\-query\-rfim\fR
Query RFIM frequency information
.TP
\fB\-\-intel\-set\-rfim\fR=\fI\,[\/\fR(on|off)]
Enable or disable RFIM (disabled by default)
.SS "Microsoft Voice Extensions Service options:"
.TP
\fB\-\-ms\-query\-nitz\fR
Query network identity and time zone
.SS "Microsoft UICC Low Level Access Service options:"
.TP
\fB\-\-ms\-query\-uicc\-application\-list\fR
Query UICC application list
.TP
\fB\-\-ms\-query\-uicc\-file\-status\fR=\fI\,[\/\fR"key=value,..."]
Query UICC file status (allowed keys: application\-id, file\-path)
.TP
\fB\-\-ms\-query\-uicc\-read\-binary\fR=\fI\,[\/\fR"key=value,..."]
Read UICC binary file (allowed keys: application\-id, file\-path, read\-offset, read\-size, local\-pin and data)
.TP
\fB\-\-ms\-query\-uicc\-read\-record\fR=\fI\,[\/\fR"key=value,..."]
Read UICC record file (allowed keys: application\-id, file\-path, record\-number, local\-pin and data)
.TP
\fB\-\-ms\-set\-uicc\-open\-channel\fR=\fI\,[\/\fR"key=value,..."]
Set UICC open channel (allowed keys: application\-id, selectp2arg, channel\-group)
.TP
\fB\-\-ms\-set\-uicc\-close\-channel\fR=\fI\,[\/\fR"key=value,..."]
Set UICC close channel (allowed keys: channel, channel\-group)
.TP
\fB\-\-ms\-query\-uicc\-atr\fR
Query UICC atr
.TP
\fB\-\-ms\-set\-uicc\-apdu\fR=\fI\,[\/\fR"key=value,..."]
Set UICC apdu (allowed keys: channel, secure\-message, classbyte\-type, command)
.TP
\fB\-\-ms\-set\-uicc\-reset\fR=\fI\,[\/\fR(Pass Through Action)]
Set UICC reset
.TP
\fB\-\-ms\-query\-uicc\-reset\fR
Query UICC reset
.TP
\fB\-\-ms\-set\-uicc\-terminal\-capability\fR=\fI\,[\/\fR"key=value,..."]
Set UICC terminal capability (allowed keys: terminal\-capability)
.TP
\fB\-\-ms\-query\-uicc\-terminal\-capability\fR
Query UICC terminal capability
.SS "Application Options:"
.TP
\fB\-d\fR, \fB\-\-device\fR=\fI\,[PATH]\/\fR
Specify device path
.TP
\fB\-p\fR, \fB\-\-device\-open\-proxy\fR
Request to use the 'mbim\-proxy' proxy
.TP
\fB\-\-device\-open\-ms\-mbimex\-v2\fR
Request to enable Microsoft MBIMEx v2.0 support
.TP
\fB\-\-device\-open\-ms\-mbimex\-v3\fR
Request to enable Microsoft MBIMEx v3.0 support
.TP
\fB\-\-no\-open\fR=\fI\,[Transaction\/\fR ID]
Do not explicitly open the MBIM device before running the command
.TP
\fB\-\-no\-close\fR
Do not close the MBIM device after running the command
.TP
\fB\-\-noop\fR
Don't run any command
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Run action with verbose logs, including the debug ones
.TP
\fB\-\-verbose\-full\fR
Run action with verbose logs, including the debug ones and personal info
.TP
\fB\-\-silent\fR
Run action with no logs; not even the error/warning ones
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version
.SH COPYRIGHT
Copyright \(co 2013\-2021 Aleksander Morgado
License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl\-2.0.html>
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
The full documentation for
.B mbimcli
is maintained as a Texinfo manual.  If the
.B info
and
.B mbimcli
programs are properly installed at your site, the command
.IP
.B info mbimcli
.PP
should give you access to the complete manual.