Share via

EnterPSSessionCommand Class

  • Reference

Definition

Namespace:
Microsoft.PowerShell.Commands
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Enter-PSSession cmdlet.

public ref class EnterPSSessionCommand : Microsoft::PowerShell::Commands::PSRemotingBaseCmdlet
public class EnterPSSessionCommand : Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet
[System.Management.Automation.Cmdlet("Enter", "PSSession", DefaultParameterSetName="ComputerName", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096695", RemotingCapability=System.Management.Automation.RemotingCapability.OwnedByCommand)]
public class EnterPSSessionCommand : Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet
[System.Management.Automation.Cmdlet("Enter", "PSSession", DefaultParameterSetName="ComputerName", HelpUri="https://go.microsoft.com/fwlink/?LinkID=135210", RemotingCapability=System.Management.Automation.RemotingCapability.OwnedByCommand)]
public class EnterPSSessionCommand : Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet
type EnterPSSessionCommand = class
    inherit PSRemotingBaseCmdlet
[<System.Management.Automation.Cmdlet("Enter", "PSSession", DefaultParameterSetName="ComputerName", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096695", RemotingCapability=System.Management.Automation.RemotingCapability.OwnedByCommand)>]
type EnterPSSessionCommand = class
    inherit PSRemotingBaseCmdlet
[<System.Management.Automation.Cmdlet("Enter", "PSSession", DefaultParameterSetName="ComputerName", HelpUri="https://go.microsoft.com/fwlink/?LinkID=135210", RemotingCapability=System.Management.Automation.RemotingCapability.OwnedByCommand)>]
type EnterPSSessionCommand = class
    inherit PSRemotingBaseCmdlet
Public Class EnterPSSessionCommand
Inherits PSRemotingBaseCmdlet
Inheritance
Object
InternalCommand
Cmdlet
PSCmdlet
PSRemotingCmdlet
PSRemotingBaseCmdlet
EnterPSSessionCommand
Attributes
CmdletAttribute

Constructors

EnterPSSessionCommand()

Fields

ComputerInstanceIdParameterSet

Computername with session instance ID parameter set.

(Inherited from PSRemotingCmdlet)
ComputerNameParameterSet

Computername parameter set.

(Inherited from PSRemotingCmdlet)
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)
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)
UriParameterSet

Uri parameter set.

(Inherited from PSRemotingBaseCmdlet)
UseWindowsPowerShellParameterSet

Parameter set to use Windows PowerShell.

(Inherited from PSRemotingCmdlet)
VMIdParameterSet

VM guid parameter set.

(Inherited from PSRemotingCmdlet)
VMNameParameterSet

VM name parameter set.

(Inherited from PSRemotingCmdlet)

Properties

AllowRedirection

The AllowRedirection parameter enables the implicit redirection functionality.

(Inherited from PSRemotingBaseCmdlet)
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.

(Inherited from PSRemotingBaseCmdlet)
Authentication

Use basic authentication to authenticate the user.

(Inherited from PSRemotingBaseCmdlet)
CertificateThumbprint

Specifies the certificate thumbprint to be used to impersonate the user on the remote machine.

(Inherited from PSRemotingBaseCmdlet)
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 name parameter.
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 no configuration is used.
ConnectingTimeout

Gets or sets a value in milliseconds that limits the time allowed for an SSH connection to be established. Default timeout value is infinite.

(Inherited from PSRemotingBaseCmdlet)
ConnectionUri

ConnectionUri parameter.
ContainerId

The Id of the target container.
Credential

Specifies the credentials of the user to impersonate in the virtual 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)
EnableNetworkAccess

When set 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.
Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
HostName

Host name for an SSH remote connection.
HostName

Host name for an SSH remote connection.

(Inherited from PSRemotingBaseCmdlet)
Id

SessionId of the remote runspace info object.
InstanceId

RemoteRunspaceId of the remote runspace info object.
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)
KeyFilePath

SSH Key File Path.

(Inherited from PSRemotingBaseCmdlet)
MyInvocation

Contains information about the identity of this cmdlet and how it was invoked.

(Inherited from PSCmdlet)
Name

Name of the remote runspace info object.
Options

Gets or sets the Hashtable containing options to be passed to OpenSSH.
Options

Gets or sets the Hashtable containing options to be passed to OpenSSH.

(Inherited from PSRemotingBaseCmdlet)
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)

(Inherited from PSRemotingBaseCmdlet)
ResolvedComputerNames

Computer names after they have been resolved (null, empty string, "." resolves to localhost)

(Inherited from PSRemotingBaseCmdlet)
RunAsAdministrator

When set, PowerShell process inside container will be launched with high privileged account. Otherwise (default case), PowerShell process inside container will be launched with low privileged account.

(Inherited from