New-PubVDIDesktop

NAME

New-PubVDIDesktop

SYNOPSIS

Adds a published VDI desktop to a site.

SYNTAX

New-PubVDIDesktop [-Name] <string> [-ConnectTo <VDIMatchingMode> {AnyGuest | SpecificGuest | Guest | SpecificRASTemplate}] [-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}] [-Enable <bool>] [-Height <uint>] [-Icon <string>] [-IconIndex <uint>] [-MultiMonitor <AllowMultiMonitor> {Enabled | Disabled | UseClientSettings}] [-NameRule <VDINameRule> {Username | IPAddress}] [-ParentFolder <PubFolder>] [-Persistent <bool>] [-PoolId <uint>] [-PublishToSite <Site[]>] [-SiteId <uint>] [-StartOnLogon <SwitchParameter>] [-VDIGuest <VDIGuest>] [-VDITemplate <VDITemplate>] [-Width <uint>] [<CommonParameters>]

DESCRIPTION

Adds a published VDI desktop to a site.

PARAMETERS


-Persistent <bool>
Specifies whether the connection is persistent or not.

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

-ConnectTo <VDIMatchingMode>
Specifies the 'Matching Mode' option to connect with.

Acceptable values: 0 (Any Guest), 1 (Specific Guest), 2 (Guest), 3 (Specific RAS Template).

Named values can also be used: AnyGuest, SpecificGuest, Guest.

Possible values: AnyGuest, SpecificGuest, Guest, SpecificRASTemplate

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

-NameRule <VDINameRule>
Specifies the 'Name Rule' option.

Acceptable values: 0 (Username), 1 (IP Address).

Named values can also be used: Username, IPAddress

Possible values: Username, IPAddress

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

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

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

-VDIGuest <VDIGuest>
Specifies the guest VM 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

-StartOnLogon <SwitchParameter>
Enables or disables the 'Start automatically when user logs on' option.

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

-Width <uint>
Specified a custom desktop width.

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

-Height <uint>
Specifies a custom desktop height.

        Required?                    false
        Position?                    named
        Default value                0
        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                FullScreen
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

Acceptable values: 0 (Enable), 1 (disable), 2 (Use client settings).

Possible values: Enabled, Disabled, UseClientSettings

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

-Name <string>
Published resource name.

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ParentFolder <PubFolder>
Parent publishing folder name.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-Icon <string>
An icon to use for a publishing resource.

This can be an executable or a .dll 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

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

        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

-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 (http://go.microsoft.com/fwlink/?LinkID=113216). 

INPUTS

PSAdmin.PubFolder

        Parent publishing folder name.

OUTPUTS

PSAdmin.PubVDIDesktop

EXAMPLES


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

New-PubVDIDesktop "My VDI Desktop"

Adds a published desktop and gives it the specified name.

RELATED LINKS

Parallels RAS v16.0