Public/Update-RubrikVMwareVM.ps1
|
#Requires -Version 3 function Update-RubrikVMwareVM { <# .SYNOPSIS Connects to Rubrik to refresh the metadata for the specified VMware VM .DESCRIPTION The Update-RubrikVMwareVM cmdlet will refresh the specified VMware VM metadata known to the connected Rubrik cluster. .NOTES Written by Pierre-François Guglielmi for community usage Twitter: @pfguglielmi GitHub: pfguglielmi .LINK https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/update-rubrikvmwarevm .EXAMPLE Get-RubrikVM -Name 'myvm.domain.local' | Update-RubrikVMwareVM This will refresh the VMware VM metadata on the currently connected Rubrik cluster .EXAMPLE Update-RubrikVMwareVM -Id vCenter:::1226ff04-6100-454f-905b-5df817b6981a -moid vm-100 This will refresh the VMware VM metadata, for the VM and vcCenter specified, on the currently connected Rubrik cluster .EXAMPLE Import-Csv .\RefreshVM.csv | Update-RubrikVMwareVM -Verbose This will refresh the VMware VM metadata, for the VM and vcCenter specified in the csv file, on the currently connected Rubrik cluster while displaying verbose information. Please note that the .csv file should contain the id and moid fields. #> [CmdletBinding()] Param( # vCenter id value from the Rubrik Cluster [Parameter( ValueFromPipelineByPropertyName = $true, Mandatory = $true )] [ValidateNotNullOrEmpty()] [Alias('id')] [String]$vcenterId, # VMware VM id value from the Rubrik Cluster [Parameter( ValueFromPipelineByPropertyName = $true, Mandatory = $true )] [ValidateNotNullOrEmpty()] [Alias('moid')] [String]$vmMoid, # Rubrik server IP or FQDN [String]$Server = $global:RubrikConnection.server, # API version [ValidateNotNullorEmpty()] [String]$api = $global:RubrikConnection.api ) Begin { # The Begin section is used to perform one-time loads of data necessary to carry out the function's purpose # If a command needs to be run with each iteration or pipeline input, place it in the Process section # Check to ensure that a session to the Rubrik cluster exists and load the needed header data for authentication Test-RubrikConnection # API data references the name of the function # For convenience, that name is saved here to $function $function = $MyInvocation.MyCommand.Name # Retrieve all of the URI, method, body, query, result, filter, and success details for the API endpoint Write-Verbose -Message "Gather API Data for $function" $resources = Get-RubrikAPIData -endpoint $function Write-Verbose -Message "Load API data for $($resources.Function)" Write-Verbose -Message "Description: $($resources.Description)" } Process { $uri = New-URIString -server $Server -endpoint ($resources.URI) -id $vcenterId $uri = Test-QueryParam -querykeys ($resources.Query.Keys) -parameters ((Get-Command $function).Parameters.Values) -uri $uri $body = New-BodyString -bodykeys ($resources.Body.Keys) -parameters ((Get-Command $function).Parameters.Values) $result = Submit-Request -uri $uri -header $Header -method $($resources.Method) -body $body $result = Test-ReturnFormat -api $api -result $result -location $resources.Result $result = Test-FilterObject -filter ($resources.Filter) -result $result return $result } # End of process } # End of function |