Edit

Share via

New-WmsVirtualDesktopTemplate

Module:
MultiPointVdi Module

Create a virtual desktop template.

Syntax

NonDomainJoin 

New-WmsVirtualDesktopTemplate
    -InputFilePath <String>
    -TemplatePrefix <String>
    -AdministratorUser <String>
    -AdministratorPassword <String>
    [-VhdLocation <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DomainJoin 

New-WmsVirtualDesktopTemplate
    -InputFilePath <String>
    -TemplatePrefix <String>
    -AdministratorUser <String>
    -Domain <String>
    [-VhdLocation <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-WmsVirtualDesktopTemplate cmdlet shuts down all station virtual desktops based on an existing template of the same name. It then creates a virtual desktop template using the virtual hard disk created with Import-WmsVirtualDesktop. This virtual desktop is in either a workgroup or attached to the supplied domain, and has an administrative account with the specified user name and password.

Examples

Example 1: Create a virtual desktop template

PS C:\> New-WmsVirtualDesktopTemplate -InputFilePath "C:\Images\Windows10Enterprise.iso" -TemplatePrefix "MyVdiImage" -VhdLocation "C:\MultiPointVhdImages" -AdministratorUser "admin" -AdministratorPassword "password"

This command creates a virtual desktop template that you can customize or use to generate station virtual desktops.

Parameters

-AdministratorPassword

Specifies the password to assign to the Administrator account.

Parameter properties

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

Parameter sets

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

-AdministratorUser

Specifies the name of a user to create in the virtual desktop template that has Administrator privileges.

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

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

Parameter properties

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

Parameter sets

DomainJoin
Position:Named
Mandatory:True
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 to the location to store the desktop 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