Add-SqlFirewallRule
Adds a Windows Firewall rule to allow connections to a specific instance of SQL Server.
Syntax
ByPath (Default)
Add-SqlFirewallRule
[-Credential] <PSCredential>
[-Path <String[]>]
[-AutomaticallyAcceptUntrustedCertificates]
[-ManagementPublicPort <Int32>]
[-RetryTimeout <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByObject
Add-SqlFirewallRule
[-Credential] <PSCredential>
-InputObject <Server[]>
[-AutomaticallyAcceptUntrustedCertificates]
[-ManagementPublicPort <Int32>]
[-RetryTimeout <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByName
Add-SqlFirewallRule
[-Credential] <PSCredential>
-ServerInstance <String[]>
[-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.
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.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 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.
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 of the target instance of SQL Server.
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 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.
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 this parameter is not specified, the value of this parameter defaults to 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 server. After the timeout expires, no retry is 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.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.
Inputs
Microsoft.SqlServer.Management.Smo.Server
System.String[]