Public/Remove-RubrikHost.ps1
|
#requires -Version 3 function Remove-RubrikHost { <# .SYNOPSIS Delete host by specifying the host ID. .DESCRIPTION The Remove-RubrikHost cmdlet is used to remove a host registered with the Rubrik cluster. .NOTES Written by Chris Wahl for community usage Twitter: @ChrisWahl GitHub: chriswahl .LINK http://rubrikinc.github.io/rubrik-sdk-for-powershell/reference/Remove-RubrikHost.html .EXAMPLE Get-RubrikHost -Name 'Server1.example.com' | Remove-RubrikHost This will remove a host that matches the name "Server1.example.com" .EXAMPLE Remove-RubrikHost -id 'Host:::111111-2222-3333-4444-555555555555' This will specifically remove the host id matching "Host:::111111-2222-3333-4444-555555555555" #> [CmdletBinding(SupportsShouldProcess = $true,ConfirmImpact = 'High')] Param( # The Rubrik ID value of the host [Parameter(Mandatory = $true,ValueFromPipelineByPropertyName = $true)] [String]$id, # Rubrik server IP or FQDN [String]$Server = $global:RubrikConnection.server, # API version [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 $id $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 |