Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

PSSession Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Provides information about a Windows PowerShell session on a local or remote computer. This object is returned by the New-PSSession and Get-PSSession cmdlets, and is used by the Enter-PsSession and Exit-PsSession cmdlets to specify a session.

Namespace:   System.Management.Automation.Runspaces
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

System.Object
  System.Management.Automation.Runspaces.PSSession

public sealed class PSSession

NameDescription
System_CAPS_pubpropertyApplicationPrivateData

Gets private data for the application that is running Windows PowerShell on the computer where the session is created.

System_CAPS_pubpropertyAvailability

Gets an indicator that identifies the availability of the session.

System_CAPS_pubpropertyComputerName

Gets the name of the computer where the session is created.

System_CAPS_pubpropertyComputerType

Type of the computer target.

System_CAPS_pubpropertyConfigurationName

Gets the name of the session configuration that was used to create the session.

System_CAPS_pubpropertyContainerId

Id of the container target.

System_CAPS_pubpropertyContainerName

Gets or sets the name of the container target.

System_CAPS_pubpropertyId

Gets an identifier for the session that is unique only for the session that ran the New-PSSession cmdlet.

System_CAPS_pubpropertyInstanceId

Gets the unique identifier of this instance of the session. This identifier can be used to identify this instance of the session when running cmdlets.

System_CAPS_pubpropertyName

Gets and sets the user friendly name for the session. This name can be used to identify the session when running cmdlets.

System_CAPS_pubpropertyRunspace

Gets information about the runspace for the session.

System_CAPS_pubpropertyVMId

Guid of the virtual machine target.

System_CAPS_pubpropertyVMName

Name of the virtual machine target.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

Retrieves a string that represents the PSSession. Introduced in Windows PowerShell 3.0.(Overrides Object.ToString().)

This class cannot be inherited.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: