New-RASPubRDSDesktop
NAME
New-RASPubRDSDesktop
SYNOPSIS
Adds a published desktop to a site.
SYNTAX
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}] [-Enabled <bool>] [-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.
PARAMETERS
-ConnectToConsole <SwitchParameter> Enable or disable the 'Connect to console' option.
Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false-PublishFrom <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
Required? false Position? named Default value All Accept pipeline input? false Accept wildcard characters? false-PublishFromGroup <RDSHostPool[]> Specifies one or multiple groups from which to publish a desktop. The PublishFrom parameter must specify 1 (HostPool).
Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false-PublishFromHostPoolIds <uint[]> Specifies one or multiple host pool Ids from which to publish a desktop. The PublishFrom parameter must specify 1 (HostPool).
Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false-PublishFromServer <RDSHost[]> Specifies one or multiple RDS Host servers from which to publish a desktop. The PublishFrom parameter must specify 2 (Host).
Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false-PublishFromServerIds <uint[]> Specifies one or multiple RDS Host server Ids from which to publish a desktop. The PublishFrom parameter must specify 2 (Host).
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> 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> 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> 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> 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> 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-ReplicateMaintenance <bool> Replicate Maintenance.
Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false-InheritMaintenance <bool> Inherit Maintenance.
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-EnabledMode <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[]> 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.
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 .
INPUTS
OUTPUTS
EXAMPLES
---------- EXAMPLE 1 ---------- New-RASPubRDSDesktop "My RDS Desktop" Adds a published desktop and gives it the specified name.
Last updated