PSCredentialStore/docs/Disconnect-From.md
Marco Blessing dbe5319537 Adds markdown help pages in docs folder
* adds docs folder (#5)
  * fist module description
  * adds cmdlet markdown help
  * adds meta pages
2017-09-28 11:08:41 +02:00

2.9 KiB

external help file Module Name online version schema
PSCredentialStore-help.xml PSCredentialStore https://github.com/OCram85/PSCredentialStore 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

PARAMETERS

-RemoteHost

Specify the remote endpoint, whose session you would like to terminate.

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

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Force the disconnect, even if the disconnect would fail.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: False
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-To.ps1 Author : Marco Blessing - marco.blessing@googlemail.com Requires :

https://github.com/OCram85/PSCredentialStore