# New-RASPubVDIDesktop ## NAME New-RASPubVDIDesktop ## SYNOPSIS Adds a published VDI desktop to a site. ## SYNTAX **New-RASPubVDIDesktop** \[[Name](#name-string)]\*\* *(string)* \[-[AllowMultiMonitor](#AllowMultiMonitor) {Enabled | Disabled | UseClientSettings}] \[-[ConnectTo](#ConnectTo) {AnyGuest}] \[[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}] \[[Height](#height-string) *(uint)*] \[[Icon](#icon-string) *(string)*] \[[IconIndex](#iconindex-string) *(uint)*] \[[InheritMaintenance](#inheritmaintenance-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)*] \[-[ParentFolder](#ParentFolder) *(*[*PubFolder*](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/pubfolder)*)*] \[[ParentId](#parentid-string) *(uint)*] \[[Persistent](#persistent-string) *(bool)*] \[[PreviousId](#previousid-string) *(uint)*] \[-[PreviousItem](#PreviousItem) *(*[*PubItem*](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/pubitem)*)*] \[-[PublishToSite](#PublishToSite) *(*[*Site\[\]*](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/site)*)*] \[-[PublishToSiteIds](#PublishToSiteIds) *(uint\[])*] \[[ReplicateMaintenance](#replicatemaintenance-string) *(bool)*] \[[SiteId](#siteid-string) *(uint)*] \[[StartOnLogon](#startonlogon-string) *(SwitchParameter)*] \[-[VDIHostPool](#VDIHostPool) *(*[*VDIHostPool*](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/vdihostpool)*)*] \[[VDIHostPoolId](#vdihostpoolid-string) *(uint)*] \[-[VDITemplate](#VDITemplate) *(*[*Template*](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/template)*)*] \[[VDITemplateId](#vditemplateid-string) *(uint)*] \[[Width](#width-string) *(uint)*] \[*(*[*CommonParameters*](#CommonParameters)*)*] ## DESCRIPTION Adds a published VDI desktop to a site. In case of connecting to Any Desktop, one must specify a VDI Pool Id or Object. ## 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](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/vdimatchingmode)) Specifies the 'Matching Mode' option to connect with. Acceptable values: AnyGuest. Default: AnyGuest. Possible values: AnyGuest ``` Required? false Position? named Default value AnyGuest Accept pipeline input? false Accept wildcard characters? false ``` ## VDIHostPoolId (uint) Specifies the VDI Host Pool ID from which to publish a desktop. ``` Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false ``` ## VDIHostPool ([VDIHostPool](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/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 ``` ## VDITemplateId (uint) Specifies the VDI Template ID from which to publish an application. ``` Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false ``` ## VDITemplate ([Template](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/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 ``` ## StartOnLogon (SwitchParameter) Enable or disable 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) Specifies 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 ([DesktopSize](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/desktopsize)) Desktop Size. Possible values are: 0 (Use available area), 1 (Full screen), Custom = 25. Acceptable values: 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 ``` ## AllowMultiMonitor ([AllowMultiMonitor](https://docs.parallels.com/landing/ras-powershell-api-guide/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 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](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/pubfolder)) Parent publishing folder. ``` Required? false Position? named Default value Accept pipeline input? true (ByValue, ByPropertyName) Accept wildcard characters? false ``` ## ParentId (uint) Parent publishing folder ID. ``` Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false ``` ## PreviousItem ([PubItem](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/pubitem)) Previous published item. ``` Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false ``` ## PreviousId (uint) Previous published ID. ``` Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false ``` ## Icon (string) An icon to use for a publishing resource. This 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) 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) Whether the option 'Replicate Maintenance' is enabled or not. ``` Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false ``` ## InheritMaintenance (bool) Whether to inherit default Maintenance settings. ``` 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/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\_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\_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\_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/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 IDs to which to publish a resource. ``` Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false ``` ## SiteId (uint) Site ID in which to publish the specified Item. If the parameter is omitted, the site ID of the Licensing Server will be used. ``` 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 [PubFolder](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/pubfolder) ## OUTPUTS [PubVDIDesktop](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/pubvdidesktop) ## EXAMPLES **---------- EXAMPLE 1 ----------** New-RASPubVDIDesktop "My VDI Desktop" Adds a published desktop and gives it the specified name. ## RELATED LINKS * [Get-RASPubVDIDesktop](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/get-raspubvdidesktop) * [Set-RASPubVDIDesktop](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/set-raspubvdidesktop) * [Remove-RASPubVDIDesktop](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/remove-raspubvdidesktop) * [Get-RASVDIHost](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/get-rasvdihost)