Edit

Share via


New-WmsVirtualDesktop

Creates a virtual desktop.

Syntax

CreateVirtualDesktopById

New-WmsVirtualDesktop
    [-StationId] <UInt32[]>
    -InputFilePath <String>
    -TemplatePrefix <String>
    [-VhdLocation <String>]
    [-Domain <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateAllVirtualDesktops

New-WmsVirtualDesktop
    -InputFilePath <String>
    -TemplatePrefix <String>
    [-All]
    [-VhdLocation <String>]
    [-Domain <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-WmsVirtualDesktop cmdlet creates a virtual desktop from the specified virtual desktop template for a specified MultiPoint station or all stations, and replaces any existing stations in the process.

Examples

Example 1: Create a virtual desktop for all stations on a computer

PS C:\> New-WmsVirtualDesktop -All -InputFilePath "C:\Images\Windows10Enterprise.iso" -TemplatePrefix "MyVdiImage" -VhdLocation "C:\MultiPointVhdImages"

This command creates a virtual desktop from the template in C:\Images\Windows10Enterprise.iso for all of the stations on a computer.

Parameters

-All

Indicates that this operation creates a virtual desktop for all stations.

Parameter properties

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

Parameter sets

CreateAllVirtualDesktops
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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 to contain the virtual desktop.

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

-InputFilePath

Specifies the full path of the input file to use for the virtual desktop template. Valid file types are .wim, .iso, or .vhd that contains the version of Windows to use as the guest operating system.

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

-StationId

Specifies an array of station IDs for which to create a virtual desktop.

Parameter properties

Type:

UInt32[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateVirtualDesktopById
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-TemplatePrefix

Specifies the prefix to use for the name of the virtual machine 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

-VhdLocation

Specifies the path to store the template and station .vhd files.

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

-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