Updated Tutorial and fixed a few bugs

Author: ffeldhaus

README.md

@@ -30,7 +30,8 @@ Show help for Cmdlet to connect to StorageGRID Management Server
 Connect to StorageGRID Management Server (use the `-Insecure` switch to skip checking the certificate of the server)
 
     $Credential = Get-Credential
-    Connect-SGWMgmtServer -Name myserver.mydomain.tld -Credential $Credential -Insecure
+	$Server = "nms.mydomain.tld"
+    Connect-SGWServer -Name $Server -Credential $Credential -Insecure
 
 List all StorageGRID-Webscale Accounts
 

S3-Mgmt-Tutorial.md StorageGRID-Webscale-Tutorial.mdS3-Mgmt-Tutorial.md renamed to StorageGRID-Webscale-Tutorial.md

@@ -1,39 +1,39 @@
-# StorageGRID S3 Management PowerShell Cmdlet Tutorial
+# StorageGRID Webscale PowerShell Cmdlet Tutorial
 
-This tutorial will give an introduction to the StorageGRID S3 Management PowerShell Cmdlets
+This tutorial will give an introduction to the StorageGRID Webscale PowerShell Cmdlets
 
 ## Discovering the available Cmdlets
 
-Load the S3-Mgmt Module
+Load the StorageGRID-Webscale Module
 
 ```powershell
-Import-Module S3-Mgmt
+Import-Module StorageGRID-Webscale
 ```
 
-Show all available Cmdlets from the S3-Mgmt Module
+Show all available Cmdlets from the StorageGRID-Webscale Module
 
 ```powershell
-Get-Command -Module S3-Mgmt
+Get-Command -Module StorageGRID-Webscale
 ```
 
-Show the syntax of all Cmdlets from the S3-Mgmt Module
+Show the syntax of all Cmdlets from the StorageGRID-Webscale Module
 
 ```powershell
-Get-Command -Module S3-Mgmt
+Get-Command -Module StorageGRID-Webscale -Syntax
 ```
 
-To get detailed help including examples for a specific Cmdlet (e.g. for Connect-S3MgmtServer) run
+To get detailed help including examples for a specific Cmdlet (e.g. for Connect-SGWServer) run
 
 ```powershell
-Get-Help Connect-S3MgmtServer -Detailed
+Get-Help Connect-SGWServer -Detailed
 ```
 
 ## Connecting to a StorageGRID Management Server
 
-For data retrieval a connection to the StorageGRID Management Server is required. The Connect-S3MgmtServer Cmdlet expects the hostname or IP and the credentials for authentication
+For data retrieval a connection to the StorageGRID Management Server is required. The Connect-SGWServer Cmdlet expects the hostname or IP and the credentials for authentication
 
 ```powershell
-$ServerName = 'nms.stroagegrid.example.com'
+$Server = "nms.mydomain.tld"
 $Credential = Get-Credential
 Connect-S3MgmtServer -Name $ServerName -Credential $Credential
 ```

src/StorageGRID-Webscale.psm1

@@ -41,13 +41,6 @@ function global:Connect-SGWServer {
                    HelpMessage="Specify -Transient to not set the global variable `$CurrentOciServer.")][Switch]$Transient
     )
 
-    $body = @"
-{
-    "username": "$($Credential.UserName)", 
-    "password": "$($Credential.GetNetworkCredential().Password)"
-}
-"@
-
     # check if untrusted SSL certificates should be ignored
     if ($Insecure) {
         [System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy
@@ -66,58 +59,88 @@ function global:Connect-SGWServer {
     $Server = New-Object -TypeName PSCustomObject
     $Server | Add-Member -MemberType NoteProperty -Name Name -Value $Name
     $Server | Add-Member -MemberType NoteProperty -Name Credential -Value $Credential
+
+    $Body = @"
+{
+    "username": "$($Credential.UserName)", 
+    "password": "$($Credential.GetNetworkCredential().Password)"
+}
+"@
 
     if ($HTTPS -or !$HTTP) {
         Try {
             $Server | Add-Member -MemberType NoteProperty -Name BaseURI -Value "https://$Name"
-            $Response = Invoke-RestMethod -Method POST -Uri "$BaseURI/api/v1/authorize" -TimeoutSec 10 -ContentType "application/json" -Body $body
+            $Response = Invoke-RestMethod -Method POST -Uri "$($Server.BaseURI)/api/v1/authorize" -TimeoutSec 10 -ContentType "application/json" -Body $body
             if ($Response.status -eq "success") {
                 $Server | Add-Member -MemberType NoteProperty -Name APIVersion -Value $Response.apiVersion
                 $Server | Add-Member -MemberType NoteProperty -Name Headers -Value @{"Authorization"="Bearer $($Response.data)"}
             }
+            if (!$Transient) {
+                Set-Variable -Name CurrentSGWServer -Value $Server -Scope Global
+            }
+ 
+            return $Server
         }
         Catch {
             if ($_.Exception.Message -match "Unauthorized") {
-                Write-Error "Authorization for $BaseURI/api/v1/authorize with user $($Credential.UserName) failed"
+                Write-Error "Authorization for $($Server.BaseURI)/api/v1/authorize with user $($Credential.UserName) failed"
                 return
             }
             else {
                 if ($HTTPS) {
-                    Write-Error "Login to $BaseURI/api/v1/authorize failed via HTTPS protocol, but HTTPS was enforced"
+                    $result = $_.Exception.Response.GetResponseStream()
+                    $reader = New-Object System.IO.StreamReader($result)
+                    $reader.BaseStream.Position = 0
+                    $reader.DiscardBufferedData()
+                    $responseBody = $reader.ReadToEnd()
+                    if ($responseBody.StartsWith('{')) {
+                        $responseBody = $responseBody | ConvertFrom-Json | ConvertTo-Json
+                    }
+                    Write-Error "GET to $Uri failed with status code $($_.Exception.Response.StatusCode) and response body:`n$responseBody"
                     return
                 }
                 else {
+                    Write-Warning "Login to $BaseURI/api/v1/authorize failed via HTTPS protocol"
                     $HTTP = $True
                 }
             }
         }
     }
-    else {
+
+    if ($HTTP) {
         Try {
-            $Server | Add-Member -MemberType NoteProperty -Name BaseURI -Value "http://$Name"
-            $Response = Invoke-RestMethod -Method POST -Uri "$BaseURI/api/v1/authorize" -TimeoutSec 10 -ContentType "application/json" -Body $body
+            $Server | Add-Member -MemberType NoteProperty -Name BaseURI -Value "http://$Name" -Force
+            $Response = Invoke-RestMethod -Method POST -Uri "$($Server.BaseURI)/api/v1/authorize" -TimeoutSec 10 -ContentType "application/json" -Body $Body
             if ($Response.status -eq "success") {
                 $Server | Add-Member -MemberType NoteProperty -Name APIVersion -Value $Response.apiVersion
                 $Server | Add-Member -MemberType NoteProperty -Name Headers -Value @{"Authorization"="Bearer $($Response.data)"}
             }
+            
+            if (!$Transient) {
+                Set-Variable -Name CurrentSGWServer -Value $Server -Scope Global
+            }
+ 
+            return $Server
         }
         Catch {
             if ($_.Exception.Message -match "Unauthorized") {
-                Write-Error "Authorization for $BaseURI/api/v1/authorize with user $($Credential.UserName) failed"
+                Write-Error "Authorization for $($Server.BaseURI)/api/v1/authorize with user $($Credential.UserName) failed"
                 return
             }
             else {
-                Write-Error "Login to $BaseURI/api/v1/authorize failed via HTTP protocol, but HTTP was enforced"
+                $result = $_.Exception.Response.GetResponseStream()
+                $reader = New-Object System.IO.StreamReader($result)
+                $reader.BaseStream.Position = 0
+                $reader.DiscardBufferedData()
+                $responseBody = $reader.ReadToEnd()
+                if ($responseBody.StartsWith('{')) {
+                    $responseBody = $responseBody | ConvertFrom-Json | ConvertTo-Json
+                }
+                Write-Error "GET to $Uri failed with status code $($_.Exception.Response.StatusCode) and response body:`n$responseBody"
                 return
             }
         }
     }
- 
-    if (!$Transient) {
-        Set-Variable -Name CurrentSGWServer -Value $Server -Scope Global
-    }
- 
-    return $Server
 }
 
 <#
@@ -1059,7 +1082,7 @@ function Global:Update-SGWIdentitySources {
         [parameter(
             Mandatory=$False,
             Position=3,
-            HelpMessage="Identity Source Port")][Integer]$Port,
+            HelpMessage="Identity Source Port")][Int]$Port,
         [parameter(
             Mandatory=$False,
             Position=4,