Resource Type: dsc_xrdsessioncollectionconfiguration

Defined in:

lib/puppet/type/dsc_xrdsessioncollectionconfiguration.rb

Providers:

powershell

Overview

The DSC xRDSessionCollectionConfiguration resource type. Automatically generated from ‘xRemoteDesktopSessionHost/DSCResources/MSFT_xRDSessionCollectionConfiguration/MSFT_xRDSessionCollectionConfiguration.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present

Parameters

• dsc_activesessionlimitmin

  ActiveSessionLimitMin - Specifies the maximum time, in minutes, an active session runs. After this period, the RD Session Host server ends the session.

• dsc_authenticateusingnla

  AuthenticateUsingNLA - 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.

  Supported values:

  • true
  • false
• dsc_automaticreconnectionenabled

  AutomaticReconnectionEnabled - Indicates whether the Remote Desktop client attempts to reconnect after a connection interruption.

  Supported values:

  • true
  • false
• dsc_brokenconnectionaction

  BrokenConnectionAction - 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.

• dsc_clientdeviceredirectionoptions

  ClientDeviceRedirectionOptions - 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.

• dsc_clientprinterasdefault

  ClientPrinterAsDefault - 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.

  Supported values:

  • true
  • false
• dsc_clientprinterredirected

  ClientPrinterRedirected - Indicates whether to use client printer redirection, which routes print jobs from the Remote Desktop session to a printer attached to the client computer.

  Supported values:

  • true
  • false
• dsc_collectiondescription

  CollectionDescription - Specifies a description of the session collection.

• dsc_collectionname

  CollectionName - Specifies the name of a session collection.

• dsc_connectionbroker

  ConnectionBroker - Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment.

• dsc_customrdpproperty

  CustomRdpProperty - 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.

• dsc_disconnectedsessionlimitmin

  DisconnectedSessionLimitMin - Specifies a length of time, in minutes. After client disconnection from a session for this period, the RD Session Host ends the session.

• dsc_encryptionlevel

  EncryptionLevel - 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.

• dsc_idlesessionlimitmin

  IdleSessionLimitMin - 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.

• dsc_maxredirectedmonitors

  MaxRedirectedMonitors - 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.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_rdeasyprintdriverenabled

  RDEasyPrintDriverEnabled - Specifies whether to enable the Remote Desktop Easy Print driver.

  Supported values:

  • true
  • false
• dsc_securitylayer

  SecurityLayer - Specifies which security protocol to use. The acceptable values for this parameter are: RDP, Negotiate, SSL. The default value is Negotiate.

• dsc_temporaryfoldersdeletedonexit

  TemporaryFoldersDeletedOnExit - Specifies whether to delete temporary folders from the RD Session Host server for a disconnected session.

  Supported values:

  • true
  • false
• dsc_usergroup

  UserGroup - Specifies a domain group authorized to connect to the RD Session Host servers in a session collection.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xrdsessioncollectionconfiguration` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.