2
2
external help file : System.Management.Automation.dll-Help.xml
3
3
Locale : en-US
4
4
Module Name : Microsoft.PowerShell.Core
5
- ms.date : 06/05 /2024
5
+ ms.date : 07/24 /2024
6
6
online version : https://learn.microsoft.com/powershell/module/microsoft.powershell.core/register-pssessionconfiguration?view=powershell-5.1&WT.mc_id=ps-gethelp
7
7
schema : 2.0.0
8
8
title : Register-PSSessionConfiguration
60
60
61
61
Every PowerShell session (** PSSession** ) uses a session configuration, also known as an endpoint.
62
62
When users create a session that connects to the computer, they can select a session configuration
63
- or use the default session configuration that is registered when you enable PowerShell remoting.
63
+ or use the default session configuration that's registered when you enable PowerShell remoting.
64
64
Users can also set the $PSSessionConfigurationName preference variable, which specifies a default
65
65
configuration for remote sessions created in the current session.
66
66
@@ -74,8 +74,10 @@ You can define the elements of configuration by using an assembly that implement
74
74
configuration class and by using a script that runs in the session. Beginning in PowerShell
75
75
3.0, you can also use a session configuration file to define the session configuration.
76
76
77
- For information about session configurations, see [ about_Session_Configurations] ( About/about_Session_Configurations.md ) .
78
- For information about session configuration files, see [ about_Session_Configuration_Files] ( About/about_Session_Configuration_Files.md ) .
77
+ For information about session configurations, see
78
+ [ about_Session_Configurations] ( About/about_Session_Configurations.md ) . For information about session
79
+ configuration files, see
80
+ [ about_Session_Configuration_Files] ( About/about_Session_Configuration_Files.md ) .
79
81
80
82
## EXAMPLES
81
83
@@ -189,7 +191,7 @@ information about dot sourcing, see [about_Scopes](./About/about_Scopes.md).
189
191
Enables and disables the session configuration and determines whether it can be used for remote or
190
192
local sessions on the computer. The acceptable values for this parameter are:
191
193
192
- - Disabled. Disables the session configuration. It cannot be used for remote or local access to the
194
+ - Disabled. Disables the session configuration. It can't be used for remote or local access to the
193
195
computer.
194
196
- Local. Allows users of the local computer to use the session configuration to create a local
195
197
loopback session on the same computer, but denies access to remote users.
@@ -220,9 +222,9 @@ Accept wildcard characters: False
220
222
221
223
### -ApplicationBase
222
224
223
- Specifies the path of the assembly file (\ * .dll) that is specified in the value of the
224
- **AssemblyName** parameter. Use this parameter when the value of the **AssemblyName** parameter does
225
- not include a path. The default is the current directory.
225
+ Specifies the path of the assembly file (` *.dll` ) that's specified in the value of the
226
+ **AssemblyName** parameter. Use this parameter when the value of the **AssemblyName** parameter
227
+ doesn't include a path. The default is the current directory.
226
228
227
229
` ` ` yaml
228
230
Type: System.String
@@ -257,15 +259,15 @@ Accept wildcard characters: False
257
259
258
260
# ## -ConfigurationTypeName
259
261
260
- Specifies the fully qualified name of the Microsoft .NET Framework type that is used for this
262
+ Specifies the fully qualified name of the Microsoft .NET Framework type that's used for this
261
263
configuration. The type that you specify must implement the
262
264
**System.Management.Automation.Remoting.PSSessionConfiguration** class.
263
265
264
- To specify the assembly file (\ * .dll) that implements the configuration type, specify the
266
+ To specify the assembly file (` *.dll` ) that implements the configuration type, specify the
265
267
**AssemblyName** and **ApplicationBase** parameters.
266
268
267
269
Creating a type lets you control more aspects of the session configuration, such as exposing or
268
- hiding certain parameters of cmdlets, or setting data size and object size limits that users cannot
270
+ hiding certain parameters of cmdlets, or setting data size and object size limits that users can't
269
271
override.
270
272
271
273
If you omit this parameter, the **DefaultRemotePowerShellConfiguration** class is used for the
@@ -307,7 +309,7 @@ Accept wildcard characters: False
307
309
Specifies a limit for the amount of data that can be sent to this computer in any single remote
308
310
command. Enter the data size in megabytes (MB). The default is 50 MB.
309
311
310
- If a data size limit is defined in the configuration type that is specified in the
312
+ If a data size limit is defined in the configuration type that's specified in the
311
313
**ConfigurationTypeName** parameter, the limit in the configuration type is used and the value of
312
314
this parameter is ignored.
313
315
@@ -318,7 +320,7 @@ Aliases:
318
320
319
321
Required : False
320
322
Position : Named
321
- Default value : 50
323
+ Default value : None
322
324
Accept pipeline input : False
323
325
Accept wildcard characters : False
324
326
` ` `
@@ -328,7 +330,7 @@ Accept wildcard characters: False
328
330
Specifies a limit for the amount of data that can be sent to this computer in any single object.
329
331
Enter the data size in megabytes. The default is 10 MB.
330
332
331
- If an object size limit is defined in the configuration type that is specified in the
333
+ If an object size limit is defined in the configuration type that's specified in the
332
334
**ConfigurationTypeName** parameter, the limit in the configuration type is used and the value of
333
335
this parameter is ignored.
334
336
@@ -390,8 +392,10 @@ Accept wildcard characters: False
390
392
# ## -NoServiceRestart
391
393
392
394
The intent of this parameter is to prevent the restart the **WinRM** service. This functionality
393
- isn't implemented. This will be fixed in PowerShell 7.5, but there is no plan to back port this
394
- change to Windows PowerShell 5.1.
395
+ isn't implemented.
396
+
397
+ This functionality was implemented in PowerShell 7.5.0-preview.4, but there's no plan to back
398
+ port this change to Windows PowerShell 5.1.
395
399
396
400
` ` ` yaml
397
401
Type: System.Management.Automation.SwitchParameter
@@ -496,7 +500,7 @@ use a session configuration in a session, users must have at least Execute (Invo
496
500
the configuration.
497
501
498
502
If the security descriptor is complex, consider using the **ShowSecurityDescriptorUI** parameter
499
- instead of this parameter. You cannot use both parameters in the same command.
503
+ instead of this parameter. You can't use both parameters in the same command.
500
504
501
505
If you omit this parameter, the root SDDL for the **WinRM** service is used for this configuration.
502
506
To view or change the root SDDL, use the WSMan provider. For example
@@ -558,7 +562,7 @@ returns.
558
562
The options of sessions that use the session configuration are determined by the values of session
559
563
options and the session configuration options. Unless specified, options set in the session, such as
560
564
by using the `New-PSSessionOption` cmdlet, take precedence over options set in the session
561
- configuration. However, session option values cannot exceed maximum values set in the session
565
+ configuration. However, session option values can't exceed maximum values set in the session
562
566
configuration.
563
567
564
568
This parameter was introduced in PowerShell 3.0.
@@ -584,7 +588,7 @@ command and then restart the **WinRM** service.
584
588
When setting the permissions for the configuration, remember that users must have at least Execute
585
589
(Invoke) permission to use the session configuration in a session.
586
590
587
- You cannot use the **SecurityDescriptorSDDL** parameter and this parameter in the same command.
591
+ You can't use the **SecurityDescriptorSDDL** parameter and this parameter in the same command.
588
592
589
593
` ` ` yaml
590
594
Type: System.Management.Automation.SwitchParameter
@@ -604,7 +608,7 @@ Specifies the fully qualified path of a PowerShell script. The specified script
604
608
session that uses the session configuration.
605
609
606
610
You can use the script to additionally configure the session. If the script generates an error, even
607
- a non-terminating error, the session is not created and the `New-PSSession` command fails.
611
+ a non-terminating error, the session isn't created and the `New-PSSession` command fails.
608
612
609
613
` ` ` yaml
610
614
Type: System.String
@@ -619,9 +623,12 @@ Accept wildcard characters: False
619
623
` ` `
620
624
621
625
# ## -ThreadApartmentState
622
- Specifies the apartment state of the threads in the session.
623
- The acceptable values for this parameter are : STA, MTA, and Unknown.
624
- The default value is Unknown.
626
+
627
+ Specifies the apartment state of the threading module to be used. Acceptable values are :
628
+
629
+ - Unknown
630
+ - MTA
631
+ - STA
625
632
626
633
` ` ` yaml
627
634
Type: System.Threading.ApartmentState
@@ -718,7 +725,7 @@ Accept wildcard characters: False
718
725
719
726
# ## -WhatIf
720
727
721
- Shows what would happen if the cmdlet runs. The cmdlet is not run.
728
+ Shows what would happen if the cmdlet runs. The cmdlet isn't run.
722
729
723
730
` ` ` yaml
724
731
Type: System.Management.Automation.SwitchParameter
0 commit comments