< Back

Connect-To

Sun Jan 19, 2020 6:35 pm

NAME Connect-To



SYNOPSIS

Connects to the given host using the stored CredentialStoreItem.





SYNTAX

Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>] [-PassThru]

[<CommonParameters>]



Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>] -Shared [-Path

<String>] [-PassThru] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-RemoteHost <String>

Specify the host, for which you would like to change the credentials.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Identifier <String>

Defaults to "". Specify a string, which separates two CredentialStoreItems for the

same hostname.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Type <String>

Specify the host type of the target. Currently implemented targets are: Possible connection values are:

CiscoUcs, FTP, NetAppFAS, VMware, CisServer, ExchangeHTTP, ExchangeHTTPS, SCP.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credentials <PSCredential>

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Shared [<SwitchParameter>]

Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which

can be decrypted across systems.



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Path <String>

Define a custom path to a shared CredentialStore.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Returns the value from the underlying connection type function.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

[None]





OUTPUTS

[None]





NOTES





- File Name : Connect-To.ps1

- Author : Marco Blessing - marco.blessing@googlemail.com

- Requires :



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Connect-To -RemoteHost "ftp.myside.local" -Type FTP













-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS













-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Connect-To -RemoteHost "esx01.myside.local" -Type VMware













-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer













-------------------------- EXAMPLE 6 --------------------------



PS C:\\>Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP













-------------------------- EXAMPLE 7 --------------------------



PS C:\\>Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS















RELATED LINKS

https://github.com/OCram85/PSCredentialStore