WSManConnectionInfo Members
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Top
Top
Top
Top
Top
System.Management.Automation.Runspaces Namespace
Provides the connection information that is needed to connect to a remote runspace. Windows PowerShell uses a Windows Remote Management (WinRM) connection to connect to the computer where the remote runspace is opened. This class is introduced in Windows PowerShell 2.0.
The following tables list the members exposed by the WSManConnectionInfo type.
Public Constructors
| Name | Description | |
|---|---|---|
| WSManConnectionInfo | Creates a new WSManConnectionInfo object that connects only to the local computer. This constructor is introduced by Windows PowerShell 2.0. | |
| WSManConnectionInfo | Creates a new WSManConnectionInfo object that contains a Boolean value that indicates whether a secure connection such HTTPS is used, the name of the computer, credentials, and more. This constructor is introduced by Windows PowerShell 2.0. | |
| WSManConnectionInfo | Creates a new WSManConnectionInfo object that contains a Boolean value that indicates whether a secure connection such HTTPS is used, the maximum allowed time (in milliseconds) for the remote runspace to open, and more. This constructor is introduced by Windows PowerShell 2.0. | |
| WSManConnectionInfo | ||
| WSManConnectionInfo | Creates a new WSManConnectionInfo object that contains the schema, computer name, port, credentials, and more. This constructor is introduced by Windows PowerShell 2.0. | |
| WSManConnectionInfo | Creates a new WSManConnectionInfo object that contains the schema, computer name, the maximum allowed time (in milliseconds) for the remote runspace to open, and more. This constructor is introduced by Windows PowerShell 2.0. | |
| WSManConnectionInfo | Creates a new WSManConnectionInfo object that contains the Uniform Resource Identifier (URI) that defines the connection endpoint. This constructor is introduced by Windows PowerShell 2.0. | |
| WSManConnectionInfo | Creates a new WSManConnectionInfo object that contains the Uniform Resource Identifier (URI) of the connection endpoint, the URI of the shell, and the credentials used to make the connection. This constructor is introduced by Windows PowerShell 2.0. | |
| WSManConnectionInfo | Creates a new WSManConnectionInfo object that contains the Uniform Resource Identifier (URI) of the connection endpoint, the URI of the shell, and a thumbprint of the certificate used to make the connection. This constructor is introduced by Windows PowerShell 2.0. |
Public Fields
| Name | Description | |
|---|---|---|
|
HttpScheme | |
|
HttpsScheme |
Public Properties
| Name | Description | |
|---|---|---|
|
ConnectionUri | Gets the Uniform Resource Identifier (URI) that defines the connection endpoint. This property is introduced in Windows PowerShell 2.0. |
|
ComputerName | Overridden. Gets the name of the computer where the remote runspace is opened. This property is introduced in Windows PowerShell 2.0. |
|
Scheme | Gets the scheme used to make the connection. |
|
Port | Gets the number of the port used to make the remote connection. |
|
AppName | Gets the application name for the endpoint on the remote computer. This property is introduced in Windows PowerShell 2.0. |
|
Credential | Overridden. Gets the user account that has permission to make the connection. This property is introduced in Windows PowerShell 2.0. |
|
ShellUri | Gets the Uniform Resource Identifier (URI) of the shell that is launched when the connection is made. This property is introduced in Windows PowerShell 2.0. |
|
AuthenticationMechanism | Overridden. Gets the type of authentication mechanism used to create a PSSession using this connection, such as CredSSP authentication. This property is introduced in Windows PowerShell 2.0. |
|
CertificateThumbprint | Overridden. Gets the thumbprint of the digital public key certificate (X509) used to make the connection. This property is introduced in Windows PowerShell 2.0. |
|
MaximumConnectionRedirectionCount | Get the maximum Universal Resource Identifier (URI) redirection that is allowed of this connection. This property is introduced in Windows PowerShell 2.0. |
|
MaximumReceivedDataSizePerCommand | Gets the maximum amount of data (in bytes) that can be received using this connection. This property is introduced in Windows PowerShell 2.0. |
|
MaximumReceivedObjectSize | Gets the maximum size (in bytes) of a deserialized object that can be received from using this connection. This property is introduced in Windows PowerShell 2.0. |
|
UseCompression | Gets and sets a Boolean value that indicates whether the WSMan infrastructure compresses the data sent over the network. This property is introduced in Windows PowerShell 2.0. |
|
NoMachineProfile | Gets and sets a Boolean value that indicates whether the Windows profile of the user is loaded. |
|
ProxyAccessType | Gets and sets the mechanism that is used to resolve the host name. |
|
ProxyAuthentication | Gets and sets the authentication method that is used for proxy resolution. |
|
ProxyCredential | Gets and sets the credentials used to make the connection on the computer. |
|
SkipCACheck | Gets and sets Boolean value that indicates whether, when connecting over HTTPS, the client does not validate that the server certificate is signed by a trusted certificate authority (CA). |
|
SkipCNCheck | Gets and sets Boolean value that indicates whether the certificate common name (CN) of the server and the hostname of the server are not checked for being the same. |
|
SkipRevocationCheck | Gets and sets Boolean value that indicates whether the connect does not validate the revocation status of the server certificate. |
|
NoEncryption | Gets and sets a Boolean value that indicates whether data encryption is used . |
|
UseUTF16 | Gets and sets Boolean value that indicates whether requests are formatted in UTF16 format. |
|
OutputBufferingMode | |
|
Culture | Gets and sets the culture that is used when running commands in the remote runspace. (Inherited from RunspaceConnectionInfo) |
|
UICulture | Gets and sets the UI culture that is used when running commands in the remote runspace. (Inherited from RunspaceConnectionInfo) |
|
OpenTimeout | Gets and sets the maximum amount of time (in milliseconds) that Windows PowerShell will wait for an open operation to complete. (Inherited from RunspaceConnectionInfo) |
|
CancelTimeout | Gets and sets the maximum allowed time (in milliseconds) that Windows PowerShell will wait before it times due to a cancel operations, such as closing the runspace or stopping Windows PowerShell. (Inherited from RunspaceConnectionInfo) |
|
OperationTimeout | Gets and sets the amount of time (in milliseconds) that Windows PowerShell will wait for an operation to complete. (Inherited from RunspaceConnectionInfo) |
|
IdleTimeout | Gets and sets the amount of time (in milliseconds) that Windows PowerShell will wait for an idle operation to complete. (Inherited from RunspaceConnectionInfo) |
Public Methods
(see also Protected Methods)| Name | Description | |
|---|---|---|
![]() | ToString | (Inherited from Object) |
![]() | Equals | (Inherited from Object) |
![]() | GetHashCode | (Inherited from Object) |
![]() | GetType | (Inherited from Object) |
![]() | Copy | Creates a WSManConnectionInfo object that is the same as the current WSManConnectionInfo object. This method is introduced in Windows PowerShell 2.0. |
![]() | SetSessionOptions | Overridden. |
Protected Methods
| Name | Description | |
|---|---|---|
|
Finalize | (Inherited from Object) |
|
MemberwiseClone | (Inherited from Object) |
See Also
Reference
WSManConnectionInfo ClassSystem.Management.Automation.Runspaces Namespace
Other Resources
Windows PowerShell SDKSend comments about this topic to Microsoft.
