The New-SCVirtualDiskDrive cmdlet creates a virtual disk drive object on a virtual machine deployed on a host managed by Virtual Machine Manager (VMM), or creates a virtual disk drive object on a template in the VMM library.
In System Center, you can create a differencing disk by using the Differencing and ParentVirtualHardDiskPath parameters.
A differencing disk is a disk associated in a parent-child relationship to another disk that you want to leave intact.
You can change the data or operating system on the child disk without affecting the parent disk.
You can revert changes to the child disk.
The child disk must have the same virtual hard disk format as the parent disk, either VHD or VHDX.
You can set the format by using the VirtualHardDiskFormat parameter.
A virtual hard disk file that is stored on a VMM library share, but is not attached to a virtual disk drive, exists as a stand-alone object in the library.
It could be a Windows-based .vhd or .vhdx file or a VMware-based .vmdk file.
A pass-through disk is a disk on a Hyper-V or VMware ESX host that a virtual machine on that host can use instead of using a virtual hard disk.
The corresponding VMware term is Raw Device Mapping (RDM).
The host disk is either a local hard disk or a logical unit on a Storage Area Network (SAN).
VMM lets the virtual machine bypass the host file system and access the pass-through disk directly.
Hyper-V hosts support pass-through disks and conversion of a pass-through disk to a VHD.
VMware ESX hosts support pass-through disks, but not disk conversion.
Citrix XenServer hosts do not support pass-through disks.
You cannot create a checkpoint of a pass-through disk because checkpoint creation is designed to work with virtual hard disks.
Examples
Example 1: Create a virtual disk drive on a template and attach an existing virtual hard disk
The first command gets the virtual hard disk object named Blank Disk - Small from the VMM library by using the Get-SCVirtualHardDisk cmdlet.
The command stores that object in the $VHD variable.
The second command gets the virtual machine template object named VMTemplate01 from the library by using the Get-SCVMTemplate cmdlet.
The command stores stores that object in the $Template variable.
The last command creates a virtual disk drive on VMTemplate01.
The commandattaches the virtual hard disk stored in $VHD to the second channel in the second slot of the IDE bus on the virtual disk drive.
Example 2: Create a virtual disk drive and add it to an existing virtual machine
The first command gets the virtual machine object named VM01 by using the Get-SCVirtualMachine cmdlet.
The command stores that object in the $VM variable.
The second command creates a dynamic virtual disk drive on the first IDE channel in the second slot of the virtual machine.
The command specifies its size as 19.5 GB.
Example 3: Create a virtual disk drive from an existing VHD and attach it to a new virtual machine
The first command generates a GUID, and the stores it as a string in the $JobGroupID variable.
The job group ID functions as an identifier that groups subsequent commands that include $JobGroupID into a single job group.
The second command gets the virtual hard disk object from the VMM library location \LibraryServer01.Contoso.com\MSSCVMMLibrary\VHDs\Blank Disk - Large.vhd, and then stores that object in the $VHD variable.
The third command creates a virtual hard disk drive object and assigns the new object to IDE Bus 0 and LUN 1.
This command also attaches the virtual hard disk stored in $VHD to the new object.
By using the JobGroup parameter, this command runs just before the last command that invokes the job group and associate the new virtual hard disk drive object with the new virtual machine created in the previous command.
The fourth command gets the hardware profile object that contains the string NewHWProfile01 in its name by using the Get-SCHardwareProfile cmdlet.
The command stores that object in the $HwProfile variable.
The fifth command gets the host object named VMHost03 by using the Get-SCVMHost cmdlet.
The command stores the host object in the $VMHost variable.
The last command creates a virtual machine named VM10 using the hardware settings stored in $HWProfile.
The command deploys the virtual machine on VMHost03.
The command specifies that the virtual machine is not automatically started when the host starts and is put into a saved state when the virtualization service stops.
This command uses the JobGroup parameter to indicate that any previous cmdlets that use the same job group ID is run before creating the virtual machine.
In this case, the New-SCVirtualDiskDrive cmdlet from the third command creates a virtual disk drive and associates it with the new virtual machine.
Example 4: Create a virtual disk drive using a host disk and attach it to an existing virtual machine
The first command gets the virtual machine object named VM04, and then stores that object in the $VM variable.
The second command gets the host object named VMHost04, and then stores that object in the $VMHost variable.
The third command gets all storage disk objects on VMHost04 that are pass-through capable, and then stores those objects in the $HostDisk variable.
Using the @ symbol and parentheses makes sure that the command stores the results in an array, in case the command returns a single object or a $Null value.
The last command creates a virtual disk drive object that is connected to a physical host disk on VMHost04.
The virtual disk drive is attached to the second slot of the first SCSI bus on VM04.
This example assumes the virtual machine already has a SCSI controller.
Example 5: Create a virtual disk drive from an existing VHDX and attach it to an existing virtual machine
The first command gets the virtual hard disk object named Blank Disk - Large.vhdx from the VMM library, and then stores that object in the $VHDX variable.
The second command gets the virtual machine object named VM05, and then stores that object in the $VM variable.
The last command creates a virtual disk drive from Blank Disk - Large.vhdx and attaches the new virtual disk drive to VM05.
Example 6: Create a differencing disk and attach it to an existing virtual machine
The first command gets the virtual machine object named VM06, and that stores that object in the $VM variable.
The second command creates a differencing disk named DiffDisk.vhdx that has the specified parent disk, and attaches the differencing disk to VM06.
Parameters
-AnyStorageDisk
Indicates that this cmdlet uses placeholder parameter that indicates the creation of pass-through disks in a new virtual machine job group.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
AnyHostDisk
Parameter sets
AnyHostDiskToTemplateParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
AnyHostDiskToTemplateParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
AnyHostDiskToJobGroupParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
AnyHostDiskToJobGroupParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-BootVolume
Indicates that the volume attached to the VirtualDiskDrive is a boot volume.
Parameter properties
Type:
SwitchParameter
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
-Bus
Specifies the IDE bus to which to attach a virtual disk drive or the SCSI bus to which to attach a virtual disk drive.
Parameter properties
Type:
Byte
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
-CreateDiffDisk
Indicates whether the cmdlet creates a differencing disk.
Parameter properties
Type:
Boolean
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
-Differencing
Indicates that the virtual hard disk is created as a differencing disk.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
newVirtualDiskDriveDifferencing
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Dynamic
Specifies that a virtual hard disk can expand dynamically.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
newToVMParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-FileName
Specifies the file name to use when you rename a virtual hard disk file as you add it to a virtual machine.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
existingVHDToVMParamSetSCSI
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToJobGroupParamSetIDE
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToVMParamSetIDE
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToJobGroupParamSetSCSI
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToVMParamSetSCSI
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToJobGroupParamSetSCSI
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Fixed
Indicates that a virtual hard disk is fixed in size.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
newToVMParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-IDE
Indicates that IDE is the bus type to which to attach a virtual disk drive object configured on a virtual machine or on a template.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
existingVHDToTemplateParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToJobGroupParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToVMParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingHostVHDToVMParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToVMParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
AnyHostDiskToTemplateParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToJobGroupParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
AnyHostDiskToJobGroupParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingHostVHDToVMParamSetIDEJobGroup
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-JobGroup
Specifies an identifier for a series of commands that run as a set just before the final command that includes the same job group identifier runs.
Parameter properties
Type:
Guid
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
existingVHDToJobGroupParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToJobGroupParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToJobGroupParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToJobGroupParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
AnyHostDiskToJobGroupParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
AnyHostDiskToJobGroupParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingHostVHDToVMParamSetSCSIJobGroup
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingHostVHDToVMParamSetIDEJobGroup
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-JobVariable
Specifies a variable in which job progress is tracked and stored.
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
-LUN
Specifies the logical unit number (LUN) for a virtual disk drive object or for a virtual disk drive object on a SCSI bus.
Parameter properties
Type:
Byte
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
-OnBehalfOfUser
Specifies a user name.
This cmdlet operates on behalf of the user that this parameter specifies.
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
-OnBehalfOfUserRole
Specifies a user role.
To obtain a user role, use the Get-SCUserRole cmdlet.
This cmdlet operates on behalf of the user role that this parameter specifies.
Parameter properties
Type:
UserRole
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
-ParentVirtualHardDiskPath
Specifies the path of the parent virtual hard disk to use to create a differencing disk.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
newVirtualDiskDriveDifferencing
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Path
Specifies the destination path for the virtual disk drive.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
existingVHDToVMParamSetSCSI
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToJobGroupParamSetIDE
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToVMParamSetIDE
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToJobGroupParamSetSCSI
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToVMParamSetSCSI
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetSCSIFixed
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetIDEFixed
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetIDEDynamic
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetSCSIDynamic
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newVirtualDiskDriveDifferencing
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToJobGroupParamSetSCSI
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetSCSIFixed
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetIDEDynamic
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetSCSIDynamic
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetIDEFixed
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-PROTipID
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action.
This parameter lets you audit PRO tips.
Parameter properties
Type:
Guid
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
-ReturnImmediately
Indicates that control is returned to the calling process immediately, before the job is created.
Parameter properties
Type:
SwitchParameter
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
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Parameter properties
Type:
SwitchParameter
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
-SCSI
Specifies SCSI as the bus type to which to attach a virtual disk drive object configured on a virtual machine or on a template.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
existingVHDToVMParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToTemplateParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToJobGroupParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToVMParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingHostVHDToVMParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
AnyHostDiskToTemplateParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToJobGroupParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
AnyHostDiskToJobGroupParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingHostVHDToVMParamSetSCSIJobGroup
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-SharedStorage
Indicates whether the virtual disk drive uses shared storage.
Parameter properties
Type:
Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
existingVHDToTemplateParamSetSCSI
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToJobGroupParamSetSCSI
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-StorageClassification
Specifies a storage classification object.
Parameter properties
Type:
StorageClassification
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
-StorageDisk
Specifies a disk on a Hyper-V or VMware ESX host that a virtual machine on that host can use instead of using a virtual hard disk.
This disk is referred to as a pass-through disk.
The corresponding VMware term is Raw Device Mapping (RDM).
The host disk is either a local hard disk or a logical unit on a Storage Area Network (SAN).
VMM lets the virtual machine bypass the host's file system and access the pass-through disk directly.
Hyper-V hosts support pass-through disks and conversion of a pass-through disk to a VHD.
VMware ESX hosts support pass-through disks, but not disk conversion.
Citrix XenServer hosts do not support pass-through disks.
Parameter properties
Type:
StorageDisk
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
HostDisk
Parameter sets
HostDiskToVMParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToVMParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToJobGroupParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToJobGroupParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-StorageQoSPolicy
Specifies a storage Quality of Service (QoS) policy.
Parameter properties
Type:
StorageQoSPolicy
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
-SystemVolume
Indicates that the volume attached to the VirtualDiskDrive is a system volume.
Parameter properties
Type:
SwitchParameter
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
-UseLocalVirtualHardDisk
Verifies that the VHD file or files to use to create the virtual machine exist and are stored on the destination host.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
existingHostVHDToVMParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingHostVHDToVMParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingHostVHDToVMParamSetSCSIJobGroup
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingHostVHDToVMParamSetIDEJobGroup
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-VirtualHardDisk
Specifies a virtual hard disk object.
Parameter properties
Type:
StandaloneVirtualHardDisk
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
existingVHDToTemplateParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToVMParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToJobGroupParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToVMParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToTemplateParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToJobGroupParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-VirtualHardDiskFormatType
Specifies the hard disk format type.
Valid values are:
VHD
VMDK
VHDX
Parameter properties
Type:
VHDFormatType
Default value:
None
Accepted values:
VHD, VMDK, VHDX, VHDS
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
-VirtualHardDiskSizeMB
Specifies the size, in megabytes (MB), of a fixed virtual hard disk file or the maximum possible size of a dynamically expanding virtual hard disk file.
Parameter properties
Type:
Int64
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
Size
Parameter sets
newToVMParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToJobGroupParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-VM
Specifies a virtual machine object.
Parameter properties
Type:
VM
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
existingVHDToVMParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToVMParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToVMParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingHostVHDToVMParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingHostVHDToVMParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
HostDiskToVMParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToVMParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-VMMServer
Specifies a VMM server object.
Parameter properties
Type:
ServerConnection
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-VMTemplate
Specifies a VMM template object that is used to create virtual machines.
Parameter properties
Type:
Template
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
Template
Parameter sets
existingVHDToTemplateParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
existingVHDToTemplateParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetSCSIDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetIDEDynamic
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
AnyHostDiskToTemplateParamSetSCSI
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
AnyHostDiskToTemplateParamSetIDE
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetIDEFixed
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
newToTemplateParamSetSCSIFixed
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-VolumeType
Specifies the volume type for a virtual hard disk.
Valid values are: Boot, System, BootAndSystem, and None.
Parameter properties
Type:
VolumeType
Default value:
None
Accepted values:
None, Boot, System, BootAndSystem
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
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.
Outputs
VirtualDiskDrive
This cmdlet returns a VirtualDiskDrive object.
Notes
This cmdlet requires a VMM virtual hard disk object, which can be retrieved by using the Get-SCVirtualHardDisk cmdlet.