Network shell (netsh)

Network shell (netsh) is a versatile and comprehensive command-line utility for configuring, managing, and monitoring network components and server roles on Windows and Windows Server systems. With netsh, you can view and modify network settings, automate tasks, and troubleshoot network issues locally or remotely.

In many scenarios, the netsh commands offer equivalent functionality to the Microsoft Management Console (MMC) snap-ins for managing networking server roles and features. This allows administrators to perform configuration and management tasks either through the graphical MMC interface or by using command-line automation.

For example, you can configure Network Policy Server (NPS) by using either the NPS MMC snap-in or the netsh commands in the netsh nps context. In addition, there are netsh commands for network technologies, such as for IPv6, network bridge, and Remote Procedure Call (RPC), that aren't available in Windows Server as an MMC snap-in.

Example syntax

netsh [-a <Aliasfile>][-c <Context>][-r <Remotecomputer>][-u [<domainname>\<username>][-p <Password> | [{<NetshCommand> | -f <scriptfile>}]

The following parameters are optional.

If you specify -r followed by another command, netsh runs the command on the remote computer and then returns to the command prompt. If you specify -r without another command, netsh opens in remote mode. The process is similar to using set machine at the netsh command shell. When you use -r, you set the target computer for the current instance of netsh only.

If your string value contains spaces between characters, you must enclose the string value in quotation marks. For example, -r "contoso remote device". After you exit and reenter netsh, the target computer is reset as the local computer. You can run netsh commands on a remote computer by specifying a computer name stored in WINS, a UNC name, an internet name to be resolved by the DNS server, or an IP address.

Running netsh commands

Running netsh commands can be performed using an elevated command prompt or PowerShell window. You can change to the context that contains the command you want to use depending on the networking components that are installed.

For example, if you type netsh, you're taken directly into the network shell. Once here, if you type dhcp and press Enter, you're taken into the context menu for dhcpclient commands.

Command contexts

Netsh interacts with other operating system components by using dynamic-link library (DLL) files. Each netsh helper DLL provides an extensive set of features called a context, which is a group of commands that's specific to a networking server role or feature. These contexts extend the functionality of netsh by providing configuration and monitoring support for one or more services, utilities, or protocols.

For example, dhcpmon.dll provides netsh with the context and set of commands necessary to configure and manage DHCP servers.

The > placement let's you know which context or subcontext you're in. You can obtain a list of netsh contexts by running netsh ? or netsh help and pressing Enter for any of the available commands.

Here's an example output:

The following commands are available:

Commands in this context:
..            - Goes up one context level.
?             - Displays a list of commands.
abort         - Discards changes made while in offline mode.
add           - Adds a configuration entry to a list of entries.
advfirewall   - Changes to the 'netsh advfirewall' context.
alias         - Adds an alias.
branchcache   - Changes to the 'netsh branchcache' context.
bridge        - Changes to the 'netsh bridge' context.
bye           - Exits the program.
commit        - Commits changes made while in offline mode.
delete        - Deletes a configuration entry from a list of entries.
dhcpclient    - Changes to the 'netsh dhcpclient' context.
dnsclient     - Changes to the 'netsh dnsclient' context.
dump          - Displays a configuration script.
exec          - Runs a script file.
exit          - Exits the program.
firewall      - Changes to the 'netsh firewall' context.
help          - Displays a list of commands.
http          - Changes to the 'netsh http' context.
interface     - Changes to the 'netsh interface' context.
ipsec         - Changes to the 'netsh ipsec' context.
ipsecdosprotection - Changes to the 'netsh ipsecdosprotection' context.
lan           - Changes to the 'netsh lan' context.
namespace     - Changes to the 'netsh namespace' context.
netio         - Changes to the 'netsh netio' context.
offline       - Sets the current mode to offline.
online        - Sets the current mode to online.
popd          - Pops a context from the stack.
pushd         - Pushes current context on stack.
quit          - Exits the program.
ras           - Changes to the 'netsh ras' context.
rpc           - Changes to the 'netsh rpc' context.
set           - Updates configuration settings.
show          - Displays information.
trace         - Changes to the 'netsh trace' context.
unalias       - Deletes an alias.
wfp           - Changes to the 'netsh wfp' context.
winhttp       - Changes to the 'netsh winhttp' context.
winsock       - Changes to the 'netsh winsock' context.

The following sub-contexts are available:
advfirewall branchcache bridge dhcpclient dnsclient firewall http interface ipsec lan mbn namespace netio nlm ras rpc trace wcn wfp winhttp winsock wlan

To view help for a command, type the command, followed by a space, and then type ?.

Command subcontexts

The contexts might also include both commands and nested contexts known as subcontexts. For instance, the interface context contains subcontexts such as ipv4 and ipv6, which allow you to manage specific network interface settings. For example:

netsh> interface help

The following commands are available:

Commands in this context:
6to4           - Changes to the 'netsh interface 6to4' context.
?              - Displays a list of commands.
dump           - Displays a configuration script.
fl48           - Changes to the 'netsh interface fl48' context.
fl68           - Changes to the 'netsh interface fl68' context.
help           - Displays a list of commands.
httpstunnel    - Changes to the 'netsh interface httpstunnel' context.
ipv4           - Changes to the 'netsh interface ipv4' context.
ipv6           - Changes to the 'netsh interface ipv6' context.
isatap         - Changes to the 'netsh interface isatap' context.
portproxy      - Changes to the 'netsh interface portproxy' context.
set            - Sets configuration information.
show           - Displays information.
tcp            - Changes to the 'netsh interface tcp' context.
teredo         - Changes to the 'netsh interface teredo' context.
udp            - Changes to the 'netsh interface udp' context.

The following sub-contexts are available:
 6to4 fl48 fl68 httpstunnel ipv4 ipv6 isatap portproxy tcp teredo udp

To view help for a command, type the command, followed by a space, and then
 type ?.

To perform tasks in another context without changing from your current context, type the context path of the command you want to use at the netsh shell. For example, to add a static IPv4 address for "NetLAN1" and specify both the subnet mask and gateway, type:

netsh interface ipv4 set address "NetLAN1" static <IP_Address> <Subnet_Mask> <Gateway>

Formatting legend

You can use the following formatting legend to interpret and use correct command syntax when running commands interactively, in a batch file, or a script.

• Text in italic is information that you must supply when you type the command. For example, if a command has a parameter named -UserName, you must type the actual user name.
• Text in bold is information that you must type exactly as shown when you type the command.
• Text followed by an ellipsis ... is a parameter that can be repeated several times in a command line.
• Text that's between brackets [ ] is an optional item.
• Text that's between braces { } with choices separated by a pipe provides a set of choices from which you must select only one, such as {enable|disable}.
• Text that's formatted with the Courier font is code or program output.

String values for netsh commands

There are commands that contain parameters for which a string value is required. In the case where a string value contains spaces between characters, you're required to enclose the string value in double quotation marks.

When setting the interface parameter for IPv4 networks with a string value of Wireless Network Connection to DHCP, use double quotation marks around the string value. For example:

netsh interface ipv4> set address name="Wireless Network Connection" dhcp

Alternatively, for network interfaces, the index number can be used in place of the name associated to it. For example:

netsh interface ipv4> set address name=15 dhcp

To find the name or index of the connected interfaces in the interface subcontext, select your interface type and type show interfaces to view detailed information. For example:

netsh interface> ipv4 show interfaces

netsh interface> ipv6 show interfaces

If you aren't in the interface subcontext, you can run the full command for either interface. For example:

netsh interface ipv4 show interfaces

netsh interface ipv6 show interfaces

Using netsh in batch files

A batch file is a plain text file that contains a series of commands to be executed by the Windows Command Prompt (CMD). Batch files have a .bat or .cmd extension. They're used to automate repetitive tasks, manage system configurations, and run sequences of commands without user intervention. Batch files are especially useful for tasks that involve multiple command-line instructions.

A batch script would be useful in these scenarios:

• Bulk network configuration: If you need to configure network settings for multiple computers, a batch file can streamline the process by automating the setup. Bulk configurations are helpful in enterprise environments or for IT professionals managing multiple machines.

• Network reconfiguration: Users switching between different network environments can use batch files to quickly change settings like IP addresses and DNS servers without manual intervention.

• Backup and restore settings: You can create a batch script to backup network settings before making changes, and another to restore them if needed.

Here's an example batch file. The lines beginning with "rem" are comments that let users know what action the commands perform:

@echo off
echo Configuring network settings...

REM Set the IP address, subnet mask, and default gateway
netsh interface ip set address name="Ethernet" static 192.168.1.100 255.255.255.0 192.168.1.1

REM Set the DNS server address
netsh interface ip set dns name="Ethernet" static 8.8.8.8

REM Add a secondary DNS server
netsh interface ip add dns name="Ethernet" 8.8.4.4 index=2

REM Enable the firewall
netsh advfirewall set allprofiles state on

echo Network settings configured successfully.
pause

Here's a brief explanation of what this script does:

• It sets a static IP address, subnet mask, and default gateway for the network interface named "Ethernet".
• Configures the primary DNS server to be used.
• Adds a secondary (fallback) DNS server.
• Enables the Windows Firewall with Advanced Security for all profiles.

See also

• Command-Line Syntax Key