functions/Set-DbaTcpPort.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
Function Set-DbaTcpPort
{
<#
.SYNOPSIS
Changes the TCP port used by the specified SQL Server.
  
.DESCRIPTION
This function changes the TCP port used by the specified SQL Server.
   
.PARAMETER SqlServer
The SQL Server that you're connecting to.
 
.PARAMETER Credential
Credential object used to connect to the SQL Server as a different user
 
.PARAMETER IPAddress
Wich IPAddress should the portchange , if omitted allip (0.0.0.0) will be changed with the new portnumber.
 
.PARAMETER Port
TCPPort that SQLService should listen on.
 
.NOTES
dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 Chrissy LeMaire
 
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
 
.LINK
https://dbatools.io/Set-DbaTcpPort
 
.EXAMPLE
Set-DbaTcpPort -SqlServer sqlserver2014a -Port 1433
 
Sets the port number 1433 for allips on the default instance on sqlserver2014a
 
.EXAMPLE
Set-DbaTcpPort -SqlServer winserver\sqlexpress -IpAddress 192.168.1.22 -Port 1433
 
Sets the port number 1433 for IP 192.168.1.22 on the sqlexpress instance on winserver    
 
.EXAMPLE
Set-DbaTcpPort -sqlserver 'SQLDB2014A' ,'SQLDB2016B' -port 1337
 
Sets the port number 1337 for ALLIP's on sqlserver SQLDB2014A and SQLDB2016B
#>

    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = "High")]
    Param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlInstance")]
        [string[]]$SqlServer,
        [Alias("SqlCredential")]
        [PsCredential]$Credential,
        [parameter(Mandatory = $true)]
        [ValidateRange(1, 65535)]
        [int]$Port,
        [string[]]$IpAddress
    )
    BEGIN
    {

        if ($ipaddress.Length -eq 0)
        {
            $ipaddress = '0.0.0.0'
        }
        else
        {
            if ($SqlServer.count -gt 1)
            {
                throw '-IpAddress switch cannot be used with a collection of serveraddresses'
            }
        }
    }
    PROCESS
    {
        
        $servercount = $sqlserver.Count
        foreach ($servername in $SqlServer)
        {
            try
            {
                $server = Connect-SqlServer -SqlServer "TCP:$servername" -SqlCredential $Credential
                      }

            catch
            {
                if ($servercount -eq 1)
                {
                    throw $_
                }
                else
                {
                    Write-Warning "Can't connect to $servername. Moving on."
                    Continue
                }
            }
            
            if ($server.VersionMajor -lt 9)
            {
                if ($servercount -eq 1)
                {
                    throw 'SQL Server 2000 not supported.'
                }
                else
                {
                    Write-Warning "SQL Server 2000 not supported. Skipping $servername."
                    Continue
                }
            }

                    $instancename = $server.instanceName
                if ($instancename.length -eq 0)
                {
                    $instancename = 'MSSQLSERVER'
                }
                if ($server.IsClustered)
                {
                    write-verbose "Instance is clustered fetching nodes..."
                    $clusterquery = "select nodename from sys.dm_os_cluster_nodes where not nodename = '$($server.ComputerNamePhysicalNetBIOS)'"
                    $clusterresult = $server.ConnectionContext.ExecuteWithResults("$clusterquery")    
                    foreach ($row in $clusterresult.tables[0].rows) {$ClusterNodes +=  $row.Item(0) + " "}
                    Write-Warning "$servername is a clustered instance, portchanges will be reflected on other nodes ( $clusternodes) after a failover..."
                }
                $scriptblock = {
                $servername = $args[0]
                $instancename = $args[1]
                $port = $args[2]                        
                $ipaddress = $args[3]
                $wmi = New-Object Microsoft.SqlServer.Management.Smo.Wmi.ManagedComputer $servername
                $instance = $wmi.ServerInstances | Where-Object { $_.Name -eq $instancename }
                $tcp= $instance.ServerProtocols | Where-Object { $_.DisplayName -eq 'TCP/IP' }
                $ipaddress = $tcp.IPAddresses | where-object {$_.IPAddress -eq $ipaddress }
                $tcpport = $ipaddress.IPAddressProperties | Where-Object { $_.Name -eq 'TcpPort' }
                try
                {
                    $tcpport.value = $port
                    $tcp.Alter()
                }
                catch
                {
                    return $_
                }
                }
                try
                {
                    $ServernameNI = $servername.split("\")[0]
                    $resolved = Resolve-DbaNetworkName -ComputerName $servernameNI -Verbose:$false
                    write-verbose "Writing TCPPort $port for $Servername to $($resolved.FQDN)..."
                    $setport = Invoke-ManagedComputerCommand -ComputerName $resolved.FQDN -ScriptBlock $scriptblock -ArgumentList $Server.NetName, $instancename, $port, $ipaddress  
                    if ($setport.length -eq 0)
                    {
                        if ($ipaddress -eq '0.0.0.0') 
                        {
                           Write-Host "SQLSERVER: $Servername IPADDRESS: ALLIP's PORT: $port"
                        }
                        else
                        {
                            Write-Host "SQLSERVER: $Servername IPADDRESS: $ipaddress PORT: $port"
                        }
                    }
                    else
                    {
                        if ($ipaddress -eq '0.0.0.0') 
                        {
                           Write-Host "SQLSERVER: $Servername IPADDRESS: ALLIP's PORT: $port" -NoNewline
                           Write-Host " FAILED!" -ForegroundColor Red 
                        }
                        else
                        {
                            Write-Host "SQLSERVER: $Servername IPADDRESS: $ipaddress PORT: $port" -NoNewline
                            Write-Host " FAILED!" -ForegroundColor Red 
                        }
                    }
                }   
                catch
                {
                    try
                    {
                        write-verbose "Failed to write TCPPort $port for $Servername to $($resolved.FQDN) trying computername $($server.ComputerNamePhysicalNetBIOS)...."
                        $setport = Invoke-ManagedComputerCommand -ComputerName $server.ComputerNamePhysicalNetBIOS -ScriptBlock $scriptblock -ArgumentList $Server.NetName, $instancename, $port, $ipaddress  
                        if ($setport.length -eq 0)
                        {
                            if ($ipaddress -eq '0.0.0.0') 
                            {
                                Write-Host "SQLSERVER: $Servername IPADDRESS: ALLIP's PORT: $port"
                            }
                            else
                            {
                                Write-Host "SQLSERVER: $Servername IPADDRESS: $ipaddress PORT: $port"
                            }
                        }
                        else
                        {
                            if ($ipaddress -eq '0.0.0.0') 
                            {
                                Write-Host "SQLSERVER: $Servername IPADDRESS: ALLIP's PORT: $port" -NoNewline
                                Write-Host " FAILED!" -ForegroundColor Red
                            }
                            else
                            {
                                Write-Host "SQLSERVER: $Servername IPADDRESS: $ipaddress PORT: $port" -NoNewline
                                Write-Host " FAILED!" -ForegroundColor Red
                            }
                        }
                    }
                    catch
                    {
                        Write-Warning "Could not write new TCPPort for $servername"
                        Continue
                    }
                }
                        
 }
    }
    END
    {
            return 
    }
}