Set-RASPubVDIDesktop

NAME

Set-RASPubVDIDesktop

SYNOPSIS

Modifies properties of a published desktop.

SYNTAX

Set-RASPubVDIDesktop [-Id] <uint> [-AllowMultiMonitor <AllowMultiMonitor> {Enabled | Disabled | UseClientSettings}] [-ConnectTo <VDIMatchingMode> {AnyGuest | SpecificRASTemplate}] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-DesktopSize <DesktopSize> {UseAvailableArea | FullScreen | W640xH480 | W800xH600 | W854xH480 | W1024xH576 | W1024xH768 | W1152xH864 | W1280xH720 | W1280xH768 | W1280xH800 | W1280xH960 | W1280xH1024 | W1360xH768 | W1366xH768 | W1400xH1050 | W1440xH900 | W1600xH900 | W1600xH1024 | W1600xH1200 | W1680xH1050 | W1920xH1080 | W1920xH1200 | W1920xH1440 | W2048xH1152 | Custom}] [-Enabled <bool>] [-EnabledMode <PubResourceEnabledMode> {Disabled | Enabled | Maintenance}] [-ExcludePrelaunch <bool>] [-Height <uint>] [-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_ru_RU <string>] [-MaintenanceMessage_zh_CN <string>] [-MaintenanceMessage_zh_TW <string>] [-Name <string>] [-Persistent <bool>] [-PreferredRoutingEnabled <bool>] [-PublishToSite <Site[]>] [-PublishToSiteIds <uint[]>] [-ReplicateMaintenance <bool>] [-ReplicateShortcutSettings <bool>] [-SiteId <uint>] [-StartOnLogon <bool>] [-StartPath <string>] [-VDIPool <VDIPool>] [-VDIPoolId <uint>] [-VDITemplate <VDITemplate>] [-Width <uint>] [<CommonParameters>]

Set-RASPubVDIDesktop [-InputObject] <PubItem> [-AllowMultiMonitor <AllowMultiMonitor> {Enabled | Disabled | UseClientSettings}] [-ConnectTo <VDIMatchingMode> {AnyGuest | SpecificRASTemplate}] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-DesktopSize <DesktopSize> {UseAvailableArea | FullScreen | W640xH480 | W800xH600 | W854xH480 | W1024xH576 | W1024xH768 | W1152xH864 | W1280xH720 | W1280xH768 | W1280xH800 | W1280xH960 | W1280xH1024 | W1360xH768 | W1366xH768 | W1400xH1050 | W1440xH900 | W1600xH900 | W1600xH1024 | W1600xH1200 | W1680xH1050 | W1920xH1080 | W1920xH1200 | W1920xH1440 | W2048xH1152 | Custom}] [-Enabled <bool>] [-EnabledMode <PubResourceEnabledMode> {Disabled | Enabled | Maintenance}] [-ExcludePrelaunch <bool>] [-Height <uint>] [-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_ru_RU <string>] [-MaintenanceMessage_zh_CN <string>] [-MaintenanceMessage_zh_TW <string>] [-Name <string>] [-Persistent <bool>] [-PreferredRoutingEnabled <bool>] [-PublishToSite <Site[]>] [-PublishToSiteIds <uint[]>] [-ReplicateMaintenance <bool>] [-ReplicateShortcutSettings <bool>] [-SiteId <uint>] [-StartOnLogon <bool>] [-StartPath <string>] [-VDIPool <VDIPool>] [-VDIPoolId <uint>] [-VDITemplate <VDITemplate>] [-Width <uint>] [<CommonParameters>]

DESCRIPTION

Modifies properties of a published desktop.

You can include only those parameters (desktop properties) that you want to modify.

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

PARAMETERS


-Persistent <bool>
Defines 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, SpecificRASTemplate.

Possible values: AnyGuest, SpecificRASTemplate 

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

-VDIPoolId <uint>
Specifies the VDI Pool from which to publish a desktop. 

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

-VDIPool <VDIPool>
Specifies the VDI Pool from which to publish a desktop. 

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

-VDITemplate <VDITemplate>
Specifies the RAS Template from which to publish a desktop. 

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

-Width <uint>
Desktop width. 

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

-Height <uint>
Desktop height. 

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

-DesktopSize <DesktopSize>
Desktop Size. Possible values are: 0 (Use available area), 1 (Full screen), Custom = 25.

Specific sizes are specified by numbers in the 2 to 24 range: 2 (640x480), 3 (800x600), ... 24 (2048 x 1152)

Listed in that order: 640x480, 800x600, 854x480, 1024x576, 1024x768, 1152x864, 1280x720,

1280x768, 1280x800, 1280x960, 1280x1024, 1360x768, 1366x768,

1400x1050, 1440x900, 1600x900, 1600x1024, 1600x1200, 1680x1050,

1920x1440, 1920x1080, 1920x1200, 2048x1152

Possible values: UseAvailableArea, FullScreen, W640xH480, W800xH600, W854xH480, W1024xH576, W1024xH768, W1152xH864, W1280xH720, W1280xH768, W1280xH800, W1280xH960, W1280xH1024, W1360xH768, W1366xH768, W1400xH1050, W1440xH900, W1600xH900, W1600xH1024, W1600xH1200, W1680xH1050, W1920xH1080, W1920xH1200, W1920xH1440, W2048xH1152, Custom 

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

-AllowMultiMonitor <AllowMultiMonitor>
Specifies the Multi-monitor option.

Acceptable values: Enabled, Disabled, UseClientSettings.

Possible values: Enabled, Disabled, UseClientSettings 

        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

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

        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_ru_RU <string>
Maintenance message for the published resource in Russian. 

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

Disables a published desktop specified by ID.

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

Set-RASPubVDIDesktop $PubVDIDesktop -Enabled $false

Disables a published desktop specified by the $PubVDIDesktop object.

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

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

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

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

RELATED LINKS