Register-PSSessionConfiguration

Syntax

NameParameterSet (Standard)

Register-PSSessionConfiguration
    [-Name] <String>
    [-ProcessorArchitecture <String>]
    [-ApplicationBase <String>]
    [-RunAsCredential <PSCredential>]
    [-ThreadApartmentState <ApartmentState>]
    [-ThreadOptions <PSThreadOptions>]
    [-AccessMode <PSSessionConfigurationAccessMode>]
    [-UseSharedProcess]
    [-StartupScript <String>]
    [-MaximumReceivedDataSizePerCommandMB <Double>]
    [-MaximumReceivedObjectSizeMB <Double>]
    [-SecurityDescriptorSddl <String>]
    [-ShowSecurityDescriptorUI]
    [-Force]
    [-NoServiceRestart]
    [-PSVersion <Version>]
    [-SessionTypeOption <PSSessionTypeOption>]
    [-TransportOption <PSTransportOption>]
    [-ModulesToImport <Object[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AssemblyNameParameterSet

Register-PSSessionConfiguration
    [-Name] <String>
    [-AssemblyName] <String>
    [-ConfigurationTypeName] <String>
    [-ProcessorArchitecture <String>]
    [-ApplicationBase <String>]
    [-RunAsCredential <PSCredential>]
    [-ThreadApartmentState <ApartmentState>]
    [-ThreadOptions <PSThreadOptions>]
    [-AccessMode <PSSessionConfigurationAccessMode>]
    [-UseSharedProcess]
    [-StartupScript <String>]
    [-MaximumReceivedDataSizePerCommandMB <Double>]
    [-MaximumReceivedObjectSizeMB <Double>]
    [-SecurityDescriptorSddl <String>]
    [-ShowSecurityDescriptorUI]
    [-Force]
    [-NoServiceRestart]
    [-PSVersion <Version>]
    [-SessionTypeOption <PSSessionTypeOption>]
    [-TransportOption <PSTransportOption>]
    [-ModulesToImport <Object[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SessionConfigurationFile

Register-PSSessionConfiguration
    [-Name] <String>
    -Path <String>
    [-ProcessorArchitecture <String>]
    [-RunAsCredential <PSCredential>]
    [-ThreadApartmentState <ApartmentState>]
    [-ThreadOptions <PSThreadOptions>]
    [-AccessMode <PSSessionConfigurationAccessMode>]
    [-UseSharedProcess]
    [-StartupScript <String>]
    [-MaximumReceivedDataSizePerCommandMB <Double>]
    [-MaximumReceivedObjectSizeMB <Double>]
    [-SecurityDescriptorSddl <String>]
    [-ShowSecurityDescriptorUI]
    [-Force]
    [-NoServiceRestart]
    [-TransportOption <PSTransportOption>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Exempel

Exempel 1: Registrera en Konfiguration av NewShell-sessioner

$sessionConfiguration = @{
    Name='NewShell'
    ApplicationBase='C:\MyShells\'
    AssemblyName='MyShell.dll'
    ConfigurationTypeName='MyClass'
}
Register-PSSessionConfiguration @sessionConfiguration

Exempel 2: Registrera en MaintenanceShell-sessionskonfiguration

Register-PSSessionConfiguration -Name MaintenanceShell -StartupScript C:\ps-test\Maintenance.ps1

Exempel 3: Registrera en sessionskonfiguration

$sddl = "O:NSG:BAD:P(A;;GA;;;BA)S:P(AU;FA;GA;;;WD)(AU;FASA;GWGX;;;WD)"
$sessionParams = @{
    Name="AdminShell"
    SecurityDescriptorSDDL=$sddl
    MaximumReceivedObjectSizeMB=20
    StartupScript="C:\scripts\AdminShell.ps1"
}
Register-PSSessionConfiguration @sessionParams

Exempel 4: Returnera ett konfigurationscontainerelement

$s = Register-PSSessionConfiguration -Name MaintenanceShell -StartupScript C:\ps-test\Maintenance.ps1
$s | Format-List -Property *
dir WSMan:\LocalHost\Plugin

PSPath            : Microsoft.WSMan.Management\WSMan::localhost\Plugin\MaintenanceShell
PSParentPath      : Microsoft.WSMan.Management\WSMan::localhost\Plugin
PSChildName       : MaintenanceShell
PSDrive           : WSMan
PSProvider        : Microsoft.WSMan.Management\WSMan
PSIsContainer     : True
Keys              : {Name=MaintenanceShell}
Name              : MaintenanceShell
TypeNameOfElement : Container

Name                      Type                 Keys
----                      ----                 ----
MaintenanceShell          Container            {Name=MaintenanceShell}
microsoft.powershell      Container            {Name=microsoft.powershell}
microsoft.powershell32    Container            {Name=microsoft.powershell32}

Exempel 5: Registrera en sessionskonfiguration med ett startskript

Register-PSSessionConfiguration -Name WithProfile -StartupScript Add-Profile.ps1

Parametrar

-AccessMode

Aktiverar och inaktiverar sessionskonfigurationen och avgör om den kan användas för fjärrsessioner eller lokala sessioner på datorn. De godtagbara värdena för den här parametern är:

• Avaktiverad. Inaktiverar sessionskonfigurationen. Den kan inte användas för fjärråtkomst eller lokal åtkomst till datorn.
• Lokal. Tillåter användare av den lokala datorn att använda sessionskonfigurationen för att skapa en lokal loopback-session på samma dator, men nekar åtkomst till fjärranvändare.
• Fjärrkontroll. Gör att lokala och fjärranslutna användare kan använda sessionskonfigurationen för att skapa sessioner och köra kommandon på den här datorn.

Standardvärdet är Fjärr.

Andra cmdletar kan åsidosätta värdet för den här parametern senare. Till exempel tillåter cmdleten Enable-PSRemoting fjärråtkomst till alla sessionskonfigurationer, Enable-PSSessionConfiguration-cmdleten aktiverar sessionskonfigurationer och cmdleten Disable-PSRemoting förhindrar fjärråtkomst till alla sessionskonfigurationer.

Den här parametern introducerades i PowerShell 3.0.

Parameteregenskaper

Parameteruppsättningar

-ApplicationBase

Anger sökvägen till sammansättningsfilen (*.dll) som anges i värdet för parametern AssemblyName. Använd den här parametern när värdet för parametern AssemblyName inte innehåller någon sökväg. Standardvärdet är den aktuella katalogen.

Parameteregenskaper

Parameteruppsättningar

-AssemblyName

Anger namnet på en sammansättningsfil (*.dll) där konfigurationstypen har definierats. Du kan ange sökvägen för .dll i den här parametern eller i värdet för parametern ApplicationBase.

Den här parametern krävs när du anger parametern ConfigurationTypeName.

Parameteregenskaper

Parameteruppsättningar

-ConfigurationTypeName

Anger det fullständigt kvalificerade namnet på den Microsoft .NET Framework-typ som används för den här konfigurationen. Den typ som du anger måste implementera klassen System.Management.Automation.Remoting.PSSessionConfiguration.

Om du vill ange sammansättningsfilen (*.dll) som implementerar konfigurationstypen anger du parametrarna AssemblyName och ApplicationBase.

Genom att skapa en typ kan du styra fler aspekter av sessionskonfigurationen, till exempel att exponera eller dölja vissa parametrar för cmdletar, eller ange datastorlek och objektstorleksgränser som användarna inte kan åsidosätta.

Om du utelämnar den här parametern används klassen DefaultRemotePowerShellConfiguration för sessionskonfigurationen.

Parameteregenskaper

Parameteruppsättningar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Parameteruppsättningar

-Force

Undertrycker alla användarprompter och startar om tjänsten WinRM utan att fråga. Om du startar om tjänsten blir konfigurationsändringen effektiv.

Om du vill förhindra en omstart och ignorera omstartsprompten anger du parametern NoServiceRestart.

Parameteregenskaper

Parameteruppsättningar

-MaximumReceivedDataSizePerCommandMB

Anger en gräns för hur mycket data som kan skickas till den här datorn i ett enda fjärrkommando. Ange datastorleken i megabyte (MB). Standardvärdet är 50 MB.

Om en datastorleksgräns definieras i den konfigurationstyp som anges i parametern ConfigurationTypeName används gränsen i konfigurationstypen och värdet för den här parametern ignoreras.

Parameteregenskaper

Parameteruppsättningar

-MaximumReceivedObjectSizeMB

Anger en gräns för hur mycket data som kan skickas till den här datorn i ett enskilt objekt. Ange datastorleken i megabyte. Standardvärdet är 10 MB.

Om en storleksgräns för objekt definieras i den konfigurationstyp som anges i parametern ConfigurationTypeName används gränsen i konfigurationstypen och värdet för den här parametern ignoreras.

Parameteregenskaper

Parameteruppsättningar

-ModulesToImport

Anger de moduler som automatiskt importeras till sessioner som använder sessionskonfigurationen.

Som standard importeras endast Microsoft.PowerShell.Core- till sessioner. Om inte cmdletarna undantas kan du använda Import-Module för att lägga till moduler i sessionen.

Modulerna som anges i det här parametervärdet importeras utöver moduler som anges av parametern SessionType och de som anges i ModulesToImportera-nyckeln i sessionskonfigurationsfilen (New-PSSessionConfigurationFile). Inställningarna i sessionskonfigurationsfilen kan dock dölja kommandon som exporteras av moduler eller hindra användare från att använda dem.

Den här parametern introducerades i PowerShell 3.0.

Parameteregenskaper

Parameteruppsättningar

-Name

Anger ett namn för sessionskonfigurationen. Den här parametern krävs.

Parameteregenskaper

Parameteruppsättningar

-NoServiceRestart

Startar inte om tjänsten WinRM och undertrycker uppmaningen att starta om tjänsten.

När du kör ett Register-PSSessionConfiguration-kommando uppmanas du som standard att starta om tjänsten WinRM för att den nya sessionskonfigurationen ska gälla. Den nya sessionskonfigurationen gäller inte förrän WinRM--tjänsten har startats om.

Om du vill starta om WinRM-tjänsten utan att fråga anger du parametern Force. Om du vill starta om tjänsten WinRM manuellt använder du cmdleten Restart-Service.

Den här funktionen implementerades i PowerShell 7.5.0-preview.4.

Parameteregenskaper

Parameteruppsättningar

-Path

Anger sökvägen och filnamnet för en sessionskonfigurationsfil (.pssc), till exempel en som skapats av New-PSSessionConfigurationFile. Om du utelämnar sökvägen är standardvärdet den aktuella katalogen.

Den här parametern introducerades i PowerShell 3.0.

Parameteregenskaper

Parameteruppsättningar

-ProcessorArchitecture

Avgör om en 32-bitars eller 64-bitars version av PowerShell-processen startas i sessioner som använder den här sessionskonfigurationen. De godtagbara värdena för den här parametern är: x86 (32-bitars) och AMD64 (64-bitars). Standardvärdet bestäms av processorarkitekturen på den dator som är värd för sessionskonfigurationen.

Du kan använda den här parametern för att skapa en 32-bitars session på en 64-bitars dator. Försök att skapa en 64-bitarsprocess på en 32-bitars dator misslyckas.

Parameteregenskaper

Parameteruppsättningar

-PSVersion

Anger versionen av PowerShell i sessioner som använder den här sessionskonfigurationen.

Värdet för den här parametern har företräde framför värdet för PowerShellVersion nyckel i sessionskonfigurationsfilen.

Den här parametern introducerades i PowerShell 3.0.

Parameteregenskaper

Parameteruppsättningar

-RunAsCredential

Anger autentiseringsuppgifter för kommandon i sessionen. Som standard körs kommandon med den aktuella användarens behörigheter.

Den här parametern introducerades i PowerShell 3.0.

Parameteregenskaper

Parameteruppsättningar

-SecurityDescriptorSddl

Anger en SDDL-sträng (Security Descriptor Definition Language) för konfigurationen.

Den här strängen avgör vilka behörigheter som krävs för att använda den nya sessionskonfigurationen. Om du vill använda en sessionskonfiguration i en session måste användarna ha minst behörigheten Kör (anropa) för konfigurationen.

Om säkerhetsbeskrivningen är komplex bör du överväga att använda parametern ShowSecurityDescriptorUI i stället för den här parametern. Du kan inte använda båda parametrarna i samma kommando.

Om du utelämnar den här parametern används rot-SDDL för tjänsten WinRM för den här konfigurationen. Om du vill visa eller ändra rot-SDDL använder du WSMan-providern. Till exempel Get-Item WSMan:\localhost\service\rootSDDL. Om du vill ha mer information om WSMan-providern skriver du Get-Help WSMan.

Parameteregenskaper

Parameteruppsättningar

-SessionTypeOption

Anger typspecifika alternativ för sessionskonfigurationen. Ange ett alternativobjekt för sessionstyp, till exempel PSWorkflowExecutionOption objekt som cmdleten New-PSWorkflowExecutionOption returnerar.

Alternativen för sessioner som använder sessionskonfigurationen bestäms av värdena för sessionsalternativen och sessionskonfigurationsalternativen. Om inget annat anges har de alternativ som angetts i sessionen, till exempel med hjälp av cmdleten New-PSSessionOption, företräde framför de alternativ som angetts i sessionskonfigurationen. Sessionsalternativvärden kan dock inte överskrida de högsta värden som anges i sessionskonfigurationen.

Den här parametern introducerades i PowerShell 3.0.

Parameteregenskaper

Parameteruppsättningar

-ShowSecurityDescriptorUI

Anger att den här cmdleten visar ett egenskapsblad som hjälper dig att skapa SDDL för sessionskonfigurationen. Egenskapsbladet visas när du har angett kommandot Register-PSSessionConfiguration och startar sedan om tjänsten WinRM.

När du anger behörigheterna för konfigurationen ska du komma ihåg att användarna måste ha minst behörigheten Kör (Anropa) för att kunna använda sessionskonfigurationen i en session.

Du kan inte använda parametern SecurityDescriptorSDDL och den här parametern i samma kommando.

Parameteregenskaper

Parameteruppsättningar

-StartupScript

Anger den fullständigt kvalificerade sökvägen för ett PowerShell-skript. Det angivna skriptet körs i den nya sessionen som använder sessionskonfigurationen.

Du kan använda skriptet för att dessutom konfigurera sessionen. Om skriptet genererar ett fel, inte ens ett icke-avslutande fel, skapas inte sessionen och kommandot New-PSSession misslyckas.

Parameteregenskaper

Parameteruppsättningar

-ThreadApartmentState

Anger lägenhetstillståndet för den trådmodul som ska användas. Godtagbara värden är:

• Okänd
• MTA
• STA

Parameteregenskaper

Parameteruppsättningar

-ThreadOptions

Anger hur trådar skapas och används när ett kommando körs i sessionen. De godtagbara värdena för den här parametern är:

• Förinställning
• ReuseThread (på engelska)
• UseCurrentThread (på engelska)
• UseNewThread

Standardvärdet är UseCurrentThread.

Mer information finns i PSThreadOptions Enumeration.

Parameteregenskaper

Parameteruppsättningar

-TransportOption

Anger transportalternativet.

Den här parametern introducerades i PowerShell 3.0.

Parameteregenskaper

Parameteruppsättningar

-UseSharedProcess

Använd bara en process för att vara värd för alla sessioner som startas av samma användare och använda samma sessionskonfiguration. Som standard körs varje session i sin egen process.

Den här parametern introducerades i PowerShell 3.0.

Parameteregenskaper

Parameteruppsättningar

-WhatIf

Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.

Parameteregenskaper

Parameteruppsättningar

CommonParameters

Indata

None

Utdata

WSManConfigContainerElement

Kommentarer

Relaterade länkar

• Inaktivera-PSSessionKonfiguration
• Aktivera-PSSessionKonfiguration
• Get-PSSessionConfiguration
• New-PSSessionConfigurationFile
• Set-PSSessionConfiguration
• Test-PSSessionskonfigurationsfil
• Avregistrera-PSSessionKonfiguration
• WSMan-leverantör
• om_Sessionskonfigurationer
• om_Sessionskonfigurationsfiler