Get-VsanComponent Command | Vmware PowerCLI Reference

Get-VsanComponent

This cmdlet retrieves basic information about the vSAN component, including its uuid, the vSAN object it belongs to, the disk it resides on, its status and type.

Syntax

Get-VsanComponent
[-Id < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Id String[] named
  • wildcards
Filters vSAN components by ID.
optional ProgressAction ActionPreference named
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 the Connect-VIServer cmdlet.
Get-VsanComponent
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[-VsanDisk < VsanDisk[] > ]
[-VsanObject < VsanObject[] > ]
[-VsanStoragePoolDisk < VsanStoragePoolDisk[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional ProgressAction ActionPreference named
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 the Connect-VIServer cmdlet.
optional VsanDisk VsanDisk[] named
  • wildcards
Filters vSAN components by the specific vSAN disk.
optional VsanObject VsanObject[] named
  • wildcards
Filters vSAN components by the specific vSAN object.
optional VsanStoragePoolDisk VsanStoragePoolDisk[] named
  • wildcards
Filters vSAN components by the specific vSAN storage pool disk. This parameter is available starting from vSphere8.0.

Output

VMware.VimAutomation.Storage.Types.V1.Vsan.VsanComponent

Examples

Example 1

Get-VsanComponent -Id $id

Retrieves vSAN components by filtering them by ID.

Example 2

Get-VsanComponent -VsanObject $vsanObject

Retrieves the component that belongs to the vSAN object.

Example 3

Get-VsanComponent -VsanDisk $vsanDisk

Retrieves the component that resides on the vSAN disk.

Example 4

Get-VsanComponent -VsanObject $vsanObject -VsanDisk $vsanDisk

Retrieves the component that belongs to the vSAN object and resides on the vSAN disk.

Example 5

Get-VsanComponent -VsanStoragePoolDik $vsanStoragePoolDisk

Retrieves the component that resides on the vSAN storage pool disk. Note: The VsanStoragePoolDisk entity type is available from vSphere 8.0.

Related Commands

VsanComponent

This cmdlet retrieves basic information about the vSAN component, including its universal unique identifier (UUID), the vSAN object it belongs to, the disk it resides on, and its status and type.