RegisterPSSessionConfigurationCommand RegisterPSSessionConfigurationCommand RegisterPSSessionConfigurationCommand RegisterPSSessionConfigurationCommand Class

Definition

Class implementing Register-PSSessionConfiguration

public ref class RegisterPSSessionConfigurationCommand sealed : Microsoft::PowerShell::Commands::PSSessionConfigurationCommandBase
[System.Management.Automation.Cmdlet("Register", "PSSessionConfiguration", ConfirmImpact=System.Management.Automation.ConfirmImpact.Medium, DefaultParameterSetName="NameParameterSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=144306", SupportsShouldProcess=true)]
public sealed class RegisterPSSessionConfigurationCommand : Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase
type RegisterPSSessionConfigurationCommand = class
    inherit PSSessionConfigurationCommandBase
Public NotInheritable Class RegisterPSSessionConfigurationCommand
Inherits PSSessionConfigurationCommandBase
Inheritance
Attributes

Constructors

RegisterPSSessionConfigurationCommand() RegisterPSSessionConfigurationCommand() RegisterPSSessionConfigurationCommand() RegisterPSSessionConfigurationCommand()

Properties

AccessMode AccessMode AccessMode AccessMode

Set access mode

(Inherited from PSSessionConfigurationCommandBase)
ApplicationBase ApplicationBase ApplicationBase ApplicationBase

This parameter can accompany with AssemblyName. This supplies the directory to search while loading the assembly specified with parameter AssemblyName. Environment variables are accepted in the string value.

(Inherited from PSSessionConfigurationCommandBase)
AssemblyName AssemblyName AssemblyName AssemblyName

This parameter enables the user to load an Assembly and supply InitialSessionstate for each user connecting to the shell.

(Inherited from PSSessionConfigurationCommandBase)
CommandOrigin CommandOrigin CommandOrigin CommandOrigin

This property tells you if you were being invoked inside the runspace or if it was an external request.

(Inherited from InternalCommand)
CommandRuntime CommandRuntime CommandRuntime CommandRuntime

Holds the command runtime object for this command. This object controls what actually happens when a write is called.

(Inherited from Cmdlet)
ConfigurationTypeName ConfigurationTypeName ConfigurationTypeName ConfigurationTypeName

This parameter should be specified with AssemblyName. This supplies the type to load to get the InitialSessionState. The type should be derived from PSSessionConfiguration.

(Inherited from PSSessionConfigurationCommandBase)
CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction

(Inherited from Cmdlet)
Events Events Events Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
Force Force Force Force

Property that sets force parameter. This will allow restarting the WinRM service after the changes were made.

(Inherited from PSSessionConfigurationCommandBase)
Host Host Host Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
InvokeCommand InvokeCommand InvokeCommand InvokeCommand

Provides access to utility routines for executing scripts and creating script blocks.

(Inherited from PSCmdlet)
InvokeProvider InvokeProvider InvokeProvider InvokeProvider

Gets the instance of the provider interface APIs for the current runspace.

(Inherited from PSCmdlet)
JobManager JobManager JobManager JobManager

Manager for JobSourceAdapters registered.

(Inherited from PSCmdlet)
JobRepository JobRepository JobRepository JobRepository

Repository for jobs

(Inherited from PSCmdlet)
MaximumReceivedDataSizePerCommandMB MaximumReceivedDataSizePerCommandMB MaximumReceivedDataSizePerCommandMB MaximumReceivedDataSizePerCommandMB

Total data (in MB) that can be received from a remote machine targeted towards a command.

(Inherited from PSSessionConfigurationCommandBase)
MaximumReceivedObjectSizeMB MaximumReceivedObjectSizeMB MaximumReceivedObjectSizeMB MaximumReceivedObjectSizeMB

Maximum size (in MB) of a deserialized object received from a remote machine.

(Inherited from PSSessionConfigurationCommandBase)
ModulesToImport ModulesToImport ModulesToImport ModulesToImport

