Remove-SqlFirewallRule
Disables the Windows Firewall rule that allows connections to a specific instance of SQL Server.
Syntax
ByPath (Default)
Remove-SqlFirewallRule
[-Credential] <PSCredential>
[-Path <String[]>]
[-AutomaticallyAcceptUntrustedCertificates]
[-ManagementPublicPort <Int32>]
[-RetryTimeout <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByObject
Remove-SqlFirewallRule
[-Credential] <PSCredential>
-InputObject <Server[]>
[-AutomaticallyAcceptUntrustedCertificates]
[-ManagementPublicPort <Int32>]
[-RetryTimeout <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByName
Remove-SqlFirewallRule
[-Credential] <PSCredential>
-ServerInstance <String[]>
[-AutomaticallyAcceptUntrustedCertificates]
[-ManagementPublicPort <Int32>]
[-RetryTimeout <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-SqlFirewallRule cmdlet disables the Windows Firewall rule that allows connections to a specific instance of SQL Server.
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 ServerInstance object 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: Disable a Windows Firewall rule that blocks connections to a SQL Server instance
PS C:\> CD SQLSERVER:\SQL\Computer\Instance
PS SQLSERVER:\SQL\Computer\Instance> Remove-SqlFirewallRule -Credential $Credential -AcceptSelfSignedCertificate
This command disables the Windows Firewall rule on the computer to block connections to the SQL Server instance on this computer. The current working directory is used to determine the server instance where the operation should occur. The self-signed certificate of the target computer is automatically accepted without prompting the user.
Example 2: Disable a Windows Firewall rule that blocks connections to all SQL Server instances
PS C:\> Get-SqlInstance -Credential $Credential -MachineName "Computer002" | Remove-SqlFirewallRule -Credential $Credential -AcceptSelfSignedCertificate
This command gets all instances of SQL Server on the computer named Computer002 and disables the Windows Firewall rules to block connections to each one of them.
The self-signed certificate of the target computer is automatically accepted without prompting the user.
Parameters
-AutomaticallyAcceptUntrustedCertificates
Indicates that this cmdlet automatically accepts untrusted certificates.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies a user account with Windows Administrator credentials on the target computer.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the Server object, as an array, of the target instance.
Parameter properties
| Type: | Server[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ManagementPublicPort
Specifies the public management port on the target computer. This parameter should be used when the ports of the target computer are not directly accessible but are exposed through endpoints, which means that we need to connect to a different port.
SQL Server Cloud Adapter must be accessible by this port.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Path
Specifies the path 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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByPath
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RetryTimeout
Specifies the time period to retry the command on the target sever. After the timeout expires, no retry will be attempted.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ServerInstance
Specifies the name of an instance of SQL Server, as an array, that becomes the target of the operation.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.