Add the PSD export for Find-CredentialStoreItem

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,14 +18,13 @@ function Connect-To {
 
         - CiscoUcs
         - CiscoUcsCentral
+        - CisServer
         - ExchangeHTTP
         - ExchangeHTTPS
         - FTP
         - NetAppFAS
-        - NetAppStorageGRID
         - SCP
         - VMware
-        - VMwareCisServer
 
     .PARAMETER Credentials
         Use this parameter to bypass the stored credentials. Without this parameter Connect-To tries to read the
@@ -49,42 +48,36 @@ function Connect-To {
         [None]
 
     .EXAMPLE
-        Connect-To -RemoteHost 'vc.domain.local' -Type CisServer
+        Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs
 
     .EXAMPLE
-        Connect-To -RemoteHost 'ucs.domain.local' -Type CiscoUcs
+       Connect-To -RemoteHost "ucscentral.myside.local" -Type 'CiscoUcsCentral'
 
     .EXAMPLE
-        Connect-To -RemoteHost 'ucs-central.domain.local' -Type 'CiscoUcsCentral'
+        Connect-To -RemoteHost "ftp.myside.local" -Type FTP
 
     .EXAMPLE
-        Connect-To -RemoteHost 'exchange01.domain.local' -Type ExchangeHTTP
+        Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS
 
     .EXAMPLE
-        Connect-To -RemoteHost 'exchange01.domain.local' -Type ExchangeHTTPS
+        Connect-To -RemoteHost "esx01.myside.local" -Type VMware
 
     .EXAMPLE
-        Connect-To -RemoteHost 'ftp.domain.local' -Type FTP
+        Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer
 
     .EXAMPLE
-        Connect-To -RemoteHost 'fas.domain.local' -Type NetAppFAS
+        Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
 
     .EXAMPLE
-        Connect-To -RemoteHost 'grid.domain.local' -Type NetAppStorageGRID
+        Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
-
-    .EXAMPLE
-        Connect-To -RemoteHost 'esx01.domain.local' -Type VMware
-
     #>
 
     [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')]
@@ -99,14 +92,13 @@ function Connect-To {
         [ValidateSet(
             'CiscoUcs',
             'CiscoUcsCentral',
-            'ExchangeHTTP',
-            'ExchangeHTTPS',
             'FTP',
             'NetAppFAS',
-            'NetAppStorageGRID',
-            'SCP',
             'VMware',
-            'VMwareCisServer'
+            'CisServer',
+            'ExchangeHTTP',
+            'ExchangeHTTPS',
+            'SCP'
         )]
         [string]$Type,
 
@@ -128,7 +120,7 @@ function Connect-To {
 
     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
         }
@@ -139,7 +131,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
 
@@ -147,11 +139,6 @@ 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 {
@@ -162,8 +149,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 '') {
+                if ($Identifier -ne "") {
-                    $RemoteHostIdentifier = '{0}/{1}' -f $Identifier, $RemoteHost
+                    $RemoteHostIdentifier = "{0}/{1}" -f $Identifier, $RemoteHost
                     $creds = Get-CredentialStoreItem -Shared -RemoteHost $RemoteHostIdentifier -Path $Path
                 }
                 else {
@@ -174,8 +161,8 @@ function Connect-To {
             catch {
                 $MessageParams = @{
                     Message     = (
-                        'Unable to look up credential store item for RemoteHost ' +
+                        "Unable to look up credential store item for RemoteHost " +
-                        ('{0}/Identifier {1}!' -f $RemoteHost, $Identifier)
+                        ("{0}/Identifier {1}!" -f $RemoteHost, $Identifier)
                     )
                     ErrorAction = 'Stop'
                 }
@@ -186,70 +173,44 @@ 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 -NotDefault
+                        $handle = Connect-Ucs -Name $RemoteHost -Credential $creds -ErrorAction 'Stop' -NotDefault
                         $ExecutionContext.SessionState.PSVariable.Set('DefaultUcs', $handle)
                     }
 
                     catch {
-                        Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
+                        $MessageParams = @{
+                            Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
+                            ErrorAction = 'Stop'
+                        }
+                        Write-Error @MessageParams
                     }
                 }
-
+                "CiscoUcsCentral" {
-                'CiscoUcsCentral' {
                     try {
                         $handle = Connect-UcsCentral -Name $RemoteHost -Credential $creds -NotDefault
                         $ExecutionContext.SessionState.PSVariable.Set('DefaultUcsCentral', $handle)
                     }
 
                     catch {
-                        Write-Error -Message ('Unable to connect to {0} using {1}' -f $RemoteHost, $Type)
+                        $MessageParams = @{
+                            Message     = ('Unable to connect to {0} using {1}' -f $RemoteHost, $Type)
+                            ErrorAction = 'Stop'
+                        }
+                        Write-Error @MessageParams
                     }
                 }
-
+                "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
@@ -257,81 +218,115 @@ function Connect-To {
                         Protocol   = 'Ftp'
                         FtpMode    = 'Passive'
                     }
-
                     try {
                         $FTPSessionOption = New-WinSCPSessionOption @WinSCPConParams
-                        $global:WinSCPSession = New-WinSCPSession -SessionOption $FTPSessionOption
+                        $Global:WinSCPSession = New-WinSCPSession -SessionOption $FTPSessionOption
                     }
                     catch {
-                        Write-Error -Message ('Could not connect to {0} using {1} protocol!' -f $RemoteHost, $Type)
+                        throw "Could not connect to {0} using {1} protocol!" -f $RemoteHost, $Type
                     }
-
                     # Check the Connection State
-                    if (-not $WinSCPSession.Opened) {
+                    if (!($WinSCPSession.Opened)) {
                         # Check the connection state and find out if the session is still open.
-                        $m = 'Connection to {0} using Type {1} was established. ' -f $RemoteHost, $Type
+                        $MessageParams = @{
-                        $m += 'But now it seems to be lost!'
+                            Message     = (
-                        Write-Error -Message $m
+                                ("Connection to {0} using Type {1} " -f $RemoteHost, $Type) +
+                                "was established. But now it seems to be lost!"
+                            )
+                            ErrorAction = 'Stop'
+                        }
+                        Write-Error @MessageParams
                     }
                 }
-
+                "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 {
-                        $handle = Connect-NcController @params
+                        $null = Connect-NcController -Name $RemoteHost -Credential $creds -ErrorAction Stop -HTTPS
                     }
 
                     catch {
                         # Write a error message to the log.
-                        Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
+                        $MessageParams = @{
+                            Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
+                            ErrorAction = 'Stop'
                         }
-
+                        Write-Error @MessageParams
-                    if ($PSBoundParameters.ContainsKey('PassThru')) {
-                        return $handle
                     }
                 }
-
+                "VMware" {
-                'NetAppStorageGRID' {
-                    # Construct the splatting for Connect-SgwServer
-                    $params = @{
-                        Name                 = $RemoteHost
-                        Credential           = $creds
-                        SkipCertificateCheck = $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 {
-                        $SgwSession = Connect-SgwServer @params
+                        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)
+                        $MessageParams = @{
+                            Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
+                            ErrorAction = 'Stop'
+                        }
+                        Write-Error @MessageParams
+                    }
+                }
+                "CisServer" {
+                    try {
+                        if ($PassThru.IsPresent) {
+                            Connect-CisServer -Server $RemoteHost -Credential $creds -ErrorAction Stop
+                        }
+                        else {
+                            Connect-CisServer -Server $RemoteHost -Credential $creds -ErrorAction Stop | Out-Null
                         }
 
-                    if ($PSBoundParameters.ContainsKey('PassThru')) {
-                        return $SgwSession
-                    }
                     }
 
-                'SCP' {
+                    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" {
                     $WinSCPSessionParams = @{
                         Credential                           = $creds
                         Hostname                             = $RemoteHost
@@ -340,49 +335,39 @@ 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.
-                        Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
+                        $MessageParams = @{
+                            Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
+                            ErrorAction = 'Stop'
+                        }
+                        Write-Error @MessageParams
                     }
                     # Check the Connection State
                     if (!($WinSCPSession.Opened)) {
                         # Check the connection state and find out if the session is still open.
-                        $m = 'Connection to {0} using Type {1} was established. ' -f $RemoteHost, $Type
+                        $MessageParams = @{
-                        $m += 'But now it seems to be lost!'
+                            Message     = (
-                        Write-Error -Message $m
+                                ("Connection to {0} using Type {1} was established. " -f $RemoteHost, $Type) +
+                                "But now it seems to be lost!"
+                            )
+                            ErrorAction = 'Stop'
+                        }
+                        Write-Error @MessageParams
                     }
                 }
-
+                default {
-                '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)
+                    $MessageParams = @{
-                    }
+                        Message     = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
-                }
+                        ErrorAction = 'Stop'
-
-                'VMwareCisServer' {
-                    try {
-                        if ($PassThru.IsPresent) {
-                            Connect-CisServer -Server $RemoteHost -Credential $creds
-                        }
-                        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)
                     }
+                    Write-Error @MessageParams
                 }
             }
         }

src/Connection/Disconnect-From.ps1

@@ -1,26 +1,30 @@
 function Disconnect-From {
     <#
     .SYNOPSIS
-        Terminates a session established with Connect-To.
+        Terminates a session established with Connect-To using a CredentialStoreItem.
 
     .DESCRIPTION
-        Terminates a session established with Connect-To.
+        Terminates a session established with Connect-To using a CredentialStoreItem.
 
     .PARAMETER RemoteHost
         Specify the remote endpoint, whose session you would like to terminate.
 
+    .PARAMETER Identifier
+        Defaults to "". Specify a string, which separates two CredentialStoreItems for the
+        same hostname.
+
     .PARAMETER Type
         Specify the host type of the target. Currently implemented targets are:
+
         - CiscoUcs
         - CiscoUcsCentral
-        - ExchangeHTTP
-        - ExchangeHTTPS
         - FTP
         - NetAppFAS
-        - NetAppStorageGRID
-        - SCP
         - VMware
-        - VMwareCisServer
+        - CisServer
+        - ExchangeHTTP
+        - ExchangeHTTPS
+        - SCP
 
     .PARAMETER Force
         Force the disconnect, even if the disconnect would fail.
@@ -32,45 +36,36 @@ function Disconnect-From {
         [None]
 
     .EXAMPLE
-        Disconnect-From -RemoteHost 'vc.domain.local' -Type CisServer
+        Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs
 
     .EXAMPLE
-        Disconnect-From -RemoteHost 'ucs.domain.local' -Type CiscoUcs
+        Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP
 
     .EXAMPLE
-        Disconnect-From -RemoteHost 'ucs-central.domain.local' -Type 'CiscoUcsCentral'
+        Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS
 
     .EXAMPLE
-        Disconnect-From -RemoteHost 'exchange01.domain.local' -Type ExchangeHTTP
+        Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware
 
     .EXAMPLE
-        Disconnect-From -RemoteHost 'exchange01.domain.local' -Type ExchangeHTTPS
+        Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True
 
     .EXAMPLE
-        Disconnect-From -RemoteHost 'ftp.domain.local' -Type FTP
+        Disconnect-From -RemoteHost "vcenter.myside.local" -Type CisServer
 
     .EXAMPLE
-        Disconnect-From -RemoteHost 'fas.domain.local' -Type NetAppFAS
+        Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
 
     .EXAMPLE
-        Disconnect-From -RemoteHost 'grid.domain.local' -Type NetAppStorageGRID
+        Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
-
-    .EXAMPLE
-        Disconnect-From -RemoteHost 'esx01.domain.local' -Type VMware
-
-    .EXAMPLE
-        Disconnect-From -RemoteHost 'esx01.domain.local' -Type VMware -Force:$True
-
     #>
 
     [CmdletBinding()]
-
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
         'PSAvoidGlobalVars',
         '',
         Justification = 'Wrapping existing global vars from external modules'
     )]
-
     param (
         [Parameter(Mandatory = $true)]
         [string]$RemoteHost,
@@ -79,14 +74,13 @@ function Disconnect-From {
         [ValidateSet(
             'CiscoUcs',
             'CiscoUcsCentral',
-            'ExchangeHTTP',
-            'ExchangeHTTPS',
             'FTP',
             'NetAppFAS',
-            'NetAppStorageGRID',
-            'SCP',
             'VMware',
-            'VMwareCisServer'
+            'CisServer',
+            'ExchangeHTTP',
+            'ExchangeHTTPS',
+            'SCP'
         )]
         [string]$Type,
 
@@ -94,132 +88,145 @@ function Disconnect-From {
         [switch]$Force
     )
 
-    begin {
+    begin {}
-        # Set sane defaults for Progress, ErrorAction and InformationPreference
-        $ProgressPreference = 'SilentlyContinue'
-        $ErrorActionPreference = 'Stop'
-        $InformationPreference = 'Continue'
-    }
 
     process {
         switch -Regex ($Type) {
-            'CiscoUcs' {
+            "VMware" {
-                try {
-                    $null = Disconnect-Ucs -Ucs $RemoteHost
-                }
-
-                catch {
-                    # Write a error message to the log.
-                    Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
-                }
-            }
-
-            'CiscoUCSCentral' {
-                try {
-                    $null = Disconnect-UcsCentral -Name $RemoteHost
-                    $ExecutionContext.SessionState.PSVariable.Set('DefaultUcsCentral', $null)
-                }
-                catch {
-                    Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
-                }
-            }
-
-            'ExchangeHTTP*' {
-                try {
-                    Get-Variable -Name 'PSExchangeRemote' -Scope 'Global'
-                    Remove-PSSession -Session $global:PSExchangeRemote
-                }
-                catch {
-                    Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
-                }
-            }
-
-            # Check for an existing WinSCP Session var
-            'FTP' {
-                if ($global:WinSCPSession.Opened) {
-                    Remove-WinSCPSession -WinSCPSession $global:WinSCPSession
-                }
-                else {
-                    Write-Error -Message 'There is no open WinSCP Session'
-                }
-            }
-
-            # DataONTAP doesn't have a CmdLet `Disconnect-NcController`.
-            # So we go ahead and clear the CurrentNcController variable.
-            'NetAppFAS' {
-                try {
-                    $m = 'Setting {0} to $null, which will disconnect NetAppFAS' -f $global:CurrentNcController
-                    Write-Verbose -Message $m
-                    $global:CurrentNcController = $null
-                }
-
-                catch {
-                    # Write a error message to the log.
-                    Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
-                }
-            }
-
-            'NetAppSGWS' {
-                try {
-                    $null = Disconnect-SgwServer -Server $RemoteHost
-                    $null = Remove-Variable -Name CurrentSgwServer -Scope Global -ErrorAction 'SilentlyContinue'
-                }
-
-                catch {
-                    # Write a error message to the log.
-                    Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
-                }
-            }
-
-            'SCP' {
-                if ($global:WinSCPSession.Opened) {
-                    Remove-WinSCPSession -WinSCPSession $global:WinSCPSession
-                }
-                else {
-                    Write-Error -Message 'There is no open WinSCP Session'
-                }
-            }
-
-            'VMware' {
-                # Construct the splatting for Disconnect-VIServer
-                $params = @{
-                    Server  = $RemoteHost
-                    Confirm = $false
-                }
-
-                if ($PSBoundParameters.ContainsKey('Force')) {
-                    $params.Add('Force', $true)
-                }
-
-                try {
-                    $null = Disconnect-VIServer @params
-                }
-
-                catch {
-                    # Write a error message to the log.
-                    Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
-                }
-            }
-
-            'VMwareCisServer' {
                 try {
                     if ($Force) {
-                        $null = Disconnect-CisServer -Server $RemoteHost -Confirm:$false -Force:$true
+                        Disconnect-VIServer -Server $RemoteHost -Confirm:$false -ErrorAction 'Stop' -Force:$true
                     }
                     else {
-                        $null = Disconnect-CisServer -Server $RemoteHost -Confirm:$false
+                        Disconnect-VIServer -Server $RemoteHost -Confirm:$false -ErrorAction 'Stop'
                     }
                 }
 
                 catch {
                     # Write a error message to the log.
-                    Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
+                    $MessageParams = @{
+                        Message     = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
+                        ErrorAction = 'Stop'
+                    }
+                    Write-Error @MessageParams
+                }
+            }
+            "CisServer" {
+                try {
+                    if ($Force) {
+                        Disconnect-CisServer -Server $RemoteHost -Confirm:$false -ErrorAction 'Stop' -Force:$true
+                    }
+                    else {
+                        Disconnect-CisServer -Server $RemoteHost -Confirm:$false -ErrorAction 'Stop'
                     }
                 }
 
+                catch {
+                    # Write a error message to the log.
+                    $MessageParams = @{
+                        Message     = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
+                        ErrorAction = 'Stop'
+                    }
+                    Write-Error @MessageParams
+                }
+            }
+            # Check for an existing WinSCP Session var
+            "FTP" {
+                if ($Global:WinSCPSession.Opened) {
+                    Remove-WinSCPSession -WinSCPSession $Global:WinSCPSession
+                }
+                else {
+                    $MessageParams = @{
+                        Message     = 'There is no open WinSCP Session'
+                        ErrorAction = 'Stop'
+                    }
+                    Write-Error @MessageParams
+                }
+            }
+            # DataONTAP doesn't have a CmdLet `Disconnect-NcController`.
+            # So we go ahead and clear the CurrentNcController variable.
+            "NetAppFAS" {
+                try {
+                    $MessageParams = @{
+                        Message     = (
+                            "Setting {0} to `$null, which will disconnect NetAppFAS" -f $Global:CurrentNcController
+                        )
+                        ErrorAction = 'Continue'
+                    }
+                    Write-Verbose @MessageParams
+                    $Global:CurrentNcController = $null
+                }
+
+                catch {
+                    # Write a error message to the log.
+                    $MessageParams = @{
+                        Message     = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
+                        ErrorAction = 'Stop'
+                    }
+                    Write-Error @MessageParams
+                }
+
+            }
+            "CiscoUcs" {
+                try {
+                    Disconnect-Ucs -Ucs $RemoteHost
+                }
+
+                catch {
+                    # Write a error message to the log.
+                    $MessageParams = @{
+                        Message     = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
+                        ErrorAction = 'Stop'
+                    }
+                    Write-Error @MessageParams
+                }
+            }
+            "CiscoUCSCentral" {
+                try {
+                    $handle = Connect-UcsCentral -Name $RemoteHost -Credential $creds -NotDefault
+                    $ExecutionContext.SessionState.PSVariable.Set('DefaultUcsCentral', $handle)
+                }
+                catch {
+                    $MessageParams = @{
+                        Message     = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
+                        ErrorAction = 'Stop'
+                    }
+                    Write-Error @MessageParams
+                }
+            }
+
+            "ExchangeHTTP*" {
+                try {
+                    Get-Variable -Name 'PSExchangeRemote' -Scope 'Global' -ErrorAction 'Stop'
+                    Remove-PSSession -Session $Global:PSExchangeRemote -ErrorAction 'Stop'
+                }
+                catch {
+                    $MessageParams = @{
+                        Message     = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
+                        ErrorAction = 'Stop'
+                    }
+                    Write-Error @MessageParams
+                }
+            }
+            "SCP" {
+                if ($Global:WinSCPSession.Opened) {
+                    Remove-WinSCPSession -WinSCPSession $Global:WinSCPSession
+                }
+                else {
+                    $MessageParams = @{
+                        Message     = 'There is no open WinSCP Session'
+                        ErrorAction = 'Stop'
+                    }
+                    Write-Error @MessageParams
+                }
+            }
             default {
                 # Write a error message to the log.
-                Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
+                $MessageParams = @{
+                    Message     = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
+                    ErrorAction = 'Stop'
+                }
+                Write-Error @MessageParams
             }
         }
     }

src/Item/Find-CredentialStoreItem.Tests.ps1

@@ -0,0 +1,150 @@
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+    'PSAvoidUsingConvertToSecureStringWithPlainText',
+    '',
+    Justification = 'just used in pester tests.'
+)]
+param ()
+
+BeforeAll {
+    $Repo = Get-RepoPath
+    Import-Module $Repo.Src.Manifest.Item.FullName -Force
+
+    # Backup existing CredentialStores
+    $Paths = @(('{0}\AppData\Roaming' -f $env:USERPROFILE), ('{0}\ProgramData\PSCredentialStore\' -f $env:SystemDrive))
+    $Files = @('CredentialStore.json', 'PSCredentialStore.pfx')
+
+    foreach ($Filepath in $Paths) {
+        foreach ($File in $Files) {
+            $OrgPath = Join-Path -Path $FilePath -ChildPath $File
+            $NewPath = $OrgPath + '.orig'
+            if (Test-Path $OrgPath) {
+                try {
+                    $null = Remove-Item -Path $NewPath -Force -Confirm:$false
+                    $null = Rename-Item -Path $OrgPath -NewName $NewPath -Confirm:$false
+                }
+                catch {
+                    $_.Exception.Message | Write-Warning
+                    Write-Error -Message ('Unable to revert {0} to {1}' -f $OrgPath, $NewPath)
+                }
+            }
+        }
+    }
+
+    # Construct the necessary CredentialStores for the Unit tests.
+    New-CredentialStore -Force
+    New-CredentialStore -Shared -Force
+
+    # Construct the necessary CredentialStoreItems for the Unit tests.
+    $CredentialUserName = 'MyUser'
+    $CredentialPassword = 'FooBar' | ConvertTo-SecureString -AsPlainText -Force
+    $Credential = [PSCredential]::new($CredentialUserName, $CredentialPassword)
+
+    # Create the CredentialStoreItems
+    New-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' -Credential $Credential
+    New-CredentialStoreItem -Shared -RemoteHost 'test-case-a.domain.my' -Credential $Credential
+
+    New-CredentialStoreItem -Shared -RemoteHost 'test-case-b.domain.my' -Credential $Credential
+    New-CredentialStoreItem -RemoteHost 'test-case-c.domain.my' -Credential $Credential
+
+    New-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' -Credential $Credential -Identifier 'Foo'
+    New-CredentialStoreItem -Shared -RemoteHost 'test-case-a.domain.my' -Credential $Credential -Identifier 'Foo'
+
+    New-CredentialStoreItem -Shared -RemoteHost 'test-case-b.domain.my' -Credential $Credential -Identifier 'Foo'
+    New-CredentialStoreItem -RemoteHost 'test-case-c.domain.my' -Credential $Credential -Identifier 'Foo'
+}
+
+AfterAll {
+    # Check if the private CredentialStore exists
+    $Paths = @(('{0}\AppData\Roaming' -f $env:USERPROFILE), ('{0}\ProgramData\PSCredentialStore\' -f $env:SystemDrive))
+    $Files = @('CredentialStore.json.orig', 'PSCredentialStore.pfx.orig')
+
+    foreach ($Filepath in $Paths) {
+        foreach ($File in $Files) {
+            $OrgPath = Join-Path -Path $FilePath -ChildPath $File
+            $NewPath = $OrgPath.Replace('.orig', '')
+            if (Test-Path $OrgPath) {
+                try {
+                    $null = Remove-Item -Path $NewPath -Force -Confirm:$false -ErrorAction SilentlyContinue
+                    $null = Rename-Item -Path $OrgPath -NewName $NewPath -Confirm:$false
+                }
+                catch {
+                    $_.Exception.Message | Write-Warning
+                    Write-Error -Message ('Unable to revert {0} to {1}' -f $OrgPath, $NewPath)
+                }
+            }
+        }
+    }
+}
+
+Describe 'Find-CredentialStoreItem' {
+    Context 'Default tests' -Tag 'Default' {
+        It 'Test Function' {
+            { Get-Command -Name 'Find-CredentialStoreItem' -Module $Repo.Artifact } | Should -Not -Throw
+        }
+
+        It 'Test Help' {
+            { Get-Help -Name 'Find-CredentialStoreItem' } | Should -Not -Throw
+        }
+
+        It 'Help Content' {
+            $foo = Get-Help -Name 'Find-CredentialStoreItem'
+            $foo.Synopsis.Length | Should -BeGreaterThan 5
+            $foo.Description.Count | Should -BeGreaterOrEqual 1
+            $foo.Description[0].Text.Length | Should -BeGreaterThan 5
+        }
+    }
+
+    Context 'Coding tests' -Tag 'Coding' {
+        It 'Calling Find-CredentialStoreItem with wrong Type' {
+            { Find-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' -Type 'Foo' } | Should -Throw
+        }
+
+        It 'Calling Find-CredentialStoreItem present in both CredentialStores w/o Identifier' {
+            { Find-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' } | Should -Not -Throw
+
+            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-a.domain.my'
+            $foo.UserName | Should -Be 'MyUser'
+            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
+        }
+
+        It 'Calling Find-CredentialStoreItem present only in shared CredentialStore w/o Identifier' {
+            { Find-CredentialStoreItem -RemoteHost 'test-case-b.domain.my' } | Should -Not -Throw
+
+            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-b.domain.my'
+            $foo.UserName | Should -Be 'MyUser'
+            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
+        }
+
+        It 'Calling Find-CredentialStoreItem present only in private CredentialStore w/o Identifier' {
+            { Find-CredentialStoreItem -RemoteHost 'test-case-c.domain.my' } | Should -Not -Throw
+
+            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-c.domain.my'
+            $foo.UserName | Should -Be 'MyUser'
+            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
+        }
+
+        It 'Calling Find-CredentialStoreItem present in both CredentialStores w Identifier' {
+            { Find-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' -Identifier 'Foo' } | Should -Not -Throw
+
+            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' -Identifier 'Foo'
+            $foo.UserName | Should -Be 'MyUser'
+            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
+        }
+
+        It 'Calling Find-CredentialStoreItem present only in shared CredentialStore w/o Identifier' {
+            { Find-CredentialStoreItem -RemoteHost 'test-case-b.domain.my' -Identifier 'Foo' } | Should -Not -Throw
+
+            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-b.domain.my' -Identifier 'Foo'
+            $foo.UserName | Should -Be 'MyUser'
+            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
+        }
+
+        It 'Calling Find-CredentialStoreItem present only in private CredentialStore w/o Identifier' {
+            { Find-CredentialStoreItem -RemoteHost 'test-case-c.domain.my' -Identifier 'Foo' } | Should -Not -Throw
+
+            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-c.domain.my' -Identifier 'Foo'
+            $foo.UserName | Should -Be 'MyUser'
+            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
+        }
+    }
+}

src/Item/Find-CredentialStoreItem.ps1

@@ -0,0 +1,152 @@
+function Find-CredentialStoreItem {
+    <#
+    .SYNOPSIS
+        Locates a CredentialStoreItem in any CredentialStore from a given remote host item.
+
+    .DESCRIPTION
+        Find the credential object and return it as PSCredential object.
+
+    .PARAMETER RemoteHost
+        Specify the host, for which you would like to find the credentials.
+
+    .PARAMETER Identifier
+        Provide a custom identifier to the given remote host key. This enables you to store multiple credentials
+        for a single remote host entry. For example ad/sys1, ftp/sys1, sql/sys1
+
+    .PARAMETER Type
+        Influence in which types of CredentialStore this function will look for a object. List of possible types:
+          - All (include private and shared CredentialStore) - this is also the default.
+          - Private (only look in a private CredentialStore)
+          - Shared (only look in the shared CredentialStore)
+
+    .INPUTS
+        [None]
+
+    .OUTPUTS
+        [System.Management.Automation.PSCredential]
+
+    .EXAMPLE
+        $Credential = Find-CredentialStoreItem -RemoteHost 'support.komm-one.net' -Type 'All'
+
+    .EXAMPLE
+        $params = @{
+            RemoteHost = 'support.komm-one.net'
+            Type = 'Private'
+            Identifier = 'PersonId'
+        }
+        $Credential = Find-CredentialStoreItem @params
+    #>
+
+    [CmdletBinding()]
+
+    param(
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullOrEmpty()]
+        [string] $RemoteHost,
+
+        [Parameter(Mandatory = $false)]
+        [string] $Identifier,
+
+        [Parameter(Mandatory = $false)]
+        [ValidateSet('All', 'Private', 'Shared')]
+        [string] $Type = 'All'
+    )
+
+    begin {
+        # Define some defaults for the PreferenceVariables.
+        $ErrorActionPreference = 'Stop'
+        $InformationPreference = 'Continue'
+        $WarningPreference = 'Continue'
+        $ProgressPreference = 'SilentlyContinue'
+
+        # Construct the CredentialStore list, based on what $Type says.
+        switch ($Type) {
+            'All' {
+                $CredentialStoreList = @('Private', 'Shared')
+                break
+            }
+            'Private' {
+                $CredentialStoreList = @('Private')
+            }
+            'Shared' {
+                $CredentialStoreList = @('Shared')
+            }
+        }
+    }
+
+    process {
+        # Now go and look for the CredentialStoreItem.
+        foreach ($Store in $CredentialStoreList) {
+            # First make sure, that the CredentialStore exists. Sadly I don't have a way to solve this any better
+            # programmatically, as PowerShell behaves oddly, if you try and pass an empty splatting to a function.
+            Write-Verbose -Message ('Checking if CredentialStore of type {0} exists' -f $Store)
+
+            if ($Store -eq 'Private') {
+                if (-not (Test-CredentialStore)) {
+                    Write-Warning -Message ('CredentialStore of type {0} not found, skipping ahead' -f $Store)
+                    continue
+                }
+            }
+            elseif ($Store -eq 'Shared') {
+                if (-not (Test-CredentialStore -Shared)) {
+                    Write-Warning -Message ('CredentialStore of type {0} not found, skipping ahead' -f $Store)
+                    continue
+                }
+            }
+            else {
+                Write-Error -Message ('Invalid CredentialStore type {0} supplied' -f $Store)
+                continue
+            }
+
+            # Now that we're here, means we have tested the CredentialStore for existence. We can check, if it
+            # contains a CredentialStoreItem that we are looking for.
+            $params = @{
+                RemoteHost = $RemoteHost
+            }
+
+            # Check if the user passed -Identifier, then we add it to the splatting.
+            if (-not [string]::IsNullOrWhiteSpace($Identifier)) {
+                $params.Add('Identifier', $Identifier)
+            }
+
+            # Check the CredentialStore type we're currently looking at.
+            if ($Store -eq 'Shared') {
+                $params.Add('Shared', $true)
+            }
+
+            # Now check if the CredentialStoreItem exists
+            $message = 'Checking if CredentialStoreItem {0}/{1} exists in CredentialStore {2}'
+            $argumentlist = @($RemoteHost, $Identifier, $Store)
+            Write-Verbose -Message ($message -f $argumentlist)
+
+            if (Test-CredentialStoreItem @params) {
+                $message = 'Looking up CredentialStoreItem {0}/{1} from CredentialStore {2}'
+                $argumentlist = @($RemoteHost, $Identifier, $Store)
+                Write-Verbose -Message ($message -f $argumentlist)
+
+                try {
+                    Write-Information -MessageData ($message -f $argumentlist)
+                    # Read the CredentialStoreItem from the CredentialStore and store it in $CredentialObject
+                    $CredentialObject = Get-CredentialStoreItem @params
+
+                    # Now finish the loop, as we've found what we're looking for.
+                    break
+                }
+                catch {
+                    $_.Exception.Message | Write-Warning
+                    $message = 'Unable to read CredentialStoreItem {0}/{1} from CredentialStore {2}'
+                    $argumentlist = @($RemoteHost, $Identifier, $Store)
+
+                    Write-Warning -Message ($message -f $argumentlist)
+                }
+            }
+        }
+    }
+
+    end {
+        # Only if we've found a CredentialStoreItem above, return it back to the caller.
+        if ($null -ne $CredentialObject) {
+            $CredentialObject
+        }
+    }
+}

src/PSCredentialStore.psd1

@@ -85,6 +85,7 @@
         'Test-CSConnection',
         # Item
         'Get-CredentialStoreItem',
+        'Find-CredentialStoreItem',
         'New-CredentialStoreItem',
         'Remove-CredentialStoreItem',
         'Set-CredentialStoreItem',
@@ -146,19 +147,19 @@
             ExternalModuleDependencies = @(
                 @{
                     ModuleName = 'VMware.VimAutomation.Core'
-                    ModuleVersion = '6.5.2.6234650'
+                    ModuleVersion = '12.7.0.20091293'
                 },
                 @{
                     ModuleName = 'VMware.VimAutomation.Cis.Core'
-                    ModuleVersion = '6.5.4.6983166'
+                    ModuleVersion = '12.6.0.19601368'
                 },
                 @{
-                    ModuleName    = 'Cisco.UCS.Core'
+                    ModuleName = 'Cisco.UCS.Common'
-                    ModuleVersion = '2.3.1.5'
+                    ModuleVersion = '3.0.1.2'
                 },
                 @{
                     ModuleName = 'Cisco.UCSManager'
-                    ModuleVersion = '2.5.2.2'
+                    ModuleVersion = '3.0.1.2'
                 },
                 @{
                     ModuleName = 'WinSCP'
@@ -167,14 +168,6 @@
                 @{
                     ModuleName = 'NetApp.ONTAP'
                     ModuleVersion = '9.10.1.2111'
-                },
-                @{
-                    ModuleName    = 'StorageGRID-WebScale'
-                    ModuleVersion = '7.2.1'
-                },
-                @{
-                    ModuleName    = 'StorageGRID-WebScale'
-                    ModuleVersion = '7.2.1'
                 }
             )