ProductsSupportPartners

Set-RASPubVDIApp

NAME

Set-RASPubVDIApp

SYNOPSIS

Modifies properties of a published VDI application.

SYNTAX

Set-RASPubVDIApp [-Id] <uint> [-ConnectTo {AnyGuest}] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-EnabledMode {Disabled | Enabled | Maintenance}] [-ExcludePrelaunch <bool>] [-Icon <string>] [-IconIndex <uint>] [-InheritMaintenance <bool>] [-InheritShortcutDefaultSettings <bool>] [-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>] [-Package <string>] [-PackagedApp <string>] [-Parameters <string>] [-Persistent <bool>] [-PreferredRoutingEnabled <bool>] [-PublishToSite <Site[]>] [-PublishToSiteIds <uint[]>] [-ReplicateMaintenance <bool>] [-ReplicateShortcutSettings <bool>] [-SiteId <uint>] [-StartIn <string>] [-StartOnLogon <bool>] [-StartPath <string>] [-Target <string>] [-VDIHostPool <VDIHostPool>] [-VDIHostPoolId <uint>] [-VDITemplate <Template>] [-WinType {Normal | Maximized | Minimized}] [<CommonParameters>]

Set-RASPubVDIApp [-InputObject] <PubItem> [-ConnectTo {AnyGuest}] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-EnabledMode {Disabled | Enabled | Maintenance}] [-ExcludePrelaunch <bool>] [-Icon <string>] [-IconIndex <uint>] [-InheritMaintenance <bool>] [-InheritShortcutDefaultSettings <bool>] [-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>] [-Package <string>] [-PackagedApp <string>] [-Parameters <string>] [-Persistent <bool>] [-PreferredRoutingEnabled <bool>] [-PublishToSite <Site[]>] [-PublishToSiteIds <uint[]>] [-ReplicateMaintenance <bool>] [-ReplicateShortcutSettings <bool>] [-SiteId <uint>] [-StartIn <string>] [-StartOnLogon <bool>] [-StartPath <string>] [-Target <string>] [-VDIHostPool <VDIHostPool>] [-VDIHostPoolId <uint>] [-VDITemplate <Template>] [-WinType {Normal | Maximized | Minimized}] [<CommonParameters>]

DESCRIPTION

Modifies properties of a published VDI application.

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

To set filtering options, use the Pub Filtering cmdlets.

PARAMETERS

-Persistent <bool> Specifies whether the connection is persistent or not.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ConnectTo <VDIMatchingMode> Specifies the 'Matching Mode' option to connect with.

Acceptable values: AnyGuest.

Possible values: AnyGuest

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VDIHostPoolId <uint> Specifies the VDI Host Pool from which to publish an application.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VDIHostPool <VDIHostPool> Specifies the VDI Host Pool from which to publish an application.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VDITemplate <Template> Specifies the RAS template from which to publish an application.

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

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

Set-RASPubVDIApp $PubVDIApp -Enabled $false

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

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

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

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

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

RELATED LINKS

PreviousSet-RASPubRDSDesktopNextSet-RASPubVDIDesktop

Last updated

© 2024 Parallels International GmbH. All rights reserved.