Mount-SCStorageDisk

Mounts a storage disk.

Description

The Mount-SCStorageDisk cmdlet mounts a storage disk.

For more information about Mount-SCStorageDisk, type: "Get-Help Mount-SCStorageDisk -online".

Parameters

GuidPartitionTable

Required? true
Accept Pipeline Input? false
Position? named
Indicates that the storage disk is a GUID partition table disk.

JobGroup

Required? true
Accept Pipeline Input? false
Position? named
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs. 

QuickFormat

Required? true
Accept Pipeline Input? false
Position? named
Indicates that a quick format of the partition is performed.

StorageLogicalUnit

Required? true
Accept Pipeline Input? true (ByValue)
Position? named
Specifies a storage logical unit object.

CreateClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will create a Cluster Shared Volume.

DeleteClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will delete a Cluster Shared Volume.

DesiredUnitAllocationSizeBytes

Required? false
Accept Pipeline Input? false
Position? named
Specifies, in bytes, the default allocation size of a volume.

ForceFormat

Required? false
Accept Pipeline Input? false
Position? named
Forces the formatting of the storage disk even if volumes are already present.

FullFormat

Required? false
Accept Pipeline Input? false
Position? named
Indicates that a full format of the partition is performed.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

MountPoint

Required? false
Accept Pipeline Input? false
Position? named
Specifies a mount point location.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

VolumeLabel

Required? false
Accept Pipeline Input? false
Position? named
Specifies a label for a disk volume.

JobGroup

Required? true
Accept Pipeline Input? false
Position? named
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs. 

MasterBootRecord

Required? true
Accept Pipeline Input? false
Position? named
Indicates that the storage disk is a master boot record disk.

QuickFormat

Required? true
Accept Pipeline Input? false
Position? named
Indicates that a quick format of the partition is performed.

StorageLogicalUnit

Required? true
Accept Pipeline Input? true (ByValue)
Position? named
Specifies a storage logical unit object.

CreateClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will create a Cluster Shared Volume.

DeleteClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will delete a Cluster Shared Volume.

DesiredUnitAllocationSizeBytes

Required? false
Accept Pipeline Input? false
Position? named
Specifies, in bytes, the default allocation size of a volume.

ForceFormat

Required? false
Accept Pipeline Input? false
Position? named
Forces the formatting of the storage disk even if volumes are already present.

FullFormat

Required? false
Accept Pipeline Input? false
Position? named
Indicates that a full format of the partition is performed.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

MountPoint

Required? false
Accept Pipeline Input? false
Position? named
Specifies a mount point location.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

VolumeLabel

Required? false
Accept Pipeline Input? false
Position? named
Specifies a label for a disk volume.

JobGroup

Required? true
Accept Pipeline Input? false
Position? named
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs. 

StorageDisk

