Public/Get-RubrikQstarArchive.ps1
|
#requires -Version 3 function Get-RubrikQstarArchive { <# .SYNOPSIS Connects to Rubrik and retrieves a list of QStar archive targets .DESCRIPTION The Get-RubrikQstarArchive cmdlet is used to pull a list of configured QStar archive targets from the Rubrik cluster. .NOTES Written by Mike Preston for community usage Twitter: @mwpreston GitHub: mwpreston .LINK https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikqstararchive .EXAMPLE Get-RubrikQstarArchive This will return all the QStar archive targets configured on the Rubrik cluster. .EXAMPLE Get-RubrikQstarArchive -id '1111-2222-3333' This will return the archive target with an id of '1111-2222-3333' on the Rubrik cluster. .EXAMPLE Get-RubrikQstarArchive -Name 'QStar01' This will return the archive target with a name of 'QStar01' on the Rubrik cluster. #> [CmdletBinding(DefaultParameterSetName = 'Query')] Param( # QStar Archive ID [ValidateNotNullOrEmpty()] [Parameter( Position = 0, Mandatory = $true, ParameterSetName = 'ID', ValueFromPipelineByPropertyName = $true)] [String]$Id, # QStar Archive Name [ValidateNotNullOrEmpty()] [Parameter( ParameterSetName='Query', Position = 0)] [String]$Name, # 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 $result = $result | Select-Object -Property *,@{Name="locationType";Expression={"QStar"}} $result = Set-ObjectTypeName -TypeName $resources.ObjectTName -result $result return $result } # End of process } # End of function |