Updated documentation for Get Report #692 🩺

rubrikinc · Sep 21, 2020 · 4b267a6 · 4b267a6
1 parent 0f54c31
commit 4b267a6
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/Rubrik/Public/Get-RubrikReport.ps1 b/Rubrik/Public/Get-RubrikReport.ps1
@@ -35,6 +35,16 @@ function Get-RubrikReport
       Get-RubrikReport -id '11111111-2222-3333-4444-555555555555'
 
       This will return details on the report id "11111111-2222-3333-4444-555555555555"
+
+      .EXAMPLE
+      Get-RubrikReport -Name 'Protection Tasks Details' | Get-RubrikReportData
+      
+      Using the pipeline in combination with Get-RubrikReportData additional information and report data are retrieved
+
+      .EXAMPLE
+      Get-RubrikReport -Name 'Protection Tasks Details' | Get-RubrikReportData | Select-Object -ExpandProperty DatagridObject
+
+      Using the pipeline in combination with Get-RubrikReportData additional information and report data are retrieved. Using Select-Object to dig into the individual Protection Tasks
   #>
 
   [CmdletBinding()]

diff --git a/Rubrik/Public/Get-RubrikReportData.ps1 b/Rubrik/Public/Get-RubrikReportData.ps1
@@ -17,22 +17,27 @@ function Get-RubrikReportData {
 
       .EXAMPLE
       Get-RubrikReport -Name 'SLA Compliance Summary' | Get-RubrikReportData
+      
       This will return table data from the "SLA Compliance Summary" report
 
       .EXAMPLE
       Get-RubrikReport -Name 'SLA Compliance Summary' | Get-RubrikReportData -ComplianceStatus 'NonCompliance'
+      
       This will return table data from the "SLA Compliance Summary" report when the compliance status is "NonCompliance"
 
       .EXAMPLE
       Get-RubrikReport -Name 'SLA Compliance Summary' | Get-RubrikReportData -ComplianceStatus 'NonCompliance' -Limit 10
+      
       This will return table data from the "SLA Compliance Summary" report when the compliance status is "NonCompliance", only returns the first 10 results.
 
       .EXAMPLE
       Get-RubrikReport -Name 'Object Protection Summary' | Get-RubrikReportData -Limit -1
+      
       This will return all of the table data from the "Object Protection Summary" report. Note: Using '-Limit -1' may affect performance for reports containing large amounts of data.
 
       .EXAMPLE
       (Get-RubrikReport -Name "System Capacity" | Get-RubrikReportData).DatagridObject | Format-Table
+
       This will return a human readable table view of the items within the System Capacity report.
   #>