Scroll to navigation

MBIMCLI(1) User Commands MBIMCLI(1)

NAME

mbimcli - Control MBIM devices

DESCRIPTION

Usage:

mbimcli [OPTION?] - Control MBIM devices

Help Options:

Show help options
Show all help options
Show Basic Connect Service options
Show Phonebook Service options
Show Device Service Stream options
Show Microsoft Firmware ID Service options
Show Microsoft Host Shutdown Service options
Show Microsoft SAR Service options
Show AT&T Device Service options
Show Intel Firmware Update Service options
Show Microsoft Basic Connect Extensions Service options
Show Quectel Service options
Show link management specific options
Show Intel Thermal RF Service options
Show Microsoft Voice Extensions Service options
Show Microsoft UICC Low Level Access Service options
Show Intel mutual authentication Service options
Show Intel 5G tools options
Show Google Service options

Basic Connect options:

Query device capabilities
Query subscriber ready status
Query radio state
Set radio state
Query device services
Query PIN state
Enter PIN (PIN type is optional, defaults to PIN1, allowed options: (pin1,network-pin,network-subset-pin,service-provider-pin,corporate-pin)
Change PIN
Enable PIN
Disable PIN (PIN type is optional, see enter-pin for details)
Enter PUK (PUK type is optional, defaults to PUK1, allowed options: (puk1,network-puk,network-subset-puk,service-provider-puk,corporate-puk)
Query PIN list
Query home provider
Query preferred providers
Query visible providers
Query registration state
Launch automatic registration
Query signal state
Query packet service state
Attach to the packet service
Detach from the packet service
Query connection state (SessionID is optional, defaults to 0)
Connect (allowed keys: session-id, access-string, ip-type, auth, username, password, compression, context-type)
Query IP configuration (SessionID is optional, defaults to 0)
Disconnect (SessionID is optional, defaults to 0)
Query packet statistics
Query IP packet filters (SessionID is optional, defaults to 0)
Set IP packet filters (allowed keys: session-id, packet-filter, packet-mask, filter-id)
Query provisioned contexts
Set provisioned contexts (allowed keys: context-id, context-type, auth, compression, username, password, access-string, provider-id)
Set signal state (allowed keys: signal-strength-interval, rssi-threshold, error-rate-threshold)
Set network idle hint
Query network idle hint
Set emergency mode
Query emergency mode
Set service activation

Phonebook options:

Query the phonebook configuration
Read phonebook entry with given index
Read all phonebook entries
Add new phonebook entry or update an existing one
Delete phonebook entry with given index
Delete all phonebook entries

Device Service Stream options:

Connect DSS session
Disconnect DSS session

Microsoft Firmware ID options:

Query firmware ID

Microsoft Host Shutdown options:

Notify that host is shutting down

Microsoft SAR options:

Set SAR config
Query SAR config
Set transmission status and hysteresis timer (in seconds)
Query transmission status

AT&T Device Service options:

Query signal info
Query cell location

Intel Firmware Update Service options:

Reboot modem. Boot mode and timeout arguments only required if MBIMEx >= 2.0.

Microsoft Basic Connect Extensions options:

Query PCO value (SessionID is optional, defaults to 0)
Query LTE attach configuration
Query LTE attach status information
Query system capabilities
Query device capabilities
Query slot information status
Set device slot mappings for each executor
Query device slot mappings
Query location info status
Set provisioned contexts (allowed keys: operation, context-type, ip-type, state, roaming-control, media-type, source, auth, compression, username, password, access-string)
Query provisioned contexts
Query base stations info
Reset device
Exchange supported version information. Since MBIMEx v2.0.
Query registration parameters. Since MBIMEx v3.0.
Set registration parameters (required keys: mico-mode, drx-cycle, ladn-info, default-pdu-activation-hint, re-register-if-needed). Since MBIMEx v3.0.
Query modem configuration. Since MBIMEx v3.0.
Query wake reason. Since MBIMEx v3.0.

Quectel options:

Query radio state
Set radio state
List links created from a given interface
Create new network interface link
Delete a given network interface link
Delete all network interface links from the given interface

Intel Thermal RF Service options:

Query RFIM frequency information
Enable or disable RFIM (disabled by default)

Microsoft Voice Extensions Service options:

Query network identity and time zone

Microsoft UICC Low Level Access Service options:

Query UICC application list
Query UICC file status (allowed keys: application-id, file-path)
Read UICC binary file (allowed keys: application-id, file-path, read-offset, read-size, local-pin and data)
Read UICC record file (allowed keys: application-id, file-path, record-number, local-pin and data)
Set UICC open channel (allowed keys: application-id, selectp2arg, channel-group)
Set UICC close channel (allowed keys: channel, channel-group)
Query UICC atr
Set UICC apdu (allowed keys: channel, secure-message, classbyte-type, command)
Set UICC reset
Query UICC reset
Set UICC terminal capability (allowed keys: terminal-capability)
Query UICC terminal capability

Intel mutual authentication Service options:

Query FCC lock information
Set FCC lock information

Intel 5G tools options

Set trace configuration
Query trace configuration

Google options:

Set Google Carrier Lock
Query Google Carrier Lock

Application Options:

Specify device path
Request to use the 'mbim-proxy' proxy
Request to enable Microsoft MBIMEx v2.0 support
Request to enable Microsoft MBIMEx v3.0 support
Do not explicitly open the MBIM device before running the command
Do not close the MBIM device after running the command
Don't run any command
Run action with verbose logs, including the debug ones
Run action with verbose logs, including the debug ones and personal info
Run action with no logs; not even the error/warning ones
Get the printable info of the given hex encoded MBIM message
Print version

COPYRIGHT

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

SEE ALSO

The full documentation for mbimcli is maintained as a Texinfo manual. If the info and mbimcli programs are properly installed at your site, the command

info mbimcli

should give you access to the complete manual.

September 2024 mbimcli 1.30.0