Set-PubRDSApp

NAME

Set-PubRDSApp

SYNOPSIS

Modifies properties of a published application.

SYNTAX

Set-PubRDSApp [-InputObject] <PubItem> [-ColorDepth <ColorDepth> {Colors8Bit | Colors15Bit | Colors16Bit | Colors24Bit | Colors32Bit | ClientSpecified}] [-ConCurrentLicenses <uint>] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-DisableSessionSharing <bool>] [-Enabled <bool>] [-EnableFileExtensions <bool>] [-FileExtensions <string>] [-Icon <string>] [-IconIndex <uint>] [-InheritDisplayDefaultSettings <bool>] [-InheritLicenseDefaultSettings <bool>] [-InheritShortcutDefaultSettings <bool>] [-LicenseLimitNotify <LimitNotify> {WarnUserAndNoStart | WarnUserAndStart | NotifyAdminAndStart | NotifyUserAdminAndStart | NotifyUserAdminAndNoStart}] [-NewName <string>] [-OneInstancePerUser <bool>] [-Parameters <string>] [-PublishFrom <PublishFrom> {All | Group | Server}] [-PublishFromGroup <RDSGroup[]>] [-PublishFromGroupIds <List`1>] [-PublishFromServer <RDS[]>] [-PublishFromServerIds <List`1>] [-PublishToSite <Site[]>] [-PublishToSiteIds <List`1>] [-ReplicateDefaultServerSettings <bool>] [-ReplicateDisplaySettings <bool>] [-ReplicateFileExtensionSettings <bool>] [-ReplicateLicenseSettings <bool>] [-ReplicateShortcutSettings <bool>] [-ServerId <uint>] [-SiteId <uint>] [-StartIn <string>] [-StartMaximized <bool>] [-StartOnLogon <bool>] [-StartPath <string>] [-Target <string>] [-WaitForPrinters <bool>] [-WaitForPrintersTimeout <uint>] [-WinType <WindowType> {Normal | Maximized | Minimized}] [<CommonParameters>]

Set-PubRDSApp [-Id] <uint> [-ColorDepth <ColorDepth> {Colors8Bit | Colors15Bit | Colors16Bit | Colors24Bit | Colors32Bit | ClientSpecified}] [-ConCurrentLicenses <uint>] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-DisableSessionSharing <bool>] [-Enabled <bool>] [-EnableFileExtensions <bool>] [-FileExtensions <string>] [-Icon <string>] [-IconIndex <uint>] [-InheritDisplayDefaultSettings <bool>] [-InheritLicenseDefaultSettings <bool>] [-InheritShortcutDefaultSettings <bool>] [-LicenseLimitNotify <LimitNotify> {WarnUserAndNoStart | WarnUserAndStart | NotifyAdminAndStart | NotifyUserAdminAndStart | NotifyUserAdminAndNoStart}] [-NewName <string>] [-OneInstancePerUser <bool>] [-Parameters <string>] [-PublishFrom <PublishFrom> {All | Group | Server}] [-PublishFromGroup <RDSGroup[]>] [-PublishFromGroupIds <List`1>] [-PublishFromServer <RDS[]>] [-PublishFromServerIds <List`1>] [-PublishToSite <Site[]>] [-PublishToSiteIds <List`1>] [-ReplicateDefaultServerSettings <bool>] [-ReplicateDisplaySettings <bool>] [-ReplicateFileExtensionSettings <bool>] [-ReplicateLicenseSettings <bool>] [-ReplicateShortcutSettings <bool>] [-ServerId <uint>] [-SiteId <uint>] [-StartIn <string>] [-StartMaximized <bool>] [-StartOnLogon <bool>] [-StartPath <string>] [-Target <string>] [-WaitForPrinters <bool>] [-WaitForPrintersTimeout <uint>] [-WinType <WindowType> {Normal | Maximized | Minimized}] [<CommonParameters>]

DESCRIPTION

Modifies properties of a published application.

You can include only the parameters (application properties) that you want to modify.

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

PARAMETERS


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

Acceptable values: All (All servers in the site), Group (Server Groups), Server (Individual Servers).

Possible values: All, Group, Server 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

The PublishFrom parameter must be set to 1 (Server Groups). 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PublishFromGroupIds <List`1>
Specifies one or multiple group Ids from which to publish the application.

The PublishFrom parameter must specify 1 (Server groups). 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

The PublishFrom parameter must be set to 2 (Individual Servers). 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PublishFromServerIds <List`1>
One or multiple RDS Host server Ids from which to publish the application.

The PublishFrom parameter must specify 2 (Individual Servers). 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ReplicateDisplaySettings <bool>
Enables 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>
Enables or disables 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

-WaitForPrinters <bool>
Enables or disables 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>
Enables or disables the 'Inherit default settings" option for display properties. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ReplicateLicenseSettings <bool>
Enables or disables 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>
Enables or disables the 'Disable session sharing' option (licenses). 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-OneInstancePerUser <bool>
Enables or disables 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>
Enables or disables the 'Inherit default license settings' option. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ReplicateFileExtensionSettings <bool>
Enables 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>
Enables 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

-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

-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

-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

-InheritShorcutDefaultSettings <bool>
Inherit default shortcut settings.

This is an alias of the InheritShortcutDefaultSettings parameter. 

        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

-InputObject <PubItem>
Published item to be updated. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-NewName <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

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

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

This is an alias of the Enabled parameter. 

        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 <List`1>
An array of sites to which to publish a resource. 

        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

-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-PubRDSApp -Id 1 -Enabled $false

Disables a published application specified by ID.

---------- EXAMPLE 2 ----------

Set-PubRDSApp $PubRDSApp -Enabled $false

Disables a published application specified by the $PubRDSApp object.

---------- EXAMPLE 3 ----------

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

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

RELATED LINKS