Get-VsanDisk

NAME Get-VsanDisk



SYNOPSIS

This cmdlet retrieves the host disks that belong to a vSAN disk group.





SYNTAX

Get-VsanDisk [[-CanonicalName] <String[]>] [-Server <VIServer[]>] [-VsanDiskGroup <VsanDiskGroup[]>]

[<CommonParameters>]



Get-VsanDisk [[-CanonicalName] <String[]>] [-Server <VIServer[]>] -VMHost <VMHost[]> [<CommonParameters>]



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





DESCRIPTION

This cmdlet retrieves the host disks that belong to a vSAN disk group. The cmdlet retrieves both SSD and HDD types

of disks.





PARAMETERS

-CanonicalName <String[]>

Specifies the canonical names of the retrieved disks.



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Id <String[]>

Specifies the IDs of the retrieved disks.



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



-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 disks are attached to.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-VsanDiskGroup <VsanDiskGroup[]>

Specifies the vSAN disk groups that the disks are part of.



Required? false

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 VsanDisk objects







NOTES





Works only with vCenter Server 5.5 or later.



-------------------------- Example 1 --------------------------



Get-VsanDisk -CanonicalName "DiskCanonicalName" -VMHost $vmHost



Retrieves all vSAN disks with canonical name "DiskCanonicalName" from the $vmHost virtual machine host.

-------------------------- Example 2 --------------------------



Get-VsanDisk -CanonicalName "DiskCanonicalName" -VsanDiskGroup $vsanDiskGroup



Retrieves all vSAN disks with canonical name "DiskCanonicalName" from the $vsanDiskGroup vSAN disk group.

-------------------------- Example 3 --------------------------



Get-VsanDisk -Id "MyVsanDiskId"



Retrieves the vSAN disk with ID "MyVsanDiskId".



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... nDisk.html

New-VsanDisk

Remove-VsanDisk