Public/Get-RubrikReport.ps1
|
#requires -Version 3 function Get-RubrikReport { <# .SYNOPSIS Retrieves details on one or more reports created in Rubrik Envision .DESCRIPTION The Get-RubrikReport cmdlet is used to pull information on any number of Rubrik Envision reports .NOTES Written by Chris Wahl for community usage Twitter: @ChrisWahl GitHub: chriswahl .LINK https://github.com/rubrikinc/PowerShell-Module .EXAMPLE Get-RubrikReport This will return details on all reports .EXAMPLE Get-RubrikReport -Name 'SLA' -Type Custom This will return details on all custom reports that contain the string "SLA" .EXAMPLE Get-RubrikReport -id '11111111-2222-3333-4444-555555555555' This will return details on the report id "11111111-2222-3333-4444-555555555555" #> [CmdletBinding()] Param( # Filter the returned reports based off their name. [Alias('search_text')] [String]$Name, # Filter the returned reports based off the reports type. Options are Canned and Custom. [ValidateSet('Canned', 'Custom')] [Alias('report_type')] [String]$Type, # The ID of the report. [Parameter(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 |