Netsh Mobile Broadband Network commands
Applies to: Windows Server 2022, Windows Server 2019, Windows Server 2016, Azure Stack HCI, versions 21H2 and 20H2
You can use netsh mbn to query and configure Mobile Broadband Network (MBN) settings and parameters.
Tip
You can get help on the netsh mbn command by using
netsh mbn /?
The available netsh mbn commands are:
add
Adds a configuration entry to a table.
The available netsh mbn add commands are:
dmprofile
Adds a DM Config profile in the Profile Data Store.
Syntax
add dmprofile [interface=]<string> [name=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| name | Name of the profile XML file. The name of the XML file containing the profile data. | Required |
Example
add dmprofile interface="Cellular" name="Profile1.xml"
profile
Adds a network profile in the Profile Data Store.
Syntax
add profile [interface=]<string> [name=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| name | Name of the profile XML file. The name of the XML file containing the profile data. | Required |
Example
add profile interface="Cellular" name="Profile1.xml"
connect
Connects to a Mobile Broadband network.
Syntax
connect [interface=]<string> [connmode=]tmp|name [name=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| connmode | Specifies how connection parameters are being provided. You can request the connection either using a profile XML, or using a profile name for the profile XML that has been previously stored in the Mobile Broadband Profile Data Store using the netsh mbn add profile command. In former case, the parameter connmode shall hold tmp as value. Whereas it shall be name in the latter case |
Required |
| name | Name of the profile XML file. The name of the XML file containing the profile data. | Required |
Examples
connect interface="Cellular" connmode=tmp name=d:\profile.xml
connect interface="Cellular" connmode=name name=MyProfileName
delete
Deletes a configuration entry from a table.
The available netsh mbn delete commands are:
dmprofile
Deletes a DM Config profile from the Profile Data Store.
Syntax
delete dmprofile [interface=]<string> [name=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| name | Name of the profile XML file. The name of the XML file containing the profile data. | Required |
Example
delete dmprofile interface="Cellular" name="myProfileName"
profile
Deletes a network profile from the Profile Data Store.
Syntax
delete profile [interface=]<string> [name=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| name | Name of the profile XML file. The name of the XML file containing the profile data. | Required |
Example
delete profile interface="Cellular" name="myProfileName"
diagnose
Runs diagnostics for basic cellular problems.
Syntax
diagnose [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
diagnose interface="Cellular"
disconnect
Disconnects from a Mobile Broadband network.
Syntax
disconnect [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
disconnect interface="Cellular"
dump
Displays a configuration script.
Creates a script that contains the current configuration. If saved to a file, this script can be used to restore altered configuration settings.
Syntax
dump
help
Displays a list of commands.
Syntax
help
set
Sets configuration information.
The available netsh mbn set commands are:
- acstate
- dataenablement
- dataroamcontrol
- enterpriseapnparams
- highestconncategory
- powerstate
- profileparameter
- slotmapping
- tracing
acstate
Sets the Mobile Broadband data auto connect state for the given interface.
Syntax
set acstate [interface=]<string> [state=]autooff|autoon|manualoff|manualon
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| name | The auto connect state to be set. One of the following values:autooff: Auto connect token off.autoon: Auto connect token on.manualoff: Manual connect token off.manualon: Manual connect token on. |
Required |
Example
set acstate interface="Cellular" state=autoon
dataenablement
Turns the Mobile Broadband data on or off for the given profile set and interface.
Syntax
set dataenablement [interface=]<string> [profileset=]internet|mms|all [mode=]yes|no
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| profileset | Name of the profile set. | Required |
| mode | One of the following values:yes: Enables the target profile set.no: Disables the target profile set. |
Required |
Example
set dataenablement interface="Cellular" profileset=mms mode=yes
dataroamcontrol
Sets the Mobile Broadband data roam control state for the given profile set and interface.
Syntax
set dataroamcontrol [interface=]<string> [profileset=]internet|mms|all [state=]none|partner|all
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| profileset | Name of the profile set. | Required |
| mode | One of the following values:none: Home carrier only.partner: Home and partner carriers only.all: Home, partner, and roaming carriers. |
Required |
Example
set dataroamcontrol interface="Cellular" profileset=mms mode=partner
enterpriseapnparams
Sets the Mobile Broadband data enterpriseAPN parameters for the given interface.
Syntax
set enterpriseapnparams [interface=]<string> [allowusercontrol=]yes|no|nc [allowuserview=]yes|no|nc [profileaction=]add|delete|modify|nc
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| allowusercontrol | One of the following values:yes: allow user control enterpriseAPN.no: disallow user control enterpriseAPN.nc: no change. |
Required |
| allowuserview | One of the following values:yes: allow user view enterpriseAPN.no: disallow user view enterpriseAPN.nc: no change. |
Required |
| profileaction | One of the following values:add: an enterpriseAPN profile is added.delete: an enterpriseAPN profile is deleted.modify: an enterpriseAPN profile is modified.nc: no change. |
Required |
Example
set enterpriseapnparams interface="Cellular" profileset=mms mode=yes
highestconncategory
Sets the Mobile Broadband data highest connection category for the given interface.
Syntax
set highestconncategory [interface=]<string> [highestcc=]admim|user|operator|device
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| highestcc | One of the following values:admin: admin provisioned profiles.user: user provisioned profiles.operator: operator provisioned profiles.device: device provisioned profiles. |
Required |
Example
set highestconncategory interface="Cellular" highestcc=operator
powerstate
Turns the Mobile Broadband radio on or off for the given interface.
Syntax
set powerstate [interface=]<string> [state=]on|off
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| state | One of the following values:on: power on radio transceiver.off: power off the radio transceiver. |
Required |
Example
set powerstate interface="Cellular" state=on
profileparameter
Set parameters in a Mobile Broadband Network Profile.
Syntax
set profileparameter [name=]<string> [[interface=]<string>] [[cost]=default|unrestricted|fixed|variable]
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| name | Name of the profile to be modified. If the interface is specified, then only the profile on that interface is modified. | Required |
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Optional |
| cost | Cost associated with the profile. | Optional |
Remarks
At least one parameter between the interface name and the cost must be specified.
Example
set profileparameter name="profile 1" cost=default
slotmapping
Sets the Mobile Broadband modem slot mapping for the given interface.
Syntax
set slotmapping [interface=]<string> [slotindex=]<integer>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| slotindex | Slot index to be set. | Required |
Example
set slotmapping interface="Cellular" slotindex=1
tracing
Enable or disable tracing.
Syntax
set tracing [mode=]yes|no
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| mode | One of the following values:yes: Enables tracing for Mobile Broadband.no: Disables tracing for Mobile Broadband. |
Required |
Example
set tracing mode=yes
show
Displays mobile broadband network information.
The available netsh mbn show commands are:
- acstate
- capability
- connection
- dataenablement
- dataroamcontrol
- dmprofiles
- enterpriseapnparams
- highestconncategory
- homeprovider
- interfaces
- netlteattachinfo
- pin
- pinlist
- preferredproviders
- profiles
- profilestate
- provisionedcontexts
- purpose
- radio
- readyinfo
- signal
- slotmapping
- slotstatus
- smsconfig
- tracing
- visibleproviders
acstate
Shows the Mobile Broadband data auto connect state for the given interface.
Syntax
show acstate [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show acstate interface="Cellular"
capability
Shows the interface capability information for the given interface.
Syntax
show capability [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show capability interface="Cellular"
connection
Shows the current connection information for the given interface.
Syntax
show connection [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show connection interface="Cellular"
dataenablement
Shows the Mobile Broadband data enablement state for the given interface.
Syntax
show dataenablement [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show dataenablement interface="Cellular"
dataroamcontrol
Shows the Mobile Broadband data roam control state for the given interface.
Syntax
show dataroamcontrol [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show dataroamcontrol interface="Cellular"
dmprofiles
Shows a list of DM Config profiles configured on the system.
Syntax
show dmprofiles [[name=]<string>] [[interface=]<string>]
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| name | Name of the profile to display. | Optional |
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Optional |
Remarks
Shows the profile data or lists the profiles on the system.
If the profile name is given, then the content of the profile are displayed. Otherwise profiles are listed for the interface.
If the interface name is given, only the specified profile on the given interface are listed. Otherwise, the first matched profile is displayed.
Example
show dmprofiles name="profile 1" interface="Cellular"
show dmprofiles name="profile 2"
show dmprofiles
enterpriseapnparams
Shows the Mobile Broadband data enterpriseAPN parameters for the given interface.
Syntax
show enterpriseapnparams [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show enterpriseapnparams interface="Cellular"
highestconncategory
Shows the Mobile Broadband data highest connnection category for the given interface.
Syntax
show highestconncategory [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show highestconncategory interface="Cellular"
homeprovider
Shows the home provider information for the given interface.
Syntax
show homeprovider [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show homeprovider interface="Cellular"
interfaces
Shows a list of Mobile Broadband interfaces on the system. There are no parameters for this command.
Syntax
show interfaces
netlteattachinfo
Shows the Mobile Broadband network LTE attach information for the given interface.
Syntax
show netlteattachinfo [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show netlteattachinfo interface="Cellular"
pin
Shows the pin information for the given interface.
Syntax
show pin [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show pin interface="Cellular"
pinlist
Shows the pin list information for the given interface.
Syntax
show pinlist [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show pinlist interface="Cellular"
preferredproviders
Shows the preferred providers list for the given interface.
Syntax
show preferredproviders [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show preferredproviders interface="Cellular"
profiles
Shows a list of profiles configured on the system.
Syntax
show profiles [[name=]<string>] [[interface=]<string>] [[purpose=]<string>]
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| name | Name of the profile to display. | Optional |
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Optional |
| purpose | Purpose | Optional |
Remarks
If the profile name is given, then the content of the profile are displayed. Otherwise profiles are listed for the interface.
If the interface name is given, only the specified profile on the given interface will be listed. Otherwise, the first matched profile is displayed.
If the purpose is provided, only profiles with the matching purpose GUID are displayed. Otherwise, profiles won't be filtered by purpose. The string can either be a GUID with curly brackets or one of the following strings: internet, supl, mms, ims, or allhost.
Example
show profiles interface="Cellular" purpose="{00000000-0000-0000-0000-000000000000}"
show profiles name="profile 1" interface="Cellular"
show profiles name="profile 2"
show profiles
profilestate
Shows the state of a Mobile Broadband profile for the given interface.
Syntax
show profilestate [interface=]<string> [name=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
| name | Name of the profile. The name of the profile that has the state to be shown. | Required |
Example
show profilestate interface="Cellular" name="myProfileName"
provisionedcontexts
Shows the provisioned contexts information for the given interface.
Syntax
show provisionedcontexts [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show provisionedcontexts interface="Cellular"
purpose
Shows the purpose group GUIDs that can be used to filter profiles on the device. There are no parameters for this command.
Syntax
show purpose
radio
Shows the radio state information for the given interface.
Syntax
show radio [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show radio interface="Cellular"
readyinfo
Shows the ready information for the given interface.
Syntax
show readyinfo [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show readyinfo interface="Cellular"
signal
Shows the signal information for the given interface.
Syntax
show signal [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show signal interface="Cellular"
slotmapping
Shows the Mobile Broadband modem slot mapping for the given interface.
Syntax
show slotmapping [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show slotmapping interface="Cellular"
slotstatus
Shows the Mobile Broadband modem slot status for the given interface.
Syntax
show slotstatus [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show slotstatus interface="Cellular"
smsconfig
Shows the SMS configuration information for the given interface.
Syntax
show smsconfig [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show smsconfig interface="Cellular"
tracing
Shows whether Mobile Broadband tracing is enabled or disabled.
Syntax
show tracing
visibleproviders
Shows the visible providers list for the given interface.
Syntax
show visibleproviders [interface=]<string>
Parameters
| Parameter | Description | Requirement |
|---|---|---|
| interface | Interface name. One of the interface names shown by netsh mbn show interfaces command. |
Required |
Example
show visibleproviders interface="Cellular"
test
Runs tests for a specific feature area, while collecting logs.
Syntax
test [feature=<feature area>] [testPath=<path>] [taefPath=<path>] [param=<test input params>]
Parameters
| Tag | Value | Optional? |
|---|---|---|
| feature | A feature area out of the supported feature areas listed in the following remarks section | Required |
| testpath | Path containing the test binaries | Optional if HLK Server is installed |
| taefpath | Path containing the TAEF binaries | Optional if HLK Server is installed |
| param | Comma separated parameters, to be used for the tests | Required for certain feature areas, optional for others |
Remarks
Supported feature areas are:
- connectivity
- power
- radio
- esim
- sms
- dssa
- lte
- bringup
Some tests require more parameters to be provided in the param field.
Here are the required parameters for the features:
- connectivity: AccessString, UserName (If applicable), Password (If applicable)
- radio: AccessString, UserName (If applicable), Password (If applicable)
- esim: ActivationCode
- bringup: AccessString, UserName (If applicable), Password (If applicable)
Examples
test feature=connectivity param="AccessString=internet"
test feature=lte testpath="C:\\data\\test\\bin" taefpath="C:\\data\\test\\bin"
test feature=lte
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for