ModulesToImport

(Inherited from PSSessionConfigurationCommandBase)
MyInvocation MyInvocation MyInvocation MyInvocation

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

(Inherited from PSCmdlet)
Name Name Name Name

This parameter enables the user to specify a shell name for the created custom shell.

(Inherited from PSSessionConfigurationCommandBase)
NoServiceRestart NoServiceRestart NoServiceRestart NoServiceRestart

If true, then the cmdlet will not attempt to restart WinRM service after completion. Typically WinRM service need to be restarted for changes to take place.

(Inherited from PSSessionConfigurationCommandBase)
PagingParameters PagingParameters PagingParameters 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 ParameterSetName ParameterSetName ParameterSetName

The name of the parameter set in effect.

(Inherited from PSCmdlet)
Path Path Path Path

Declaration initial session config file path

(Inherited from PSSessionConfigurationCommandBase)
ProcessorArchitecture ProcessorArchitecture ProcessorArchitecture ProcessorArchitecture

Parameter used to specify the Processor Architecture that this shell targets. On a 64bit base OS, specifying a value of 32 means that the shell is configured to launch like a 32bit process (WOW64).

PSVersion PSVersion PSVersion PSVersion

Property corresponding to PSVersion parameter in the ConfigXML. This is treated as the minimum PowerShell version to load. This will allow existing endpoints creating during migration or upgrade that have PSVersion=2.0 to roll forward to PowerShell 3.0 automatically without changing the ConfigXML.

(Inherited from PSSessionConfigurationCommandBase)
RunAsCredential RunAsCredential RunAsCredential RunAsCredential

Parameter used to specify the RunAs credentials.

(Inherited from PSSessionConfigurationCommandBase)
RunAsVirtualAccount RunAsVirtualAccount RunAsVirtualAccount RunAsVirtualAccount Inherited from PSSessionConfigurationCommandBase
RunAsVirtualAccountGroups RunAsVirtualAccountGroups RunAsVirtualAccountGroups RunAsVirtualAccountGroups

Comma delimited string specifying groups a virtual account is associated with

(Inherited from PSSessionConfigurationCommandBase)
RunAsVirtualAccountSpecified RunAsVirtualAccountSpecified RunAsVirtualAccountSpecified RunAsVirtualAccountSpecified Inherited from PSSessionConfigurationCommandBase
SecurityDescriptorSddl SecurityDescriptorSddl SecurityDescriptorSddl SecurityDescriptorSddl

This enables the user to specify an SDDL on the shell. The default SDDL is the default used by Wsman.

(Inherited from PSSessionConfigurationCommandBase)
SessionState SessionState SessionState SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
SessionType SessionType SessionType SessionType

SessionType

SessionTypeOption SessionTypeOption SessionTypeOption SessionTypeOption

SessionTypeOption

(Inherited from PSSessionConfigurationCommandBase)
ShowSecurityDescriptorUI ShowSecurityDescriptorUI ShowSecurityDescriptorUI ShowSecurityDescriptorUI

Shows a UI to choose permissions/access rights for this session configuration.

(Inherited from PSSessionConfigurationCommandBase)
StartupScript StartupScript StartupScript StartupScript

Initialization script to run upon Runspace creation for this shell.

(Inherited from PSSessionConfigurationCommandBase)
Stopping Stopping Stopping Stopping

Is this command stopping?

(Inherited from Cmdlet)
ThreadApartmentState ThreadApartmentState ThreadApartmentState ThreadApartmentState

ApartmentState of the Runspace created for the shell.

(Inherited from PSSessionConfigurationCommandBase)
ThreadOptions ThreadOptions ThreadOptions ThreadOptions

ThreadOptions of the Runspace created for the shell.

(Inherited from PSSessionConfigurationCommandBase)
TransportOption TransportOption TransportOption TransportOption

TransportOption

