Set-RASPubVDIDesktop
Modifies properties of a published desktop.
Set-RASPubVDIDesktop [-] <uint> [- {Enabled | Disabled | UseClientSettings}] [- {AnyGuest}] [- <bool>] [- <bool>] [- <bool>] [- <string>] [- {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}] [- <bool>] [- {Disabled | Enabled | Maintenance}] [- <bool>] [- <uint>] [- <string>] [- <uint>] [- <bool>] [- <bool>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>
Set-RASPubVDIDesktop [-] <> [- {Enabled | Disabled | UseClientSettings}] [- {AnyGuest}] [- <bool>] [- <bool>] [- <bool>] [- <string>] [- {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}] [- <bool>] [- {Disabled | Enabled | Maintenance}] [- <bool>] [- <uint>] [- <string>] [- <uint>] [- <bool>] [- <bool>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [-
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).
-Persistent <bool> Defines whether the connection is persistent or not.
-ConnectTo <> Specifies the 'Matching Mode' option to connect with.
Acceptable values: AnyGuest.
Possible values: AnyGuest
-VDIHostPoolId <uint> Specifies the VDI Host Pool from which to publish a desktop.
-VDIHostPool <> Specifies the VDI Host Pool from which to publish a desktop.
-VDITemplate <> Specifies the RAS Template from which to publish a desktop.
-Width <uint> Desktop width.
-Height <uint> Desktop height.
-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
-AllowMultiMonitor <> Specifies the Multi-monitor option.
Acceptable values: Enabled, Disabled, UseClientSettings.
Possible values: Enabled, Disabled, UseClientSettings
-ReplicateShortcutSettings <bool> Replicate shortcut settings to all sites.
-CreateShortcutOnDesktop <bool> Create a shortcut on a client's desktop.
-CreateShortcutInStartFolder <bool> Create a shortcut in the client's Start folder.
-CreateShortcutInStartUpFolder <bool> Create a shortcut in the client's Auto Start folder.
-StartPath <string> Specifies the path in the Start folder where the shortcut will be created.
-InheritShortcutDefaultSettings <bool> Inherit default shortcut settings.
-StartOnLogon <bool> Start a resource automatically when a user logs on.
-ExcludePrelaunch <bool> Exclude application from prelaunch.
-Name <string> A new name to assign to the published resource.
-Icon <string> Published resource icon file name. Can be an executable (.exe), a .dll or a .ico file.
-IconIndex <uint> Icon index
Specifies the index of the icon that will be loaded from the binary specified in the Icon property
-ReplicateMaintenance <bool> Replicate Maintenance
-InheritMaintenance <bool> Inherit Maintenance
-Enabled <bool> Enable or disable a published resource.
-EnabledMode <> Changes the availability status of the published resource.
Possible values: Disabled, Enabled, Maintenance
-MaintenanceMessage_en_US <string> Maintenance message for the published resource in English.
-MaintenanceMessage_ja_JP <string> Maintenance message for the published resource in Japanese.
-MaintenanceMessage_fr_FR <string> Maintenance message for the published resource in French.
-MaintenanceMessage_es_ES <string> Maintenance message for the published resource in Spanish.
-MaintenanceMessage_it_IT <string> Maintenance message for the published resource in Italian.
-MaintenanceMessage_pt_BR <string> Maintenance message for the published resource in Portuguese.
-MaintenanceMessage_nl_NL <string> Maintenance message for the published resource in Dutch.
-MaintenanceMessage_de_DE <string> Maintenance message for the published resource in German.
-MaintenanceMessage_zh_TW <string> Maintenance message for the published resource in Chinese (Traditional).
-MaintenanceMessage_zh_CN <string> Maintenance message for the published resource in Chinese (Simplified).
-MaintenanceMessage_ko_KR <string> Maintenance message for the published resource in Korean.
-Description <string> Published resource description.
-PublishToSite <> An array of sites to which to publish a resource.
-PublishToSiteIds <uint[]> An array of sites to which to publish a resource.
-PreferredRoutingEnabled <bool> Enable or disable Preferred Routing.
-Id <uint> Published resource ID.
-InputObject <> An object specifying the published resource.
To obtain the object, use the Get-PubItem cmdlet.
-SiteId <uint> Site ID.
<CommonParameters>
-none-
---------- 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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? false Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation.