DisconnectPSSessionCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

System.Management.Automation.dll

Package:

System.Management.Automation v7.4.0

This cmdlet disconnects PS sessions (RemoteRunspaces) that are in the Opened state and returns the PS session objects in the Disconnected state. While the PS sessions are in the disconnected state no commands can be invoked on them and any existing remote running commands will not return any data. The PS sessions can be reconnected by using the Connect-PSSession cmdlet.

The cmdlet can be used in the following ways:

Disconnect a PS session object: > $session = New-PSSession serverName > Disconnect-PSSession $session

Disconnect a PS session by name: > Disconnect-PSSession -Name $session.Name

Disconnect a PS session by Id: > Disconnect-PSSession -Id $session.Id

Disconnect a collection of PS sessions: > Get-PSSession | Disconnect-PSSession

public ref class DisconnectPSSessionCommand : Microsoft::PowerShell::Commands::PSRunspaceCmdlet, IDisposable

[System.Management.Automation.Cmdlet("Disconnect", "PSSession", DefaultParameterSetName="Session", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096576", RemotingCapability=System.Management.Automation.RemotingCapability.OwnedByCommand, SupportsShouldProcess=true)]
[System.Management.Automation.OutputType(typeof(System.Management.Automation.Runspaces.PSSession))]
public class DisconnectPSSessionCommand : Microsoft.PowerShell.Commands.PSRunspaceCmdlet, IDisposable

[<System.Management.Automation.Cmdlet("Disconnect", "PSSession", DefaultParameterSetName="Session", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096576", RemotingCapability=System.Management.Automation.RemotingCapability.OwnedByCommand, SupportsShouldProcess=true)>]
[<System.Management.Automation.OutputType(typeof(System.Management.Automation.Runspaces.PSSession))>]
type DisconnectPSSessionCommand = class
    inherit PSRunspaceCmdlet
    interface IDisposable

Public Class DisconnectPSSessionCommand
Inherits PSRunspaceCmdlet
Implements IDisposable

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

PSRemotingCmdlet

PSRunspaceCmdlet

DisconnectPSSessionCommand

Attributes

CmdletAttribute OutputTypeAttribute

Implements

IDisposable

Constructors

DisconnectPSSessionCommand()

Fields

ComputerInstanceIdParameterSet	Computername with session instance ID parameter set. (Inherited from PSRemotingCmdlet)
ComputerNameParameterSet	Computername parameter set. (Inherited from PSRemotingCmdlet)
ContainerIdInstanceIdParameterSet	ContainerIdInstanceId parameter set: container id + session instance id. (Inherited from PSRunspaceCmdlet)
ContainerIdParameterSet	Container ID parameter set. (Inherited from PSRemotingCmdlet)
DefaultPowerShellRemoteShellAppName	Default application name for the connection uri. (Inherited from PSRemotingCmdlet)
DefaultPowerShellRemoteShellName	Default shellname. (Inherited from PSRemotingCmdlet)
IdParameterSet	Session id parameter set. (Inherited from PSRunspaceCmdlet)
InstanceIdParameterSet	Runspace Id parameter set. (Inherited from PSRunspaceCmdlet)
NameParameterSet	Name parameter set. (Inherited from PSRunspaceCmdlet)
SessionParameterSet	Runspace parameter set. (Inherited from PSRemotingCmdlet)
SSHHostHashParameterSet	SSH host parmeter set supporting hash connection parameters. (Inherited from PSRemotingCmdlet)
SSHHostParameterSet	SSH host parameter set. (Inherited from PSRemotingCmdlet)
UseWindowsPowerShellParameterSet	Parameter set to use Windows PowerShell. (Inherited from PSRemotingCmdlet)
VMIdInstanceIdParameterSet	VMIdInstanceId parameter set: vm id + session instance id. (Inherited from PSRunspaceCmdlet)
VMIdParameterSet	VM guid parameter set. (Inherited from PSRemotingCmdlet)
VMNameInstanceIdParameterSet	VMNameInstanceId parameter set: vm name + session instance id. (Inherited from PSRunspaceCmdlet)
VMNameParameterSet	VM name parameter set. (Inherited from PSRemotingCmdlet)

Properties

CommandOrigin	This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand)
CommandRuntime	Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet)
ComputerName	Disconnect-PSSession does not support ComputerName parameter set. This may change for later versions.
ContainerId	Overriding to suppress this parameter
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
Id	Session Id of the remoterunspace info object. (Inherited from PSRunspaceCmdlet)
IdleTimeoutSec	Idle Timeout session option in seconds. Used in this cmdlet to set server disconnect idletimeout option.
InstanceId	RemoteRunspaceId to retrieve corresponding PSSession object. (Inherited from PSRunspaceCmdlet)
InvokeCommand	Provides access to utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
InvokeProvider	Gets the instance of the provider interface APIs for the current runspace. (Inherited from PSCmdlet)
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repository for jobs. (Inherited from PSCmdlet)
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
Name	Name of the remote runspaceinfo object. (Inherited from PSRunspaceCmdlet)
OutputBufferingMode	Output buffering mode session option. Used in this cmdlet to set server disconnect OutputBufferingMode option.
PagingParameters	If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null. (Inherited from PSCmdlet)
ParameterSetName	The name of the parameter set in effect. (Inherited from PSCmdlet)
Session	The PSSession object or objects to be disconnected.
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
Stopping	Is this command stopping? (Inherited from Cmdlet)
ThrottleLimit	Allows the user of the cmdlet to specify a throttling value for throttling the number of remote operations that can be executed simultaneously.
VMId	Overriding to suppress this parameter
VMName	Overriding to suppress this parameter

Methods

BeginProcessing()	Set up the ThrottleManager for runspace disconnect processing.
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
Dispose()	Dispose method of IDisposable. Gets called in the following cases: 1. Pipeline explicitly calls dispose on cmdlets 2. Called by the garbage collector
EndProcessing()	End processing clean up.
GetMatchingRunspaces(Boolean, Boolean, SessionFilterState, String)	Gets the matching runspaces based on the parameterset. (Inherited from PSRunspaceCmdlet)
GetMatchingRunspaces(Boolean, Boolean)	Gets the matching runspaces based on the parameterset. (Inherited from PSRunspaceCmdlet)
GetMatchingRunspacesByName(Boolean, Boolean)	Gets the matching runspaces based on name. (Inherited from PSRunspaceCmdlet)
GetMatchingRunspacesByRunspaceId(Boolean, Boolean)	Gets the matching runspaces based on the runspaces instance id. (Inherited from PSRunspaceCmdlet)
GetResolvedProviderPathFromPSPath(String, ProviderInfo)	(Inherited from PSCmdlet)
GetResourceString(String, String)	Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
GetVariableValue(String)	(Inherited from PSCmdlet)
Invoke()	Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet)
Invoke<T>()	Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet)
ProcessRecord()	Perform runspace disconnect processing on all input.
ResolveAppName(String)	Determines the appname to be used based on the following order: 1. AppName parameter specified 2. DEFAULTREMOTEAPPNAME variable set 3. WSMan. (Inherited from PSRemotingCmdlet)
ResolveComputerName(String)	Resolves a computer name. If its null or empty its assumed to be localhost. (Inherited from PSRemotingCmdlet)
ResolveComputerNames(String[], String[])	Resolve all the machine names provided. Basically, if a machine name is '.' assume localhost. (Inherited from PSRemotingCmdlet)
ResolveShell(String)	Determines the shellname to use based on the following order: 1. ShellName parameter specified 2. DEFAULTREMOTESHELLNAME variable set 3. PowerShell. (Inherited from PSRemotingCmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet)
ShouldProcess(String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet)
StopProcessing()	User has signaled a stop for this cmdlet.
ThrowTerminatingError(ErrorRecord)	Terminate the command and report an error. (Inherited from Cmdlet)
TransactionAvailable()	Returns true if a transaction is available and active. (Inherited from Cmdlet)
WriteCommandDetail(String)	Write text into pipeline execution log. (Inherited from Cmdlet)
WriteDebug(String)	Display debug information. (Inherited from Cmdlet)
WriteError(ErrorRecord)	Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet)
WriteInformation(InformationRecord)	Route information to the user or host. (Inherited from Cmdlet)
WriteInformation(Object, String[])	Route information to the user or host. (Inherited from Cmdlet)
WriteObject(Object, Boolean)	Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)