(Inherited from PSSessionConfigurationCommandBase)
UseSharedProcess UseSharedProcess UseSharedProcess UseSharedProcess

Host mode

(Inherited from PSSessionConfigurationCommandBase)

Methods

BeginProcessing() BeginProcessing() BeginProcessing() BeginProcessing()

When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns.

(Inherited from Cmdlet)
CurrentProviderLocation(String) CurrentProviderLocation(String) CurrentProviderLocation(String) CurrentProviderLocation(String) Inherited from PSCmdlet
EndProcessing() EndProcessing() EndProcessing() EndProcessing()

When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns.

(Inherited from Cmdlet)
GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) Inherited from PSCmdlet
GetResourceString(String, String) GetResourceString(String, String) GetResourceString(String, String) GetResourceString(String, String)

Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior.

(Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) Inherited from PSCmdlet
GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) Inherited from PSCmdlet
GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) Inherited from PSCmdlet
Invoke() Invoke() Invoke() Invoke()

Invoke this cmdlet object returning a collection of results.

(Inherited from Cmdlet)
Invoke<T>() Invoke<T>() Invoke<T>() Invoke<T>()

Returns a strongly-typed enumerator for the results of this cmdlet.

(Inherited from Cmdlet)
ProcessRecord() ProcessRecord() ProcessRecord() ProcessRecord()

When overridden in the derived class, performs execution of the command.

(Inherited from Cmdlet)
ShouldContinue(String, String) ShouldContinue(String, String) ShouldContinue(String, String) ShouldContinue(String, String)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll.

(Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll.

(Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll.

(Inherited from Cmdlet)
ShouldProcess(String) ShouldProcess(String) ShouldProcess(String) ShouldProcess(String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

(Inherited from Cmdlet)
ShouldProcess(String, String) ShouldProcess(String, String) ShouldProcess(String, String) ShouldProcess(String, String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify text for both the target resource and the action.

(Inherited from Cmdlet)
ShouldProcess(String, String, String) ShouldProcess(String, String, String) ShouldProcess(String, String, String) ShouldProcess(String, String, String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify the complete text describing the operation, rather than just the name and action.

(Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify the complete text describing the operation, rather than just the name and action.

(Inherited from Cmdlet)
StopProcessing() StopProcessing() StopProcessing() StopProcessing()

When overridden in the derived class, interrupts currently running code within the command. It should interrupt BeginProcessing, ProcessRecord, and EndProcessing. Default implementation in the base class just returns.

(Inherited from Cmdlet)
ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord)

Terminate the command and report an error

(Inherited from Cmdlet)
TransactionAvailable() TransactionAvailable() TransactionAvailable() TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from Cmdlet)
WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String)

Write text into pipeline execution log.

(Inherited from Cmdlet)
WriteDebug(String) WriteDebug(String) WriteDebug(String) WriteDebug(String)

Display debug information

(Inherited from Cmdlet)
WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord)

Internal variant: Writes the specified error to the error pipe.

(Inherited from Cmdlet)
WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord)

Route information to the user or host.

(Inherited from Cmdlet)
WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[])

Route information to the user or host.

(Inherited from Cmdlet)
WriteObject(Object) WriteObject(Object) WriteObject(Object) WriteObject(Object)

Writes the object to the output pipe.

(Inherited from Cmdlet)
WriteObject(Object, Boolean) WriteObject(Object, Boolean) WriteObject(Object, Boolean) WriteObject(Object, Boolean)

Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually.

(Inherited from Cmdlet)
WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord)

Display progress information

(Inherited from Cmdlet)
WriteVerbose(String) WriteVerbose(String) WriteVerbose(String) WriteVerbose(String)

Display verbose information

(Inherited from Cmdlet)
WriteWarning(String) WriteWarning(String) WriteWarning(String) WriteWarning(String)

Display warning information

(Inherited from Cmdlet)

Applies to