GetPSSessionCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

System.Management.Automation.dll

Package:

System.Management.Automation v7.4.0

This cmdlet is used to retrieve runspaces from the global cache and write it to the pipeline. The runspaces are wrapped and returned as PSSession objects.

The cmdlet can be used in the following ways:

List all the available runspaces get-pssession

Get the PSSession from session name get-pssession -Name sessionName

Get the PSSession for the specified ID get-pssession -Id sessionId

Get the PSSession for the specified instance Guid get-pssession -InstanceId sessionGuid

Get PSSessions from remote computer. Optionally filter on state, session instanceid or session name. get-psession -ComputerName computerName -StateFilter Disconnected

Get PSSessions from virtual machine. Optionally filter on state, session instanceid or session name. get-psession -VMName vmName -Name sessionName

Get PSSessions from container. Optionally filter on state, session instanceid or session name. get-psession -ContainerId containerId -InstanceId instanceId.

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

[System.Management.Automation.Cmdlet("Get", "PSSession", DefaultParameterSetName="Name", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096697", RemotingCapability=System.Management.Automation.RemotingCapability.OwnedByCommand)]
[System.Management.Automation.OutputType(typeof(System.Management.Automation.Runspaces.PSSession))]
public class GetPSSessionCommand : Microsoft.PowerShell.Commands.PSRunspaceCmdlet, IDisposable

[<System.Management.Automation.Cmdlet("Get", "PSSession", DefaultParameterSetName="Name", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096697", RemotingCapability=System.Management.Automation.RemotingCapability.OwnedByCommand)>]
[<System.Management.Automation.OutputType(typeof(System.Management.Automation.Runspaces.PSSession))>]
type GetPSSessionCommand = class
    inherit PSRunspaceCmdlet
    interface IDisposable

Public Class GetPSSessionCommand
Inherits PSRunspaceCmdlet
Implements IDisposable

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

PSRemotingCmdlet

PSRunspaceCmdlet

GetPSSessionCommand

Attributes

CmdletAttribute OutputTypeAttribute

Implements

IDisposable

Constructors

GetPSSessionCommand()

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

AllowRedirection	The AllowRedirection parameter enables the implicit redirection functionality.
ApplicationName	This parameters specifies the appname which identifies the connection end point on the remote machine. If this parameter is not specified then the value specified in DEFAULTREMOTEAPPNAME will be used. If that's not specified as well, then "WSMAN" will be used.
Authentication	Use basic authentication to authenticate the user.
CertificateThumbprint	Specifies the certificate thumbprint to be used to impersonate the user on the remote machine.
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	Computer names to connect to.
ConfigurationName	For WSMan sessions: If this parameter is not specified then the value specified in the environment variable DEFAULTREMOTESHELLNAME will be used. If this is not set as well, then Microsoft.PowerShell is used. For VM/Container sessions: If this parameter is not specified then all sessions that match other filters are returned.
ConnectionUri	A complete URI(s) specified for the remote computer and shell to connect to and create a runspace for.
ContainerId	ID of target container. (Inherited from PSRunspaceCmdlet)
Credential	Specifies the credentials of the user to impersonate in the remote machine. If this parameter is not specified then the credentials of the current user process will be assumed.
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)
InstanceId	Instance Ids to filter on.
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	Session names to filter on.
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)
Port	Port specifies the alternate port to be used in case the default ports are not used for the transport mechanism (port 80 for http and port 443 for useSSL)
SessionOption	Session options.
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
State	Filters returned remote runspaces based on runspace state.
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.
UseSSL	This parameter suggests that the transport scheme to be used for remote connections is useSSL instead of the default http.Since there are only two possible transport schemes that are possible at this point, a SwitchParameter is being used to switch between the two.
VMId	Guid of target virtual machine. (Inherited from PSRunspaceCmdlet)
VMName	Name of target virtual machine. (Inherited from PSRunspaceCmdlet)

Methods

BeginProcessing()	Resolves shellname.
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
Dispose()	Dispose method of IDisposable.
EndProcessing()	End processing clean up.
GetMatchingRunspaces(Boolean, Boolean)	Gets the matching runspaces based on the parameterset. (Inherited from PSRunspaceCmdlet)
GetMatchingRunspaces(Boolean, Boolean, SessionFilterState, String)	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)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(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()	Get the list of runspaces from the global cache and write them down. If no computername or instance id is specified then list all runspaces.
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)	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)	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)	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)	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)	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)	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)	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()	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)	Writes the object to the output pipe. (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)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)