Marco Blessing
2422afbd8f
- fix pester test execution order in vscode test task. - fix coveralls.io link in bagde. - skip coverage report creation for PR triggered builds - update docs - Connection type SCP added for `Connect-To` and `Disconnect-From`. ## Internal Changes - pester tests now don't need to dotsource other public functions from the same module (fixes #17 ) - helper and private functions stilll needs to be dotsourced. - basic module tests added - pester tests for `Resolve-Dependency` added - Wrapper function `Get-ModuleBase` added. This enables mocking in tests.
4.0 KiB
| external help file | Module Name | online version | schema |
|---|---|---|---|
| PSCredentialStore-help.xml | PSCredentialStore | https://github.com/OCram85/PSCredentialStore | 2.0.0 |
Connect-To
SYNOPSIS
Connects to the given host using the stored CredentialStoreItem.
SYNTAX
Private (Default)
Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>]
[<CommonParameters>]
Shared
Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>]
[-Path <String>] [-Shared] [<CommonParameters>]
DESCRIPTION
Establish a connection to the selected host using a stored CredentialStoreItem.
EXAMPLES
EXAMPLE 1
Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs
EXAMPLE 2
Connect-To -RemoteHost "ftp.myside.local" -Type FTP
EXAMPLE 3
Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS
EXAMPLE 4
Connect-To -RemoteHost "esx01.myside.local" -Type VMware
EXAMPLE 5
Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer
EXAMPLE 6
Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
EXAMPLE 7
Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
PARAMETERS
-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.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identifier
Defaults to "". Specify a string, which separates two CredentialStoreItems for the same hostname.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
Define a custom path to a shared CredentialStore.
Type: String
Parameter Sets: Shared
Aliases:
Required: False
Position: Named
Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData
Accept pipeline input: False
Accept wildcard characters: False
-RemoteHost
Specify the host, for which you would like to change the credentials.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Shared
Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which can be decrypted across systems.
Type: SwitchParameter
Parameter Sets: Shared
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Type
Specify the host type of the target. Currently implemented targets are: Possible connection values are: CiscoUcs, FTP, NetAppFAS, VMware, CisServer, ExchangeHTTP, ExchangeHTTPS, SCP.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
[None]
OUTPUTS
[None]
NOTES
File Name : Connect-To.ps1 Author : Marco Blessing - marco.blessing@googlemail.com Requires :