Set-PubVDIDesktop

Set-PubVDIDesktop

Modifies properties of a published desktop.

Set-PubVDIDesktop [-InputObject] <PubItem> [-AllowMultiMonitor <AllowMultiMonitor> {Enabled | Disabled | UseClientSettings}] [-ConnectTo <VDIMatchingMode> {AnyGuest | SpecificRASTemplate}] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-DesktopSize <DesktopSizes> {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>] [-Height <uint>] [-Icon <string>] [-IconIndex <uint>] [-InheritShortcutDefaultSettings <bool>] [-NewName <string>] [-Persistent <bool>] [-PublishToSite <Site[]>] [-PublishToSiteIds <List`1>] [-ReplicateShortcutSettings <bool>] [-SiteId <uint>] [-StartOnLogon <bool>] [-StartPath <string>] [-VDIPool <VDIPool>] [-VDIPoolId <uint>] [-VDITemplate <VDITemplate>] [-Width <uint>] [<CommonParameters>]

Set-PubVDIDesktop [-Id] <uint> [-AllowMultiMonitor <AllowMultiMonitor> {Enabled | Disabled | UseClientSettings}] [-ConnectTo <VDIMatchingMode> {AnyGuest | SpecificRASTemplate}] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-DesktopSize <DesktopSizes> {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>] [-Height <uint>] [-Icon <string>] [-IconIndex <uint>] [-InheritShortcutDefaultSettings <bool>] [-NewName <string>] [-Persistent <bool>] [-PublishToSite <Site[]>] [-PublishToSiteIds <List`1>] [-ReplicateShortcutSettings <bool>] [-SiteId <uint>] [-StartOnLogon <bool>] [-StartPath <string>] [-VDIPool <VDIPool>] [-VDIPoolId <uint>] [-VDITemplate <VDITemplate>] [-Width <uint>] [<CommonParameters>]

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-PubItemClientFilter).

-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

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

This is an alias of the VDIPoolId parameter.

        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 <DesktopSizes>
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

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

Acceptable values: Enabled, Disabled, UseClientSettings.

Possible values: Enabled, Disabled, UseClientSettings

This is an alias of the AllowMultiMonitor parameter.

        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

-InheritShorcutDefaultSettings <bool>
Inherit default shortcut settings.

This is an alias of the InheritShortcutDefaultSettings parameter.

        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

-InputObject <PubItem>
Published item to be updated.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-NewName <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

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

This is an alias of the Enabled parameter.

        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 <List`1>
An array of sites to which to publish a resource.

        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

-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. 

PubItem

---------- EXAMPLE 1 ----------

Set-PubVDIDesktop -Id 1 -Enabled $false

Disables a published desktop specified by ID.

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

Set-PubVDIDesktop $PubVDIDesktop -Enabled $false

Disables a published desktop specified by the $PubVDIDesktop object.

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

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

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

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