Required? true
Accept Pipeline Input? true (ByValue)
Position? named
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 referrred to as a pass-through disk (the corresponding VMware term is Raw Device Mapping, or 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.

TYPE OF HOST   PASS-THROUGH DISK SUPPORT
------------   -------------------------
Hyper-V		Supports pass-through disks
   Supports converting a pass-through disk to a VHD
VMware ESX	 Supports pass-through disks (RDP), but not disk conversion
Citrix XenServer Does not support pass-through disks

StorageLogicalUnit

Required? true
Accept Pipeline Input? true (ByValue)
Position? named
Specifies a storage logical unit object.

CreateClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will create a Cluster Shared Volume.

DeleteClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will delete a Cluster Shared Volume.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

MountPoint

Required? false
Accept Pipeline Input? false
Position? named
Specifies a mount point location.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

DiskId

Required? true
Accept Pipeline Input? false
Position? named
Specifies the ID of a disk object.

JobGroup

Required? true
Accept Pipeline Input? false
Position? named
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs. 

StorageDisk

Required? true
Accept Pipeline Input? true (ByValue)
Position? named
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 referrred to as a pass-through disk (the corresponding VMware term is Raw Device Mapping, or 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.

TYPE OF HOST   PASS-THROUGH DISK SUPPORT
------------   -------------------------
Hyper-V		Supports pass-through disks
   Supports converting a pass-through disk to a VHD
VMware ESX	 Supports pass-through disks (RDP), but not disk conversion
Citrix XenServer Does not support pass-through disks

CreateClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will create a Cluster Shared Volume.

DeleteClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will delete a Cluster Shared Volume.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

MountPoint

Required? false
Accept Pipeline Input? false
Position? named
Specifies a mount point location.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

DiskSignature

Required? true
Accept Pipeline Input? false
Position? named
Specifies the signature of a disk object.

JobGroup

Required? true
Accept Pipeline Input? false
Position? named
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs. 

StorageDisk

Required? true
Accept Pipeline Input? true (ByValue)
Position? named
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 referrred to as a pass-through disk (the corresponding VMware term is Raw Device Mapping, or 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.

TYPE OF HOST   PASS-THROUGH DISK SUPPORT
------------   -------------------------
Hyper-V		Supports pass-through disks
   Supports converting a pass-through disk to a VHD
VMware ESX	 Supports pass-through disks (RDP), but not disk conversion
Citrix XenServer Does not support pass-through disks

CreateClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will create a Cluster Shared Volume.

DeleteClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will delete a Cluster Shared Volume.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

MountPoint

Required? false
Accept Pipeline Input? false
Position? named
Specifies a mount point location.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

GuidPartitionTable

Required? true
Accept Pipeline Input? false
Position? named
Indicates that the storage disk is a GUID partition table disk.

JobGroup

Required? true
Accept Pipeline Input? false
Position? named
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs. 

StorageDisk

Required? true
Accept Pipeline Input? true (ByValue)
Position? named
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 referrred to as a pass-through disk (the corresponding VMware term is Raw Device Mapping, or 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.

TYPE OF HOST   PASS-THROUGH DISK SUPPORT
------------   -------------------------
Hyper-V		Supports pass-through disks
   Supports converting a pass-through disk to a VHD
VMware ESX	 Supports pass-through disks (RDP), but not disk conversion
Citrix XenServer Does not support pass-through disks

CreateClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will create a Cluster Shared Volume.

DeleteClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will delete a Cluster Shared Volume.

DesiredUnitAllocationSizeBytes

Required? false
Accept Pipeline Input? false
Position? named
Specifies, in bytes, the default allocation size of a volume.

ForceFormat

Required? false
Accept Pipeline Input? false
Position? named
Forces the formatting of the storage disk even if volumes are already present.

FullFormat

Required? false
Accept Pipeline Input? false
Position? named
Indicates that a full format of the partition is performed.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

MountPoint

Required? false
Accept Pipeline Input? false
Position? named
Specifies a mount point location.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

VolumeLabel

Required? false
Accept Pipeline Input? false
Position? named
Specifies a label for a disk volume.

JobGroup

Required? true
Accept Pipeline Input? false
Position? named
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs. 

MasterBootRecord

Required? true
Accept Pipeline Input? false
Position? named
Indicates that the storage disk is a master boot record disk.

StorageDisk

Required? true
Accept Pipeline Input? true (ByValue)
Position? named
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 referrred to as a pass-through disk (the corresponding VMware term is Raw Device Mapping, or 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.

TYPE OF HOST   PASS-THROUGH DISK SUPPORT
------------   -------------------------
Hyper-V		Supports pass-through disks
   Supports converting a pass-through disk to a VHD
VMware ESX	 Supports pass-through disks (RDP), but not disk conversion
Citrix XenServer Does not support pass-through disks

CreateClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will create a Cluster Shared Volume.

DeleteClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will delete a Cluster Shared Volume.

DesiredUnitAllocationSizeBytes

Required? false
Accept Pipeline Input? false
Position? named
Specifies, in bytes, the default allocation size of a volume.

ForceFormat

Required? false
Accept Pipeline Input? false
Position? named
Forces the formatting of the storage disk even if volumes are already present.

FullFormat

Required? false
Accept Pipeline Input? false
Position? named
Indicates that a full format of the partition is performed.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

MountPoint

Required? false
Accept Pipeline Input? false
Position? named
Specifies a mount point location.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

VolumeLabel

Required? false
Accept Pipeline Input? false
Position? named
Specifies a label for a disk volume.

GuidPartitionTable

Required? true
Accept Pipeline Input? false
Position? named
Indicates that the storage disk is a GUID partition table disk.

JobGroup

Required? true
Accept Pipeline Input? false
Position? named
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs. 

QuickFormat

Required? true
Accept Pipeline Input? false
Position? named
Indicates that a quick format of the partition is performed.

StorageDisk

Required? true
Accept Pipeline Input? true (ByValue)
Position? named
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 referrred to as a pass-through disk (the corresponding VMware term is Raw Device Mapping, or 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.

TYPE OF HOST   PASS-THROUGH DISK SUPPORT
------------   -------------------------
Hyper-V		Supports pass-through disks
   Supports converting a pass-through disk to a VHD
VMware ESX	 Supports pass-through disks (RDP), but not disk conversion
Citrix XenServer Does not support pass-through disks

CreateClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will create a Cluster Shared Volume.

DeleteClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will delete a Cluster Shared Volume.

DesiredUnitAllocationSizeBytes

Required? false
Accept Pipeline Input? false
Position? named
Specifies, in bytes, the default allocation size of a volume.

ForceFormat

Required? false
Accept Pipeline Input? false
Position? named
Forces the formatting of the storage disk even if volumes are already present.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

MountPoint

Required? false
Accept Pipeline Input? false
Position? named
Specifies a mount point location.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

VolumeLabel

Required? false
Accept Pipeline Input? false
Position? named
Specifies a label for a disk volume.

JobGroup

Required? true
Accept Pipeline Input? false
Position? named
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs. 

MasterBootRecord

Required? true
Accept Pipeline Input? false
Position? named
Indicates that the storage disk is a master boot record disk.

QuickFormat

Required? true
Accept Pipeline Input? false
Position? named
Indicates that a quick format of the partition is performed.

StorageDisk

Required? true
Accept Pipeline Input? true (ByValue)
Position? named
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 referrred to as a pass-through disk (the corresponding VMware term is Raw Device Mapping, or 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.

TYPE OF HOST   PASS-THROUGH DISK SUPPORT
------------   -------------------------
Hyper-V		Supports pass-through disks
   Supports converting a pass-through disk to a VHD
VMware ESX	 Supports pass-through disks (RDP), but not disk conversion
Citrix XenServer Does not support pass-through disks

CreateClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will create a Cluster Shared Volume.

DeleteClusterSharedVolume

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the cmdlet will delete a Cluster Shared Volume.

DesiredUnitAllocationSizeBytes

Required? false
Accept Pipeline Input? false
Position? named
Specifies, in bytes, the default allocation size of a volume.

ForceFormat

Required? false
Accept Pipeline Input? false
Position? named
Forces the formatting of the storage disk even if volumes are already present.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

MountPoint

Required? false
Accept Pipeline Input? false
Position? named
Specifies a mount point location.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

VolumeLabel

Required? false
Accept Pipeline Input? false
Position? named
Specifies a label for a disk volume.
Requires a VMM storage disk object, which can be retrieved using the Get-SCStorageDisk cmdlet.

Examples

1: Format a new disk.
PS C:\> $JobGroup = [Guid]::NewGuid().ToString()
PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01"
PS C:\> $LU = Get-SCStorageLogicalUnit -Name "LUN01"
PS C:\> Register-SCStorageLogicalUnit -StorageLogicalUnit $LU -VMHost $VMHost -JobGroup $JobGroup
PS C:\> Mount-SCStorageDisk -QuickFormat -MasterBootRecord -VolumeLabel "New Volume" -StorageLogicalUnit $LU -MountPoint "S:\" -JobGroup $JobGroup
PS C:\> Set-SCVMHost -VMHost $VMHost -JobGroup $JobGroup

The first command generates a globally unique identifier (GUID) and stores the GUID string in variable $JobGroup. Subsequent commands that include this GUID are collected into a single job group.

The second command gets the host object nmaed VMHost01 and stores the object in the $VMHost variable.

The third command gets the storage logical unit object named LUN01 and stores the object in the $LU variable.

The fourth command registers LUN01 with VMHost01. Using the JobGroup parameter specifies tha this command will not run until just before the final command that includes the JobGroup with the same GUID.

The fifth command mounts LUN01 on VMHost01, performs a quick format on the volume, labels the volume "New Volume", and sets the mount point to S:\. Using the JobGroup parameter specifies tha this command will not run until just before the final command that includes the JobGroup with the same GUID.

The last command updates VMHost01 with the mounted storage disk. This command uses the JobGroup parameter to register and mount LUN01 prior to running Set-SCVMHost.

See Also