PSCredentialStore/docs/Disconnect-From.md
Marco Blessing 1e7dd78c2b
Some checks reported errors
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build was killed
adds CiscoUCSCentral connection type (#67)
#### 📖 Summary

- adds CiscoUCSCentrall connection type in `Connect-To` and `Disconnect-From`

#### 📑 Test Plan

> 💡 Select your test plan for the code changes.

- [x] Tested via Drone.io pipeline
- [ ] Custom test
- [ ] No test plan

##### Details / Justification

<!-- Add your test details or justification for missing tests here. -->

#### 📚 Additional Notes

<!-- A place for additional detail notes. -->

Co-authored-by: OCram85 <marco.blessing@googlemail.com>
Reviewed-on: #67
2022-07-19 14:29:25 +02:00

2.5 KiB

external help file Module Name online version schema
ModuleRoot-help.xml 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

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.

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.

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
  • CiscoUcsCentral
  • FTP
  • NetAppFAS
  • VMware
  • CisServer
  • ExchangeHTTP
  • ExchangeHTTPS
  • SCP
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.

INPUTS

[None]

OUTPUTS

[None]

NOTES