MBIMCLI(1)

📦

version 1.34.0 · 17 versions

✨ MBIMCLI(1) — mbimcli from User Commands ✨

okay so bestie, this is the mbimcli manual, aka the group chat where your MBIM device finally spills everything. This is part 1, and it's giving full-control energy with zero skipped options. 💅

💖 NAME 💖

mbimcli - Control MBIM devices

🦋 DESCRIPTION 🦋

✨ Usage: ✨

mbimcli [OPTION…] - Control MBIM devices

🎀 Help Options 🎀

-h, --help — shows the help options. iconic lil helper.
--help-all — shows all help options. the whole menu, no crumbs.
--help-basic-connect — shows the Basic Connect Service options.
--help-phonebook — shows the Phonebook Service options.
--help-dss — shows the Device Service Stream options.
--help-ms-firmware-id — shows the Microsoft Firmware ID Service options.
--help-ms-host-shutdown — shows the Microsoft Host Shutdown Service options.
--help-ms-sar — shows the Microsoft SAR Service options.
--help-atds — shows the AT&T Device Service options.
--help-intel-firmware-update — shows the Intel Firmware Update Service options.
--help-ms-basic-connect-extensions — shows the Microsoft Basic Connect Extensions Service options.
--help-quectel — shows the Quectel Service options.
--help-link-management — shows link management specific options.
--help-intel-thermal-rf — shows the Intel Thermal RF Service options.
--help-ms-voice-extensions — shows the Microsoft Voice Extensions Service options.
--help-ms-uicc-low-level-access — shows the Microsoft UICC Low Level Access Service options.
--help-intel-mutual-authentication — shows the Intel mutual authentication Service options.
--help-intel-tools — shows the Intel 5G tools options.
--help-google — shows the Google Service options.
--help-fibocom — shows the Fibocom Service options.
--help-sms — shows the SMS service options.
--help-compal — shows the Compal Service options.
--help-intel-at-tunnel — shows the Intel AT Tunnel Service options.

💅 Basic Connect options 💅

--query-device-caps — queries device capabilities.
--query-subscriber-ready-status — queries subscriber ready status.
--query-radio-state — queries radio state.
--set-radio-state=[(on|off)] — sets radio state to on or off.
--query-device-services — queries device services.
--query-pin-state — queries PIN state.
--enter-pin=[(PIN type),(current PIN)] — enters PIN. PIN type is optional and defaults to PIN1; allowed options are (pin1,network-pin,network-subset-pin,service-provider-pin,corporate-pin).
--change-pin=[(current PIN),(new PIN)] — changes PIN.
--enable-pin=[(current PIN)] — enables PIN.
--disable-pin=[(PIN type),(current PIN)] — disables PIN. PIN type is optional; see enter-pin for details.
--enter-puk=[(PUK type),(PUK),(new PIN)] — enters PUK. PUK type is optional and defaults to PUK1; allowed options are (puk1,network-puk,network-subset-puk,service-provider-puk,corporate-puk).
--query-pin-list — queries PIN list.
--query-home-provider — queries home provider.
--query-preferred-providers — queries preferred providers.
--query-visible-providers — queries visible providers.
--query-register-state — queries register state.
--set-register-state=["key=value,..."] — sets basic register settings. Allowed keys: action, provider-id, data-class.
--query-signal-state — queries signal state.
--query-packet-service-state — queries packet service state.
--attach-packet-service — attaches to the packet service.
--detach-packet-service — detaches from the packet service.
--query-connection-state=[SessionID] — queries connection state. SessionID is optional and defaults to 0.
--connect=["key=value,..."] — connects. Allowed keys: session-id, access-string, ip-type, auth, username, password, compression, context-type.
--query-ip-configuration=[SessionID] — queries IP configuration. SessionID is optional and defaults to 0.
--disconnect=[SessionID] — disconnects. SessionID is optional and defaults to 0.
--query-packet-statistics — queries packet statistics.
--query-ip-packet-filters=[SessionID] — queries IP packet filters. SessionID is optional and defaults to 0.
--set-ip-packet-filters=["key=value,..."] — sets IP packet filters. Allowed keys: session-id, packet-filter, packet-mask, filter-id.
--query-provisioned-contexts — queries provisioned contexts.
--set-provisioned-contexts=["key=value,..."] — sets provisioned contexts. Allowed keys: context-id, context-type, auth, compression, username, password, access-string, provider-id.
--set-signal-state=["key=value,..."] — sets signal state. Allowed keys: signal-strength-interval, rssi-threshold, error-rate-threshold.
--set-network-idle-hint=[(enabled|disabled)] — sets network idle hint to enabled or disabled.
--query-network-idle-hint — queries network idle hint.
--set-emergency-mode=[(on|off)] — sets emergency mode to on or off.
--query-emergency-mode — queries emergency mode.
--set-service-activation=[Data] — sets service activation with Data.

