Set-RASPubRDSApp.md

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)] [-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)] [-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.

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PublishFromGroup (RDSHostPool[])

One or multiple server group from which to publish the application.

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PublishFromHostPoolIds (uint[])

Specifies one or multiple host pool Ids from which to publish the application.

The PublishFrom parameter must specify 1 (HostPool).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PublishFromServer (RDSHost[])

One or multiple RDS Host servers from which to publish the application.

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PublishFromServerIds (uint[])

One or multiple RDS Host server Ids from which to publish the application.

The PublishFrom parameter must specify 2 (Host).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ReplicateDisplaySettings (bool)

Enable or disable the 'Replicate settings' option (replicates display settings to all sites).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

StartMaximized (bool)

Enable or disable the 'Start the application as maximized when using mobile clients" option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

StartFullscreen (bool)

Enable or disable the 'Start in fullscreen mode for WYSE ThinOS clients" option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

WaitForPrinters (bool)

Enable or disable the 'Wait until all RAS universal printers are redirected before showing the application" option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

WaitForPrintersTimeout (uint)

Printer redirection timeout (in seconds). Set this option when enabling the WaitForPrinters option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

InheritDisplayDefaultSettings (bool)

Enable or disable the 'Inherit default settings" option for display properties.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ReplicateLicenseSettings (bool)

Enable or disable the 'Replicate licensing settings" (settings are replicated to all sites).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

DisableSessionSharing (bool)

Enable or disable the 'Disable session sharing' option (licenses).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

OneInstancePerUser (bool)

Enable or disable the 'Allow users to start only one instance of the application' option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ConCurrentLicenses (uint)

Specifies the 'Concurrent licenses' option (the number of concurrent licenses).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

LicenseLimitNotify (LimitNotify)

Specifies the "If license limit is exceeded' option.

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

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

InheritLicenseDefaultSettings (bool)

Enable or disable the 'Inherit default license settings' option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnableFileExtensions (bool)

Enable or disable the 'Enable File Extensions' option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ReplicateFileExtensionSettings (bool)

Enable or disable the 'Replicate settings' option (replicates extension settings to all sites).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ReplicateDefaultServerSettings (bool)

Enable or disable the 'Replicate settings' option (replicates default server settings to all sites).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

FileExtensions (string)

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ServerId (uint)

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Target (string)

File name and path of a published application executable.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

StartIn (string)

Folder name in which to start a published application.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Parameters (string)

Optional parameters to pass to the published application executable.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Package (string)

The MSIX Package.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PackagedApp (string)

The application within the MSIX package.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

WinType (WindowType)

Published application window type. Acceptable values: Normal, Maximized, Minimized.

Possible values: Normal, Maximized, Minimized

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ReplicateShortcutSettings (bool)

Replicate shortcut settings to all sites.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

CreateShortcutOnDesktop (bool)

Create a shortcut on a client's desktop.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

CreateShortcutInStartFolder (bool)

Create a shortcut in the client's Start folder.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

CreateShortcutInStartUpFolder (bool)

Create a shortcut in the client's Auto Start folder.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

StartPath (string)

Specifies the path in the Start folder where the shortcut will be created.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

InheritShortcutDefaultSettings (bool)

Inherit default shortcut settings.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

StartOnLogon (bool)

Start a resource automatically when a user logs on.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ExcludePrelaunch (bool)

Exclude application from prelaunch.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Name (string)

A new name to assign to the published resource.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Icon (string)

Published resource icon file name. Can be an executable (.exe), a .dll or a .ico file.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

IconIndex (uint)

Icon index

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ReplicateMaintenance (bool)

Replicate Maintenance

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

InheritMaintenance (bool)

Inherit Maintenance

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnabledMode

(PubResourceEnabledMode) Changes the availability status of the published resource.

Possible values: Disabled, Enabled, Maintenance

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaintenanceMessage_en_US (string)

Maintenance message for the published resource in English.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaintenanceMessage_ja_JP (string)

Maintenance message for the published resource in Japanese.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaintenanceMessage_fr_FR (string)

Maintenance message for the published resource in French.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaintenanceMessage_es_ES (string)

Maintenance message for the published resource in Spanish.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaintenanceMessage_it_IT (string)

Maintenance message for the published resource in Italian.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaintenanceMessage_pt_BR (string)

Maintenance message for the published resource in Portuguese.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaintenanceMessage_nl_NL (string)

Maintenance message for the published resource in Dutch.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaintenanceMessage_de_DE (string)

Maintenance message for the published resource in German.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaintenanceMessage_zh_TW (string)

Maintenance message for the published resource in Chinese (Traditional).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaintenanceMessage_zh_CN (string)

Maintenance message for the published resource in Chinese (Simplified).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaintenanceMessage_ko_KR (string)

Maintenance message for the published resource in Korean.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Description (string)

Published resource description.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PublishToSite (Site[])

An array of sites to which to publish a resource.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PublishToSiteIds (uint[])

An array of sites to which to publish a resource.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PreferredRoutingEnabled (bool)

Enable or disable Preferred Routing.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

Published resource ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

InputObject (PubItem)

An object specifying the published resource.

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

SiteId (uint)

Site ID.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

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.

RELATED LINKS

• Get-RASPubRDSApp

• Remove-RASPubRDSApp

• Set-RASPubDefaultSettings