v9.0.1 Release of Rubrik Powershell SDK

This release fixes a critical bug within the Disconnect-Rubrik cmdlet

v6.0.1 Release of Rubrik SDK for PowerShell

Summary of Changes

For a full summary of changes between all version, please take a look at our CHANGELOG.md

Added

Support for Service Accounts : Added new parameterset to Connect-Rubrik containing ID and Secret parameter to facilitate logging into the SDK with Service Accounts. Resolves #812

v6.0.0 Release of Rubrik SDK for PowerShell

Summary of Changes

This module is also packaged and available on the PowerShell Gallery - Rubrik

For a full summary of changes between all version, please take a look at our CHANGELOG.md

Changed

• Changed behavior of Test-RubrikSLA when no explicit primaryclusterid is specified and multiple matches are found it defaults to local, resolves Issue 782
• Updated various sections of the documentations with additional TLS 1.2 troubleshooting steps & solutions, resolves Issue 778
• Modified Get-RubrikAvailabilityGroup query parameters to respect the PrimaryClusterId. Resolves Issue 777
• Modified Get-RubrikAvailabilityGroup to use the v1 endpoint in CDM 6.0 and above
• Modified TypeDefinition for SQL Instance to show status of unprotected instances rather than just show retention SLA. Resolves Issue 760
• Added support for the v1 endpoint for Get-RubrikOracleDB when using 6.0 or above. Resolves Issue 784
• Added ability to retain snapshots while setting the -DoNotProtect parameter to Protect-RubrikFileset,Protect-RubrikDatabase,Protect-RubrikHyperVVM and Protect-RubrikNutanixVM, this resolves Issue 795 and Issue 785 and Issue 697

Added

• Added Get-RubrikClusterUpgradeHistory which Retrieves upgrade history for a given cluster, resolves Issue 789
• Added Find-RubrikFile which allows end users to automate the search process of finding files within Rubrik snapshots. Issue 798
• Added CANCELED as an exit condition for Get-RubrikRequest as suggested by @IamTHEvilONE, resolves Issue 794
• Added -ReseedOnBreak switch parameter to New-RubrikLogShipping to support reseed operations in version 6.0 and above, resolves Issue 792

Fixed

• Test-UnicodeInString issue fixed, issue with slowness for large JSON response thanks @Nic080 & @IISResetMe, resolves Issue 774
• Get-RubrikDownloadLink issue fixed where incorrect timezone could cause cmdlet to get stuck, thanks @benckendall

v5.3.1 Release of Rubrik SDK for PowerShell

Summary of Changes

For a full summary of changes between all version, please take a look at our CHANGELOG.md

Changed

• Added new parameter set & two parameters to Get-RubrikSnapshot, -SnapshotId & -SnapshotType to allow for querying by snapshotid Issue 743
• Updated parameter help for -Archival parameter in New-RubrikSla cmdlet

Added

• Added troubleshooting step and additional CDM API links, resolving Issue 770
• Added additional debug logging to Invoke-RubrikWebRequest, resolving Issue 721

Fixed

• Fixed typo in documentation, resolving Issue 776
• Fixed Unicode issues for all cmdlets, resolving Issue 768, Issue 750, Issue 749
• Fixed documentation for Sync-RubrikTag, resolving Issue 757
• Fixed documentation for New-RubrikHyperVVMMount resolving Issue 756
• Updated API endpoints to v1 for Get-RubrikHostVolume, New-RubrikSnapshot (VolumeGroup endpoint) & Protect-RubrikVolumeGroup cmdlets, fixing Issue 747
• Fixed bug in Submit-Request which causes several issues Issue 751 & Issue 752

Rubrik SDK for PowerShell v5.3

Summary of Changes

For a full summary of changes between all version, please take a look at our CHANGELOG.md

Changed

• Changed the Quick Start Guide to links are pointing to working VMware pages Issue 726
• Changed, parameter sets, SLA_Name/SLA_ByID/SLA_Unprotected/SLA_Forever, added to Protect-RubrikFileset & New-RubrikSnapshot, fixing Issue 720
• Added support for WhatIf & Confirm to the Invoke-RubrikRESTCall cmdlet fixing Issue 713
• Created 3 new parameter sets to Invoke-RubrikRESTCall : BodyAsArray, BodyAsJson, General fixing Issue 711
• Changed how ConfirmImpact is handled in the New-RubrikSnapshot cmdlet, it will now error when no SLAID is found when query by SLA and won't prompt for Test-SLA unless using -Confirm, fixing Issue 699
• Removed 2 deprecated parameters from Get-RubrikReport: -ShowOnlyLatest & -FilterOnlyOnLatest Issue 696
• Changed how PrimaryClusterID is handled in the Get-RubrikDatabase cmdlet fixing Issue 691
• Changed Protect-RubrikVM to use correct REST endpoint & body for Rubrik CDM 5.2 and later Issue 689

Added