🍓 Phonebook options 🍓

--phonebook-query-configuration — queries the phonebook configuration.
--phonebook-read=[(Phonebook index)] — reads the phonebook entry with the given index.
--phonebook-read-all — reads all phonebook entries.
--phonebook-write=[(Name),(Number)[,(Index)]] — adds a new phonebook entry or updates an existing one.
--phonebook-delete=[(Phonebook index)] — deletes the phonebook entry with the given index.
--phonebook-delete-all — deletes all phonebook entries.

🦋 Device Service Stream options 🦋

--dss-connect=[(UUID),(Session ID)] — connects DSS session.
--dss-disconnect=[(UUID),(Session ID)] — disconnects DSS session.

⭐ Microsoft Firmware ID options ⭐

--ms-query-firmware-id — queries firmware ID.

🌸 Microsoft Host Shutdown options 🌸

--ms-notify-host-shutdown — notifies that host is shutting down.

🔥 Microsoft SAR options 🔥

--ms-set-sar-config=[(device|os),(enabled|disabled)[,[{antenna_index,backoff_index}...]]] — sets SAR config; it takes device or os, then enabled or disabled, then optional {antenna_index,backoff_index} pairs.
--ms-query-sar-config — queries SAR config.
--ms-set-transmission-status=[(enabled|disabled),(timer)] — sets transmission status and hysteresis timer (in seconds).
--ms-query-transmission-status — queries transmission status.

💖 AT&T Device Service options 💖

--atds-query-signal — queries signal info.
--atds-query-location — queries cell location.
--atds-query-operators — queries operators.
--atds-query-rat — queries Radio Access Technology.

👑 Intel Firmware Update Service options 👑

--intel-modem-reboot=[(Boot Mode),(Timeout)] — reboots modem. Boot mode and timeout arguments are only required if MBIMEx >= 2.0.

🧚 Microsoft Basic Connect Extensions options 🧚

--ms-query-pco=[SessionID] — queries PCO value. SessionID is optional and defaults to 0.
--ms-query-lte-attach-configuration — queries LTE attach configuration.
--ms-set-lte-attach-configuration=[(default|restore-factory)[,"key=value,..."[/"key=value,..."[/"key=value,..."]]]] — sets LTE attach configurations. Groups are separated by / if there is more than one, and allowed-keys are: ip-type, roaming-control, source, access-string, username, password, compression, auth.
--ms-query-lte-attach-info — queries LTE attach status information.
--ms-query-sys-caps — queries system capabilities.
--ms-query-device-caps — queries device capabilities.
--ms-query-slot-info-status=[SlotIndex] — queries slot information status.
--ms-set-device-slot-mappings=[(SlotIndex)[,(SlotIndex)[,...]]] — sets device slot mappings for each executor.
--ms-query-device-slot-mappings — queries device slot mappings.
--ms-query-location-info-status — queries location info status.
--ms-set-provisioned-contexts=["key=value,..."] — sets provisioned contexts. Allowed keys: operation, context-type, ip-type, state, roaming-control, media-type, source, auth, compression, username, password, access-string.
--ms-query-provisioned-contexts — queries provisioned contexts.
--ms-query-base-stations-info — queries base stations info.
--ms-device-reset — resets device.
--ms-query-version=[(MBIM version),(MBIM extended version)] — exchanges supported version information. Since MBIMEx v2.0.
--ms-query-registration-parameters — queries registration parameters. Since MBIMEx v3.0.
--ms-set-registration-parameters=["key=value,..."] — sets registration parameters. Required keys: mico-mode, drx-cycle, ladn-info, default-pdu-activation-hint, re-register-if-needed. Since MBIMEx v3.0.
--ms-query-modem-configuration — queries modem configuration. Since MBIMEx v3.0.
--ms-query-wake-reason — queries wake reason. Since MBIMEx v3.0.

🫶 Quectel options 🫶

--quectel-query-radio-state — queries radio state.
--quectel-set-radio-state=[(on)] — sets radio state to on.
--quectel-set-command=[(Command type),("Command")] — sends command to module. Command type is optional and defaults to AT; allowed options are (at, system).

🌈 Link management options 🌈

--link-list=[IFACE] — lists links created from a given interface.
--link-add=[iface=IFACE,prefix=PREFIX[,session-id=N]] — creates a new network interface link.
--link-delete=IFACE — deletes a given network interface link.
--link-delete-all=[IFACE] — deletes all network interface links from the given interface.

