> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/new-raspubrdsdesktop.md).

# New-RASPubRDSDesktop

## SYNOPSIS

Adds a published desktop to a site.

## SYNTAX

```powershell
New-RASPubRDSDesktop [-Name] <string> [-AllowMultiMonitor {Enabled | Disabled | UseClientSettings}]
 [-ConnectToConsole <SwitchParameter>] [-Description <string>]
 [-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 {Disabled | Enabled | Maintenance}] [-Height <uint>] [-Icon <string>]
 [-IconIndex <uint>] [-InheritMaintenance <bool>] [-MaintenanceMessage_de_DE <string>]
 [-MaintenanceMessage_en_US <string>] [-MaintenanceMessage_es_ES <string>]
 [-MaintenanceMessage_fr_FR <string>] [-MaintenanceMessage_it_IT <string>]
 [-MaintenanceMessage_ja_JP <string>] [-MaintenanceMessage_ko_KR <string>]
 [-MaintenanceMessage_nl_NL <string>] [-MaintenanceMessage_pt_BR <string>]
 [-MaintenanceMessage_zh_CN <string>] [-MaintenanceMessage_zh_TW <string>]
 [-ParentFolder <PubFolder>] [-ParentId <uint>] [-PreviousId <uint>] [-PreviousItem <PubItem>]
 [-PublishFrom {All | HostPool | Group | Host | Server}] [-PublishFromGroup <RDSHostPool[]>]
 [-PublishFromHostPoolIds <uint[]>] [-PublishFromServer <RDSHost[]>]
 [-PublishFromServerIds <uint[]>] [-PublishToSite <Site[]>] [-PublishToSiteIds <uint[]>]
 [-ReplicateMaintenance <bool>] [-SiteId <uint>] [-StartOnLogon <SwitchParameter>] [-Width <uint>]
 [<CommonParameters>]
```

## DESCRIPTION

Adds a published desktop to a site.

The only mandatory parameter is -Name (a name you want to use for the desktop). All other parameters are optional.

## EXAMPLES

### Example 1

```powershell
New-RASPubRDSDesktop "My RDS Desktop"
```

Adds a published desktop and gives it the specified name.

## PARAMETERS

### -ConnectToConsole

Enable or disable the 'Connect to console' option.

```yaml
Type: SwitchParameter
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

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

Type reference: [PublishFrom](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/publishfrom.md)

```yaml
Type: PublishFrom
Required: False
Position: Named
Default value: All
Accept pipeline input: False
Accept wildcard characters: False
```

### -PublishFromGroup

Specifies one or multiple groups from which to publish a desktop.

The PublishFrom parameter must specify 1 (HostPool).

Type reference: [RDSHostPool\[\]](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/rdshostpool.md)

```yaml
Type: RDSHostPool[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PublishFromHostPoolIds

Specifies one or multiple host pool Ids from which to publish a desktop.

The PublishFrom parameter must specify 1 (HostPool).

```yaml
Type: uint[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PublishFromServer

Specifies one or multiple RDS Host servers from which to publish a desktop.

The PublishFrom parameter must specify 2 (Host).

Type reference: [RDSHost\[\]](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/rdshost.md)

```yaml
Type: RDSHost[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PublishFromServerIds

Specifies one or multiple RDS Host server Ids from which to publish a desktop.

The PublishFrom parameter must specify 2 (Host).

```yaml
Type: uint[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -StartOnLogon

Enable or disable the 'Start automatically when user logs on' option.

```yaml
Type: SwitchParameter
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -Width

Specifies a custom desktop width.

```yaml
Type: uint
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -Height

Specifies a custom desktop height.

```yaml
Type: uint
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

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

Type reference: [DesktopSize](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/desktopsize.md)

```yaml
Type: DesktopSize
Required: False
Position: Named
Default value: FullScreen
Accept pipeline input: False
Accept wildcard characters: False
```

### -AllowMultiMonitor

Specifies the "Multi-monitor" option.

Acceptable values: Enabled, Disabled, UseClientSettings.

Possible values: Enabled, Disabled, UseClientSettings

Type reference: [AllowMultiMonitor](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/allowmultimonitor.md)

```yaml
Type: AllowMultiMonitor
Required: False
Position: Named
Default value: UseClientSettings
Accept pipeline input: False
Accept wildcard characters: False
```

### -Name

Published resource name.

```yaml
Type: string
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ParentFolder

Parent publishing folder.

Type reference: [PubFolder](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/pubfolder.md)

```yaml
Type: PubFolder
Required: False
Position: Named
Default value: None
Accept pipeline input: true (ByValue, ByPropertyName)
Accept wildcard characters: False
```

### -ParentId

Parent publishing folder ID.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PreviousItem

Previous published item.

Type reference: [PubItem](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/pubitem.md)

```yaml
Type: PubItem
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PreviousId

Previous published ID.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Icon

An icon to use for a publishing resource.

This can be an executable (.exe), a .dll or a .ico file.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -IconIndex

Specifies the index of the icon that will be loaded from the binary specified in the Icon property.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ReplicateMaintenance

Whether the option 'Replicate Maintenance' is enabled or not.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -InheritMaintenance

Whether to inherit default Maintenance settings.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnabledMode

Changes the availability status of the published resource.

Possible values: Disabled, Enabled, Maintenance

Type reference: [PubResourceEnabledMode](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/pubresourceenabledmode.md)

```yaml
Type: PubResourceEnabledMode
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaintenanceMessage\_en\_US

Maintenance message for the published resource in English.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaintenanceMessage\_ja\_JP

Maintenance message for the published resource in Japanese.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaintenanceMessage\_fr\_FR

Maintenance message for the published resource in French.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaintenanceMessage\_es\_ES

Maintenance message for the published resource in Spanish.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaintenanceMessage\_it\_IT

Maintenance message for the published resource in Italian.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaintenanceMessage\_pt\_BR

Maintenance message for the published resource in Portuguese.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaintenanceMessage\_de\_DE

Maintenance message for the published resource in German.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaintenanceMessage\_nl\_NL

Maintenance message for the published resource in Dutch.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaintenanceMessage\_zh\_TW

Maintenance message for the published resource in Chinese (Traditional).

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaintenanceMessage\_zh\_CN

Maintenance message for the published resource in Chinese (Simplified).

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaintenanceMessage\_ko\_KR

Maintenance message for the published resource in Korean.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Description

Published resource description.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PublishToSite

An array of sites to which to publish a resource.

Type reference: [Site\[\]](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/site.md)

```yaml
Type: Site[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PublishToSiteIds

An array of Sites IDs to which to publish a resource.

```yaml
Type: uint[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SiteId

Site ID in which to publish the specified Item.

If the parameter is omitted, the site ID of the Licensing Server will be used.

```yaml
Type: uint
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### [PubFolder](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/pubfolder.md)

## OUTPUTS

### [PubRDSDesktop](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/pubrdsdesktop.md)

## RELATED LINKS

* [Get-RASPubRDSDesktop](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-raspubrdsdesktop.md)
* [Set-RASPubRDSDesktop](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-raspubrdsdesktop.md)
* [Remove-RASPubRDSDesktop](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-raspubrdsdesktop.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/new-raspubrdsdesktop.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
