RemovePSSessionCommand RemovePSSessionCommand RemovePSSessionCommand RemovePSSessionCommand Class

Definition

This cmdlet stops the runspace and frees the resources associated with that runspace. If any execution is in process in that runspace, it is stopped. Also, the runspace is removed from the global cache.

This cmdlet can be used in the following ways:

Remove the runspace specified $runspace = New-PSSession Remove-PSSession -remoterunspaceinfo $runspace

Remove the runspace specified (no need for a parameter name) $runspace = New-PSSession Remove-PSSession $runspace

public ref class RemovePSSessionCommand : Microsoft::PowerShell::Commands::PSRunspaceCmdlet
[System.Management.Automation.Cmdlet("Remove", "PSSession", DefaultParameterSetName="Id", HelpUri="https://go.microsoft.com/fwlink/?LinkID=135250", RemotingCapability=System.Management.Automation.RemotingCapability.OwnedByCommand, SupportsShouldProcess=true)]
public class RemovePSSessionCommand : Microsoft.PowerShell.Commands.PSRunspaceCmdlet
type RemovePSSessionCommand = class
    inherit PSRunspaceCmdlet
Public Class RemovePSSessionCommand
Inherits PSRunspaceCmdlet
Inheritance
Attributes

Constructors

RemovePSSessionCommand() RemovePSSessionCommand() RemovePSSessionCommand() RemovePSSessionCommand()

Properties

CommandOrigin CommandOrigin CommandOrigin CommandOrigin

This property tells you if you were being invoked inside the runspace or if it was an external request.

(Inherited from InternalCommand)
CommandRuntime CommandRuntime CommandRuntime CommandRuntime

Holds the command runtime object for this command. This object controls what actually happens when a write is called.

(Inherited from Cmdlet)
ComputerName ComputerName ComputerName ComputerName

Name of the computer for which the runspace needs to be returned

(Inherited from PSRunspaceCmdlet)
ContainerId ContainerId ContainerId ContainerId

ID of target container.

CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction

(Inherited from Cmdlet)
Events Events Events Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
Host Host Host Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
Id Id Id Id

Session Id of the remoterunspace info object

(Inherited from PSRunspaceCmdlet)
InstanceId InstanceId InstanceId InstanceId

RemoteRunspaceId to retrieve corresponding PSSession object

(Inherited from PSRunspaceCmdlet)
InvokeCommand InvokeCommand InvokeCommand InvokeCommand

Provides access to utility routines for executing scripts and creating script blocks.

(Inherited from PSCmdlet)
InvokeProvider InvokeProvider InvokeProvider InvokeProvider

Gets the instance of the provider interface APIs for the current runspace.

(Inherited from PSCmdlet)
JobManager JobManager JobManager JobManager

Manager for JobSourceAdapters registered.

(Inherited from PSCmdlet)
JobRepository JobRepository JobRepository JobRepository

Repostiory for jobs

(Inherited from PSCmdlet)
MyInvocation MyInvocation MyInvocation MyInvocation

Contains information about the identity of this cmdlet and how it was invoked.

(Inherited from PSCmdlet)
Name Name Name Name

Name of the remote runspaceinfo object

(Inherited from PSRunspaceCmdlet)
PagingParameters PagingParameters PagingParameters 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 ParameterSetName ParameterSetName ParameterSetName

The name of the parameter set in effect.

(Inherited from PSCmdlet)
Session Session Session Session

Specifies the PSSession objects which need to be removed

SessionState SessionState SessionState SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
Stopping Stopping Stopping Stopping

Is this command stopping?

(Inherited from Cmdlet)
VMId VMId VMId VMId

Guid of target virtual machine.

VMName VMName VMName VMName

Name of target virtual machine.

Methods

BeginProcessing() BeginProcessing() BeginProcessing() BeginProcessing()

Verifies if remoting cmdlets can be used

(Inherited from PSRemotingCmdlet)
CurrentProviderLocation(String) CurrentProviderLocation(String) CurrentProviderLocation(String) CurrentProviderLocation(String) Inherited from PSCmdlet
EndProcessing() EndProcessing() EndProcessing() EndProcessing()

