Edit

Share via


Open-WmsVirtualDesktop

Opens a window connected to a virtual desktop template.

Syntax

Default (Default)

Open-WmsVirtualDesktop
    -TemplateVirtualMachineGuid <String>
    [-Domain <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Open-WmsVirtualDesktop cmdlet opens a window connected to the specified virtual desktop template. This enables you to customize the virtual desktop template in order to customize virtual desktops that you create.

Examples

Example 1: Open a window to a virtual desktop template

PS C:\> Open-WmsVirtualDesktop -TemplateVirtualMachineGuid "53F56307-B6BF-11D0-94F2-00A0C91EFB8B"

This command opens a window that is connected to the virtual desktop template with the ID 53F56307-B6BF-11D0-94F2-00A0C91EFB8B.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Domain

Specifies the name of the Active Directory domain that contains the virtual desktop template.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TemplateVirtualMachineGuid

Specifies the Hyper-V virtual machine ID of the virtual desktop template.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

None