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.
134 lines
2.7 KiB
Markdown
134 lines
2.7 KiB
Markdown
---
|
|
external help file: PSCredentialStore-help.xml
|
|
Module Name: PSCredentialStore
|
|
online version: https://github.com/OCram85/PSCredentialStore
|
|
schema: 2.0.0
|
|
---
|
|
|
|
# Disconnect-From
|
|
|
|
## SYNOPSIS
|
|
Terminates a session established with Connect-To using a CredentialStoreItem.
|
|
|
|
## SYNTAX
|
|
|
|
```
|
|
Disconnect-From [-RemoteHost] <String> [-Type] <String> [-Force] [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
Terminates a session established with Connect-To using a CredentialStoreItem.
|
|
|
|
## EXAMPLES
|
|
|
|
### EXAMPLE 1
|
|
```
|
|
Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs
|
|
```
|
|
|
|
### EXAMPLE 2
|
|
```
|
|
Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP
|
|
```
|
|
|
|
### EXAMPLE 3
|
|
```
|
|
Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS
|
|
```
|
|
|
|
### EXAMPLE 4
|
|
```
|
|
Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware
|
|
```
|
|
|
|
### EXAMPLE 5
|
|
```
|
|
Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True
|
|
```
|
|
|
|
### EXAMPLE 6
|
|
```
|
|
Disconnect-From -RemoteHost "vcenter.myside.local" -Type CisServer
|
|
```
|
|
|
|
### EXAMPLE 7
|
|
```
|
|
Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
|
|
```
|
|
|
|
### EXAMPLE 8
|
|
```
|
|
Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
|
|
```
|
|
|
|
## PARAMETERS
|
|
|
|
### -Force
|
|
Force the disconnect, even if the disconnect would fail.
|
|
|
|
```yaml
|
|
Type: SwitchParameter
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: False
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -RemoteHost
|
|
Specify the remote endpoint, whose session you would like to terminate.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 1
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Type
|
|
Specify the host type of the target.
|
|
Currently implemented targets are: CiscoUcs, FTP, NetAppFAS, VMware,
|
|
CisServer, ExchangeHTTP, ExchangeHTTPS, SCP.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 2
|
|
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 : Disconnect-From.ps1
|
|
Author : Marco Blessing - marco.blessing@googlemail.com
|
|
Requires :
|
|
|
|
## RELATED LINKS
|
|
|
|
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
|
|
|