Set-DbaNetworkConfiguration

Want to see the source code for this command? Check out Set-DbaNetworkConfiguration on GitHub.
Want to see the Bill Of Health for this command? Check out Set-DbaNetworkConfiguration.

Synopsis

Modifies SQL Server network protocol settings including TCP/IP, Named Pipes, and Shared Memory configurations.

Description

Modifies SQL Server network protocol settings through WMI, allowing you to enable or disable network protocols and configure TCP/IP properties like static or dynamic ports. This replaces the need to manually use SQL Server Configuration Manager for network changes.

Common DBA scenarios include switching instances from dynamic to static ports for firewall rules, enabling TCP/IP for remote connections, or configuring specific IP addresses for multi-homed servers. You can also pass modified objects from Get-DbaNetworkConfiguration to make complex property changes.

Network configuration changes require a SQL Server service restart to take effect - use the RestartService parameter to handle this automatically, otherwise you'll need to restart the service manually afterward.

Uses remote SQL WMI by default with PowerShell remoting as a fallback. Requires administrative privileges on the target server.

For detailed property explanations see: https://docs.microsoft.com/en-us/sql/tools/configuration-manager/sql-server-network-configuration

Syntax

Set-DbaNetworkConfiguration
    [-SqlInstance] <DbaInstanceParameter[]>
    [-Credential <PSCredential>]
    [-EnableProtocol <String>]
    [-DisableProtocol <String>]
    [-DynamicPortForIPAll]
    [-StaticPortForIPAll <Int32[]>]
    [-IpAddress <String[]>]
    [-RestartService]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Set-DbaNetworkConfiguration
    [-Credential <PSCredential>]
    [-RestartService]
    -InputObject <Object[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Set-DbaNetworkConfiguration -SqlInstance sql2016 -EnableProtocol SharedMemory -RestartService

Ensures that the shared memory network protocol for the default instance on sql2016 is enabled.
Restarts the service if needed.

Example: 2

PS C:\> Set-DbaNetworkConfiguration -SqlInstance sql2016\test -StaticPortForIPAll 14331, 14332 -RestartService

Ensures that the TCP/IP network protocol is enabled and configured to use the ports 14331 and 14332 for all IP addresses.
Restarts the service if needed.

Example: 3

PS C:\> $netConf = Get-DbaNetworkConfiguration -SqlInstance sqlserver2014a
PS C:\> $netConf.TcpIpProperties.KeepAlive = 60000
PS C:\> $netConf | Set-DbaNetworkConfiguration -RestartService -Confirm:$false

Changes the value of the KeepAlive property for the default instance on sqlserver2014a and restarts the service.
Does not prompt for confirmation.

Example: 4

PS C:\> Set-DbaNetworkConfiguration -SqlInstance sql2016\test -IpAddress 192.168.3.41:1433 -RestartService

Ensures that the TCP/IP network protocol is enabled and configured to only listen on port 1433 of IP address 192.168.3.41.
Restarts the service if needed.

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

-InputObject

Accepts a network configuration object from Get-DbaNetworkConfiguration for making complex property changes.
Use this when you need to modify specific TCP/IP properties like KeepAlive values or make multiple configuration changes.
The Get-DbaNetworkConfiguration command must use -OutputType Full to provide the complete configuration object.

Optional Parameters

-Credential

Credential object used to connect to the Computer as a different user.

-EnableProtocol

Enables a specific SQL Server network protocol for client connections.
Use SharedMemory for local-only connections, NamedPipes for legacy applications, or TcpIp for remote access.
TCP/IP is required for remote connections and most modern applications.

-DisableProtocol

Disables a specific SQL Server network protocol to prevent client connections via that method.
Commonly used to disable unneeded protocols for security or troubleshooting purposes.
Be cautious disabling TCP/IP as it will prevent all remote connections to the instance.

-DynamicPortForIPAll

Configures the instance to use a random port assigned by Windows for all IP addresses.
Use this for non-production environments or when you don't need predictable port numbers.
Automatically enables TCP/IP protocol and sets ListenAll to true, clearing any existing static port configuration.

-StaticPortForIPAll

Configures the instance to use specific port numbers for all IP addresses instead of dynamic ports.
Essential for production environments where firewall rules require predictable port numbers.
Automatically enables TCP/IP protocol and sets ListenAll to true. Accepts multiple ports as comma-separated values.

-IpAddress

Restricts the instance to listen only on specified IP addresses instead of all available interfaces.
Use this on multi-homed servers to control which network interfaces accept SQL Server connections.
Format as "192.168.1.10" for dynamic ports or "192.168.1.10:1433" for static ports. IPv6 addresses need square brackets like "[::1]:1433".

-RestartService

Automatically restarts the SQL Server service when network configuration changes are made.
Network configuration changes only take effect after a service restart, so use this to avoid manual restarts.
Without this parameter, you must manually restart the SQL Server service for changes to become active.

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.