Get-VsanDiskGroup

This cmdlet retrieves vSAN disk groups in a cluster or a host, by ID, name, or the canonical name of a disk within the disk group.

Syntax

[-Cluster  <Cluster[]>]
[-Name  <String[]>]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Cluster
Cluster[] named
  • wildcards
  • pipeline
  • Specifies the clusters that the retrieved groups are on.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the name of the vSAN disk group you want to retrieve.
    optional
    Server
    VIServer[] named
  • wildcards
  • 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 Connect-VIServer.

    -VMHost  <VMHost[]>
    [-DiskCanonicalName  <String[]>]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    VMHost
    VMHost[] named
  • wildcards
  • pipeline
  • Specifies the hosts that the retrieved groups are on.
    optional
    DiskCanonicalName
    String[] named Specifies the canonical names of disks that are part of the retrieved groups.
    optional
    Server
    VIServer[] named
  • wildcards
  • 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 Connect-VIServer.

    -Id  <String[]>
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named Specifies the IDs of disks that are part of the retrieved groups.
    optional
    Server
    VIServer[] named
  • wildcards
  • 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 Connect-VIServer.

    Output

    VMware.VimAutomation.Storage.Types.V1.Vsan.VsanDiskGroup

    Examples


    Example 1

    Get-VsanDiskGroup -DiskCanonicalName "DiskCanonicalName" -VMHost $vmHost

    Retrieves all vSAN disk groups that contain a disk with canonical name "DiskCanonicalName" from the $vmHost virtual machine host.

    Example 2

    Get-VsanDiskGroup -Name "MyVsanDiskGroup" -Cluster $cluster

    Retrieves all vSAN disk groups named "MyVsanDiskGroup" from the $cluster cluster.

    Example 3

    Get-VsanDiskGroup -Id "MyVsanDiskGroupId"

    Retrieves the vSAN disk group with ID "MyVsanDiskGroupId".

    Related Commands

    Feedback

    Was this page helpful?