Public/Get-ESXStorage.ps1
|
function Get-ESXStorage { <# .SYNOPSIS Get ESXi Storage Details .DESCRIPTION Will get iSCSI Software and Fibre Channel Adapter (HBA) details including Datastores All this can be gathered for a vSphere Cluster, Datacenter or individual ESXi host .NOTES File Name : Get-ESXStorage.ps1 Author : Edgar Sanchez - @edmsanchez13 Contributor : Ariel Sanchez - @arielsanchezmor Version : 2.4.4 .Link https://github.com/arielsanchezmora/vDocumentation .INPUTS No inputs required .OUTPUTS CSV file Excel file .PARAMETER esxi The name(s) of the vSphere ESXi Host(s) .EXAMPLE Get-ESXStorage -esxi devvm001.lab.local .PARAMETER cluster The name(s) of the vSphere Cluster(s) .EXAMPLE Get-ESXStorage -cluster production-cluster .PARAMETER datacenter The name(s) of the vSphere Virtual DataCenter(s) .EXAMPLE Get-ESXStorage -datacenter vDC001 Get-ESXInventory -datacenter "all vdc" will gather all hosts in vCenter(s). This is the default if no Parameter (-esxi, -cluster, or -datacenter) is specified. .PARAMETER ExportCSV Switch to export all data to CSV file. File is saved to the current user directory from where the script was executed. Use -folderPath parameter to specify a alternate location .EXAMPLE Get-ESXStorage -cluster production-cluster -ExportCSV .PARAMETER ExportExcel Switch to export all data to Excel file (No need to have Excel Installed). This relies on ImportExcel Module to be installed. ImportExcel Module can be installed directly from the PowerShell Gallery. See https://github.com/dfinke/ImportExcel for more information File is saved to the current user directory from where the script was executed. Use -folderPath parameter to specify an alternate location .EXAMPLE Get-ESXStorage -cluster production-cluster -ExportExcel .PARAMETER StorageAdapters Default switch to get iSCSI Software and Fibre Channel Adapter (HBA) details This is default option that will get processed if no switch parameter is provided. .EXAMPLE Get-ESXStorage -cluster production-cluster -StorageAdapters .PARAMETER Datastores Switch to get Datastores details .EXAMPLE Get-ESXStorage -cluster production-cluster -Datastores .PARAMETER folderPath Specificies an alternate folder path of where the exported file should be saved. .EXAMPLE Get-ESXStorage -cluster production-cluster -ExportExcel -folderPath C:\temp .PARAMETER PassThru Returns the object to the console .EXAMPLE Get-ESXStorage -esxi devvm001.lab.local -PassThru #> <# ----------------------------------------------------------[Declarations]---------------------------------------------------------- #> [CmdletBinding()] param ( $esxi, $cluster, $datacenter, [switch]$ExportCSV, [switch]$ExportExcel, [switch]$StorageAdapters, [switch]$Datastores, [switch]$PassThru, $folderPath ) $FibreChannelCollection = @() $iSCSICollection = @() $DatastoresCollection = @() $skipCollection = @() $vHostList = @() $date = Get-Date -format s $date = $date -replace ":", "-" $outputFile = "Storage" + $date <# ----------------------------------------------------------[Execution]---------------------------------------------------------- #> <# Query PowerCLI and vDocumentation versions if running Verbose #> if ($VerbosePreference -eq "continue") { Write-Verbose -Message ((Get-Date -Format G) + "`tPowerCLI Version:") Get-Module -Name VMware.* | Select-Object -Property Name, Version | Format-Table -AutoSize Write-Verbose -Message ((Get-Date -Format G) + "`tvDocumentation Version:") Get-Module -Name vDocumentation | Select-Object -Property Name, Version | Format-Table -AutoSize } #END if <# Check for an active connection to a VIServer #> Write-Verbose -Message ((Get-Date -Format G) + "`tValidate connection to a vSphere server") if ($Global:DefaultViServers.Count -gt 0) { Write-Host "`tConnected to $Global:DefaultViServers" -ForegroundColor Green } else { Write-Error -Message "You must be connected to a vSphere server before running this Cmdlet." break } #END if/else <# Validate if a parameter was specified (-esxi, -cluster, or -datacenter) Although all 3 can be specified, only the first is used Example: -esxi "host001" -cluster "test-cluster". -esxi is the first parameter and what will be used. #> Write-Verbose -Message ((Get-Date -Format G) + "`tValidate parameters used") if ([string]::IsNullOrWhiteSpace($esxi) -and [string]::IsNullOrWhiteSpace($cluster) -and [string]::IsNullOrWhiteSpace($datacenter)) { Write-Verbose -Message ((Get-Date -Format G) + "`tA parameter (-esxi, -cluster, -datacenter) was not specified. Will gather all hosts") $datacenter = "all vdc" } #END if <# Gather host list based on parameter used #> Write-Verbose -Message ((Get-Date -Format G) + "`tGather host list") if ([string]::IsNullOrWhiteSpace($esxi)) { Write-Verbose -Message ((Get-Date -Format G) + "`t-esxi parameter is Null or Empty") if ([string]::IsNullOrWhiteSpace($cluster)) { Write-Verbose -Message ((Get-Date -Format G) + "`t-cluster parameter is Null or Empty") if ([string]::IsNullOrWhiteSpace($datacenter)) { Write-Verbose -Message ((Get-Date -Format G) + "`t-datacenter parameter is Null or Empty") } else { Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using datacenter parameter") if ($datacenter -eq "all vdc") { Write-Host "`tGathering all hosts from the following vCenter(s): " $Global:DefaultViServers $vHostList = Get-VMHost | Sort-Object -Property Name } else { Write-Host "`tGathering host list from the following DataCenter(s): " (@($datacenter) -join ',') foreach ($vDCname in $datacenter) { $tempList = Get-Datacenter -Name $vDCname.Trim() -ErrorAction SilentlyContinue | Get-VMHost if ($tempList) { $vHostList += $tempList | Sort-Object -Property Name } else { Write-Warning -Message "`tDatacenter with name $vDCname was not found in $Global:DefaultViServers" } #END if/else } #END foreach } #END if/else } #END if/else } else { Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using cluster parameter") Write-Host "`tGathering host list from the following Cluster(s): " (@($cluster) -join ',') foreach ($vClusterName in $cluster) { $tempList = Get-Cluster -Name $vClusterName.Trim() -ErrorAction SilentlyContinue | Get-VMHost if ($tempList) { $vHostList += $tempList | Sort-Object -Property Name } else { Write-Warning -Message "`tCluster with name $vClusterName was not found in $Global:DefaultViServers" } #END if/else } #END foreach } #END if/else } else { Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using esxi parameter") Write-Host "`tGathering host list..." foreach ($invidualHost in $esxi) { $tempList = Get-VMHost -Name $invidualHost.Trim() -ErrorAction SilentlyContinue if ($tempList) { $vHostList += $tempList | Sort-Object -Property Name } else { Write-Warning -Message "`tESXi host $invidualHost was not found in $Global:DefaultViServers" } #END if/else } #END foreach } #END if/else $tempList = $null <# Validate export switches, folder path and dependencies #> Write-Verbose -Message ((Get-Date -Format G) + "`tValidate export switches and folder path") if ($ExportCSV -or $ExportExcel) { $currentLocation = (Get-Location).Path if ([string]::IsNullOrWhiteSpace($folderPath)) { Write-Verbose -Message ((Get-Date -Format G) + "`t-folderPath parameter is Null or Empty") Write-Warning -Message "`tFolder Path (-folderPath) was not specified for saving exported data. The current location: '$currentLocation' will be used" $outputFile = $currentLocation + "\" + $outputFile } else { if (Test-Path $folderPath) { Write-Verbose -Message ((Get-Date -Format G) + "`t'$folderPath' path found") $lastCharsOfFolderPath = $folderPath.Substring($folderPath.Length - 1) if ($lastCharsOfFolderPath -eq "\" -or $lastCharsOfFolderPath -eq "/") { $outputFile = $folderPath + $outputFile } else { $outputFile = $folderPath + "\" + $outputFile } #END if/else Write-Verbose -Message ((Get-Date -Format G) + "`t$outputFile") } else { Write-Warning -Message "`t'$folderPath' path not found. The current location: '$currentLocation' will be used instead" $outputFile = $currentLocation + "\" + $outputFile } #END if/else } #END if/else } #END if if ($ExportExcel) { if (Get-Module -ListAvailable -Name ImportExcel) { Write-Verbose -Message ((Get-Date -Format G) + "`tImportExcel Module available") } else { Write-Warning -Message "`tImportExcel Module missing. Will export data to CSV file instead" Write-Warning -Message "`tImportExcel Module can be installed directly from the PowerShell Gallery" Write-Warning -Message "`tSee https://github.com/dfinke/ImportExcel for more information" $ExportExcel = $false $ExportCSV = $true } #END if/else } #END if <# Validate that a Cmdlet switch was used. Options are -StorageAdapters, -Datastores. By default all are executed unless one is specified. #> Write-Verbose -Message ((Get-Date -Format G) + "`tValidate Cmdlet switches") if ($StorageAdapters -or $Datastores) { Write-Verbose -Message ((Get-Date -Format G) + "`tA Cmdlet switch was specified") } else { Write-Verbose -Message ((Get-Date -Format G) + "`tA Cmdlet switch was not specified") Write-Verbose -Message ((Get-Date -Format G) + "`tWill execute all (-StorageAdapters -Datastores)") $StorageAdapters = $true $Datastores = $true } #END if/else <# Main code execution #> foreach ($vmhost in $vHostList) { <# Skip if ESXi host is not in a Connected or Maintenance ConnectionState #> Write-Verbose -Message ((Get-Date -Format G) + "`t$vmhost Connection State: " + $vmhost.ConnectionState) if ($vmhost.ConnectionState -eq "Connected" -or $vmhost.ConnectionState -eq "Maintenance") { <# Do nothing - ESXi host is reachable #> } else { <# Use a custom object to keep track of skipped hosts and continue to the next foreach loop #> $skipCollection += [pscustomobject]@{ 'Hostname' = $vmhost.Name 'Connection State' = $vmhost.ConnectionState } #END [PSCustomObject] continue } #END if/else $esxcli1 = Get-EsxCli -VMHost $vmhost -V2 <# Get Storage adapters (HBA) details #> if ($StorageAdapters) { Write-Host "`tGathering storage adapter details from $vmhost ..." <# Get iSCSI HBA Details #> Write-Verbose -Message ((Get-Date -Format G) + "`tGet iSCSI Software Adapter...") if ($hba = $vmhost | Get-VMHostHba -Type iScsi | Where-Object {$_.Model -eq "iSCSI Software Adapter"}) { Write-Verbose -Message ((Get-Date -Format G) + "`tGet iSCSI HBA details for: " + $hba.Device) $hbaBinding = $esxcli1.iscsi.networkportal.list.Invoke(@{adapter = $hba.Device}) $hbaTarget = Get-IScsiHbaTarget -IScsiHba $hba $sendList = $hbaTarget | Where-Object {$_.Type -eq "Send"} | Select-Object -ExpandProperty Address $staticList = $hbaTarget | Where-Object {$_.Type -eq "Static"} | Select-Object -ExpandProperty Address <# Get active physical adapters based on PortGroup.Test both standard and distributed vSwitch #> foreach ($vmkNic in $hbaBinding) { Write-Verbose -Message ((Get-Date -Format G) + "`tGet active physical adapter for: " + $vmkNic.PortGroup) $vmNic = $vmhost | Get-VMHostNetworkAdapter | Where-Object {$_.Mac -eq $vmkNic.MACAddress} $nicList = $esxcli1.network.nic.list.Invoke() | Where-Object {$_.Name -eq $vmNic.Name} $portGroupTeam = Get-VirtualPortGroup -VMhost $vmhost -Name $vmkNic.PortGroup | Where-Object {$_.VirtualSwitchName -eq $vmkNic.Vswitch} | Get-NicTeamingPolicy if ($portGroup = Get-VirtualPortGroup -VMhost $vmhost -Name $vmkNic.PortGroup -Standard -ErrorAction SilentlyContinue | Where-Object {$_.VirtualSwitchName -eq $vmkNic.Vswitch}) { Write-Verbose -Message ((Get-Date -Format G) + "`tStandard vSwitch") $portGroupTeam = $portGroup | Get-NicTeamingPolicy $vSwitch = $esxcli1.network.vswitch.standard.list.Invoke(@{vswitchname = $vmkNic.Vswitch}) $activeAdapters = (@($PortGroupTeam.ActiveNic) -join ',') } else { Write-Verbose -Message ((Get-Date -Format G) + "`tDistributed vSwitch") $portGroup = Get-VDPortgroup -Name $vmkNic.PortGroup -VDSwitch $vmkNic.Vswitch -ErrorAction SilentlyContinue $portGroupTeam = $portGroup | Get-VDUplinkTeamingPolicy $vSwitch = $esxcli1.network.vswitch.dvs.vmware.list.Invoke(@{vdsname = $vmkNic.Vswitch}) $activeAdapters = (@($PortGroupTeam.ActiveUplinkPort) -join ',') } #END if/else <# Use a custom object to store collected data #> $iSCSICollection += [PSCustomObject]@{ 'Hostname' = $vmhost.Name 'Device' = $hba.Device 'iSCSI Name' = $hba.IScsiName 'Model' = $hba.Model 'Send Targets' = (@($sendList) -join ',') 'Static Tarets' = (@($staticList) -join ',') 'Port Group' = $vmkNic.PortGroup + " (" + $vmkNic.Vswitch + ")" 'VMkernel Adapter' = $vmkNic.Vmknic 'Port Binding' = $vmkNic.CompliantStatus 'Path Status' = $vmkNic.PathStatus 'Physical Network Adapter' = $vmNic.Name + " (" + $vmnic.BitRatePerSec / 1000 + " Gbit/s, " + $nicList.Duplex + ")" } #END [PSCustomObject] } #END foreach } #END if <# Get Fibre Channel HBA details #> Write-Verbose -Message ((Get-Date -Format G) + "`tGet Fibre Channel Adapter...") if ($hba = $vmhost | Get-VMHostHba -Type FibreChannel) { foreach ($hbaDevice in $hba) { Write-Verbose -Message ((Get-Date -Format G) + "`tGet Fibre Channel HBA details for: " + $hbaDevice.Device) $nodeWWN = ([String]::Format("{0:X}", $HbaDevice.NodeWorldWideName) -split "(\w{2})" | Where-Object {$_ -ne ""}) -join ":" $portWWN = ([String]::Format("{0:X}", $HbaDevice.PortWorldWideName) -split "(\w{2})" | Where-Object {$_ -ne ""}) -join ":" <# Use a custom object to store collected data #> $FibreChannelCollection += [PSCustomObject]@{ 'Hostname' = $vmhost.Name 'Device' = $hbaDevice.Device 'Model' = $hbaDevice.Model 'Node WWN' = $nodeWWN 'Port WWN' = $portWWN 'Driver' = $hbaDevice.Driver 'Speed (Gb)' = $hbaDevice.Speed 'Status' = $hbaDevice.Status } #END [PSCustomObject] } # END foreach } #END if } #END if <# Get Datastores details #> if ($Datastores) { Write-Host "`tGathering Datastore details from $vmhost ..." $hostDSList = $vmhost | Get-Datastore | Sort-Object -Property Name foreach ($oneDS in $hostDSList) { Write-Verbose -Message ((Get-Date -Format G) + "`tGet Datastore details for: " + $oneDS.Name) $dsCName = $oneDS.ExtensionData.Info.Vmfs.Extent | Select-Object -ExpandProperty DiskName if ($oneDS.Type -eq "vsan" -or $oneDS.Type -eq "NFS") { Write-Verbose -Message ((Get-Date -Format G) + "`t" + $oneDS.Type + " type datastore found. Skipping storage multipathing policy validation") $dsDisk = $null } else { $dsDisk = $esxcli1.storage.nmp.device.list.Invoke(@{device = $dsCName}) } #END if/else <# Validate against exising collection to speed up foreach #> $itemInCollection = $DatastoresCollection | Where-Object {$_.'Canonical Name' -like $dsCName} | Select-Object -First 1 if ($itemInCollection) { Write-Verbose -Message ((Get-Date -Format G) + "`t$dsCName already in collection; will reuse associated properties") $dsName = $itemInCollection.'Datastore Name' $dsDisplayName = $itemInCollection.'Device Name' $LUN = $itemInCollection.LUN $dsType = $itemInCollection.Type $dsCluster = $itemInCollection.'Datastore Cluster' $dsCapacityGB = $itemInCollection.'Capacity (GB)' $ProvisionedGB = $itemInCollection.'Provisioned Space (GB)' $dsFreeGB = $itemInCollection.'Free Space (GB)' $dsTransportType = $itemInCollection.Transport $dsMountPoint = $itemInCollection.'Mount Point' $dsFileSystem = $itemInCollection.'File System Version' } else { Write-Verbose -Message ((Get-Date -Format G) + "`t$dsCName not yet in collection; will query associated properties") $dsView = $oneDS | Get-View $dsSummary = $dsView | Select-Object -ExpandProperty Summary $provisionedGB = [math]::round(($dsSummary.Capacity - $dsSummary.FreeSpace + $dsSummary.Uncommitted) / 1GB, 2) if ($oneDS.Type -eq "vsan" -or $oneDS.Type -eq "NFS") { Write-Verbose -Message ((Get-Date -Format G) + "`t" + $oneDS.Type + " type datastore found. Skipping storage path validation") $dsDisplayName = $null $LUN = $null $dsTransport = $null } else { $dspath = $esxcli1.storage.core.path.list.Invoke(@{device = $dsCName}) | Select-Object -First 1 $dsDisplayName = (($dspath.DeviceDisplayName -Split " [(]")[0]) $LUN = $dspath.LUN $vmHBA = $dspath.Adapter $dsTransport = $vmhost | Get-VMHostHba | Select-Object Device, Type | Where-Object {$_.Device -eq $vmHBA} } #END if/else if ($oneDS.ParentFolder -eq $null -and $oneDS.ParentFolderId -match "StoragePod") { $dsCluster = Get-DatastoreCluster -Id $oneDS.ParentFolderId | Select-Object -ExpandProperty Name Write-Verbose -Message ((Get-Date -Format G) + "`tDatastore is part of Datastore Cluster: " + $dsCluster) } else { $dsCluster = $null Write-Verbose -Message ((Get-Date -Format G) + "`tDatastore not part of a Datastore Cluster") } #END if/else $dsName = $oneDS.Name $dsType = $oneDS.Type $dsCapacityGB = [math]::round($oneDS.CapacityGB, 2) $dsFreeGB = [math]::round($oneDS.FreeSpaceGB, 2) $dsTransportType = $dsTransport.Type $dsMountPoint = (($dsSummary.Url -split "ds://")[1]) $dsFileSystem = $oneDS.FileSystemVersion } #END if/else <# Use a custom object to store collected data #> $DatastoresCollection += [PSCustomObject]@{ 'Hostname' = $vmhost.Name 'Datastore Name' = $dsName 'Device Name' = $dsDisplayName 'Canonical Name' = $dsCName 'LUN' = $LUN 'Type' = $dsType 'Datastore Cluster' = $dsCluster 'Capacity (GB)' = $dsCapacityGB 'Provisioned Space (GB)' = $ProvisionedGB 'Free Space (GB)' = $dsFreeGB 'Transport' = $dsTransportType 'Mount Point' = $dsMountPoint 'Multipath Policy' = $dsDisk.PathSelectionPolicy 'File System Version' = $dsFileSystem } #END [PSCustomObject] } #END foreach } #END if } #END foreach Write-Verbose -Message ((Get-Date -Format G) + "`tMain code execution completed") <# Display skipped hosts and their connection status #> If ($skipCollection) { Write-Warning -Message "`tCheck Connection State or Host name " Write-Warning -Message "`tSkipped hosts: " $skipCollection | Format-Table -AutoSize } #END if <# Validate output arrays #> if ($iSCSICollection -or $FibreChannelCollection -or $DatastoresCollection) { Write-Verbose -Message ((Get-Date -Format G) + "`tInformation gathered") } else { Write-Verbose -Message ((Get-Date -Format G) + "`tNo information gathered") } #END if/else <# Output to screen Export data to CSV, Excel #> if ($iSCSICollection) { Write-Host "`n" "ESXi Storage iSCSI HBA:" -ForegroundColor Green if ($ExportCSV) { $iSCSICollection | Export-Csv ($outputFile + "iSCSI_HBA.csv") -NoTypeInformation Write-Host "`tData exported to" ($outputFile + "iSCSI_HBA.csv") "file" -ForegroundColor Green } elseif ($ExportExcel) { $iSCSICollection | Export-Excel ($outputFile + ".xlsx") -WorkSheetname iSCSI_HBA -NoNumberConversion * -AutoSize -BoldTopRow Write-Host "`tData exported to" ($outputFile + ".xlsx") "file" -ForegroundColor Green } elseif ($PassThru) { $iSCSICollection } else { $iSCSICollection | Format-List } #END if/else } #END if if ($FibreChannelCollection) { Write-Host "`n" "ESXi FibreChannel HBA:" -ForegroundColor Green if ($ExportCSV) { $FibreChannelCollection | Export-Csv ($outputFile + "FibreChannelHBA.csv") -NoTypeInformation Write-Host "`tData exported to" ($outputFile + "FibreChannelHBA.csv") "file" -ForegroundColor Green } elseif ($ExportExcel) { $FibreChannelCollection | Export-Excel ($outputFile + ".xlsx") -WorkSheetname FibreChannel_HBA -NoNumberConversion * -AutoSize -BoldTopRow Write-Host "`tData exported to" ($outputFile + ".xlsx") "file" -ForegroundColor Green } elseif ($PassThru) { $FibreChannelCollection } else { $FibreChannelCollection | Format-List } #END if/else } #END if if ($DatastoresCollection) { Write-Host "`n" "ESXi Datastores:" -ForegroundColor Green if ($ExportCSV) { $DatastoresCollection | Export-Csv ($outputFile + "Datastores.csv") -NoTypeInformation Write-Host "`tData exported to" ($outputFile + "Datastores.csv") "file" -ForegroundColor Green } elseif ($ExportExcel) { $DatastoresCollection | Export-Excel ($outputFile + ".xlsx") -WorkSheetname Datastores -NoNumberConversion * -AutoSize -BoldTopRow Write-Host "`tData exported to" ($outputFile + ".xlsx") "file" -ForegroundColor Green } elseif ($PassThru) { $DatastoresCollection } else { $DatastoresCollection | Format-List }#END if/else } #END if } #END function |