When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns.

(Inherited from Cmdlet)
GetMatchingRunspaces(Boolean, Boolean) GetMatchingRunspaces(Boolean, Boolean) GetMatchingRunspaces(Boolean, Boolean) GetMatchingRunspaces(Boolean, Boolean)

Gets the matching runspaces based on the parameterset

(Inherited from PSRunspaceCmdlet)
GetMatchingRunspaces(Boolean, Boolean, SessionFilterState, String) GetMatchingRunspaces(Boolean, Boolean, SessionFilterState, String) GetMatchingRunspaces(Boolean, Boolean, SessionFilterState, String) GetMatchingRunspaces(Boolean, Boolean, SessionFilterState, String)

Gets the matching runspaces based on the parameterset

(Inherited from PSRunspaceCmdlet)
GetMatchingRunspacesByName(Boolean, Boolean) GetMatchingRunspacesByName(Boolean, Boolean) GetMatchingRunspacesByName(Boolean, Boolean) GetMatchingRunspacesByName(Boolean, Boolean)

Gets the matching runspaces based on name

(Inherited from PSRunspaceCmdlet)
GetMatchingRunspacesByRunspaceId(Boolean, Boolean) GetMatchingRunspacesByRunspaceId(Boolean, Boolean) GetMatchingRunspacesByRunspaceId(Boolean, Boolean) GetMatchingRunspacesByRunspaceId(Boolean, Boolean)

Gets the matching runspaces based on the runspaces instance id

(Inherited from PSRunspaceCmdlet)
GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) Inherited from PSCmdlet
GetResourceString(String, String) GetResourceString(String, String) GetResourceString(String, String) 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) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) Inherited from PSCmdlet
GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) Inherited from PSCmdlet
GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) Inherited from PSCmdlet
Invoke() Invoke() Invoke() Invoke()

Invoke this cmdlet object returning a collection of results.

(Inherited from Cmdlet)
Invoke<T>() Invoke<T>() Invoke<T>() Invoke<T>()

Returns a strongly-typed enumerator for the results of this cmdlet.

(Inherited from Cmdlet)
ProcessRecord() ProcessRecord() ProcessRecord() ProcessRecord()

Do the follwing actions:

  1. If runspace is in opened state, a. stop any execution in process in the runspace b. close the runspace
  2. Remove the runspace from the global cache
ResolveAppName(String) ResolveAppName(String) ResolveAppName(String) 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) ResolveComputerName(String) ResolveComputerName(String) ResolveComputerName(String)

Resolves a computer name. If its null or empty its assumed to be localhost

(Inherited from PSRemotingCmdlet)
ResolveComputerNames(String[], String[]) ResolveComputerNames(String[], String[]) ResolveComputerNames(String[], String[]) ResolveComputerNames(String[], String[])

Resolve all the machine names provided. Basically, if a machine name is '.' assume localhost

(Inherited from PSRemotingCmdlet)
ResolveShell(String) ResolveShell(String) ResolveShell(String) 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) ShouldContinue(String, String) ShouldContinue(String, String) 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)
ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean) 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, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean) 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)
ShouldProcess(String) ShouldProcess(String) ShouldProcess(String) 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)
ShouldProcess(String, String) ShouldProcess(String, String) ShouldProcess(String, String) 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, String, String) ShouldProcess(String, String, String) ShouldProcess(String, String, String) 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, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason) 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)
StopProcessing() StopProcessing() StopProcessing() StopProcessing()

When overridden in the derived class, interrupts currently running code within the command. It should interrupt BeginProcessing, ProcessRecord, and EndProcessing. Default implementation in the base class just returns.

(Inherited from Cmdlet)
ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord)

Terminate the command and report an error

(Inherited from Cmdlet)
TransactionAvailable() TransactionAvailable() TransactionAvailable() TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from Cmdlet)
WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String)

Write text into pipeline execution log.

(Inherited from Cmdlet)
WriteDebug(String) WriteDebug(String) WriteDebug(String) WriteDebug(String)

Display debug information

(Inherited from Cmdlet)
WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord)

