Merge pull request #744 from rubrikinc/jaap-53docs

Merge updated documentation into `devel` for 5.3 release

Author: jaapbrasser

CHANGELOG.md

@@ -14,15 +14,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 * **Fixed** for any bug fixes.
 * **Security** in case of vulnerabilities.
 
-## Unreleased
-
-### Changed
-
-### Added
-
-### Fixed
-
-## [5.3.0]() - 2021-04-08
+## [5.3.0]() - 2021-04-09
 
 ### Changed
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Rubrik, Inc
+Copyright (c) 2021 Rubrik, Inc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Rubrik/Public/Get-RubrikDebugInfo.ps1

@@ -56,8 +56,8 @@ function Get-RubrikDebugInfo
     $HashProps.RubrikInstalledModule = ((Get-Module -Name Rubrik -ListAvailable) | ForEach-Object {if ($_.PrivateData.PSData.Prerelease -ne $null) {'{0}-{1}' -f $_.Version,$_.PrivateData.PSData.Prerelease} else {$_.version}}) -join ', '
 
     # Add configured module options and default parameters
-    $HashProps.RubrikModuleOptions = Get-RubrikModuleOption
-    $HashProps.RubrikModuleDefaultParameters = Get-RubrikModuleDefaultParameter
+    $HashProps.RubrikModuleOptions = (($Opt = Get-RubrikModuleOption).psobject.properties.name.foreach{"$_ = $($Opt.$_)"}) -join '; '
+    $HashProps.RubrikModuleDefaultParameters = (($Par = Get-RubrikModuleDefaultParameter).psobject.properties.name.foreach{"$_ = $($Par.$_)"}) -join '; '
 
     # Output as object
     return [pscustomobject]$HashProps

Rubrik/Rubrik.psd1

@@ -26,7 +26,7 @@
     CompanyName = 'Rubrik'
 
     # Copyright statement for this module
-    Copyright = '(c) 2015-2020 Rubrik, Inc. All rights reserved.'
+    Copyright = '(c) 2015-2021 Rubrik, Inc. All rights reserved.'
 
     # Description of the functionality provided by this module
     Description = "This is a community project that provides a PowerShell module for managing and monitoring Rubrik's Cloud Data Management platform."

Rubrik/en-US/Rubrik-help.xml

@@ -40,6 +40,7 @@
     * [Get-RubrikDatabaseMount](command-documentation/reference/get-rubrikdatabasemount.md)
     * [Get-RubrikDatabaseRecoverableRange](command-documentation/reference/get-rubrikdatabaserecoverablerange.md)
     * [Get-RubrikDatabaseRecoveryPoint](command-documentation/reference/get-rubrikdatabaserecoverypoint.md)
+    * [Get-RubrikDebugInfo](command-documentation/reference/get-rubrikdebuginfo.md)
     * [Get-RubrikDNSSetting](command-documentation/reference/get-rubrikdnssetting.md)
     * [Get-RubrikDownloadLink](command-documentation/reference/get-rubrikdownloadlink.md)
     * [Get-RubrikEmailSetting](command-documentation/reference/get-rubrikemailsetting.md)
@@ -215,6 +216,7 @@
     * [Suspend-RubrikSLA](command-documentation/reference/suspend-rubriksla.md)
     * [Sync-RubrikAnnotation](command-documentation/reference/sync-rubrikannotation.md)
     * [Sync-RubrikTag](command-documentation/reference/sync-rubriktag.md)
+    * [Test-RubrikSnapshotVerification](command-documentation/reference/test-rubriksnapshotverification.md)
     * [Update-RubrikHost](command-documentation/reference/update-rubrikhost.md)
     * [Update-RubrikNutanixCluster](command-documentation/reference/update-rubriknutanixcluster.md)
     * [Update-RubrikVCD](command-documentation/reference/update-rubrikvcd.md)

azure-pipelines/azure-pipelines-devel-merge.yml renamed to azure-pipelines/azure-pipelines-devel-merge.yml.old

@@ -0,0 +1,49 @@
+---
+external help file: Rubrik-help.xml
+Module Name: Rubrik
+online version: https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikdebuginfo
+schema: 2.0.0
+---
+
+# Get-RubrikDebugInfo
+
+## SYNOPSIS
+Displays information about the Rubrik module and the PowerShell
+
+## SYNTAX
+
+```
+Get-RubrikDebugInfo [<CommonParameters>]
+```
+
+## DESCRIPTION
+The Get-RubrikDebugInfo cmdlet will retrieve the version of code that is actively running on the system.
+It will gather essential information that can be used for quickly troubleshooting issues
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-RubrikDebugInfo
+```
+
+This will return information about the PowerShell version, the PowerShell client or console, and both the Rubrik cluster and Rubrik PowerShell module version numbers
+
+## PARAMETERS
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+Written by Jaap Brasser for community usage
+Twitter: @jaap_brasser
+GitHub: JaapBrasser
+
+## RELATED LINKS
+
+[https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikdebuginfo](https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikdebuginfo)
+

azure-pipelines/azure-pipelines-master-merge.yml renamed to azure-pipelines/azure-pipelines-master-merge.yml.old

@@ -14,10 +14,10 @@ Retrieve information for events that match the value specified in any of the fol
 
 ### eventByID
 ```
