Freigeben über


NamedPipeConnectionInfo Class

Definition

Class used to create an Out-Of-Process Runspace/RunspacePool between two local processes using a named pipe for IPC. This class does not have a dependency on WSMan and is used to implement the PowerShell attach-to-process feature.

public ref class NamedPipeConnectionInfo sealed : System::Management::Automation::Runspaces::RunspaceConnectionInfo
public sealed class NamedPipeConnectionInfo : System.Management.Automation.Runspaces.RunspaceConnectionInfo
type NamedPipeConnectionInfo = class
    inherit RunspaceConnectionInfo
Public NotInheritable Class NamedPipeConnectionInfo
Inherits RunspaceConnectionInfo
Inheritance
NamedPipeConnectionInfo

Constructors

NamedPipeConnectionInfo()

Initializes a new instance of the NamedPipeConnectionInfo class.

NamedPipeConnectionInfo(Int32)

Initializes a new instance of the NamedPipeConnectionInfo class.

NamedPipeConnectionInfo(Int32, String)

Initializes a new instance of the NamedPipeConnectionInfo class.

NamedPipeConnectionInfo(Int32, String, Int32)

Initializes a new instance of the NamedPipeConnectionInfo class.

NamedPipeConnectionInfo(String)

Initializes a new instance of the NamedPipeConnectionInfo class.

NamedPipeConnectionInfo(String, Int32)

Initializes a new instance of the NamedPipeConnectionInfo class.

Fields

MaxPort

Maximum value for port.

(Inherited from RunspaceConnectionInfo)
MinPort

Minimum value for port.

(Inherited from RunspaceConnectionInfo)

Properties

AppDomainName

Optional application domain name. If not specified then the default application domain is used.

AuthenticationMechanism

Authentication.

CancelTimeout

The duration (in ms) for which PowerShell should wait before it times out on cancel operations (close runspace or stop powershell). For instance, when the user hits ctrl-C, New-PSSession cmdlet tries to call a stop on all remote runspaces which are in the Opening state. The administrator wouldn't mind waiting for 15 seconds, but this should be time bound and of a shorter duration. A high timeout here like 3 minutes will give the administrator a feeling that the PowerShell client is not responding.

(Inherited from RunspaceConnectionInfo)
CertificateThumbprint

CertificateThumbprint.

ComputerName

Computer is always localhost.

Credential

Credential.

Culture

Culture that the remote session should use.

(Inherited from RunspaceConnectionInfo)
CustomPipeName

Gets or sets the custom named pipe name to connect to. This is usually used in conjunction with pwsh -CustomPipeName.

IdleTimeout

The duration (in ms) for which a Runspace on server needs to wait before it declares the client dead and closes itself down. This is especially important as these values may have to be configured differently for enterprise administration and exchange scenarios.

(Inherited from RunspaceConnectionInfo)
MaxIdleTimeout

The maximum allowed idle timeout duration (in ms) that can be set on a Runspace. This is a read-only property that is set once the Runspace is successfully created and opened.

(Inherited from RunspaceConnectionInfo)
OpenTimeout

The duration (in ms) for which PowerShell remoting waits before timing out on a connection to a remote machine. Simply put, the timeout for a remote runspace creation. The administrator would like to tweak this timeout depending on whether he/she is connecting to a machine in the data center or across a slow WAN.

(Inherited from RunspaceConnectionInfo)
OperationTimeout

The duration for which PowerShell remoting waits before timing out for any operation. The user would like to tweak this timeout depending on whether he/she is connecting to a machine in the data center or across a slow WAN.

Default: 3601000 == 3minutes.

(Inherited from RunspaceConnectionInfo)
ProcessId

Process Id of process to attach to.

UICulture

UI culture that the remote session should use.

(Inherited from RunspaceConnectionInfo)

Methods

Clone()

Create a copy of the connection info object.

Clone()

Create a copy of the connection info object.

(Inherited from RunspaceConnectionInfo)
CreateClientSessionTransportManager(Guid, String, PSRemotingCryptoHelper)

Creates the appropriate client session transportmanager.

CreateClientSessionTransportManager(Guid, String, PSRemotingCryptoHelper)

Creates the appropriate client session transportmanager.

(Inherited from RunspaceConnectionInfo)
SetSessionOptions(PSSessionOption)

Populates session options from a PSSessionOption instance.

(Inherited from RunspaceConnectionInfo)

Applies to