More reordering/cleanup

src/Connection/Connect-To.ps1

@@ -10,7 +10,7 @@ function Connect-To {
         Specify the host, for which you would like to change the credentials.
 
     .PARAMETER Identifier
-        Defaults to "". Specify a string, which separates two CredentialStoreItems for the
+        Defaults to ''. Specify a string, which separates two CredentialStoreItems for the
         same hostname.
 
     .PARAMETER Type
@@ -18,13 +18,13 @@ function Connect-To {
 
         - CiscoUcs
         - CiscoUcsCentral
-        - CisServer
         - ExchangeHTTP
         - ExchangeHTTPS
         - FTP
         - NetAppFAS
         - SCP
         - VMware
+        - VMwareCisServer
 
     .PARAMETER Credentials
         Use this parameter to bypass the stored credentials. Without this parameter Connect-To tries to read the
@@ -48,79 +48,81 @@ function Connect-To {
         [None]
 
     .EXAMPLE
-        Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs
+        Connect-To -RemoteHost 'ucs.myside.local' -Type CiscoUcs
 
     .EXAMPLE
-       Connect-To -RemoteHost "ucscentral.myside.local" -Type 'CiscoUcsCentral'
+       Connect-To -RemoteHost 'ucscentral.myside.local' -Type 'CiscoUcsCentral'
 
     .EXAMPLE
-        Connect-To -RemoteHost "ftp.myside.local" -Type FTP
+        Connect-To -RemoteHost 'ftp.myside.local' -Type FTP
 
     .EXAMPLE
-        Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS
+        Connect-To -RemoteHost 'fas.myside.local' -Type NetAppFAS
 
     .EXAMPLE
-        Connect-To -RemoteHost "esx01.myside.local" -Type VMware
+        Connect-To -RemoteHost 'esx01.myside.local' -Type VMware
 
     .EXAMPLE
-        Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer
+        Connect-To -RemoteHost 'vCenter.myside.local' -Type CisServer
 
     .EXAMPLE
-        Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
+        Connect-To -RemoteHost 'exchange01.myside.local' -Type ExchangeHTTP
 
     .EXAMPLE
-        Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
+        Connect-To -RemoteHost 'exchange01.myside.local' -Type ExchangeHTTPS
     #>
 
     [CmdletBinding(DefaultParameterSetName = 'Private')]
+
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
         'PSAvoidGlobalVars',
         '',
         Justification = 'Wrapping existing var from WinSCP module.'
     )]
+
     param (
         [Parameter(Mandatory = $true, ParameterSetName = 'Shared')]
         [Parameter(Mandatory = $true, ParameterSetName = 'Private')]
-        [string]$RemoteHost,
+        [string] $RemoteHost,
 
         [Parameter(Mandatory = $false, ParameterSetName = 'Shared')]
         [Parameter(Mandatory = $false, ParameterSetName = 'Private')]
-        [string]$Identifier,
+        [string] $Identifier,
 
         [Parameter(Mandatory = $true, ParameterSetName = 'Shared')]
         [Parameter(Mandatory = $true, ParameterSetName = 'Private')]
         [ValidateSet(
             'CiscoUcs',
             'CiscoUcsCentral',
-            'FTP',
-            'NetAppFAS',
-            'VMware',
-            'CisServer',
             'ExchangeHTTP',
             'ExchangeHTTPS',
-            'SCP'
+            'FTP',
+            'NetAppFAS',
+            'SCP',
+            'VMware',
+            'VMwareCisServer'
         )]
-        [string]$Type,
+        [string] $Type,
 
         [Parameter(Mandatory = $False, ParameterSetName = 'Shared')]
         [Parameter(Mandatory = $False, ParameterSetName = 'Private')]
-        [PSCredential]$Credentials,
+        [PSCredential] $Credentials,
 
         [Parameter(Mandatory = $true, ParameterSetNAme = 'Shared')]
-        [switch]$Shared,
+        [switch] $Shared,
 
         [Parameter(Mandatory = $False, ParameterSetName = 'Shared')]
         [ValidateNotNullOrEmpty()]
-        [string]$Path,
+        [string] $Path,
 
         [Parameter(Mandatory = $False, ParameterSetName = 'Private')]
         [Parameter(Mandatory = $False, ParameterSetName = 'Shared')]
-        [switch]$PassThru
+        [switch] $PassThru
     )
 
     begin {
         # Set the CredentialStore for private, shared or custom mode.
-        Write-Debug ("ParameterSetName: {0}" -f $PSCmdlet.ParameterSetName)
+        Write-Debug ('ParameterSetName: {0}' -f $PSCmdlet.ParameterSetName)
         if ($PSCmdlet.ParameterSetName -eq 'Private') {
             $Path = Get-DefaultCredentialStorePath
         }
@@ -131,7 +133,7 @@ function Connect-To {
         }
 
         switch ($Type) {
-            "VMware" {
+            'VMware' {
                 # Disable the yellow certificate warning, since we haven't replaced the SSL certs for vCenter/ESXi
                 $null = Set-PowerCLIConfiguration -Scope Session -InvalidCertificateAction Ignore -Confirm:$false
 
@@ -139,6 +141,11 @@ function Connect-To {
                 $null = Set-PowerCLIConfiguration -Scope Session -ProxyPolicy NoProxy -Confirm:$false
             }
         }
+
+        # Set sane defaults for Progress, ErrorAction and InformationPreference
+        $ProgressPreference = 'SilentlyContinue'
+        $ErrorActionPreference = 'Stop'
+        $InformationPreference = 'Continue'
     }
 
     process {
@@ -149,8 +156,8 @@ function Connect-To {
             # Check if $Identifier has been defined, in which case we need to use different name for
             # the lookup of the CredentialStoreItem.
             try {
-                if ($Identifier -ne "") {
-                    $RemoteHostIdentifier = "{0}/{1}" -f $Identifier, $RemoteHost
+                if ($Identifier -ne '') {
+                    $RemoteHostIdentifier = '{0}/{1}' -f $Identifier, $RemoteHost
                     $creds = Get-CredentialStoreItem -Shared -RemoteHost $RemoteHostIdentifier -Path $Path
                 }
                 else {
@@ -161,8 +168,8 @@ function Connect-To {
             catch {
                 $MessageParams = @{
                     Message     = (
-                        "Unable to look up credential store item for RemoteHost " +
-                        ("{0}/Identifier {1}!" -f $RemoteHost, $Identifier)
+                        'Unable to look up credential store item for RemoteHost ' +
+                        ('{0}/Identifier {1}!' -f $RemoteHost, $Identifier)
                     )
                     ErrorAction = 'Stop'
                 }
@@ -173,44 +180,66 @@ function Connect-To {
             $creds = $Credentials
         }
 
-        if ($creds.UserName -eq "" -or $creds.Password.GetType().Name -ne 'SecureString') {
+        if ($creds.UserName -eq '' -or $creds.Password.GetType().Name -ne 'SecureString') {
             $MessageParams = @{
-                Message     = "Please provide valid credentials for RemoteHost {0}!" -f $RemoteHost
+                Message     = 'Please provide valid credentials for RemoteHost {0}!' -f $RemoteHost
                 ErrorAction = 'Stop'
             }
             Write-Error @MessageParams
         }
         else {
             switch ($Type) {
-                "CiscoUcs" {
+                'CiscoUcs' {
                     try {
-                        $handle = Connect-Ucs -Name $RemoteHost -Credential $creds -ErrorAction 'Stop' -NotDefault
+                        $handle = Connect-Ucs -Name $RemoteHost -Credential $creds -NotDefault
                         $ExecutionContext.SessionState.PSVariable.Set('DefaultUcs', $handle)
                     }
 
                     catch {
-                        $MessageParams = @{
-                            Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
-                            ErrorAction = 'Stop'
-                        }
-                        Write-Error @MessageParams
+                        Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
                     }
                 }
-                "CiscoUcsCentral" {
+                'CiscoUcsCentral' {
                     try {
                         $handle = Connect-UcsCentral -Name $RemoteHost -Credential $creds -NotDefault
                         $ExecutionContext.SessionState.PSVariable.Set('DefaultUcsCentral', $handle)
                     }
 
                     catch {
-                        $MessageParams = @{
-                            Message     = ('Unable to connect to {0} using {1}' -f $RemoteHost, $Type)
-                            ErrorAction = 'Stop'
-                        }
-                        Write-Error @MessageParams
+                        Write-Error -Message ('Unable to connect to {0} using {1}' -f $RemoteHost, $Type)
                     }
                 }
-                "FTP" {
+                'ExchangeHTTP' {
+                    try {
+                        $ConnectionParams = @{
+                            ConnectionURI     = 'http://{0}/powershell' -f $RemoteHost
+                            ConfigurationName = 'Microsoft.Exchange'
+                            Credential        = $creds
+                        }
+                        $global:PSExchangeRemote = New-PSSession @ConnectionParams
+                        # ScriptAnalyzer issue (unused var) workaround.
+                        $null = $global:PSExchangeRemote
+                    }
+                    catch {
+                        # Write a error message to the log.
+                        Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
+                    }
+                }
+                'ExchangeHTTPS' {
+                    try {
+                        $ConnectionParams = @{
+                            ConnectionURI     = 'https://{0}/powershell' -f $RemoteHost
+                            ConfigurationName = 'Microsoft.Exchange'
+                            Credential        = $creds
+                        }
+                        $global:PSExchangeRemote = New-PSSession @ConnectionParams
+                    }
+                    catch {
+                        # Write a error message to the log.
+                        Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
+                    }
+                }
+                'FTP' {
                     # First establish the FTP session
                     $WinSCPConParams = @{
                         Credential = $creds
@@ -220,113 +249,48 @@ function Connect-To {
                     }
                     try {
                         $FTPSessionOption = New-WinSCPSessionOption @WinSCPConParams
-                        $Global:WinSCPSession = New-WinSCPSession -SessionOption $FTPSessionOption
+                        $global:WinSCPSession = New-WinSCPSession -SessionOption $FTPSessionOption
                     }
                     catch {
-                        throw "Could not connect to {0} using {1} protocol!" -f $RemoteHost, $Type
+                        Write-Error -Message ('Could not connect to {0} using {1} protocol!' -f $RemoteHost, $Type)
                     }
+
                     # Check the Connection State
-                    if (!($WinSCPSession.Opened)) {
+                    if (-not $WinSCPSession.Opened) {
                         # Check the connection state and find out if the session is still open.
-                        $MessageParams = @{
-                            Message     = (
-                                ("Connection to {0} using Type {1} " -f $RemoteHost, $Type) +
-                                "was established. But now it seems to be lost!"
-                            )
-                            ErrorAction = 'Stop'
-                        }
-                        Write-Error @MessageParams
+                        $m = 'Connection to {0} using Type {1} was established. ' -f $RemoteHost, $Type
+                        $m += 'But now it seems to be lost!'
+                        Write-Error -Message $m
                     }
                 }
-                "NetAppFAS" {
+                'NetAppFAS' {
+                    # Construct the splatting for Connect-NcController
+                    $params = @{
+                        Name       = $RemoteHost
+                        Credential = $creds
+                        HTTPS      = $true
+                    }
+
+                    # Check if -PassThru was passed. If so, a) do not set the default variable and b) return the
+                    # session object to the caller.
+                    if ($PSBoundParameters.ContainsKey('PassThru')) {
+                        $params.Add('Transient', $true)
+                    }
+
                     try {
-                        $null = Connect-NcController -Name $RemoteHost -Credential $creds -ErrorAction Stop -HTTPS
+                        $handle = Connect-NcController @params
                     }
 
                     catch {
                         # Write a error message to the log.
-                        $MessageParams = @{
-                            Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
-                            ErrorAction = 'Stop'
-                        }
-                        Write-Error @MessageParams
-                    }
-                }
-                "VMware" {
-                    try {
-                        Connect-VIServer -Server $RemoteHost -Credential $creds -ErrorAction Stop | Out-Null
+                        Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
                     }
 
-                    catch {
-                        # Write a error message to the log.
-                        $MessageParams = @{
-                            Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
-                            ErrorAction = 'Stop'
-                        }
-                        Write-Error @MessageParams
+                    if ($PSBoundParameters.ContainsKey('PassThru')) {
+                        return $handle
                     }
                 }
-                "CisServer" {
-                    try {
-                        if ($PassThru.IsPresent) {
-                            Connect-CisServer -Server $RemoteHost -Credential $creds -ErrorAction Stop
-                        }
-                        else {
-                            Connect-CisServer -Server $RemoteHost -Credential $creds -ErrorAction Stop | Out-Null
-                        }
-
-                    }
-
-                    catch {
-                        # Write a error message to the log.
-                        $MessageParams = @{
-                            Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
-                            ErrorAction = 'Stop'
-                        }
-                        Write-Error @MessageParams
-                    }
-                }
-                "ExchangeHTTP" {
-                    try {
-                        $ConnectionParams = @{
-                            ConnectionURI     = "http://{0}/powershell" -f $RemoteHost
-                            ConfigurationName = 'Microsoft.Exchange'
-                            Credential        = $creds
-                            ErrorAction       = 'Stop'
-                        }
-                        $Global:PSExchangeRemote = New-PSSession @ConnectionParams
-                        # ScriptAnalyzer issue (unused var) workaround.
-                        $null = $Global:PSExchangeRemote
-                    }
-                    catch {
-                        # Write a error message to the log.
-                        $MessageParams = @{
-                            Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
-                            ErrorAction = 'Stop'
-                        }
-                        Write-Error @MessageParams
-                    }
-                }
-                "ExchangeHTTPS" {
-                    try {
-                        $ConnectionParams = @{
-                            ConnectionURI     = "https://{0}/powershell" -f $RemoteHost
-                            ConfigurationName = 'Microsoft.Exchange'
-                            Credential        = $creds
-                            ErrorAction       = 'Stop'
-                        }
-                        $Global:PSExchangeRemote = New-PSSession @ConnectionParams
-                    }
-                    catch {
-                        # Write a error message to the log.
-                        $MessageParams = @{
-                            Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
-                            ErrorAction = 'Stop'
-                        }
-                        Write-Error @MessageParams
-                    }
-                }
-                "SCP" {
+                'SCP' {
                     $WinSCPSessionParams = @{
                         Credential                           = $creds
                         Hostname                             = $RemoteHost
@@ -335,39 +299,51 @@ function Connect-To {
                     }
                     try {
                         $SessionOption = New-WinSCPSessionOption @WinSCPSessionParams
-                        $Global:WinSCPSession = New-WinSCPSession -SessionOption $SessionOption
+                        $global:WinSCPSession = New-WinSCPSession -SessionOption $SessionOption
                         Write-Verbose -Message (
-                            "SCP Connection established with {0}" -f $Global:WinSCPSession.Hostname
+                            'SCP Connection established with {0}' -f $global:WinSCPSession.Hostname
                         )
                     }
                     catch {
                         # Write a error message to the log.
-                        $MessageParams = @{
-                            Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
-                            ErrorAction = 'Stop'
-                        }
-                        Write-Error @MessageParams
+                        Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
                     }
                     # Check the Connection State
                     if (!($WinSCPSession.Opened)) {
                         # Check the connection state and find out if the session is still open.
-                        $MessageParams = @{
-                            Message     = (
-                                ("Connection to {0} using Type {1} was established. " -f $RemoteHost, $Type) +
-                                "But now it seems to be lost!"
-                            )
-                            ErrorAction = 'Stop'
+                        $m = 'Connection to {0} using Type {1} was established. ' -f $RemoteHost, $Type
+                        $m += 'But now it seems to be lost!'
+                        Write-Error -Message $m
+                    }
+                }
+                'VMware' {
+                    try {
+                        Connect-VIServer -Server $RemoteHost -Credential $creds -ErrorAction Stop | Out-Null
+                    }
+
+                    catch {
+                        # Write a error message to the log.
+                        Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
+                    }
+                }
+                'VMwareCisServer' {
+                    try {
+                        if ($PassThru.IsPresent) {
+                            Connect-CisServer -Server $RemoteHost -Credential $creds
                         }
-                        Write-Error @MessageParams
+                        else {
+                            $null = Connect-CisServer -Server $RemoteHost -Credential $creds
+                        }
+                    }
+
+                    catch {
+                        # Write a error message to the log.
+                        Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
                     }
                 }
                 default {
                     # Write a error message to the log.
-                    $MessageParams = @{
-                        Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
-                        ErrorAction = 'Stop'
-                    }
-                    Write-Error @MessageParams
+                    Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
                 }
             }
         }