WSManConnectionInfo
Class
Definition
Class which defines path to a remote runspace that need to be created
public sealed class WSManConnectionInfo : System.Management.Automation.Runspaces.RunspaceConnectionInfo
- Inheritance
Inherited Members
System.Management.Automation.Runspaces.RunspaceConnectionInfo
Constructors
| WSManConnectionInfo() |
Creates a WSManConnectionInfo for the following URI and with the default credentials, default server life time and default open timeout http://localhost/ The default shellname Microsoft.PowerShell will be used |
| WSManConnectionInfo(PSSessionType) |
Constructor that constructs the configuration name from its type |
| WSManConnectionInfo(Uri) |
constructor to create a WSManConnectionInfo with a uri specified and the default credentials, default server life time and default open timeout |
| WSManConnectionInfo(Uri, String, PSCredential) |
Constructor to create a WSManConnectionInfo with a uri and explicit credentials - server life time is default and open timeout is default |
| WSManConnectionInfo(Uri, String, String) |
Constructor used to create a WSManConnectionInfo. This constructor supports a certificate thumbprint to be used while connecting to a remote machine instead of credential. |
| WSManConnectionInfo(Boolean, String, Int32, String, String, PSCredential) |
Constructor used to create a WSManConnectionInfo |
| WSManConnectionInfo(String, String, Int32, String, String, PSCredential) |
Constructor used to create a WSManConnectionInfo |
| WSManConnectionInfo(Boolean, String, Int32, String, String, PSCredential, Int32) | |
| WSManConnectionInfo(String, String, Int32, String, String, PSCredential, Int32) |
Constructor used to create a WSManConnectionInfo |
Fields
| HttpScheme |
string for http scheme |
| HttpsScheme |
string for https scheme |
Properties
| AppName |
AppName which identifies the connection end point in the machine |
| AuthenticationMechanism |
Authentication mechanism to use while connecting to the server |
| CertificateThumbprint |
ThumbPrint of a certificate used for connecting to a remote machine. When this is specified, you dont need to supply credential and authentication mechanism. |
| ComputerName |
Name of the computer |
| ConnectionUri |
Uri associated with this connection path |
| Credential |
Credential used for the connection |
| EnableNetworkAccess |
When true and in loopback scenario (localhost) this enables creation of WSMan host process with the user interactive token, allowing PowerShell script network access, i.e., allows going off box. When this property is true and a PSSession is disconnected, reconnection is allowed only if reconnecting from a PowerShell session on the same box. |
| IncludePortInSPN |
Uses Service Principal Name (SPN) along with the Port number during authentication. |
| MaxConnectionRetryCount | |
| MaximumConnectionRedirectionCount |
Maximum uri redirection count |
| MaximumReceivedDataSizePerCommand |
Total data (in bytes) that can be received from a remote machine targeted towards a command. If null, then the size is unlimited. Default is unlimited data. |
| MaximumReceivedObjectSize |
Maximum size (in bytes) of a deserialized object received from a remote machine. If null, then the size is unlimited. Default is unlimited object size. |
| NoEncryption |
Specifies that no encryption will be used when doing remote operations over http. Unencrypted traffix is not allowed by default and must be enabled in the local configuration |
| NoMachineProfile |
If |
| OutputBufferingMode |
Determines how server in disconnected state deals with cached output data when the cache becomes filled. |
| Port |
Port in which to connect |
| ProxyAccessType |
By default, wsman uses IEConfig - the current user Internet Explorer proxy settings for the current active network connection. This option requires the user profile to be loaded, so the option can be directly used when called within a process that is running under an interactive user account identity; if the client application is running under a user context different then the interactive user, the client application has to explicitly load the user profile prior to using this option.
|
| ProxyAuthentication |
The following is the definition of the input parameter "ProxyAuthentication". This parameter takes a set of authentication methods the user can select from. The available options should be as follows:
|
| ProxyCredential |
The following is the definition of the input parameter "ProxyCredential". |
| Scheme |
Scheme used for connection |
| ShellUri | |
| SkipCACheck |
When connecting over HTTPS, the client does not validate that the server certificate is signed by a trusted certificate authority (CA). Use only when the remote computer is trusted by other means, for example, if the remote computer is part of a network that is physically secure and isolated or the remote computer is listed as a trusted host in WinRM configuration |
| SkipCNCheck |
Indicates that certificate common name (CN) of the server need not match the hostname of the server. Used only in remote operations using https. This option should only be used for trusted machines. |
| SkipRevocationCheck |
Indicates that certificate common name (CN) of the server need not match the hostname of the server. Used only in remote operations using https. This option should only be used for trusted machines |
| UseCompression |
If true, underlying WSMan infrastructure will compress data sent on the network. If false, data will not be compressed. Compression improves performance by reducing the amount of data sent on the network. Compression my require extra memory consumption and CPU usage. In cases where available memory / CPU is less, set this property to false. By default the value of this property is "true". |
| UseUTF16 |
Indicates the request is encoded in UTF16 format rather than UTF8 format; UTF8 is the default. |
Methods
| Copy() |
Does a shallow copy of the current instance |
| SetSessionOptions(PSSessionOption) |
Populates session options from a PSSessionOption instance. |