Public/Set-RubrikVgfAutoUpgrade.ps1
|
#requires -Version 3 function Set-RubrikVgfAutoUpgrade { <# .SYNOPSIS Updates the Volume Group format auto upgrade settings on a Rubrik cluster .DESCRIPTION The Set-RubrikVgfAutoUpgrade cmdlet is used to update the Volume Group format auto upgrade settings to a Rubrik cluster. There are two configurations available: - 'migrateFastVirtualDiskBuild', or 'AutoUpgradeMode', is a string-type flag that controls the use of the fast VHDX builder during volume group migration. When the value of the flag is 'Error-Only,' the volume group uses the fast VHDX builder when a pre-5.1 volume group backup operation fails during the fetch phase. When the value of the flag is 'All,' the volume group uses the fast VHDX builder the next time the volume group is backed up. Any other value disables the fast VHDX builder. This flag is used in combination with the maxFullMigrationStoragePercentage value. - 'maxFullMigrationStoragePercentage', is an integer which specifies a percentage of the total storage space. When performing a full volume group backup operation would bring the total used storage space above this threshold, the cluster takes incremental backups instead. This value is used in combination with the migrateFastVirtualDiskBuild flag. .NOTES Written by Feng Lu for community usage github: fenglu42 .LINK https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/set-rubrikvgfautoupgrade .EXAMPLE Set-RubrikVgfAutoUpgrade -migrateFastVirtualDiskBuild 'All' This will set the cluster configuration to automatically upgrade format for all Volume Groups. .EXAMPLE Set-RubrikVgfAutoUpgrade -migrateFastVirtualDiskBuild 'Error-Only' This will set the cluster configuration to automatically upgrade for Volume Groups that have a failure during the last backup. .EXAMPLE Set-RubrikVgfAutoUpgrade -migrateFastVirtualDiskBuild 'None' This will set the cluster configuration to not automatically upgrade format for any Volume Groups. .EXAMPLE Set-RubrikVgfAutoUpgrade -maxFullMigrationStoragePercentage 70 This will set the cluster configuration to allow automatic upgrade only when the projected cluster space usage after upgrade does not exceed 70% of total cluster storage. .EXAMPLE Set-RubrikVgfAutoUpgrade -migrateFastVirtualDiskBuild 'Error-Only' -maxFullMigrationStoragePercentage 70 This will set both configurations on the cluster. #> [CmdletBinding()] Param( # Mode of automatic upgrade [Alias('AutoUpgradeMode')] [String]$migrateFastVirtualDiskBuild, # Maximum allowed cluster storage space usage if upgrade happens [Int]$maxFullMigrationStoragePercentage, # Filter the report based on whether the Volume Group used fast VHDX format for its latest snapshot. [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 { if (!$migrateFastVirtualDiskBuild -and !$maxFullMigrationStoragePercentage) { Write-Host "Invalid input: At least one of the parameters, 'migrateFastVirtualDiskBuild' and 'maxFullMigrationStoragePercentage', should be non-empty. Exiting the process." return $null } # Precheck for valid inputs of migrateFastVirtualDiskBuild if ($migrateFastVirtualDiskBuild -and ($migrateFastVirtualDiskBuild -ne 'All') -and ($migrateFastVirtualDiskBuild -ne 'Error-Only') -and ($migrateFastVirtualDiskBuild -ne 'None')) { Write-Host "Invalid input value for migrateFastVirtualDiskBuild (AutoUpgradeMode). Valid values are 'All', 'Error-Only' and 'None'." return $null } # Precheck for valid inputs of maxFullMigrationStoragePercentage if (($maxFullMigrationStoragePercentage -lt 0) -or ($maxFullMigrationStoragePercentage -gt 100)) { Write-Host "Invalid input value for maxFullMigrationStoragePercentage. Please use an integer between 0 and 100." return $null } Write-Verbose "Setting cluster-wide Volume Group configuration:" if ($migrateFastVirtualDiskBuild) { Write-Verbose "'migrateFastVirtualDiskBuild' to $migrateFastVirtualDiskBuild" } if ($maxFullMigrationStoragePercentage) { Write-Verbose "'maxFullMigrationStoragePercentage' to $maxFullMigrationStoragePercentage" } $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 if (($migrateFastVirtualDiskBuild -and ($result.migrateFastVirtualDiskBuild -ne $migrateFastVirtualDiskBuild)) -or ($maxFullMigrationStoragePercentage -and ($result.maxFullMigrationStoragePercentage -ne $maxFullMigrationStoragePercentage))) { Write-Warning "The operation failed to set the configs. Use -Verbose to see more information." } else { Write-Host "" if ($migrateFastVirtualDiskBuild) { if ($migrateFastVirtualDiskBuild -eq 'None') { Write-Host "Successfully disabled Volume Format Auto-Upgrade." } if ($migrateFastVirtualDiskBuild -eq 'Error-Only') { Write-Host "Successfully configured to Auto-Upgrade Volume Groups after a Backup Error." } if ($migrateFastVirtualDiskBuild -eq 'All') { Write-Host "Successfully configured to Auto-Upgrade Volume Groups on Next Backup." } } if ($maxFullMigrationStoragePercentage) { Write-Host "Successfully set the cluster space consumption limit to $maxFullMigrationStoragePercentage%." } } return $result } # End of process } # End of function |