Merge pull request #769 from rubrikinc/jaap-unicode

Fixed unicode issues with cmdlets

Author: mwpreston

CHANGELOG.md

@@ -14,7 +14,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 * **Fixed** for any bug fixes.
 * **Security** in case of vulnerabilities.
 
-## Unreleased
+## [5.3.1](https://github.com/rubrikinc/rubrik-sdk-for-powershell/tree/5.3.1) - 2021-07-06
 
 ### Changed
 
@@ -23,10 +23,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+* Added troubleshooting step and additional CDM API links, resolving [Issue 770](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/770)
+* Added additional debug logging to `Invoke-RubrikWebRequest`, resolving [Issue 721](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/721)
+
 ### Fixed
 
-* Fixed documentation for `New-RubrikHyperVVMMount` resolving [Issue 756](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/756)
+* Fixed typo in documentation, resolving [Issue 776](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/776)
+* Fixed Unicode issues for all cmdlets, resolving [Issue 768](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/768), [Issue 750](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/750), [Issue 749](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/749)
 * Fixed documentation for `Sync-RubrikTag`, resolving [Issue 757](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/757)
+* Fixed documentation for `New-RubrikHyperVVMMount` resolving [Issue 756](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/756)
 * Updated API endpoints to `v1` for `Get-RubrikHostVolume`, `New-RubrikSnapshot` (VolumeGroup endpoint) & `Protect-RubrikVolumeGroup` cmdlets, fixing [Issue 747](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/747)
 * Fixed bug in `Submit-Request` which causes several issues [Issue 751](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/751) & [Issue 752](https://github.com/rubrikinc/rubrik-sdk-for-powershell/issues/752)
 

README.md

@@ -1,8 +1,5 @@
 # Rubrik SDK for PowerShell
 
-[![Build Status](https://dev.azure.com/rubrik-build/rubrik-sdk-for-powershell/_apis/build/status/rubrikinc.rubrik-sdk-for-powershell?branchName=devel)](https://dev.azure.com/rubrik-build/rubrik-sdk-for-powershell/_build/latest?definitionId=3&branchName=devel)
-[![Build Status](https://dev.azure.com/rubrik-build/rubrik-sdk-for-powershell/_apis/build/status/rubrikinc.rubrik-sdk-for-powershell?branchName=master)](https://dev.azure.com/rubrik-build/rubrik-sdk-for-powershell/_build/latest?definitionId=3&branchName=master)
-
 This is a community project that provides a Microsoft PowerShell module for managing and monitoring Rubrik's Multi-Cloud Data Control fabric by way of published RESTful APIs. If you're looking to perform interactive automation, setting up scheduled tasks, leverage an orchestration engine, or need ad-hoc operations, this module is intended to be valuable to your needs.
 
 # :hammer: Installation
@@ -13,9 +10,9 @@ Load the module by using:
 
 If you wish to load a specific version, use:
 
-`Import-Module Rubrik -RequiredVersion #.#.#.#`
+`Import-Module Rubrik -RequiredVersion #.#.#`
 
-Where `#.#.#.#` represents the version number.
+Where `#.#.#` represents the version number, for example 5.3.1
 
 # :mag: Example
 

Rubrik/Private/Invoke-RubrikWebRequest.ps1

@@ -17,6 +17,11 @@ function Invoke-RubrikWebRequest {
     # Write Debug information
     Write-Debug -Message ($PSBoundParameters.GetEnumerator()|Out-String)
 
+    if (Test-UnicodeInString -String $Body) {
+        $PSBoundParameters.Add('ContentType', 'text/plain; charset=utf-8')
+        Write-Verbose -Message ('Submitting "{0}" request as "text/plain; charset=utf-8"' -f $Method)
+    }
+
     if (Test-PowerShellSix) {
         if (-not [string]::IsNullOrWhiteSpace($rubrikOptions.ModuleOption.DefaultWebRequestTimeOut) -or $rubrikOptions.ModuleOption.DefaultWebRequestTimeOut -gt 99) {
             Write-Verbose -Message "Invoking request with a custom timeout of $($rubrikOptions.ModuleOption.DefaultWebRequestTimeOut) seconds"
@@ -36,6 +41,7 @@ function Invoke-RubrikWebRequest {
     }
 
     Write-Verbose -Message "Received HTTP Status $($result.StatusCode)"
+    Write-Debug -Message "Raw Response content:`n $($result.rawcontent)"
 
     return $result
 }

Rubrik/Private/Submit-Request.ps1

@@ -36,14 +36,22 @@ function Submit-Request {
                 if (Test-PowerShellSix) {
                     # Uses the improved ConvertFrom-Json cmdlet as provided in PowerShell 6.1
                     # In the case of DELETE, there is no content (json body) to parse.
-                    $result = if ($null -ne ($WebResult = Invoke-RubrikWebRequest -Uri $uri -Headers $header -Method $method -Body $body)) {
-                        if ($null -ne $WebResult.Content) {
+                    $result = if (($WebResult = Invoke-RubrikWebRequest -Uri $uri -Headers $header -Method $method -Body $body)) {
+                        if ($WebResult.Content) {
                             ConvertFrom-Json -InputObject $WebResult.Content
                         } 
                     }
                 } else {
                     # Because some calls require more than the default payload limit of 2MB, ExpandPayload dynamically adjusts the payload limit
-                    $result = ExpandPayload -response ($WebResult = Invoke-RubrikWebRequest -Uri $uri -Headers $header -Method $method -Body $body)
+                    $WebResult = Invoke-RubrikWebRequest -Uri $uri -Headers $header -Method $method -Body $body
+                    if (Test-UnicodeInString -String $WebResult.Content) {
+                        $WebResult = [pscustomobject]@{
+                            Content = [system.Text.Encoding]::UTF8.GetString($WebResult.RawContentStream.ToArray())
+                            StatusCode = $WebResult.StatusCode
+                            StatusDescription = $WebResult.StatusDescription
+                        }
+                    }
+                    $result = ExpandPayload -response $WebResult
                 }
                 # If $result is null, build a $result object to return to the user. Otherwise, $result will be returned.
                 if ($null -eq $result) {   
@@ -71,7 +79,15 @@ function Submit-Request {
                     $result = ConvertFrom-Json -InputObject (Invoke-RubrikWebRequest -Uri $uri -Headers $header -Method $method -Body $body).Content
                 } else {
                     # Because some calls require more than the default payload limit of 2MB, ExpandPayload dynamically adjusts the payload limit
-                    $result = ExpandPayload -response (Invoke-RubrikWebRequest -Uri $uri -Headers $header -Method $method -Body $body)
+                    $WebResult = Invoke-RubrikWebRequest -Uri $uri -Headers $header -Method $method -Body $body
+                    if (Test-UnicodeInString -String $WebResult.Content) {
+                        $WebResult = [pscustomobject]@{
+                            Content = [system.Text.Encoding]::UTF8.GetString($WebResult.RawContentStream.ToArray())
+                            StatusCode = $WebResult.StatusCode
+                            StatusDescription = $WebResult.StatusDescription
+                        }
+                    }
+                    $result = ExpandPayload -response $WebResult
                 }
             }
         }

Rubrik/Private/Test-QueryParam.ps1

@@ -78,12 +78,16 @@
     foreach ($param in $parameters) {
       # If the parameter name matches the query option name, build a query string
       if ($param.Name -eq $query) {
-        Write-Debug ('Building Query with "{0}: {1}"' -f $resources.Query[$param.Name], (Get-Variable -Name $param.Name).Value)
+        if ((Get-Variable -Name $param.Name).Value) {
+          Write-Debug ('Building Query with "{0}: {1}"' -f $resources.Query[$param.Name], (Get-Variable -Name $param.Name).Value)
+        }
         $querystring += Test-QueryObject -object (Get-Variable -Name $param.Name).Value -location $resources.Query[$param.Name] -params $querystring
       }
       # If the parameter alias matches the query option name, build a query string
       elseif ($param.Aliases -eq $query) {
-        Write-Debug ('Building Query with "{0}: {1}"' -f (-join $resources.Query[$param.Aliases]), (Get-Variable -Name $param.Name).Value)
+        if ((Get-Variable -Name $param.Name).Value) {
+          Write-Debug ('Building Query with "{0}: {1}"' -f (-join $resources.Query[$param.Aliases]), (Get-Variable -Name $param.Name).Value)
+        }
         $querystring += Test-QueryObject -object (Get-Variable -Name $param.Name).Value -location $resources.Query[$param.Aliases] -params $querystring
       }
     }

Rubrik/Private/Test-UnicodeInString.ps1

@@ -0,0 +1,14 @@
+function Test-UnicodeInString {
+    <#
+        .SYNOPSIS
+        Test if a string contains non-ASCII characters
+    
+        .DESCRIPTION
+        Test if a string contains non-ASCII characters, returns true if it does, false if it does not. This function can be used to provide the correct character encoding for the different web cmdlets.
+    #>
+        param(
+            $String
+        )
+
+        [regex]::IsMatch($String, ".*[^\u0000-\u007F].*")
+    }

Rubrik/Public/Get-RubrikVgfClusterStorage.ps1

@@ -1,65 +1,59 @@
 #requires -Version 3
 function Get-RubrikVgfClusterStorage
 {
-  <#
-      .SYNOPSIS
-      Returns cluster free space in the case of Volume Group format upgrade
+<#
+  .SYNOPSIS
+  Returns cluster free space in the case of Volume Group format upgrade
 
-      .DESCRIPTION
-      The Get-RubrikVgfClusterStorage cmdlet is used to return projected space consumption
-      on any number of volume groups if they are migrated to use the new format, and the
-      cluster free space before and after the migration. If no Volume Group ID or list of
-      ID is given, it will report the projected space consumption of migrating all Volume
-      Groups that are currently using the old format.
+  .DESCRIPTION
+  The Get-RubrikVgfClusterStorage cmdlet is used to return projected space consumption
+  on any number of volume groups if they are migrated to use the new format, and the
+  cluster free space before and after the migration. If no Volume Group ID or list of
+  ID is given, it will report the projected space consumption of migrating all Volume
+  Groups that are currently using the old format.
 
-      .NOTES
-      Written by Feng Lu for community usage
-      github: fenglu42
+  .NOTES
+  Written by Feng Lu for community usage
+  github: fenglu42
 
-      .LINK
-      https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikvgfclusterstorage
+  .LINK
+  https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikvgfclusterstorage
 
-      .EXAMPLE
-      Get-RubrikVgfClusterStorage -VGList VolumeGroup:::e0a04776-ab8e-45d4-8501-8da658221d74, VolumeGroup:::9136a7ef-4ad2-4bb9-bf28-961fb74d4322
+  .EXAMPLE
+  Get-RubrikVgfClusterStorage -VGList VolumeGroup:::e0a04776-ab8e-45d4-8501-8da658221d74, VolumeGroup:::9136a7ef-4ad2-4bb9-bf28-961fb74d4322
 
-      This will return projected space consumption on volume groups within the given Volume Group ID list, and cluster free space before and after migration.
+  This will return projected space consumption on volume groups within the given Volume Group ID list, and cluster free space before and after migration.
 
-      .EXAMPLE
-      Get-RubrikVgfClusterStorage
+  .EXAMPLE
+  Get-RubrikVgfClusterStorage
 
-      This will return projected space consumption of migrating all old-format volume groups on the Rubrik cluster, and cluster free space before and after migration.
+  This will return projected space consumption of migrating all old-format volume groups on the Rubrik cluster, and cluster free space before and after migration.
 
-      .EXAMPLE
-      Get-RubrikVgfClusterStorage -Hostname 'Server1'
+  .EXAMPLE
+  Get-RubrikVgfClusterStorage -Hostname 'Server1'
 
-      This will return projected space consumption of migrating all old-format volume groups from host "Server1", and cluster free space before and after migration.
+  This will return projected space consumption of migrating all old-format volume groups from host "Server1", and cluster free space before and after migration.
 
-      .EXAMPLE
-      Get-RubrikVgfClusterStorage -Hostname 'Server1' -SLA Gold
+  .EXAMPLE
+  Get-RubrikVgfClusterStorage -Hostname 'Server1' -SLA Gold
 
-      This will return projected space consumption of migrating all old-format volume groups of "Server1" that are protected by the Gold SLA Domain, and cluster free space before and after migration.
+  This will return projected space consumption of migrating all old-format volume groups of "Server1" that are protected by the Gold SLA Domain, and cluster free space before and after migration.
 
-      .EXAMPLE
-      Get-RubrikVgfClusterStorage -Relic
+  .EXAMPLE
+  Get-RubrikVgfClusterStorage -Relic
 
-      This will return projected space consumption of migrating all old-format, removed volume groups that were formerly protected by Rubrik, and cluster free space before and after migration.
+  This will return projected space consumption of migrating all old-format, removed volume groups that were formerly protected by Rubrik, and cluster free space before and after migration.
 
-      .EXAMPLE
-      Get-RubrikVgfClusterStorage -FailedLastSnapshot
+  .EXAMPLE
+  Get-RubrikVgfClusterStorage -FailedLastSnapshot
 
-      This will return projected space consumption of migrating all old-format volume groups that needs to be migrated to use fast VHDX format since they have failed the latest snapshot using the legacy backup format, and cluster free space before and after migration.
+  This will return projected space consumption of migrating all old-format volume groups that needs to be migrated to use fast VHDX format since they have failed the latest snapshot using the legacy backup format, and cluster free space before and after migration.
 
-      # UsedFastVhdx not a param
-      .EXAMPLE
-      Get-RubrikVgfClusterStorage -UsedFastVhdx false
-
-      This will return projected space consumption on volume groups that did not use fast VHDX format in the latest snapshot.
-
-      .EXAMPLE
-      Get-RubrikVgfClusterStorage -Id VolumeGroup:::205b0b65-b90c-48c5-9cab-66b95ed18c0f
-      
-      This will return projected space consumption for the specified VolumeGroup ID, and 0 if this Volume Group uses fast VHDX format (no need for migration).
-  #>
+  .EXAMPLE
+  Get-RubrikVgfClusterStorage -Id VolumeGroup:::205b0b65-b90c-48c5-9cab-66b95ed18c0f
+  
+  This will return projected space consumption for the specified VolumeGroup ID, and 0 if this Volume Group uses fast VHDX format (no need for migration).
+#>
 
   [CmdletBinding()]
   Param(

Rubrik/Public/Start-RubrikManagedVolumeSnapshot.ps1

@@ -18,7 +18,7 @@ function Start-RubrikManagedVolumeSnapshot
       https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/start-rubrikmanagedvolumesnapshot
 
       .EXAMPLE
-      Start-ManagedVolumeSnapshot -id ManagedVolume:::f68ecd45-bdb9-46dd-aea4-8f041fb2dec2
+      Start-RubrikManagedVolumeSnapshot -id ManagedVolume:::f68ecd45-bdb9-46dd-aea4-8f041fb2dec2
 
       Open the specified managed volume for read/write operations
 

Rubrik/Rubrik.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: Jaap Brasser
 #
-# Generated on: 2021/01/05
+# Generated on: 2021/07/06
 #
 
 @{
@@ -362,7 +362,7 @@
 
             # Prerelease string of this module
 
-            Prerelease = 'RC3'
+            # Prerelease = ''
 
             # Flag to indicate whether the module requires explicit user acceptance for install/update
             # RequireLicenseAcceptance = $false