💜 Intel Thermal RF Service options 💜

--intel-query-rfim — queries RFIM frequency information.
--intel-set-rfim=[(on|off)] — enables or disables RFIM (disabled by default).

🎀 Microsoft Voice Extensions Service options 🎀

--ms-query-nitz — queries network identity and time zone.

💀 Microsoft UICC Low Level Access Service options 💀

--ms-query-uicc-application-list — queries UICC application list.
--ms-query-uicc-file-status=["key=value,..."] — queries UICC file status. Allowed keys: application-id, file-path.
--ms-query-uicc-read-binary=["key=value,..."] — reads UICC binary file. Allowed keys: application-id, file-path, read-offset, read-size, local-pin and data.
--ms-query-uicc-read-record=["key=value,..."] — reads UICC record file. Allowed keys: application-id, file-path, record-number, local-pin and data.
--ms-set-uicc-open-channel=["key=value,..."] — sets UICC open channel. Allowed keys: application-id, selectp2arg, channel-group.
--ms-set-uicc-close-channel=["key=value,..."] — sets UICC close channel. Allowed keys: channel, channel-group.
--ms-query-uicc-atr — queries UICC atr.
--ms-set-uicc-apdu=["key=value,..."] — sets the UICC apdu, bestie. allowed keys are channel, secure-message, classbyte-type, command ✨
--ms-set-uicc-reset=[(Pass Through Action)] — sets the UICC reset, that's it that's the whole vibe 🎀
--ms-query-uicc-reset — asks the modem what the UICC reset situation is rn 👀
--ms-set-uicc-terminal-capability=["key=value,..."] — sets the UICC terminal capability, and the only allowed key is terminal-capability, no cap 💅
--ms-query-uicc-terminal-capability — queries the UICC terminal capability, slay 🔥

Intel mutual authentication Service options 🔐

--intel-query-fcc-lock — query the FCC lock information 🦋
--intel-set-fcc-lock=[(ResponsePresent),(Response)] — set the FCC lock information, with ResponsePresent and Response as the args 🌸

Intel 5G tools options 📡

--intel-set-trace-config=[(TraceCmd)|(TraceValue)] — set the trace configuration, giving either a TraceCmd or a TraceValue ✨
--intel-query-trace-config=[(TraceCmd)] — query the trace configuration using a TraceCmd 👑

Google options 💙

--google-set-carrier-lock=[(Data)] — set the Google Carrier Lock with Data, periodt 🎀
--google-query-carrier-lock — query the Google Carrier Lock, iconic behavior 💅

FIbocom options 🧚

--fibocom-set-at-command="<AT command>" — sends an AT command to the modem and receives the AT response back, fr fr 💜

Simple message service options 💌

--sms-query-configuration — query the SMS configuration 🌸
--sms-query-message-store-status — query the SMS message store status 👀
--sms-delete=[(all|new|old|sent|draft|index=N)] — deletes all SMS matching a given filter; filters are all, new, old, sent, draft, or index=N 🗑️
--sms-read=[(all|new|old|sent|draft|index=N)] — reads all SMS matching a given filter; filters are all, new, old, sent, draft, or index=N 📖

Compal options 🍓

--compal-query-at-command="<AT command>" — sends an AT command to the modem and receives the AT response, same energy 💖

Intel AT Tunnel options 🚇

--intel-at-tunnel-set-at-command="<AT command>" — sends an AT command to the modem and receives the AT response, we love a consistent icon 🌈

Application Options ✨

-d, --device=[PATH] — specify the device path, iykyk 🫶
-p, --device-open-proxy — request to use the mbim-proxy proxy 👑
--device-open-ms-mbimex-v2 — request to enable Microsoft MBIMEx v2.0 support 🔥
--device-open-ms-mbimex-v3 — request to enable Microsoft MBIMEx v3.0 support 🔥🔥
--no-open=[Transaction ID] — do not explicitly open the MBIM device before running the command; you can hand it a Transaction ID 💀
--no-close — do not close the MBIM device after running the command, leaving it wide open 🙈
--noop — don't run any command at all. literally nothing. main character of doing nothing 😌
-v, --verbose — run the action with verbose logs, including the debug ones 🦋
--verbose-full — run the action with verbose logs, including the debug ones and personal info, so be careful what you paste in the group chat 😭
--silent — run the action with no logs; not even the error/warning ones. silence is golden 💅
--printable=[(Data)] — get the printable info of the given hex encoded MBIM message ⭐
-V, --version — print version 🎀

COPYRIGHT 📜

This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. (no cap, they really mean the no-warranty part 🙈)