Add-SqlFirewallRule

Reference

Module:: SQLServer

Adds a Windows Firewall rule to allow connections to a specific instance of SQL Server.

Syntax

Add-SqlFirewallRule
   [-Path <String[]>]
   [-Credential] <PSCredential>
   [-AutomaticallyAcceptUntrustedCertificates]
   [-ManagementPublicPort <Int32>]
   [-RetryTimeout <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-SqlFirewallRule
   -InputObject <Server[]>
   [-Credential] <PSCredential>
   [-AutomaticallyAcceptUntrustedCertificates]
   [-ManagementPublicPort <Int32>]
   [-RetryTimeout <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-SqlFirewallRule
   -ServerInstance <String[]>
   [-Credential] <PSCredential>
   [-AutomaticallyAcceptUntrustedCertificates]
   [-ManagementPublicPort <Int32>]
   [-RetryTimeout <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-SqlFirewallRule cmdlet adds a Windows Firewall rule to allow connections for the specified instance of SQL Server. The SQL Server Cloud Adapter must be running and accessible on the computer that hosts the instance of SQL Server.

This cmdlet supports the following modes of operation:

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

Note: This cmdlet ceased to work a long time ago. It's been removed in version 22 of the module.

Examples

Example 1: Add a Windows Firewall rule on the local computer

PS C:\> CD SQLSERVER:\SQL\Computer\Instance
PS SQLSERVER:\SQL\Computer\Instance> Add-SqlFirewallRule -Credential $Credential -AcceptSelfSignedCertificate

The first command changes directory to the SQL Server computer instance.

Example 2: Add a Windows Firewall rule on the local computer through a pipe

PS C:\> Get-SqlInstance -Credential $Credential -MachineName "Computer001" | Add-SqlFirewallRule -Credential $Credential -AcceptSelfSignedCertificate

This command gets the SQL Server instance based on the credentials stored in the variable named $Credentials. The command then pipes the SQL Server instances of SQL Server on the computer named 'Computer001'. The command then adds Windows Firewall rules to allow connections for each one of the instances. The self-signed certificate of the target machine is automatically accepted without prompting the user.

Parameters

-AutomaticallyAcceptUntrustedCertificates

Indicates that this cmdlet automatically accepts untrusted certificates.

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

-Confirm

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

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

-Credential

Specifies a PSCredential object for the connection to SQL Server. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Type:	PSCredential
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Specifies the server object of the target instance of SQL Server.

Type:	Server[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ManagementPublicPort

Specifies the public management port on the target machine. This parameter is used when the ports of the target machine are not directly accessible but are exposed through endpoints, which means that they need to be connected to a different port.

The SQL Server Cloud Adapter must be accessible by this port.

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

-Path

Specifies the path to the instance of SQL Server on which this cmdlet runs the operation. If this parameter is not specified, the value of this parameter defaults to the current working location.

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

-RetryTimeout

Specifies the time period to retry the command on the target server. After the timeout expires, no retry is attempted.

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

-ServerInstance

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

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

-WhatIf

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

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

Inputs

Microsoft.SqlServer.Management.Smo.Server[]

System.String[]

Outputs

System.Object

Remove-SqlFirewallRule