PSCredentialStore/src/Connection/Connect-To.ps1

function Connect-To {
    <#
    .SYNOPSIS
        Connects to the given host using the stored CredentialStoreItem.

    .DESCRIPTION
        Establish a connection to the selected host using a stored CredentialStoreItem.

    .PARAMETER RemoteHost
        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
        same hostname.

    .PARAMETER Type
        Specify the host type of the target. Currently implemented targets are:
            - CiscoUcs     Establish a connection to a Cisco UCS fabric interconnect.
            - FTP          Establish a connection to a FTP host.
            - NetAppFAS    Establish a connection to a NetApp Clustered ONTAP filer.
            - VMware       Establish a connection to a VMware vCenter or ESXi host.

    .PARAMETER Credentials
        Use this parameter to bypass the stored credentials. Without this parameter Connect-To tries to read the
        needed credentials from the CredentialStore. If you provide this parameter you skip this lookup behavior.
        So you can use it to enable credentials without preparing any user interaction.

    .PARAMETER Path
        Define a custom path to a shared CredentialStore.

    .PARAMETER Shared
        Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which
        can be decrypted across systems.

    .INPUTS
        [None]

    .OUTPUTS
        [None]

    .EXAMPLE
        Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs
        Connect-To -RemoteHost "ftp.myside.local" -Type FTP
        Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS
        Connect-To -RemoteHost "esx01.myside.local" -Type VMware

    .EXAMPLE
        $MyCreds = Get-Credential
        Connect-To -RemoteHost "vcr01.myside.local" -Type VMware -Credentials $MyCreds
        Get-VM -Name "*vlm*" | Select-Object -Property Name
        Disconnect-From -RemoteHost "vcr01.myside.local" -Type VMware

    .NOTES
        File Name   : Connect-To.ps1
        Author      : Marco Blessing - marco.blessing@googlemail.com
        Requires    : PSFTP, PowerCLI

    .LINK
        https://github.com/OCram85/PSCredentialStore
    #>
    [CmdletBinding(DefaultParameterSetName = "Private")]
    param(
        [Parameter(Mandatory = $true, ParameterSetName = "Shared")]
        [Parameter(Mandatory = $true, ParameterSetName = "Private")]
        [String]$RemoteHost,

        [Parameter(Mandatory = $false, ParameterSetName = "Shared")]
        [Parameter(Mandatory = $false, ParameterSetName = "Private")]
        [String]$Identifier,

        [Parameter(Mandatory = $true, ParameterSetName = "Shared")]
        [Parameter(Mandatory = $true, ParameterSetName = "Private")]
        [ValidateSet("CiscoUcs", "FTP", "NetAppFAS", "VMware")]
        [String]$Type,

        [Parameter(Mandatory = $False, ParameterSetName = "Shared")]
        [Parameter(Mandatory = $False, ParameterSetName = "Private")]
        [PSCredential]$Credentials,

        [Parameter(Mandatory = $False, ParameterSetName = "Shared")]
        [ValidateNotNullOrEmpty()]
        [String]$Path = "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData,

        [Parameter(Mandatory = $false, ParameterSetNAme = "Shared")]
        [Switch]$Shared
    )

    begin {
        # First check the optional modules
        if (-not (Resolve-Dependency -Name $Type)) {
            Write-Error -Message ("Could not resolve the optional dependencies defined for {0}" -f $Type) -ErrorAction 'Stop'
        }
        switch ($Type) {
            "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

                # Disable connecting through proxy, since vCenter isn't somewhere we need a proxy for.
                $null = Set-PowerCLIConfiguration -Scope Session -ProxyPolicy NoProxy -Confirm:$false
            }
        }
    }

    process {
        # Set the correct CredentialStore Path depending on the used ParameterSetName
        if ($PSCmdlet.ParameterSetName -eq "Private") {
            $Path = "{0}\CredentialStore.json" -f $env:APPDATA
        }
        if (-not ($Credentials)) {
            # Load the credential from the CredentialStore. If the credential doesn't exist, we need to
            # return 1, so a calling if statement can handle the failure detection.

            # 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
                    $creds = Get-CredentialStoreItem -RemoteHost $RemoteHostIdentifier -Path $Path
                }
                else {
                    $creds = Get-CredentialStoreItem -RemoteHost $RemoteHost -Path $Path
                }
            }

            catch {
                Write-Message2 ("Unable to look up credential store item for RemoteHost {0}/Identifier {1}!" -f $RemoteHost, $Identifier) -ErrorAction Stop
            }
        }
        else {
            $creds = $Credentials
        }

        if ($creds.UserName -eq "" -or $creds.Password.GetType().Name -ne "SecureString") {
            # Write a error message to the log.
            Write-Message2 ("Please provide valid credentials for RemoteHost {0}!" -f $RemoteHost) -ErrorAction Stop
        }
        else {
            switch ($Type) {
                "CiscoUcs" {
                    try {
                        $handle = Connect-Ucs -Name $RemoteHost -Credential $creds -ErrorAction Stop
                        $ExecutionContext.SessionState.PSVariable.Set("DefaultUcs", $handle)
                    }

                    catch {
                        # Write a error message to the log.
                        Write-Message2 ("Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type) -ErrorAction Stop
                    }
                }
                "FTP" {
                    # First establish the FTP session
                    $WinSCPConParams = @{
                        Credential = $creds
                        Hostname = $RemoteHost
                        Protocol = 'Ftp'
                        FtpMode = 'Passive'
                    }
                    try {
                        $Global:WinSCPSession = New-WinSCPSession @WinSCPConParams
                    }
                    catch {
                        throw "Could not connect to {0} using {1} protocol!" -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. But now it seems to be lost!" -f $RemoteHost, $Type
                            ErrorAction = "Stop"
                        }
                        Write-Error @MessageParams
                    }
                }
                "NetAppFAS" {
                    try {
                        $null = Connect-NcController -Name $RemoteHost -Credential $creds -ErrorAction Stop -HTTPS
                    }

                    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
                    }

                    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
                    }
                }
                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
                }
            }
        }
    }
}