# Set-RASPubVDIDesktop

## NAME

Set-RASPubVDIDesktop

## SYNOPSIS

Modifies properties of a published desktop.

## SYNTAX

**Set-RASPubVDIDesktop** \[-[Id](#Id)] _\<uint>_ \[-[AllowMultiMonitor](#AllowMultiMonitor) {Enabled | Disabled | UseClientSettings}] \[-[ConnectTo](#ConnectTo) {AnyGuest}] \[-[CreateShortcutInStartFolder](#CreateShortcutInStartFolder) _\<bool>_] \[-[CreateShortcutInStartUpFolder](#CreateShortcutInStartUpFolder) _\<bool>_] \[-[CreateShortcutOnDesktop](#CreateShortcutOnDesktop) _\<bool>_] \[-[Description](#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](#Enabled) _\<bool>_] \[-[EnabledMode](#EnabledMode) {Disabled | Enabled | Maintenance}] \[-[ExcludePrelaunch](#ExcludePrelaunch) _\<bool>_] \[-[Height](#Height) _\<uint>_] \[-[Icon](#Icon) _\<string>_] \[-[IconIndex](#IconIndex) _\<uint>_] \[-[InheritMaintenance](#InheritMaintenance) _\<bool>_] \[-[InheritShortcutDefaultSettings](#InheritShortcutDefaultSettings) _\<bool>_] \[-[MaintenanceMessage\_de\_DE](#MaintenanceMessage_de_DE) _\<string>_] \[-[MaintenanceMessage\_en\_US](#MaintenanceMessage_en_US) _\<string>_] \[-[MaintenanceMessage\_es\_ES](#MaintenanceMessage_es_ES) _\<string>_] \[-[MaintenanceMessage\_fr\_FR](#MaintenanceMessage_fr_FR) _\<string>_] \[-[MaintenanceMessage\_it\_IT](#MaintenanceMessage_it_IT) _\<string>_] \[-[MaintenanceMessage\_ja\_JP](#MaintenanceMessage_ja_JP) _\<string>_] \[-[MaintenanceMessage\_ko\_KR](#MaintenanceMessage_ko_KR) _\<string>_] \[-[MaintenanceMessage\_nl\_NL](#MaintenanceMessage_nl_NL) _\<string>_] \[-[MaintenanceMessage\_pt\_BR](#MaintenanceMessage_pt_BR) _\<string>_] \[-[MaintenanceMessage\_zh\_CN](#MaintenanceMessage_zh_CN) _\<string>_] \[-[MaintenanceMessage\_zh\_TW](#MaintenanceMessage_zh_TW) _\<string>_] \[-[Name](#Name) _\<string>_] \[-[Persistent](#Persistent) _\<bool>_] \[-[PreferredRoutingEnabled](#PreferredRoutingEnabled) _\<bool>_] \[-[PublishToSite](#PublishToSite) _<_[_Site\[\]_](../classes-and-enumerations/site)_>_] \[-[PublishToSiteIds](#PublishToSiteIds) _\<uint\[]>_] \[-[ReplicateMaintenance](#ReplicateMaintenance) _\<bool>_] \[-[ReplicateShortcutSettings](#ReplicateShortcutSettings) _\<bool>_] \[-[SiteId](#SiteId) _\<uint>_] \[-[StartOnLogon](#StartOnLogon) _\<bool>_] \[-[StartPath](#StartPath) _\<string>_] \[-[VDIHostPool](#VDIHostPool) _<_[_VDIHostPool_](../classes-and-enumerations/vdihostpool)_>_] \[-[VDIHostPoolId](#VDIHostPoolId) _\<uint>_] \[-[VDITemplate](#VDITemplate) _<_[_Template_](../classes-and-enumerations/template)_>_] \[-[Width](#Width) _\<uint>_] \[_<_[_CommonParameters_](#CommonParameters)_>_]

**Set-RASPubVDIDesktop** \[-[InputObject](#InputObject)] _<_[_PubItem_](../classes-and-enumerations/pubitem)_>_ \[-[AllowMultiMonitor](#AllowMultiMonitor) {Enabled | Disabled | UseClientSettings}] \[-[ConnectTo](#ConnectTo) {AnyGuest}] \[-[CreateShortcutInStartFolder](#CreateShortcutInStartFolder) _\<bool>_] \[-[CreateShortcutInStartUpFolder](#CreateShortcutInStartUpFolder) _\<bool>_] \[-[CreateShortcutOnDesktop](#CreateShortcutOnDesktop) _\<bool>_] \[-[Description](#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](#Enabled) _\<bool>_] \[-[EnabledMode](#EnabledMode) {Disabled | Enabled | Maintenance}] \[-[ExcludePrelaunch](#ExcludePrelaunch) _\<bool>_] \[-[Height](#Height) _\<uint>_] \[-[Icon](#Icon) _\<string>_] \[-[IconIndex](#IconIndex) _\<uint>_] \[-[InheritMaintenance](#InheritMaintenance) _\<bool>_] \[-[InheritShortcutDefaultSettings](#InheritShortcutDefaultSettings) _\<bool>_] \[-[MaintenanceMessage\_de\_DE](#MaintenanceMessage_de_DE) _\<string>_] \[-[MaintenanceMessage\_en\_US](#MaintenanceMessage_en_US) _\<string>_] \[-[MaintenanceMessage\_es\_ES](#MaintenanceMessage_es_ES) _\<string>_] \[-[MaintenanceMessage\_fr\_FR](#MaintenanceMessage_fr_FR) _\<string>_] \[-[MaintenanceMessage\_it\_IT](#MaintenanceMessage_it_IT) _\<string>_] \[-[MaintenanceMessage\_ja\_JP](#MaintenanceMessage_ja_JP) _\<string>_] \[-[MaintenanceMessage\_ko\_KR](#MaintenanceMessage_ko_KR) _\<string>_] \[-[MaintenanceMessage\_nl\_NL](#MaintenanceMessage_nl_NL) _\<string>_] \[-[MaintenanceMessage\_pt\_BR](#MaintenanceMessage_pt_BR) _\<string>_] \[-[MaintenanceMessage\_zh\_CN](#MaintenanceMessage_zh_CN) _\<string>_] \[-[MaintenanceMessage\_zh\_TW](#MaintenanceMessage_zh_TW) _\<string>_] \[-[Name](#Name) _\<string>_] \[-[Persistent](#Persistent) _\<bool>_] \[-[PreferredRoutingEnabled](#PreferredRoutingEnabled) _\<bool>_] \[-[PublishToSite](#PublishToSite) _<_[_Site\[\]_](../classes-and-enumerations/site)_>_] \[-[PublishToSiteIds](#PublishToSiteIds) _\<uint\[]>_] \[-[ReplicateMaintenance](#ReplicateMaintenance) _\<bool>_] \[-[ReplicateShortcutSettings](#ReplicateShortcutSettings) _\<bool>_] \[-[SiteId](#SiteId) _\<uint>_] \[-[StartOnLogon](#StartOnLogon) _\<bool>_] \[-[StartPath](#StartPath) _\<string>_] \[-[VDIHostPool](#VDIHostPool) _<_[_VDIHostPool_](../classes-and-enumerations/vdihostpool)_>_] \[-[VDIHostPoolId](#VDIHostPoolId) _\<uint>_] \[-[VDITemplate](#VDITemplate) _<_[_Template_](../classes-and-enumerations/template)_>_] \[-[Width](#Width) _\<uint>_] \[_<_[_CommonParameters_](#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**](../classes-and-enumerations/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 a desktop.

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**VDIHostPool <**[**VDIHostPool**](../classes-and-enumerations/vdihostpool)**>**\
Specifies the VDI Host Pool from which to publish a desktop.

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**VDITemplate <**[**Template**](../classes-and-enumerations/template)**>**\
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**](../classes-and-enumerations/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**](../classes-and-enumerations/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**](../classes-and-enumerations/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\[\]**](../classes-and-enumerations/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**](../classes-and-enumerations/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](../classes-and-enumerations/pubitem)

## OUTPUTS

-none-

## EXAMPLES

**---------- EXAMPLE 1 ----------**

Set-RASPubVDIDesktop -Id 1 -Enabled $false

Disables a published desktop specified by ID.\
&#xNAN;**---------- 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.\
&#xNAN;**---------- 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

* [New-RASPubVDIDesktop](new-raspubvdidesktop)
* [Get-RASPubVDIDesktop](get-raspubvdidesktop)
* [Remove-RASPubVDIDesktop](remove-raspubvdidesktop)
* [Set-RASPubItemUserFilter](https://github.com/Parallels-Corp/TEST-docs/blob/MDDoc-fixes/MDDocumentation/MD/RASAdmin/cmdlets/Set-RASPubItemUserFilter.md)
* [Set-RASPubItemClientFilter](https://github.com/Parallels-Corp/TEST-docs/blob/MDDoc-fixes/MDDocumentation/MD/RASAdmin/cmdlets/Set-RASPubItemClientFilter.md)
* [Set-RASPubItemIPFilter](https://github.com/Parallels-Corp/TEST-docs/blob/MDDoc-fixes/MDDocumentation/MD/RASAdmin/cmdlets/Set-RASPubItemIPFilter.md)
* [Set-RASPubItemMACFilter](https://github.com/Parallels-Corp/TEST-docs/blob/MDDoc-fixes/MDDocumentation/MD/RASAdmin/cmdlets/Set-RASPubItemMACFilter.md)
* [Set-RASPubItemGatewayFilter](https://github.com/Parallels-Corp/TEST-docs/blob/MDDoc-fixes/MDDocumentation/MD/RASAdmin/cmdlets/Set-RASPubItemGatewayFilter.md)
* [Set-RASPubDefaultSettings](set-raspubdefaultsettings)