-Get-RubrikEvent [-Limit <Int32>] [-AfterId <String>] [-Status <String>] [-EventType <String>]
- [-ExcludeEventType <String[]>] [-id <Array>] [-ObjectName <String>] [-BeforeDate <DateTime>]
- [-AfterDate <DateTime>] [-ObjectType <String>] [-ExcludeObjectType <String[]>] [-ShowOnlyLatest]
- [-FilterOnlyOnLatest] [-IncludeEventSeries] [-Server <String>] [-api <String>] [<CommonParameters>]
+Get-RubrikEvent [-Limit <Int32>] [-AfterId <String>] [-Status <String>] [-EventSeriesStatus <String>]
+ [-EventType <String>] [-ExcludeEventType <String[]>] [-id <String[]>] [-ObjectName <String>]
+ [-BeforeDate <DateTime>] [-AfterDate <DateTime>] [-ObjectType <String>] [-ExcludeObjectType <String[]>]
+ [-Descending] [-IncludeEventSeries] [-Server <String>] [-api <String>] [<CommonParameters>]
 ```
 
 ### EventSeries
@@ -99,6 +99,34 @@ Get-RubrikEvent -Limit 25 -EventType Archive -ExcludeObjectType AggregateAhvVm,M
 This will retrieve all Archive events while excluding events of the AggregateAhvVm & Mssql object types while displaying verbose messages.
 This will potentially display less than 25 objects, as filtering happens after receiving the objects from the endpoint
 
+### EXAMPLE 10
+```
+Get-RubrikDatabase | ForEach-Object {Get-RubrikEvent -Limit 1 -Verbose -id $_.ID}
+```
+
+This will retrieve the last event for each of the SQL databases protected by Rubrik identifying the database by its object_id while displaying Verbose information
+
+### EXAMPLE 11
+```
+Get-RubrikEvent -Limit 1 -Descending:$false
+```
+
+Will retrieve the oldest event on the Rubrik Cluster
+
+### EXAMPLE 12
+```
+Get-RubrikEvent -Limit 1 -Descending:$false -EventType Backup
+```
+
+Will retrieve the oldest backup event on the Rubrik Cluster
+
+### EXAMPLE 13
+```
+Get-RubrikEvent -Status Failure -EventSeriesStatus Success
+```
+
+Will retrieve the first 50 Events which have event_status failed and event_series_status Success
+
 ## PARAMETERS
 
 ### -Limit
@@ -147,13 +175,29 @@ Accept wildcard characters: False
 ```
 
 ### -Status
+Filter by Event status.
+Enter any of the following values: 'Failure', 'Warning', 'Running', 'Success', 'Canceled', 'Canceling'.
+
+```yaml
+Type: String
+Parameter Sets: eventByID
+Aliases: event_status
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -EventSeriesStatus
 Filter by Status.
-Enter any of the following values: 'Failure', 'Warning', 'Running', 'Success', 'Canceled', 'Canceling’.
+Enter any of the following values: 'Success', 'Failure', 'Scheduled', 'Active', 'Canceling', 'Canceled', 'SuccessWithWarnings'.
 
 ```yaml
 Type: String
 Parameter Sets: eventByID
-Aliases:
+Aliases: event_series_status
 
 Required: False
 Position: Named
@@ -197,7 +241,7 @@ Accept wildcard characters: False
 Filter by a comma separated list of object IDs.
 
 ```yaml
-Type: Array
+Type: String[]
 Parameter Sets: eventByID
 Aliases: object_ids
 
@@ -286,36 +330,14 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -ShowOnlyLatest
-A switch value that determines whether to show only on the most recent event in the series.
-When 'true' only the most recent event in the series are shown.
-When 'false' all events in the series are shown.
-The default value is 'true'.
-Note: Deprecated in 5.2
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: eventByID
-Aliases: show_only_latest
-
-Required: False
-Position: Named
-Default value: False
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -FilterOnlyOnLatest
-A Switch value that determines whether to filter only on the most recent event in the series.
-When 'true' only the most recent event in the series are filtered.
-When 'false' all events in the series are filtered.
-The default value is 'true'.
-Note: Deprecated in 5.2
+### -Descending
+A Switch value that determines whether to display the results in descending or ascending order.
+Setting this to Descending:$false will return the oldest results instead of the most recent
 
 ```yaml
 Type: SwitchParameter
 Parameter Sets: eventByID
-Aliases: filter_only_on_latest
+Aliases: order_by_time
 
 Required: False
 Position: Named