< Back
Get-VsanDiskGroup
Post
NAME Get-VsanDiskGroup
SYNOPSIS
This cmdlet retrieves vSAN disk groups.
SYNTAX
Get-VsanDiskGroup [[-Name] <String[]>] [-Cluster <Cluster[]>] [-Server <VIServer[]>] [<CommonParameters>]
Get-VsanDiskGroup [-DiskCanonicalName <String[]>] [-Server <VIServer[]>] -VMHost <VMHost[]> [<CommonParameters>]
Get-VsanDiskGroup -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-Cluster <Cluster[]>
Specifies the clusters that the retrieved groups are on.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-DiskCanonicalName <String[]>
Specifies the canonical names of disks that are part of the retrieved groups.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String[]>
Specifies the IDs of disks that are part of the retrieved groups.
Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that
matches exactly one of the string values in that list.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String[]>
Specifies the name of the vSAN disk group you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VMHost <VMHost[]>
Specifies the hosts that the retrieved groups are on.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more VsanDiskGroup objects
NOTES
Works only with vCenter Server 5.5 or later.
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... Group.html
New-VsanDiskGroup
Remove-VsanDiskGroup
SYNOPSIS
This cmdlet retrieves vSAN disk groups.
SYNTAX
Get-VsanDiskGroup [[-Name] <String[]>] [-Cluster <Cluster[]>] [-Server <VIServer[]>] [<CommonParameters>]
Get-VsanDiskGroup [-DiskCanonicalName <String[]>] [-Server <VIServer[]>] -VMHost <VMHost[]> [<CommonParameters>]
Get-VsanDiskGroup -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-Cluster <Cluster[]>
Specifies the clusters that the retrieved groups are on.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-DiskCanonicalName <String[]>
Specifies the canonical names of disks that are part of the retrieved groups.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String[]>
Specifies the IDs of disks that are part of the retrieved groups.
Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that
matches exactly one of the string values in that list.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String[]>
Specifies the name of the vSAN disk group you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VMHost <VMHost[]>
Specifies the hosts that the retrieved groups are on.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more VsanDiskGroup objects
NOTES
Works only with vCenter Server 5.5 or later.
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... Group.html
New-VsanDiskGroup
Remove-VsanDiskGroup