# Set-RASPubRDSDesktop.md ## NAME Set-RASPubRDSDesktop ## SYNOPSIS Modifies properties of a published desktop. ## SYNTAX **Set-RASPubRDSDesktop** \[[Id](#id-string)] *(uint)* \[-[AllowMultiMonitor](#AllowMultiMonitor) {Enabled | Disabled | UseClientSettings}] \[[ConnectToConsole](#connecttoconsole-string) *(bool)*] \[[CreateShortcutInStartFolder](#createshortcutinstartfolder-string) *(bool)*] \[[CreateShortcutInStartUpFolder](#createshortcutinstartupfolder-string) *(bool)*] \[[CreateShortcutOnDesktop](#createshortcutondesktop-string) *(bool)*] \[[Description](#description-string) *(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}] \[-[EnabledMode](#EnabledMode) {Disabled | Enabled | Maintenance}] \[[ExcludePrelaunch](#excludeprelaunch-string) *(bool)*] \[[Height](#height-string) *(uint)*] \[[Icon](#icon-string) *(string)*] \[[IconIndex](#iconindex-string) *(uint)*] \[[InheritMaintenance](#inheritmaintenance-string) *(bool)*] \[[InheritShortcutDefaultSettings](#inheritshortcutdefaultsettings-string) *(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) *(string)*] \[[PreferredRoutingEnabled](#preferredroutingenabled-string) *(bool)*] \[-[PublishFrom](#PublishFrom) {All | HostPool | Group | Host | Server}] \[-[PublishFromGroup](#PublishFromGroup) *(*[*RDSHostPool\[\]*](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/rdshostpool)*)*] \[-[PublishFromHostPoolIds](#PublishFromHostPoolIds) *(uint\[])*] \[-[PublishFromServer](#PublishFromServer) *(*[*RDSHost\[\]*](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/rdshost)*)*] \[-[PublishFromServerIds](#PublishFromServerIds) *(uint\[])*] \[-[PublishToSite](#PublishToSite) *(*[*Site\[\]*](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/site)*)*] \[-[PublishToSiteIds](#PublishToSiteIds) *(uint\[])*] \[[ReplicateMaintenance](#replicatemaintenance-string) *(bool)*] \[[ReplicateShortcutSettings](#replicateshortcutsettings-string) *(bool)*] \[[SiteId](#siteid-string) *(uint)*] \[[StartOnLogon](#startonlogon-string) *(bool)*] \[[StartPath](#startpath-string) *(string)*] \[[Width](#width-string) *(uint)*] \[*(*[*CommonParameters*](#CommonParameters)*)*] \*\*Set-RASPubRDSDesktop \[-[InputObject](#inputobject)] *(*[*PubItem*](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/pubitem)*)* \[-[AllowMultiMonitor](#AllowMultiMonitor) {Enabled | Disabled | UseClientSettings}] \[[ConnectToConsole](#connecttoconsole-string) *(bool)*] \[[CreateShortcutInStartFolder](#createshortcutinstartfolder-string) *(bool)*] \[[CreateShortcutInStartUpFolder](#createshortcutinstartupfolder-string) *(bool)*] \[[CreateShortcutOnDesktop](#createshortcutondesktop-string) *(bool)*] \[[Description](#description-string) *(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}] \[-[EnabledMode](#EnabledMode) {Disabled | Enabled | Maintenance}] \[[ExcludePrelaunch](#excludeprelaunch-string) *(bool)*] \[[Height](#height-string) *(uint)*] \[[Icon](#icon-string) *(string)*] \[[IconIndex](#iconindex-string) *(uint)*] \[[InheritMaintenance](#inheritmaintenance-string) *(bool)*] \[[InheritShortcutDefaultSettings](#inheritshortcutdefaultsettings-string) *(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) *(string)*] \[[PreferredRoutingEnabled](#preferredroutingenabled-string) *(bool)*] \[-[PublishFrom](#PublishFrom) {All | HostPool | Group | Host | Server}] \[-[PublishFromGroup](#PublishFromGroup) *(*[*RDSHostPool\[\]*](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/rdshostpool)*)*] \[-[PublishFromHostPoolIds](#PublishFromHostPoolIds) *(uint\[])*] \[-[PublishFromServer](#PublishFromServer) *(*[*RDSHost\[\]*](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/rdshost)*)*] \[-[PublishFromServerIds](#PublishFromServerIds) *(uint\[])*] \[-[PublishToSite](#PublishToSite) *(*[*Site\[\]*](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/site)*)*] \[-[PublishToSiteIds](#PublishToSiteIds) *(uint\[])*] \[[ReplicateMaintenance](#replicatemaintenance-string) *(bool)*] \[[ReplicateShortcutSettings](#replicateshortcutsettings-string) *(bool)*] \[[SiteId](#siteid-string) *(uint)*] \[[StartOnLogon](#startonlogon-string) *(bool)*] \[[StartPath](#startpath-string) *(string)*] \[[Width](#width-string) *(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. ## PARAMETERS ## ConnectToConsole (bool) Enable or disable the 'Connect to console' option. ``` Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false ``` ## PublishFrom ([PublishFrom](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/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\[\]](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/rdshostpool)) Specifies one or multiple groups from which to publish a desktop. The PublishFrom parameter must specify 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 a desktop. The PublishFrom parameter must specify 1 (HostPool). ``` Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false ``` ## PublishFromServer ([RDSHost\[\]](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/rdshost)) Specifies one or multiple RDS Host servers from which to publish a desktop. The PublishFrom parameter must specify 2 (Host). ``` Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false ``` ## PublishFromServerIds (uint\[]) Specifies one or multiple RDS Host server Ids from which to publish a desktop. The PublishFrom parameter must specify 2 (Host). ``` 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](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/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](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/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 ``` ## EnabledMode ([PubResourceEnabledMode](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/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\[\]](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/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](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/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](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/types/pubitem) ## OUTPUTS -none- ## EXAMPLES \*\*---------- EXAMPLE 1 ---------- Set-RASPubRDSDesktop -Id 1 -Enabled $false Disables a published desktop specified by ID.\ \*\*---------- EXAMPLE 2 ---------- Set-RASPubRDSDesktop $PubRDSDesktop -Enabled $false Disables a published desktop specified by the $PubRDSDesktop object. To obtain the object, use the Get-RASPubRDSDesktop cmdlet.\ \*\*---------- EXAMPLE 3 ---------- Get-RASPubRDSDesktop -Id 1 | Set-RASPubRDSDesktop -Enabled $false Disables a published desktop specified by an object obtained from the pipeline output. ## RELATED LINKS * [New-RASPubRDSDesktop](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/commands/new-raspubrdsdesktop) * [Get-RASPubRDSDesktop](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/commands/get-raspubrdsdesktop) * [Remove-RASPubRDSDesktop](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/commands/remove-raspubrdsdesktop) * [Set-RASPubDefaultSettings](https://docs.parallels.com/landing/ras-powershell-api-guide/v20/parallels-ras-powershell-admin-module/commands/set-raspubdefaultsettings)