Skip to content

Instantly share code, notes, and snippets.

@vScripter

vScripter/Get-VMDetails.ps1

Created April 4, 2017 17:16
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save vScripter/f7ca4db9b4777fa78740e86f091d153b to your computer and use it in GitHub Desktop.
Save vScripter/f7ca4db9b4777fa78740e86f091d153b to your computer and use it in GitHub Desktop.
Download ZIP
Returns more detailed statistics and configuration for a single or multiple VMs
Raw
Get-VMDetails.ps1
function Get-VMDetails {
<#
.SYNOPSIS
Returns more detailed statistics and configuration for a single or multiple VMs
.DESCRIPTION
Returns more detailed statistics and configuration for a single or multiple VMs
This function assumes that you are already connected to one, or more, vCenter Servers.
You can use the -Inventory switch which will ignore pipeline input and query all connected vCenter Servers.
.PARAMETER Name
VM object
.PARAMETER Server
Only used in conjunction with -Inventory parameter
.PARAMETER Inventory
Switch parameter which will pull a full inventory from the environment with no filtering
.INPUTS
System.String
.OUTPUTS
System.Management.Automation.PSCustomObject
.EXAMPLE
Get-VM | Get-VMDetails -Verbose | Export-Csv C:\VMGuestDetails.csv -NoTypeInformation -Force
.EXAMPLE
Get-Cluster -Name 'clus-01' | Get-VM | Get-VMDetails -Verbose | Out-GridView
.EXAMPLE
Get-VMDetails -Inventory -Verbose | Out-GridView
.EXAMPLE
Get-VMDetails -Server vcenter01.corp.com -Inventory -Verbose | Out-GridView
.EXAMPLE
Get-VMDetails -Server vcenter01.corp.com,vcenter02.corp.com -Inventory -Verbose | Out-GridView
.NOTES
Author: Kevin M. Kirkpatrick
Contact: GitHub.com/vScripter | Twitter: @vScripter
Last Update: 20170313
Last Updated by: K. Kirkpatrick
Last Update Notes:
- Added to GitHub Gist
#>
[OutputType([System.Management.Automation.PSCustomObject])]
[CmdletBinding(DefaultParameterSetName = 'default')]
param (
[Parameter(
Mandatory = $true,
Position = 0,
ValueFromPipelineByPropertyName = $true,
ValueFromPipeline = $true,
ParameterSetName = 'default')]
[ValidateNotNullOrEmpty()]
[VMware.VimAutomation.ViCore.Types.V1.Inventory.VirtualMachine[]]$Name,
[Parameter(
Mandatory = $false,
Position = 0,
ValueFromPipelineByPropertyName = $false,
ValueFromPipeline = $false,
ParameterSetName = 'inventory')]
[System.String[]]$Server,
[Parameter(
Mandatory = $false,
ValueFromPipelineByPropertyName = $false,
ValueFromPipeline = $false,
ParameterSetName = 'inventory')]
[switch]$Inventory
)
BEGIN {
#Requires -Version 3
Set-StrictMode -Version Latest
Write-Verbose -Message "[$($PSCmdlet.MyInvocation.MyCommand.Name)] Processing Started"
# if not value was given to the -Server param, check to see if there are any connected vCenter servers, and attempt to run it against, all of those
if(-not($PSCmdlet.MyInvocation.BoundParameters.Keys.Contains('Server'))) {
# using Test-Path to check for variable; if we don't, we will get an error complaining about looking for a variable that hasn't been set
if(Test-Path -Path Variable:\Global:defaultViServers){
$Server = ((Get-Variable -Scope Global -Name DefaultViServers).Value | Where-Object {$_.IsConnected -eq $true}).Name
if($Server -eq $null -or $Server -eq ''){
throw "[$($PSCmdlet.MyInvocation.MyCommand.Name)][ERROR] No Value was provided to the '-Server' Parameter and no current connection could be found"
} else {
Write-Verbose -Message "[$($PSCmdlet.MyInvocation.MyCommand.Name)] Processing connected vCenter servers discovered in variable { $Global:DefaultViServers }"
} # end else/if
} else {
throw "[$($PSCmdlet.MyInvocation.MyCommand.Name)][ERROR] No Value was provided to the -Server Parameter and no current connection could be found; variable { $Global:DefaultViServers } does not exist"
} # end if/else Test-Path
} # end if
} # end BEGIN block
PROCESS {
if($PSCmdlet.MyInvocation.BoundParameters.Keys.Contains('Inventory')) {
foreach ($viServer in $Server) {
Write-Verbose -Message "[$($PSCmdlet.MyInvocation.MyCommand.Name)] Gathering guest inventory report for vCenter { $viServer }"
$inventoryView = $null
$inventoryView = Get-View -Server $viServer -ViewType VirtualMachine -Property Name,Guest,Summary,Runtime,Config
foreach ($guestQuery in $inventoryView) {
Write-Verbose -Message "[$($PSCmdlet.MyInvocation.MyCommand.Name)] Gathering details for VM guest { $($guestQuery.Name) }"
[System.DateTime]$dateGenerated = Get-Date
$guestVcenterServer = $null
$guestVcenterServer = ([uri]$guestQuery.Client.ServiceUrl).Host
# this object contains a few less properties; stick to only making native API calls for full inventory
[PSCustomObject] @{
Name = $guestQuery.Name
HostName = $guestQuery.Guest.HostName
OS = $guestQuery.Summary.Guest.GuestFullName
IPAddress = $guestQuery.Summary.Guest.IPAddress
NumCPU = $guestQuery.Summary.Config.NumCPU
NumCPUCoresPerSocket = $guestQuery.Config.Hardware.NumCoresPerSocket
MemorySizeGB = ($guestQuery.Summary.Config.MemorySizeMB)/1024
NumEthernetCards = $guestQuery.Summary.Config.NumEthernetCards
NumVirtualDisks = $guestQuery.Summary.Config.NumVirtualDisks
ProvisionedStorageGB = [math]::Round(((((($guestQuery.Summary.Storage.Committed)+($guestQuery.Summary.Storage.Uncommitted))/1024)/1024)/1024))
CommittedStorageGB = [math]::Round((((($guestQuery.Summary.Storage.Committed)/1024)/1024)/1024))
FTEnabled = if ($guestQuery.Runtime.FaultToleranceState -eq 'running') {
[bool]$true
} else {
[bool]$false
}
CPUHotAddEnabled = $guestQuery.Config.CPUHotAddEnabled
RAMHotAddEnabled = $guestQuery.Config.MemoryHotAddEnabled
VMToolsInstallerMounted = $guestQuery.Summary.Runtime.ToolsInstallerMounted
ToolsVersion = $guestQuery.Guest.ToolsVersion
ToolsStatus = $guestQuery.Guest.ToolsStatus
ToolsVersionStatus = $guestQuery.Guest.ToolsVersionStatus2
ToolsRunningStatus = $guestQuery.Guest.ToolsRunningStatus
ToolsUpgradePolicy = $guestQuery.Config.Tools.ToolsUpgradePolicy
Annotation = $guestQuery.Summary.Config.Annotation
State = $guestQuery.Guest.GuestState
Status = $guestQuery.Summary.Runtime.PowerState
vCenterServer = $guestVcenterServer
HardwareVersion = $guestQuery.Config.Version
UUID = $guestQuery.Summary.Config.Uuid
InstanceUUID = $guestQuery.Summary.Config.InstanceUUID
GuestID = $guestQuery.Summary.Config.GuestID
Template = $guestQuery.Summary.Config.Template
Generated = $dateGenerated
} # end [PSCustomObject]
} # end foreach $guest
} # end foreach
} else {
foreach ($guest in $Name) {
Write-Verbose -Message "[$($PSCmdlet.MyInvocation.MyCommand.Name)] Gathering details for VM guest { $($guest.Name) }"
[System.DateTime]$dateGenerated = Get-Date
$guestQuery = $null
$guestQuery = $guest.ExtensionData
# capture the vCenter Server up here so that it can be used when performing external queries such as resolving the Cluster property
$guestvCenterServer = $null
$guestvCenterServer = ([uri]$guestQuery.Client.ServiceUrl).Host
[PSCustomObject] @{
Name = $guestQuery.Name
HostName = $guestQuery.Guest.HostName
OS = $guestQuery.Summary.Guest.GuestFullName
IPAddress = $guestQuery.Summary.Guest.IPAddress
NumCPU = $guestQuery.Summary.Config.NumCPU
NumCPUCoresPerSocket = $guestQuery.Config.Hardware.NumCoresPerSocket
MemorySizeGB = ($guestQuery.Summary.Config.MemorySizeMB)/1024
NumEthernetCards = $guestQuery.Summary.Config.NumEthernetCards
NumVirtualDisks = $guestQuery.Summary.Config.NumVirtualDisks
ProvisionedStorageGB = [math]::Round(((((($guestQuery.Summary.Storage.Committed)+($guestQuery.Summary.Storage.Uncommitted))/1024)/1024)/1024))
CommittedStorageGB = [math]::Round((((($guestQuery.Summary.Storage.Committed)/1024)/1024)/1024))
FTEnabled = if ($guestQuery.Runtime.FaultToleranceState -eq 'running') {
[bool]$true
} else {
[bool]$false
}
CPUHotAddEnabled = $guestQuery.Config.CPUHotAddEnabled
RAMHotAddEnabled = $guestQuery.Config.MemoryHotAddEnabled
VMToolsInstallerMounted = $guestQuery.Summary.Runtime.ToolsInstallerMounted
ToolsVersion = $guestQuery.Guest.ToolsVersion
ToolsStatus = $guestQuery.Guest.ToolsStatus
ToolsVersionStatus = $guestQuery.Guest.ToolsVersionStatus2
ToolsRunningStatus = $guestQuery.Guest.ToolsRunningStatus
ToolsUpgradePolicy = $guestQuery.Config.Tools.ToolsUpgradePolicy
Annotation = $guestQuery.Summary.Config.Annotation
State = $guestQuery.Guest.GuestState
Status = $guestQuery.Summary.Runtime.PowerState
vCenterServer = $guestvCenterServer
Cluster = (Get-VIObjectByVIView -Server $guestvCenterServer -MoRef (Get-VIObjectByVIView -Server $guestvCenterServer -MoRef $guestQuery.Runtime.Host).ExtensionData.Parent).Name
HardwareVersion = $guestQuery.Config.Version
UUID = $guestQuery.Summary.Config.Uuid
InstanceUUID = $guestQuery.Summary.Config.InstanceUUID
GuestID = $guestQuery.Summary.Config.GuestID
Generated = $dateGenerated
} # end [PSCustomObject]
} # end foreach $guest
} # end if/else
} # end PROCESS block
END {
Write-Verbose -Message "[$($PSCmdlet.MyInvocation.MyCommand.Name)] Processing Complete"
} # end END block
} # end function Get-VMDetails
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment