Set-RASPubRDSApp

NAME

Set-RASPubRDSApp

SYNOPSIS

Modifies properties of a published application.

SYNTAX

Set-RASPubRDSApp [-Id] <uint> [-ColorDepth {Colors8Bit | Colors15Bit | Colors16Bit | Colors24Bit | Colors32Bit | ClientSpecified}] [-ConCurrentLicenses <uint>] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-DisableSessionSharing <bool>] [-Enabled <bool>] [-EnabledMode {Disabled | Enabled | Maintenance}] [-EnableFileExtensions <bool>] [-ExcludePrelaunch <bool>] [-FileExtensions <string>] [-Icon <string>] [-IconIndex <uint>] [-InheritDisplayDefaultSettings <bool>] [-InheritLicenseDefaultSettings <bool>] [-InheritMaintenance <bool>] [-InheritShortcutDefaultSettings <bool>] [-LicenseLimitNotify {WarnUserAndNoStart | WarnUserAndStart | NotifyAdminAndStart | NotifyUserAdminAndStart | NotifyUserAdminAndNoStart}] [-MaintenanceMessage_de_DE <string>] [-MaintenanceMessage_en_US <string>] [-MaintenanceMessage_es_ES <string>] [-MaintenanceMessage_fr_FR <string>] [-MaintenanceMessage_it_IT <string>] [-MaintenanceMessage_ja_JP <string>] [-MaintenanceMessage_ko_KR <string>] [-MaintenanceMessage_nl_NL <string>] [-MaintenanceMessage_pt_BR <string>] [-MaintenanceMessage_zh_CN <string>] [-MaintenanceMessage_zh_TW <string>] [-Name <string>] [-OneInstancePerUser <bool>] [-Package <string>] [-PackagedApp <string>] [-Parameters <string>] [-PreferredRoutingEnabled <bool>] [-PublishFrom {All | HostPool | Group | Host | Server}] [-PublishFromGroup <RDSHostPool[]>] [-PublishFromHostPoolIds <uint[]>] [-PublishFromServer <RDSHost[]>] [-PublishFromServerIds <uint[]>] [-PublishToSite <Site[]>] [-PublishToSiteIds <uint[]>] [-ReplicateDefaultServerSettings <bool>] [-ReplicateDisplaySettings <bool>] [-ReplicateFileExtensionSettings <bool>] [-ReplicateLicenseSettings <bool>] [-ReplicateMaintenance <bool>] [-ReplicateShortcutSettings <bool>] [-ServerId <uint>] [-SiteId <uint>] [-StartFullscreen <bool>] [-StartIn <string>] [-StartMaximized <bool>] [-StartOnLogon <bool>] [-StartPath <string>] [-Target <string>] [-WaitForPrinters <bool>] [-WaitForPrintersTimeout <uint>] [-WinType {Normal | Maximized | Minimized}] [<CommonParameters>]

Set-RASPubRDSApp [-InputObject] <PubItem> [-ColorDepth {Colors8Bit | Colors15Bit | Colors16Bit | Colors24Bit | Colors32Bit | ClientSpecified}] [-ConCurrentLicenses <uint>] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-DisableSessionSharing <bool>] [-Enabled <bool>] [-EnabledMode {Disabled | Enabled | Maintenance}] [-EnableFileExtensions <bool>] [-ExcludePrelaunch <bool>] [-FileExtensions <string>] [-Icon <string>] [-IconIndex <uint>] [-InheritDisplayDefaultSettings <bool>] [-InheritLicenseDefaultSettings <bool>] [-InheritMaintenance <bool>] [-InheritShortcutDefaultSettings <bool>] [-LicenseLimitNotify {WarnUserAndNoStart | WarnUserAndStart | NotifyAdminAndStart | NotifyUserAdminAndStart | NotifyUserAdminAndNoStart}] [-MaintenanceMessage_de_DE <string>] [-MaintenanceMessage_en_US <string>] [-MaintenanceMessage_es_ES <string>] [-MaintenanceMessage_fr_FR <string>] [-MaintenanceMessage_it_IT <string>] [-MaintenanceMessage_ja_JP <string>] [-MaintenanceMessage_ko_KR <string>] [-MaintenanceMessage_nl_NL <string>] [-MaintenanceMessage_pt_BR <string>] [-MaintenanceMessage_zh_CN <string>] [-MaintenanceMessage_zh_TW <string>] [-Name <string>] [-OneInstancePerUser <bool>] [-Package <string>] [-PackagedApp <string>] [-Parameters <string>] [-PreferredRoutingEnabled <bool>] [-PublishFrom {All | HostPool | Group | Host | Server}] [-PublishFromGroup <RDSHostPool[]>] [-PublishFromHostPoolIds <uint[]>] [-PublishFromServer <RDSHost[]>] [-PublishFromServerIds <uint[]>] [-PublishToSite <Site[]>] [-PublishToSiteIds <uint[]>] [-ReplicateDefaultServerSettings <bool>] [-ReplicateDisplaySettings <bool>] [-ReplicateFileExtensionSettings <bool>] [-ReplicateLicenseSettings <bool>] [-ReplicateMaintenance <bool>] [-ReplicateShortcutSettings <bool>] [-ServerId <uint>] [-SiteId <uint>] [-StartFullscreen <bool>] [-StartIn <string>] [-StartMaximized <bool>] [-StartOnLogon <bool>] [-StartPath <string>] [-Target <string>] [-WaitForPrinters <bool>] [-WaitForPrintersTimeout <uint>] [-WinType {Normal | Maximized | Minimized}] [<CommonParameters>]

DESCRIPTION

Modifies properties of a published application.

Use only the parameters (application properties) that you want to modify.

To set filtering options, use the Pub Filtering cmdlets (e.g. Set-RASPubItemClientFilter).

PARAMETERS

-PublishFrom <PublishFrom> Specifies the 'Publish from' option.

Acceptable values: All (All Hosts in Site), HostPool (Host Pools), Host (Individual Hosts).

Possible values: All, HostPool, Group, Host, Server

-PublishFromGroup <RDSHostPool[]> One or multiple server group from which to publish the application.

The PublishFrom parameter must be set to 1 (HostPool).

-PublishFromHostPoolIds <uint[]> Specifies one or multiple host pool Ids from which to publish the application.

The PublishFrom parameter must specify 1 (HostPool).

-PublishFromServer <RDSHost[]> One or multiple RDS Host servers from which to publish the application.

The PublishFrom parameter must be set to 2 (Host).

-PublishFromServerIds <uint[]> One or multiple RDS Host server Ids from which to publish the application.

The PublishFrom parameter must specify 2 (Host).

-ReplicateDisplaySettings <bool> Enable or disable the 'Replicate settings' option (replicates display settings to all sites).

-StartMaximized <bool> Enable or disable the 'Start the application as maximized when using mobile clients" option.

-StartFullscreen <bool> Enable or disable the 'Start in fullscreen mode for WYSE ThinOS clients" option.

-WaitForPrinters <bool> Enable or disable the 'Wait until all RAS universal printers are redirected before showing the application" option.

-WaitForPrintersTimeout <uint> Printer redirection timeout (in seconds). Set this option when enabling the WaitForPrinters option.

-ColorDepth <ColorDepth> Specifies the display color depth setting.

Possible values are: Colors8Bit, Colors15Bit, Colors16Bit, Colors24Bit, Colors32Bit, ClientSpecified

Possible values: Colors8Bit, Colors15Bit, Colors16Bit, Colors24Bit, Colors32Bit, ClientSpecified

-InheritDisplayDefaultSettings <bool> Enable or disable the 'Inherit default settings" option for display properties.

-ReplicateLicenseSettings <bool> Enable or disable the 'Replicate licensing settings" (settings are replicated to all sites).

-DisableSessionSharing <bool> Enable or disable the 'Disable session sharing' option (licenses).

-OneInstancePerUser <bool> Enable or disable the 'Allow users to start only one instance of the application' option.

-ConCurrentLicenses <uint> Specifies the 'Concurrent licenses' option (the number of concurrent licenses).

-LicenseLimitNotify <LimitNotify> Specifies the "If license limit is exceeded' option.

Acceptable values: WarnUserAndNoStart, WarnUserAndStart, NotifyAdminAndStart, NotifyUserAdminAndStart, NotifyUserAdminAndNoStart

Possible values: WarnUserAndNoStart, WarnUserAndStart, NotifyAdminAndStart, NotifyUserAdminAndStart, NotifyUserAdminAndNoStart

-InheritLicenseDefaultSettings <bool> Enable or disable the 'Inherit default license settings' option.

-EnableFileExtensions <bool> Enable or disable the 'Enable File Extensions' option.

-ReplicateFileExtensionSettings <bool> Enable or disable the 'Replicate settings' option (replicates extension settings to all sites).

-ReplicateDefaultServerSettings <bool> Enable or disable the 'Replicate settings' option (replicates default server settings to all sites).

-FileExtensions <string> List of file extensions to be added to the current list, if doesn't exist(comma separated values).

-ServerId <uint>

-Target <string> File name and path of a published application executable.

-StartIn <string> Folder name in which to start a published application.

-Parameters <string> Optional parameters to pass to the published application executable.

-Package <string> The MSIX Package.

-PackagedApp <string> The application within the MSIX package.

-WinType <WindowType> Published application window type. Acceptable values: Normal, Maximized, Minimized.

Possible values: Normal, Maximized, Minimized

-ReplicateShortcutSettings <bool> Replicate shortcut settings to all sites.

-CreateShortcutOnDesktop <bool> Create a shortcut on a client's desktop.

-CreateShortcutInStartFolder <bool> Create a shortcut in the client's Start folder.

-CreateShortcutInStartUpFolder <bool> Create a shortcut in the client's Auto Start folder.

-StartPath <string> Specifies the path in the Start folder where the shortcut will be created.

-InheritShortcutDefaultSettings <bool> Inherit default shortcut settings.

-StartOnLogon <bool> Start a resource automatically when a user logs on.

-ExcludePrelaunch <bool> Exclude application from prelaunch.

-Name <string> A new name to assign to the published resource.

-Icon <string> Published resource icon file name. Can be an executable (.exe), a .dll or a .ico file.

-IconIndex <uint> Icon index

Specifies the index of the icon that will be loaded from the binary specified in the Icon property

-ReplicateMaintenance <bool> Replicate Maintenance

-InheritMaintenance <bool> Inherit Maintenance

-Enabled <bool> Enable or disable a published resource.

-EnabledMode <PubResourceEnabledMode> Changes the availability status of the published resource.

Possible values: Disabled, Enabled, Maintenance

-MaintenanceMessage_en_US <string> Maintenance message for the published resource in English.

-MaintenanceMessage_ja_JP <string> Maintenance message for the published resource in Japanese.

-MaintenanceMessage_fr_FR <string> Maintenance message for the published resource in French.

-MaintenanceMessage_es_ES <string> Maintenance message for the published resource in Spanish.

-MaintenanceMessage_it_IT <string> Maintenance message for the published resource in Italian.

-MaintenanceMessage_pt_BR <string> Maintenance message for the published resource in Portuguese.

-MaintenanceMessage_nl_NL <string> Maintenance message for the published resource in Dutch.

-MaintenanceMessage_de_DE <string> Maintenance message for the published resource in German.

-MaintenanceMessage_zh_TW <string> Maintenance message for the published resource in Chinese (Traditional).

-MaintenanceMessage_zh_CN <string> Maintenance message for the published resource in Chinese (Simplified).

-MaintenanceMessage_ko_KR <string> Maintenance message for the published resource in Korean.

-Description <string> Published resource description.

-PublishToSite <Site[]> An array of sites to which to publish a resource.

-PublishToSiteIds <uint[]> An array of sites to which to publish a resource.

-PreferredRoutingEnabled <bool> Enable or disable Preferred Routing.

-Id <uint> Published resource ID.

-InputObject <PubItem> An object specifying the published resource.

To obtain the object, use the Get-PubItem cmdlet.

-SiteId <uint> Site ID.

<CommonParameters>

INPUTS

PubItem

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Set-RASPubRDSApp -Id 1 -Enabled $false

Disables a published application specified by ID. ---------- EXAMPLE 2 ----------

Set-RASPubRDSApp $PubRDSApp -Enabled $false

Disables a published application specified by the $PubRDSApp object. ---------- EXAMPLE 3 ----------

Get-RASPubRDSApp -Id 1 | Set-RASPubRDSApp -Enabled $false

Disables a published application specified by an object obtained from the pipeline output. ---------- EXAMPLE 4 ----------

Set-RASPubRDSApp -Id 1 -Package "AppPackage2" -PackagedApp "TestApp2"

Modifies the package and application package details of the published application specified by ID.

Last updated