functions/Get-DbaDiskSpace.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
Function Get-DbaDiskSpace
{
<#
.SYNOPSIS
Displays Disk information for all local drives on a server
    
.DESCRIPTION
Returns a custom object with Server name, name of disk, label of disk, total size, free size and percent free.
    
.PARAMETER ComputerName
The SQL Server (or server in general) that you're connecting to. The -SqlServer parameter also works.

.PARAMETER Unit
Display the disk space information in a specific unit. Valid values incldue 'KB', 'MB', 'GB', 'TB', and 'PB'. Default is GB.
    
.PARAMETER CheckForSql
Check to see if any SQL Data or Log files exists on the disk. Uses Windows authentication to connect by default.

.PARAMETER SqlCredential
If you want to use SQL Server Authentication to connect.

.NOTES
Requires: Windows sysadmin access on SQL Servers

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/Get-DbaDiskSpace

.EXAMPLE
Get-DbaDiskSpace -ComputerName sqlserver2014a

Shows disk space for sqlserver2014a in GB

.EXAMPLE
Get-DbaDiskSpace -ComputerName sqlserver2014a -Unit TB

Shows disk space for sqlserver2014a in TB

.EXAMPLE
Get-DbaDiskSpace -ComputerName server1, server2, server3 -Unit MB

Returns a custom object filled with information for server1, server2 and server3, in MB
    
#>

    [CmdletBinding(SupportsShouldProcess = $true)]
    Param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlInstance", "SqlServer")]
        [string[]]$ComputerName,
        [ValidateSet('KB', 'MB', 'GB', 'TB', 'PB')]
        [String]$Unit = "GB",
        [switch]$CheckForSql,
        [object]$SqlCredential
    )
    
    BEGIN
    {
        Function Get-AllDiskSpace
        {
            
            $measure = "1$unit"
            $alldisks = @()
            
            try
            {
                $ipaddr = (Test-Connection $server -Count 1 -ErrorAction SilentlyContinue).Ipv4Address | Select-Object -First 1
                
            }
            catch
            {
                Write-Warning "Can't connect to $server"
                return
            }
            
            try
            {
                $query = "Select SystemName, Name, DriveType, FileSystem, FreeSpace, Capacity, Label, BlockSize from Win32_Volume where DriveType = 2 or DriveType = 3"
                $disks = Get-WmiObject -ComputerName $ipaddr -Query $query | Sort-Object -Property Name
            }
            catch
            {
                Write-Warning "Can't connect to WMI on $server"
                return
            }
            
            if ($CheckForSql -eq $true)
            {
                $sqlservers = @()
                $sqlservices = Get-Service -ComputerName $ipaddr | Where-Object { $_.DisplayName -like 'SQL Server (*' }
                foreach ($service in $sqlservices)
                {
                    $instance = $service.DisplayName.Replace('SQL Server (', '')
                    $instance = $instance.TrimEnd(')')
                    
                    if ($instance -eq 'MSSQLSERVER')
                    {
                        $sqlservers += $ipaddr
                    }
                    else
                    {
                        $sqlservers += "$ipaddr\$instance"
                    }
                }
            }
            
            foreach ($disk in $disks)
            {
                $diskname = $disk.Name
                if ($CheckForSql -eq $true)
                {
                    $sqldisk = $false
                    foreach ($sqlserver in $sqlservers)
                    {
                        try
                        {
                            $smoserver = Connect-SqlServer -SqlServer $SqlServer -SqlCredential $SqlCredential
                            $sql = "Select count(*) as Count from sys.master_files where physical_name like '$diskname%'"
                            $sqlcount = $smoserver.Databases['master'].ExecuteWithResults($sql).Tables[0].Count
                            if ($sqlcount -gt 0)
                            {
                                $sqldisk = $true
                                break
                            }
                        }
                        catch
                        {
                            Write-Warning "Can't connect to $server ($sqlserver)"
                            continue
                        }
                    }
                }
                
                if (!$diskname.StartsWith("\\"))
                {
                    $total = "{0:n2}" -f ($disk.Capacity/$measure)
                    $free = "{0:n2}" -f ($disk.Freespace/$measure)
                    $percentfree = "{0:n2}" -f (($disk.Freespace / $disk.Capacity) * 100)
                    
                    if ($CheckForSql -eq $true)
                    {
                        $alldisks += [PSCustomObject]@{
                            Server = $server
                            Name = $diskname
                            Label = $disk.Label
                            "SizeIn$unit" = $total
                            "FreeIn$unit" = $free
                            PercentFree = $percentfree
                            BlockSize = $disk.BlockSize
                            IsSqlDisk = $sqldisk
                        }
                    }
                    else
                    {
                        $alldisks += [PSCustomObject]@{
                            Server = $server
                            Name = $diskname
                            Label = $disk.Label
                            "SizeIn$unit" = $total
                            "FreeIn$unit" = $free
                            PercentFree = $percentfree
                            BlockSize = $disk.BlockSize
                        }
                    }
                }
            }
            return $alldisks
        }
        
        $collection = New-Object System.Collections.ArrayList
        $processed = New-Object System.Collections.ArrayList
    }
    
    PROCESS
    {
        
        foreach ($server in $ComputerName)
        {
            if ($server -match '\\')
            {
                $server = $server.Split('\')[0]
            }
            
            if ($server -notin $processed)
            {
                $null = $processed.Add($server)
                Write-Verbose "Connecting to $server"
            }
            else
            {
                continue
            }
            
            $data = Get-AllDiskSpace $server
            
            if ($data.Count -gt 1)
            {
                $data.GetEnumerator() | ForEach-Object { $null = $collection.Add($_) }
            }
            else
            {
                $null = $collection.Add($data)
            }
        }
    }
    
    END
    {
        return $collection
    }
}