New-CMVhd

New-CMVhd

Creates a VHD image.

Syntax

Parameter Set: New
New-CMVhd -DistributionPointServerNames <String[]> -Name <String> -Path <String> -TaskSequencePackageId <String> [-Description <String> ] [-Version <String> ] [-VHDSize <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The New-CMVhd cmdlet creates a virtual hard disk (VHD) image by using the operating system deployment feature.

Parameters

-Description<String>

Specifies a description for the VHD.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DistributionPointServerNames<String[]>

Specifies an array of names of distribution point servers, which contain content that the task sequence requires.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a VHD image.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Path<String>

Specifies a path for the VHD image.

Aliases

PackageSourcePath

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-TaskSequencePackageId<String>

Specifies an ID for a task sequence package.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Version<String>

Specifies a version for the VHD. Use any string.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-VHDSize<Int32>

Specifies the initial size, in gigabytes, of a dynamically expanding VHD. The default value is 50 GB.

Aliases

none

Required?

false

Position?

named

Default Value

50 GB

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Create a VHD image

This command creates a virtual hard disk (VHD) image named Windows 10 Enterprise, and then copies the VHD image file to the distribution point that is named distribution-server.contoso.com.

PS C:\> New-CMVhd -Name "Windows 10 Enterprise " -Path "\\vhd-server\hyper-v\ Windows10.vhd" -VHDSize 50 -TaskSequencePackageId "P0071267" -DistributionPointServerNames "distribution-server.contoso.com" -Version "X64"

Get-CMVhd

Remove-CMVhd

Set-CMVhd