• Added new cmdlet: Get-RubrikDebugInfo, that gathers essential information for troubleshooting Issue 742
• Added new cmdlet: Test-RubrikSnapshotVerification, that can test if a snapshot, or series of snapshots are recoverable Issue 733
• Added example in documentation for: Invoke-RubrikGraphQLCall Issue 736
• Added better warning message for New-RubrikMount, now displays warning when an object ID is specified instead of snapshot ID, Issue 732
• Added 5.3 endpoint for Get-RubrikVolumeGroupMount, resolving issue Issue 729
• Added support to Get-RubrikUser to work around all of the API endpoint changes in CDM 5.3 as per Issue 723
• Added new parameter, SLAPrimaryClusterId, to Protect-RubrikFileset & New-RubrikSnapshot, fixing Issue 720
• Added additional parameters: -DoNotProtect & -Inherit to Set-RubrikSQLInstance as requested in Issue 717
• Added Request parameter to allow Get-RubrikRequest to work directly from the pipeline as request in Issue 715
• Added BodyAsJson parameter to Invoke-RubrikRESTCall cmdlet as requested in Issue 711
• Added RetentionLock switch parameter to New-RubrikSLA & Set-RubrikSLA cmdlet as requested in Issue 712
• Added new parameter, -EventSeriesStatus, to Get-RubrikEvent to allow for filtering on event_series_status Issue 705
• Added uri parameter to Invoke-RubrikRESTCall cmdlet as requested in Issue 700
• Added 3 examples in documentation for: Get-RubrikReport Issue 696
• Added additional request types to Get-RubrikRequest as requested in Issue 695 & Issue 716
• Added example in documentation for: Get-RubrikReport Issue 692

Rubrik SDK for PowerShell v5.2

Summary of Changes

For a full summary of changes between all version, please take a look at our CHANGELOG.md

Changed

• Changed Get/Set Rubrik-Blackout to use correctly API version for Rubrik CDM 5.1 and later Issue 679
• Changed Remove-RubrikUnmanagedObject to use correct REST endpoint for Rubrik CDM 5.2 and later Issue 671

Added

• Added Get-RubrikBlackout cmdlet as requested in Issue 688
• Added additional example to New-RubrikVolumeGroupMount Issue 660
• Added additional example to Invoke-RubrikRESTCall Issue 655
• Added new cmdlet Set-RubrikReport to allow for changing settings on Rubrik Reports, and added associated unit tests Issue 654
• Added DetailedObject parameter & updated documentation for: Get-RubrikDatabaseMount, Get-RubrikHyperVVM, Get-RubrikMount, Get-RubrikNutanixVM, Get-RubrikReport, Get-RubrikSLA, Get-RubrikUser, Get-RubrikVCenter, Get-RubrikVMwareDatastore, Get-RubrikVMwareHost Issue 651
• Added additional example to Get-RubrikVolumeGroup Issue 647
• New switch added to Get-RubrikEvent -IncludeEventSeries which determines if EventSeries events are included in the results Issue 626

Fixed

• The DynamicDNS parameter of New-RubrikLDAP is no longer a mandatory parameter Issue 662
• Fixed Test-RubrikSLA internal function behaviour to no longer enforce local cluster ID when not supplied Issue 659
• WhatIf/Verbose messages for Remove-RubrikSLA will display SLA name and ID for additional clarification Issue 653
• Invoke-RubrikRestCall no longer takes Body object for Get Method Issue 652
• Created entries for 5.2 endpoints in Get-RubrikAPIData private function for Get-RubrikEvent & Get-RubrikEventSeries which caused these cmdlets to no longer work on Rubrik CDM 5.2 Issue 626

Deprecated

• The Remove-RubrikOrgAuthorization & Set-RubrikOrgAuthorization cmdlets no longer work in 5.2 because of API changes Issue 681
• Functionality in Get-RubrikEventSeries is limited to only queries by specific EventSeries id on Rubrik CDM Clusters running versions higher than 5.2. Original functionality is still available for backwards compatibility with older versions of Rubrik CDM Issue 626

Rubrik SDK for PowerShell v5.0.3

Summary of Changes

For a full summary of changes between all version, please take a look at our CHANGELOG.md

Changed

• Changed default value of DefaultWebRequestTimeout module option to 100 seconds to match cmdlets timeout. Resolves Issue 667 Issue 663 and Issue 666
• Added check to Invoke-RubrikWebRequest to check DefaultWebRequestTimeOut. If the value is not set, or set to something less than 100, Invoke-WebRequest will default to 100 seconds, otherwise, if the value is greater than 100 Invoke-WebRequest will use the custom timeout
• Added verbose messages around the timeout values

Added

• Added Update-RubrikNutanixCluster as requested by Teixeirapa, also updated documentation in Invoke-RubrikRestCall to provide an example to do an empty post request. Resolves Issue 669
• Added 5.2 API calls for Get-RubrikClusterStorage as the endpoint to retrieve Average Daily Growth no longer exists in CDM 5.2. Resolves Issue 664
• Updated API stanza for 5.2 for the Get-RubrikSyslogServer cmdlet

Fixed

• Fixed bugs in New-RubrikLDAP and updated documentation and verbose logging Issue 648

