Netsh mbn commands

netsh mbn is used to query and configure mobile broadband settings and parameters.

Netsh mbn

List of netsh mbn commands:

• add
• connect
• delete
• disconnect
• diagnose
• dump
• help
• set
• show
• test

add

Adds a configuration entry to a table. The available netsh mbn add commands are:

• dmprofile
• profile

dmprofile

Adds a DM Config profile in the Profile Data Store.

Syntax

add dmprofile [interface=]<string> [name=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required name Name of the profile XML file. It is the name of the XML file containing the profile data. Required

profile

Adds a network profile in the Profile Data Store.

Syntax

add profile [interface=]<string> [name=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required name Name of the profile XML file. It is the name of the XML file containing the profile data. Required

connect

Connects to a Mobile Broadband network.

Syntax

connect [interface=]<string> [connmode=]tmp|name [name=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required connmode Specifies how connection parameters are being provided. The connection can be requested using a profile XML, or using profile name for the profile XML that has been previously stored in Mobile Broadband Profile Data Store using "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. It is the name of the XML file containing the profile data. Required

delete

Deletes a configuration entry from a table. The available netsh mbn delete commands are:

• dmprofile
• profile

dmprofile

Deletes a DM Config profile from the Profile Data Store.

Syntax

delete dmprofile [interface=]<string> [name=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required name Name of the profile XML file. It is the name of the XML file containing the profile data. Required

profile

Deletes a network profile from the Profile Data Store.

Syntax

delete profile [interface=]<string> [name=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required name Name of the profile XML file. It is the name of the XML file containing the profile data. Required

diagnose

Runs diagnostics for basic cellular problems.

Syntax

diagnose [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

disconnect

Disconnects from a Mobile Broadband network.

Syntax

disconnect [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

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. List of netsh mbn set commands:

• 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

interface Interface name. It is 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

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

interface Interface name. It is 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

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

interface Interface name. It is 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

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

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required allowusercontrol One of the following values: yes: allow end user control enterpriseAPN. no: disallow end user control enterpriseAPN. nc: no change. Required allowuserview One of the following values: yes: allow end user view enterpriseAPN. no: disallow end user view enterpriseAPN. nc: no change. Required profileaction One of the following values: add: an enterpriseAPN profile is just added. delete: an enterpriseAPN profile is just deleted. modify: an enterpriseAPN profile is just modified. nc: no change. Required

highestconncategory

Sets the Mobile Broadband data highest connnection category for the given interface.

Syntax

set highestconncategory [interface=]<string> [highestcc=]admim|user|operator|device

Parameters

interface Interface name. It is 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 proviioned profiles. operator: operator proviioned profiles. device: device proviioned profiles. Required

powerstate

Turns the Mobile Broadband radio on or off for the given interface.

Syntax

set powerstate [interface=]<string> [state=]on|off

Parameters

interface Interface name. It is 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

profileparameter

Set parameters in a Mobile Broadband Network Profile.

Syntax

set profileparameter [name=]<string> [[interface=]<string>] [[cost]=default|unrestricted|fixed|variable]

Parameters

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. It is one of the interface names shown by "netsh mbn show interfaces" command. Optional cost Cost associated with the profile. Optional

slotmapping

Sets the Mobile Broadband modem slot mapping for the given interface.

Syntax

set slotmapping [interface=]<string> [slotindex=]

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required slotindex Slot index to be set. Required

tracing

Enable or disable tracing.

Syntax

set tracing [mode=]yes|no

Parameters

mode One of the following values: yes: Enables tracing for Mobile Broadband. no: Disables tracing for Mobile Broadband. Required

show

Displays mobile broadband network information. List of netsh mbn show commands

• 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

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

capability

Shows the interface capability information for the given interface.

Syntax

show capability [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

connection

Shows the current connection information for the given interface.

Syntax

show connection [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

dataenablement

Shows the Mobile Broadband data enablement state for the given interface.

Syntax

show dataenablement [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

dataroamcontrol

Shows the Mobile Broadband data roam control state for the given interface.

Syntax

show dataroamcontrol [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

dmprofiles

Shows a list of DM Config profiles configured on the system.

Syntax

show dmprofiles [[name=]<string>] [[interface=]<string>]

Parameters

name Name of the profile to display. Optional interface Interface name. It is 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 profile name is given then the content of the profile will be displayed. Otherwise profiles will be listed for the interface. If interface name is given, only the specified profile on the given interface will be listed. Otherwise, first matched profile will be displayed.

enterpriseapnparams

Shows the Mobile Broadband data enterpriseAPN parameters for the given interface.

Syntax

show enterpriseapnparams [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

highestconncategory

Shows the Mobile Broadband data highest connnection category for the given interface.

Syntax

show highestconncategory [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

homeprovider

Shows the home provider information for the given interface.

Syntax

Shows the home provider information for the given interface.

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

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

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

pin

Shows the pin information for the given interface.

Syntax

show pin [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

pinlist

Shows the pin list information for the given interface.

Syntax

show pinlist [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

preferredproviders

Shows the preferred providers list for the given interface.

Syntax

show preferredproviders [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

profiles

Shows a list of profiles configured on the system.

Syntax

show profiles [[name=]<string>] [[interface=]<string>] [[purpose=]<string>]

Parameters

name Name of the profile to display. Optional interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Optional purpose Purpose Optional

Remarks

If profile name is given then the content of the profile will be displayed. Otherwise profiles will be listed for the interface. If interface name is given, only the specified profile on the given interface will be listed. Otherwise, first matched profile will be displayed. If the purpose is provided, only profiles with the matching purpose GUID will be displayed. Otherwise, profiles will not 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.

profilestate

Shows the state of a Mobile Broadband profile for the given interface.

Syntax

show profilestate [interface=]<string> [name=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required name Name of the profile. It is the name of the profile that has the state to be shown. Required

provisionedcontexts

Shows the provisioned contexts information for the given interface.

Syntax

show provisionedcontexts [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

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

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

readyinfo

Shows the ready information for the given interface.

Syntax

show readyinfo [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

signal

Shows the signal information for the given interface.

Syntax

show signal [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

slotmapping

Shows the Mobile Broadband modem slot mapping for the given interface.

Syntax

show slotmapping [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

slotstatus

Shows the Mobile Broadband modem slot status for the given interface.

Syntax

show slotstatus [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

smsconfig

Shows the SMS configuration information for the given interface.

Syntax

show smsconfig [interface=]<string>

Parameters

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

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

interface Interface name. It is one of the interface names shown by "netsh mbn show interfaces" command. Required

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 below 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 additional test parameters that need to be provided in the param field. The required parameters for the features are listed below.

• 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)

Resources and References

• https://docs.microsoft.com/en-us/windows-server/networking/technologies/netsh/netsh
• https://docs.microsoft.com/en-us/windows-server/networking/technologies/netsh/netsh-contexts
• https://docs.microsoft.com/en-us/windows-server/networking/technologies/netsh/netsh-wins
• https://docs.microsoft.com/en-us/windows-server/networking/technologies/netsh/netsh-http
• https://docs.microsoft.com/en-us/windows-server/networking/technologies/netsh/netsh-interface-portproxy
• https://docs.microsoft.com/en-us/windows-server/networking/technologies/netsh/netsh-mbn