All Cmdlets by Product VMware vSphere and vSAN VM

Get-VMGuestDisk

This cmdlet retrieves storage volumes as seen by the virtual machines' guest operating systems. Optionally, you can filter the results by the virtual machine or the file system path where the storage volume is mounted. Alternatively, this cmdlet allows retrieving the guest storage volumes, backed by a specified virtual disk.Note: You should run the virtual machine's guest operating system at least once to make the storage volumes information available.

Syntax

Get-VMGuestDisk
[-DiskPath  <String[]>]
[-Server  <VIServer[]>]
[-VM  <VirtualMachine[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
DiskPath
String[] named
  • wildcards
    •      		Filters the results based on the file system mount location. For example, "C:\" or "/etc/my-mount-root". This parameter supports wildcards.
    optional
    Server
    		VIServer[] named Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
    optional
    VM
    		VirtualMachine[] named
  • pipeline
    •      		Limits the results to guest disks on the specified virtual machines.

    Get-VMGuestDisk
    [-DiskPath  <String[]>]
    [-Server  <VIServer[]>]
    [-VMGuest  <VMGuest[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    optional
    DiskPath
    		String[] named
  • wildcards
    •      		Filters the results based on the file system mount location. For example, "C:\" or "/etc/my-mount-root". This parameter supports wildcards.
    optional
    Server
    		VIServer[] named Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
    optional
    VMGuest
    		VMGuest[] named
  • pipeline
    •      		Limits the results to guest disks on the specified virtual machine guests.

    Get-VMGuestDisk
    -HardDisk  <HardDisk[]>
    [-DiskPath  <String[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    HardDisk
    		HardDisk[] named
  • pipeline
    •      		Limits the results to guest disks that are backed by the specified virtual disks.
    optional
    DiskPath
    		String[] named
  • wildcards
    •      		Filters the results based on the file system mount location. For example, "C:\" or "/etc/my-mount-root". This parameter supports wildcards.

    Output

    VMware.VimAutomation.ViCore.Types.V1.VM.Guest.VMGuestDisk

    Examples

    Example 1

    Get-VMGuestDisk -VM $myVM

    Retrieves all guest disks for a specified virtual machine.

    Example 2

    $myVms | Get-VMGuestDisk -DiskPath "C:\"

    Retrieves all C: drives on a specified set of virtual machines.

    Related Commands

    VM

    Get-VM
    This cmdlet retrieves the virtual machines on a vCenter Server system.
    Move-VM
    This cmdlet moves virtual machines to another location.
    Restart-VM
    This cmdlet restarts the specified virtual machines.
    Set-VM
    This cmdlet modifies the configuration of the virtual machine.
    Start-VM
    This cmdlet powers on virtual machines.
    Stop-VM
    This cmdlet powers off virtual machines.
    Suspend-VM
    This cmdlet suspends virtual machines.
    Remove-VM
    This cmdlet removes the specified virtual machines from the vCenter Server system.
    New-VM
    This cmdlet creates a new virtual machine.

    VMConsoleWindow

    Open-VMConsoleWindow
    This cmdlet opens a window to the virtual machine's console.

    VMGuest

    Get-VMGuest
    This cmdlet retrieves the guest operating systems of the specified virtual machines.
    Restart-VMGuest
    This cmdlet restarts the virtual machine guest operating systems.
    Stop-VMGuest
    This cmdlet shuts down the specified virtual machine guest OS.
    Suspend-VMGuest
    This cmdlet suspends the specified guest operating systems.

    VMGuestDisk

    Get-VMGuestDisk
    This cmdlet retrieves storage volumes as seen by the virtual machines' guest operating systems.

    VMGuestFile

    Copy-VMGuestFile
    This cmdlet copies files and folders from and to the guest OS of the specified virtual machines using VMware Tools.

    VMQuestion

    Get-VMQuestion
    This cmdlet retrieves the pending questions for the specified virtual machines.
    Set-VMQuestion
    This cmdlet answers the specified virtual machine question.

    VMResourceConfiguration

    Get-VMResourceConfiguration
    This cmdlet retrieves information about the resource allocation between the selected virtual machines.
    Set-VMResourceConfiguration
    This cmdlet configures resource allocation between the virtual machines.

    VMScript

    Invoke-VMScript
    This cmdlet runs a script in the guest OS of each of the specified virtual machines.

    VMStartPolicy

    Get-VMStartPolicy
    This cmdlet retrieves the start policy of the virtual machines on a vCenter Server system.
    Set-VMStartPolicy
    This cmdlet modifies the virtual machine start policy.
    Feedback

    Was this page helpful?

    ©2023 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us