Internal variant: Writes the specified error to the error pipe.

(Inherited from Cmdlet)
WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord)

Route information to the user or host.

(Inherited from Cmdlet)
WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[])

Route information to the user or host.

(Inherited from Cmdlet)
WriteObject(Object) WriteObject(Object) WriteObject(Object) WriteObject(Object)

Writes the object to the output pipe.

(Inherited from Cmdlet)
WriteObject(Object, Boolean) WriteObject(Object, Boolean) WriteObject(Object, Boolean) 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)
WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord)

Display progress information

(Inherited from Cmdlet)
WriteVerbose(String) WriteVerbose(String) WriteVerbose(String) WriteVerbose(String)

Display verbose information

(Inherited from Cmdlet)
WriteWarning(String) WriteWarning(String) WriteWarning(String) WriteWarning(String)

Display warning information

(Inherited from Cmdlet)

Fields

ComputerInstanceIdParameterSet ComputerInstanceIdParameterSet ComputerInstanceIdParameterSet ComputerInstanceIdParameterSet

Computername with session instance ID parameter set

(Inherited from PSRemotingCmdlet)
ComputerNameParameterSet ComputerNameParameterSet ComputerNameParameterSet ComputerNameParameterSet

Computername parameter set

(Inherited from PSRemotingCmdlet)
ContainerIdInstanceIdParameterSet ContainerIdInstanceIdParameterSet ContainerIdInstanceIdParameterSet ContainerIdInstanceIdParameterSet

ContainerIdInstanceId parameter set: container id + session instance id

(Inherited from PSRunspaceCmdlet)
ContainerIdParameterSet ContainerIdParameterSet ContainerIdParameterSet ContainerIdParameterSet

Container ID parameter set

(Inherited from PSRemotingCmdlet)
DefaultPowerShellRemoteShellAppName DefaultPowerShellRemoteShellAppName DefaultPowerShellRemoteShellAppName DefaultPowerShellRemoteShellAppName

default application name for the connection uri

(Inherited from PSRemotingCmdlet)
DefaultPowerShellRemoteShellName DefaultPowerShellRemoteShellName DefaultPowerShellRemoteShellName DefaultPowerShellRemoteShellName

Default shellname

(Inherited from PSRemotingCmdlet)
IdParameterSet IdParameterSet IdParameterSet IdParameterSet

session id parameter set

(Inherited from PSRunspaceCmdlet)
InstanceIdParameterSet InstanceIdParameterSet InstanceIdParameterSet InstanceIdParameterSet

Runspace Id parameter set

(Inherited from PSRunspaceCmdlet)
NameParameterSet NameParameterSet NameParameterSet NameParameterSet

name parameter set

(Inherited from PSRunspaceCmdlet)
SessionParameterSet SessionParameterSet SessionParameterSet SessionParameterSet

runspace parameter set

(Inherited from PSRemotingCmdlet)
SSHHostHashParameterSet SSHHostHashParameterSet SSHHostHashParameterSet SSHHostHashParameterSet

SSH host parmeter set supporting hash connection parameters

(Inherited from PSRemotingCmdlet)
SSHHostParameterSet SSHHostParameterSet SSHHostParameterSet SSHHostParameterSet

SSH host parameter set

(Inherited from PSRemotingCmdlet)
VMIdInstanceIdParameterSet VMIdInstanceIdParameterSet VMIdInstanceIdParameterSet VMIdInstanceIdParameterSet

VMIdInstanceId parameter set: vm id + session instance id

(Inherited from PSRunspaceCmdlet)
VMIdParameterSet VMIdParameterSet VMIdParameterSet VMIdParameterSet

VM guid parameter set

(Inherited from PSRemotingCmdlet)
VMNameInstanceIdParameterSet VMNameInstanceIdParameterSet VMNameInstanceIdParameterSet VMNameInstanceIdParameterSet

VMNameInstanceId parameter set: vm name + session instance id

(Inherited from PSRunspaceCmdlet)
VMNameParameterSet VMNameParameterSet VMNameParameterSet VMNameParameterSet

VM name parameter set

(Inherited from PSRemotingCmdlet)

Applies to