DisconnectPSSessionCommand Members

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 PS by computer name: > Disconnect-PSSession -ComputerName localhost Disconnect a collection of PS sessions: > Get-PSSession | Disconnect-PSSession

The following tables list the members exposed by the DisconnectPSSessionCommand type.

  Name Description
public property CommandOrigin  Gets the origin of the command. The command can be invoked within a runspace or it could be an external request (such as invoking the command from the command line). This property is introduced in Windows PowerShell 2.0. (Inherited from InternalCommand)
public property CommandRuntime  Gets and sets the command runtime object that controls what happens when the cmdlet writes an object to the pipeline. (Inherited from Cmdlet)
public property ComputerName Overridden.  
public property CurrentPSTransaction  Gets the latest transaction started by running the Start-Transaction cmdlet. This property is introduced in Windows PowerShell 2.0. (Inherited from Cmdlet)
public property Events  Gets the event manager for the current session where the cmdlet is running This property is introduced in Windows PowerShell 2.0. (Inherited from PSCmdlet)
public property Host  Gets information about the host that is being used by the session where the cmdlet is running. (Inherited from PSCmdlet)
public property Id  Gets and sets the value of the Id parameter for the derived cmdlet. This property is introduced in Windows PowerShell 2.0. (Inherited from PSRunspaceCmdlet)
public property IdleTimeoutSec  
public property InstanceId  Gets and sets the value of the InstanceId parameter for the derived cmdlet. This property is introduced in Windows PowerShell 2.0. (Inherited from PSRunspaceCmdlet)
public property InvokeCommand  Gets utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
public property InvokeProvider  Gets provider information that is used to access a data store. (Inherited from PSCmdlet)
public property JobManager  Gets or sets the job manager for the registered JobSourceAdapter objects. (Inherited from PSCmdlet)
public property JobRepository  Get the active jobs available in the current session where the cmdlet is running. This property is introduced in Windows PowerShell 2.0. (Inherited from PSCmdlet)
public property MyInvocation  Gets invocation information about the cmdlet. (Inherited from PSCmdlet)
public property Name  Gets and sets the value of the Name parameter for the derived cmdlet. This property is introduced in Windows PowerShell 2.0. (Inherited from PSRunspaceCmdlet)
public property OutputBufferingMode  
public property 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)
public property ParameterSetName  Gets the name of the parameter set that is used by the cmdlet. (Inherited from PSCmdlet)
public property Session The PSSession object or objects to be disconnected.
public property SessionState  Gets information about the current state of the current session where the cmdlet is running. (Inherited from PSCmdlet)
public property Stopping  Gets an indicator that the pipeline is stopping. The pipeline can be stopped for numerous reasons, such as when the user has entered the key combination CTRL+C, a terminating error has occurred, the hosting application requested a stop, and so on.  (Inherited from Cmdlet)
public property ThrottleLimit Allows the user of the cmdlet to specify a throttling value for throttling the number of remote operations that can be executed simultaneously.
Top

(see also Protected Methods)
 NameDescription
public methodCurrentProviderLocation  Returns the fully-qualified path of the current working directory for the specified provider. (Inherited from PSCmdlet)
public methodDisposeThe Dispose method of IDisposable. This method is called in the following cases: 1. Pipeline explicitly calls dispose on cmdlets 2. Garbage collection
public methodEquals  (Inherited from Object)
public methodGetHashCode  (Inherited from Object)
public methodGetResolvedProviderPathFromPSPath  Returns the resolved provider path from a specified Windows PowerShell path. (Inherited from PSCmdlet)
public methodGetResourceString  Gets a resource string that corresponds to the specified resource base key and identifier. (Inherited from Cmdlet)
public methodGetType  (Inherited from Object)
public methodGetUnresolvedProviderPathFromPSPath  Returns the fully-qualified provider path of a specified relative Windows PowerShell path. (Inherited from PSCmdlet)
public methodGetVariableValue  Overloaded. Returns the value of a specific session-state variable. The variants of this method can return a variable value with or without a default value. (Inherited from PSCmdlet)
public methodInvoke  Overloaded. Invokes a cmdlet object. The variants of this method can invoke a cmdlet that returns a collection of results or a strongly-typed enumerator. (Inherited from Cmdlet)
public methodShouldContinue  Overloaded. Requests confirmation of an operation from the user. This is typically a second query to the user. The variants of this method can send the query with or without providing yesToall or noToall options to the user. (Inherited from Cmdlet)
public methodShouldProcess  Overloaded. Requests confirmation from the user before an operation is performed. The variants of this method can be used to send the name of the resource to be changed, send the name of the resource and the operation to be performed, and more. The confirmation message that is displayed to the user is based on which variant of this method is called. (Inherited from Cmdlet)
public methodThrowTerminatingError  Reports a terminating error when the cmdlet cannot continue, or when you do not want the cmdlet to continue to process records. (Inherited from Cmdlet)
public methodToString  (Inherited from Object)
public methodTransactionAvailable  Determines whether the Start-Transaction cmdlet has been called and that there is a Windows PowerShell transaction available that the cmdlet can participate in. This method is introduced in Windows PowerShell 2.0. (Inherited from Cmdlet)
public methodWriteCommandDetail  Writes information to the execution log of the pipeline. (Inherited from Cmdlet)
public methodWriteDebug  Writes a debug message to the host. (Inherited from Cmdlet)
public methodWriteError  Reports a nonterminating error to the error pipeline when the cmdlet cannot process a record but can continue to process other records. (Inherited from Cmdlet)
public methodWriteObject  Overloaded. Writes an object to the output pipeline. The variants of this method can be used to write a single object or an object that can be enumerated. (Inherited from Cmdlet)
public methodWriteProgress  Writes a progress record to the host. (Inherited from Cmdlet)
public methodWriteVerbose  Writes a general user-level message to the pipeline. These messages can help describe what the cmdlet is doing. (Inherited from Cmdlet)
public methodWriteWarning  Writes a warning message that can be displayed. (Inherited from Cmdlet)
Top

  Name Description
protected method BeginProcessing Overridden. Sets up the ThrottleManager for runspace disconnect processing.
protected method EndProcessing Overridden. End processing clean up.
protected method Finalize  (Inherited from Object)
protected method GetMatchingRunspaces  Represents the GetMatchingRunspaces method used by the derived cmdlets. This method retrieves the matching runspaces based on the parameter set being used.  (Inherited from PSRunspaceCmdlet)
protected method GetMatchingRunspacesByName  (Inherited from PSRunspaceCmdlet)
protected method GetMatchingRunspacesByRunspaceId  (Inherited from PSRunspaceCmdlet)
protected method MemberwiseClone  (Inherited from Object)
protected method ProcessRecord Overridden. Performs runspace disconnect processing on all input.
protected method ResolveAppName  (Inherited from PSRemotingCmdlet)
protected method ResolveComputerName  Resolves a single computer name supplied to the derived cmdlet. This method is introduced in Windows PowerShell 2.0. (Inherited from PSRemotingCmdlet)
protected method ResolveComputerNames  Resolves all the computer names supplied to the derived cmdlet. This method is introduced in Windows PowerShell 2.0. (Inherited from PSRemotingCmdlet)
protected method ResolveShell  (Inherited from PSRemotingCmdlet)
protected method StopProcessing Overridden. User has signaled a stop for this cmdlet.
Top

Send comments about this topic to Microsoft.
Show:
© 2014 Microsoft