Edit

Share via

Import-WmsVirtualDesktop

Module:
MultiPointVdi Module

Creates a virtual desktop template hard disk image.

Syntax

Default (Default) 

Import-WmsVirtualDesktop
    -InputFilePath <String>
    [-VhdLocation <String>]
    -TemplatePrefix <String>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Import-WmsVirtualDesktop cmdlet creates the Windows MultiPoint Services (WMS) virtual switch if it doesn't already exist, shuts down any existing MultiPoint station virtual machines that may be running, and creates a template virtual machine hard disk (.vhd) from the specified Windows image.

Examples

Example 1: Import a template

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

This command creates a virtual machine template named MyVdiImage that installs the guest operating system from C:\images\Windows10Enterprise.iso, and stores the resulting .vhd file in the folder C:\MultiPointVhdImages.

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

-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

-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 in which 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