Resource Type: dsc_xrdremoteapp

Defined in:

lib/puppet/type/dsc_xrdremoteapp.rb

Providers:

powershell

Overview

The DSC xRDRemoteApp resource type. Automatically generated from ‘xRemoteDesktopSessionHost/DSCResources/MSFT_xRDRemoteApp/MSFT_xRDRemoteApp.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_alias

  Alias - Specifies an alias for the RemoteApp program.

• dsc_collectionname

  CollectionName - Specifies the name of the personal virtual desktop collection or session collection. The cmdlet publishes the RemoteApp program to this collection.

• dsc_commandlinesetting

  CommandLineSetting - Specifies whether the RemoteApp program accepts command-line arguments from the client at connection time. The acceptable values for this parameter are: Allow, DoNotAllow, Require

• dsc_displayname

  DisplayName - Specifies a name to display to users for the RemoteApp program.

• dsc_filepath

  FilePath - Specifies a path for the executable file for the application. Do not include any environment variables.

• dsc_filevirtualpath

  FileVirtualPath - Specifies a path for the application executable file. This path resolves to the same location as the value of the FilePath parameter, but it can include environment variables.

• dsc_foldername

  FolderName - Specifies the name of the folder that the RemoteApp program appears in on the Remote Desktop Web Access (RD Web Access) webpage and in the Start menu for subscribed RemoteApp and Desktop Connections.

• dsc_iconindex

  IconIndex - Specifies the index within the icon file (specified by the IconPath parameter) where the RemoteApp program’s icon can be found.

• dsc_iconpath

  IconPath - Specifies the path to a file containing the icon to display for the RemoteApp program identified by the Alias parameter.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_requiredcommandline

  RequiredCommandLine - Specifies a string that contains command-line arguments that the client can use at connection time with the RemoteApp program.

• dsc_showinwebaccess

  ShowInWebAccess - Specifies whether to show the RemoteApp program in the RD Web Access server, and in RemoteApp and Desktop Connections that the user subscribes to.

  Supported values:

  • true
  • false
• dsc_usergroups

  UserGroups - Specifies a domain group that can view the RemoteApp in RD Web Access, and in RemoteApp and Desktop Connections. To allow all users to see a RemoteApp program, provide a value of Null.

• name (namevar)
• provider

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