Set-​Sql​Network​Configuration

Sets the network configuration of the target instance of SQL Server.

Syntax

Set-SqlNetworkConfiguration
   [-Credential] <PSCredential>
   [-Protocol] <Protocols>
   [[-Port] <Int32>]
   [-Disable]
   [-ForceServiceRestart]
   [-NoServiceRestart]
   [-Path <String[]>]
   [-AutomaticallyAcceptUntrustedCertificates]
   [-ManagementPublicPort <Int32>]
   [-RetryTimeout <Int32>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SqlNetworkConfiguration
   [-Credential] <PSCredential>
   [-Protocol] <Protocols>
   [[-Port] <Int32>]
   [-Disable]
   [-ForceServiceRestart]
   [-NoServiceRestart]
   [-AutomaticallyAcceptUntrustedCertificates]
   [-ManagementPublicPort <Int32>]
   [-RetryTimeout <Int32>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   -InputObject <Server[]>
   [<CommonParameters>]
Set-SqlNetworkConfiguration
   [-Credential] <PSCredential>
   [-Protocol] <Protocols>
   [[-Port] <Int32>]
   [-Disable]
   [-ForceServiceRestart]
   [-NoServiceRestart]
   [-AutomaticallyAcceptUntrustedCertificates]
   [-ManagementPublicPort <Int32>]
   [-RetryTimeout <Int32>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   -ServerInstance <String[]>
   [<CommonParameters>]

Description

The Set-SqlNetworkConfiguration cmdlet sets the network configuration of the target instance of SQL Server.

SQL Server Cloud Adapter must be running and accessible on the machine that hosts the instance of SQL Server.

This cmdlet supports the following modes of operation:

  • Specify the instance of the Windows PowerShell path.
  • Specify the server object.
  • Specify the ServerInstance object of the target instance of SQL Server.

Examples

Example 1: Set the network configuration of the target SQL Server

PS C:\> CD SQLSERVER:\SQL\Computer\Instance;
PS SQLSERVER:\SQL\Computer\Instance> Set-SqlNetworkConfiguration -Credential $credential -Protocol TCP -Port 1433-NoServiceRestart -AcceptSelfSignedCertificate;

The first command changes the directory to SQLSERVER:\SQL\Computer\Instance. The second command sets the network configuration to accept TCP connections at port 1433 for the server instance named Computer\Instance. The current working directory is used to determine the server instance where the operation occurs. The SQL Server service is not restarted automatically. The self-signed certificate of the target machine is automatically accepted without prompting the user.

Example 2: Set the network configuration of the target SQL Server using the pipeline

PS C:\> Get-SqlInstance -Credential $Credential -MachineName "Computer006" | Set-SqlNetworkConfiguration -Credential $Credential -Protocol TCP -Disable -NoServiceRestart -AcceptSelfSignedCertificate;

This command gets all instances of SQL Server on the computer named Computer006 and disables TCP connections for each one of them. The SQL Server service is not restarted automatically. The self-signed certificate of the target machine is automatically accepted without prompting the user.

Required Parameters

-Credential

Specifies a user account with Windows Administrator credentials on the target computer.

Type:PSCredential
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Specifies an array of server objects of the target instance.

Type:Server[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Protocol

Specifies the network protocol that we want to configure on the target instance of SQL Server.

Type:Protocols
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ServerInstance

Specifies the name of an instance, as an array, of SQL Server that becomes the target of the operation.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False

Optional Parameters

-AutomaticallyAcceptUntrustedCertificates

Indicates that this cmdlet automatically accepts untrusted certificates.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Disable

Indicates that this cmdlet disables the specified network protocol on the target instance of SQL Server.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ForceServiceRestart

Indicates that this cmdlet forces the SQL Server service to restart, if necessary, without prompting the user.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ManagementPublicPort

Specifies the public management port on the target computer. This parameter is used when the ports of the target computer are not directly accessible but are exposed through endpoints. This means that this cmdlet needs to connect to a different port.

SQL Server Cloud Adapter must be accessible by this port.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NoServiceRestart

Indicates that this cmdlet prevents a restart of the SQL Server service without prompting the user.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Path

Specifies the path, as an array, to the instance of SQL Server on which this cmdlet runs the operation. If you do not specify a value for this parameter, the cmdlet uses the current working location.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Port

Specifies the port to accept TCP connections. To configure dynamic ports, this parameter should be set to zero.

Type:Int32
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RetryTimeout

Specifies the time period to retry the command on the target sever. After the timeout expires, no retry will be attempted.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False