DSCResources/MSFT_xRDSessionCollectionConfiguration/en-US/about_xRDSessionCollectionConfiguration.help.txt
|
.NAME
xRDSessionCollectionConfiguration .DESCRIPTION This resource is used to configure the Remote Desktop Collection Configuration. .PARAMETER CollectionName Key - String Specifies the name of a session collection. .PARAMETER ActiveSessionLimitMin Write - UInt32 Specifies the maximum time, in minutes, an active session runs. After this period, the RD Session Host server ends the session. .PARAMETER AuthenticateUsingNLA Write - Boolean Indicates whether to use Network Level Authentication (NLA). If this value is $True, Remote Desktop uses NLA to authenticate a user before the user sees a logon screen. .PARAMETER AutomaticReconnectionEnabled Write - Boolean Indicates whether the Remote Desktop client attempts to reconnect after a connection interruption. .PARAMETER BrokenConnectionAction Write - String Specifies an action for an RD Session Host server to take after a connection interruption. The acceptable values for this parameter are: None, Disconnect, LogOff. .PARAMETER ClientDeviceRedirectionOptions Write - String Specifies a type of client device to be redirected to an RD Session Host server in this session collection. The acceptable values for this parameter are: None, AudioVideoPlayBack, AudioRecording, COMPort, PlugAndPlayDevice, SmartCard, Clipboard, LPTPort, Drive, TimeZone. You can use binary-or to combine two or more values of this enum to specify multiple client device types. .PARAMETER ClientPrinterAsDefault Write - Boolean Indicates whether to use the client printer or server printer as the default printer. If this value is $True, use the client printer as default. If this value is $False, use the server as default. .PARAMETER ClientPrinterRedirected Write - Boolean Indicates whether to use client printer redirection, which routes print jobs from the Remote Desktop session to a printer attached to the client computer. .PARAMETER CollectionDescription Write - String Specifies a description of the session collection. .PARAMETER ConnectionBroker Write - String Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment. .PARAMETER CustomRdpProperty Write - String Specifies Remote Desktop Protocol (RDP) settings to include in the .rdp files for all Windows Server 2012 RemoteApp programs and remote desktops published in this collection. .PARAMETER DisconnectedSessionLimitMin Write - UInt32 Specifies a length of time, in minutes. After client disconnection from a session for this period, the RD Session Host ends the session. .PARAMETER EncryptionLevel Write - String Specifies the level of data encryption used for a Remote Desktop session. The acceptable values for this parameter are: Low, ClientCompatible, High, FipsCompliant. The default value is ClientCompatible. .PARAMETER IdleSessionLimitMin Write - UInt32 Specifies the length of time, in minutes, to wait before an RD Session Host logs off or disconnects an idle session. The BrokenConnectionAction parameter determines whether to log off or disconnect. .PARAMETER MaxRedirectedMonitors Write - UInt32 Specifies the maximum number of client monitors that an RD Session Host server can redirect to a remote session. The highest value for this parameter is 16. .PARAMETER RDEasyPrintDriverEnabled Write - Boolean Specifies whether to enable the Remote Desktop Easy Print driver. .PARAMETER SecurityLayer Write - String Specifies which security protocol to use. The acceptable values for this parameter are: RDP, Negotiate, SSL. The default value is Negotiate. .PARAMETER TemporaryFoldersDeletedOnExit Write - Boolean Specifies whether to delete temporary folders from the RD Session Host server for a disconnected session. .PARAMETER UserGroup Write - String Specifies a domain group authorized to connect to the RD Session Host servers in a session collection. .PARAMETER DiskPath Write - String Specifies the target to store the User Profile Disks .PARAMETER EnableUserProfileDisk Write - Boolean Specifies if this collection uses UserProfileDisks .PARAMETER ExcludeFilePath Write - StringArray Specifies a list of strings for files to exclude from the user profile disk .PARAMETER ExcludeFolderPath Write - StringArray Specifies a list of strings for folders to exclude from the user profile disk .PARAMETER IncludeFilePath Write - StringArray Specifies a list of strings for files to include in the user profile disk .PARAMETER IncludeFolderPath Write - StringArray Specifies a list of strings for folders to include in the user profile disk .PARAMETER MaxUserProfileDiskSizeGB Write - UInt32 Specifies the maximum size in GB for a User Profile Disk .EXAMPLE 1 This example shows how to ensure a session collection is configured. configuration Example { Import-DscResource -ModuleName 'xRemoteDesktopSessionHost' node localhost { xRDSessionCollectionConfiguration 'ExampleApplications' { CollectionName = 'ExampleApplications' CollectionDescription = 'A collection to deploy example applications' ConnectionBroker = 'connectionbroker.server.fqdn' UserGroup = 'DOMAIN\AllowedUsersGroup' ActiveSessionLimitMin = 0 BrokenConnectionAction = 'Disconnect' AutomaticReconnectionEnabled = $True DisconnectedSessionLimitMin = 30 IdleSessionLimitMin = 1440 # One day TemporaryFoldersDeletedOnExit = $True RDEasyPrintDriverEnabled = 0 MaxRedirectedMonitors = 16 ClientPrinterRedirected = 0 ClientDeviceRedirectionOptions = 'AudioVideoPlayBack, AudioRecording, Clipboard' ClientPrinterAsDefault = 0 AuthenticateUsingNLA = $True EncryptionLevel = 'High' SecurityLayer = 'SSL' EnableUserProfileDisk = $True DiskPath = '\\file.server.fqdn\RDSProfileShare' MaxUserProfileDiskSizeGB = 5 } } } |