Public/Get-RubrikVM.ps1
|
#requires -Version 3 function Get-RubrikVM { <# .SYNOPSIS Retrieves details on one or more virtual machines known to a Rubrik cluster .DESCRIPTION The Get-RubrikVM cmdlet is used to pull a detailed data set from a Rubrik cluster on any number of virtual machines .NOTES Written by Chris Wahl for community usage Twitter: @ChrisWahl GitHub: chriswahl .LINK https://github.com/rubrikinc/PowerShell-Module .EXAMPLE Get-RubrikVM -VM 'Server1' This will return the ID of the virtual machine named Server1 #> [CmdletBinding()] Param( # Name of the virtual machine # If no value is specified, will retrieve information on all virtual machines [Parameter(Position = 0,ValueFromPipeline = $true)] [Alias('name','search_value')] [String]$VM, # Filter results based on active, relic (removed), or all virtual machines [Parameter(Position = 1)] [Alias('archive_status','effective_sla_domain_id')] [ValidateSet('True', 'False')] [String]$Relic, # SLA Domain policy [Parameter(Position = 2,ValueFromPipeline = $true)] [Alias('sla_domain_id')] [String]$SLA, # Virtual machine id [Alias('id')] [String]$VMID, # Rubrik server IP or FQDN [String]$Server = $global:RubrikConnection.server, # API version [ValidateNotNullorEmpty()] [String]$api = $global:RubrikConnection.api ) Begin { Test-RubrikConnection Write-Verbose -Message 'Gather API data' $resources = Get-RubrikAPIData -endpoint ('VMwareVMGet') } Process { Write-Verbose -Message 'Build the URI' $uri = 'https://'+$Server+$resources.$api.URI if ($VMID) { $uri += "/$VMID" } Write-Verbose -Message 'Build the query parameters' $params = @() $params += Test-QueryObject -object $Relic -location $resources.$api.Params.Filter -params $params $params += Test-QueryObject -object $VM -location $resources.$api.Params.Search -params $params $params += Test-QueryObject -object (Test-RubrikSLA -SLA $SLA) -location $resources.$api.Params.SLA -params $params $uri = New-QueryString -params $params -uri $uri -nolimit $true Write-Verbose -Message 'Build the method' $method = $resources.$api.Method try { Write-Verbose -Message "Submitting a request to $uri" $r = Invoke-WebRequest -Uri $uri -Headers $Header -Method $method Write-Verbose -Message 'Convert JSON content to PSObject (Max 64MB)' $result = ExpandPayload -response $r } catch { throw $_ } if (!$VMID) { Write-Verbose -Message 'Formatting return value' $result = Test-ReturnFormat -api $api -result $result -location $resources.$api.Result } return $result } # End of process } # End of function |