Rubrik SDK for PowerShell v5.0.0

NOTE: Some information here will be provided in subsequent releases, as the time between this release and the previous release is over 2 years. Because of this all functions in this release are either new or changed

This is the first release of the Rubrik SDK for PowerShell, verified to run against Rubrik CDM 5.0 and later.

Summary of Changes

For a full summary of changes, please take a look at CHANGELOG.md, specifically the 5.0.0 - 2019-11-24 section which contains all the changes made to this release.

• Added support for vCloud Director with RubrikVCD & RubrikVApp functions - #453
• Added default output types for many of the Rubrik functions by adding object definitions and adding object types using the Set-ObjectTypeName function - #456
• Added new function to allow for Rubrik Volume Filter Driver installation - #301
• Added function, Get-RubrikOracleDB for querying information Oracle databases protected by Rubrik - #266
• Added unit tests to many of the public and private functions to allow for easier contributions to the module
• Added templates folder to the module - #373
• Added bootstrap functions, thanks @nshores! - #373
• Added Get-RubrikObject that can query for any type of snappable on a Rubrik Cluster by ID - #444
• Added support for managing organizations using the module - #293 #459 #514
• Added *-RubrikUser functions to manage accounts on a Rubrik Cluster - #452

Breaking Changes

• Switched Boolean parameters to Switch parameters, this has the possibility of providing breaking changes as the syntax of calling the parameters like '-Parameter $true' will no longer be supported.

Changed Functions

• Changed New-RubrikSLA and added Set-RubrikSLA with support for v2 SLAs which were introduced in Rubrik CDM 5.0 - #328
• Changed CI/CD pipeline from Appveyor to Azure DevOps - #458
• Changed the folder structure of the module - #498
• Changed Connect-Rubrik to add a user agent string when connecting to a Rubrik cluster - #522
• Changed Connect-Rubrik with support for API tokens to authenticate to the Rubrik cluster - #380
• Changed removed boolean parameters and replaced them by switch parameters, this can potentially break existing scripts that rely on these parameters being boolean. - #104 #357 #473
• Changed most Get-Rubrik functions such as Get-RubrikVM to have support for the -DetailedObject switch parameter. This will retrieve additional information about the snappable by querying the endpoint by {id} - #264 #301 #320 #360 #492

Bug Fixes

• Fixed pagination and output parsing bugs - #355 #488
• Fixed Get-RubrikFileSet not returning exact matches returning infix search results instead - #425
• Fixed multiple issues with Get-RubrikSnapshot - #395 #396
• Fixed bugs with various HTTP status code on patch - post - delete operations - #403 #379
• Fixed documentation where applicable

New Functions

Not available in this release

New Internal Functions

Not available in this release

Rubrik PowerShell Module v3.1.0.4

This release has been tested against Rubrik CDM version 3.1.1.

Change Log

• All private and public functions have been refactored for the 3.1 RCDM release of the RESTful APIs.
• Functions are now mostly stateless with calls to private (internal) functions. Exemptions are spelled out with #region One-off regions.
• All behavior for query, body, result, and filter objects are embedded into Get-RubrikAPIData and sorted by the function's name.
• Note that most functions now work off an id value based on their scope. i.e. VMware-centric functions are looking for the VirtualMachine id, snapshot functions want the snapshot id, mount functions want a mount id, and so forth.
• Please double check that your scripts have adjusted for these differences and that you are running RCDM 3.1 before installing this new module code.

New Cmdlets

• Get-RubrikDatabase
• Get-RubrikFileset
• Get-RubrikFilesetTemplate
• Protect-RubrikDatabase
• Protect-RubrikFileset

New Helpers

• New-BodyString
• New-QueryString
• New-URIString
• Submit-Request
• Test-DateDifference
• Test-FilterObject
• Test-QueryObject
• Test-QueryParam
• Test-ReturnFilter
• Test-ReturnFormat
• Test-RubrikConnection
• Test-RubrikCredential
• Test-RubrikSLA
• Test-VMwareConnection

Visit this comparison to see all committed changes in this release.

Rubrik PowerShell Module v3.0.0

This release has been tested against Rubrik CDM version 3.0.

Change Log

• Complete architecture overhaul to support versioned API
• Created new Pester unit tests for AppVeyor builds triggered by merge / PR activity
• Updated Get-RubrikVM to fetch all VMs if no params are passed (kudos basvinken)
• Updated Get-RubrikVM with JSON parser for large payloads
• Updated Protect-RubrikVM to handle multiple ID values
• Updated Set-RubrikVM with new params: SnapConsistency, MaxNestedSnapshots, and PauseBackups
• Update Remove-RubrikMount by removing the -VM param. Pipe in a Mount object for removal. See Get-Help Remove-RubrikMount for details.
• Removed Get-RubrikTask in favor of New-RubrikReport
• Removed Set-RubrikMount
• Removed Sync-RubrikAttribute

New Cmdlets

• N/A

New Helpers

• Get-RubrikAPIData

Visit this comparison to see all committed changes in this release.