PowerCLI Reference

Get-VsanComponent

Synopsis

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

Syntax

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

Get-VsanComponent [-Server <VIServer[]>] [-VsanDisk <VsanDisk[]>] [-VsanObject <VsanObject[]>] [<CommonParameters>]

Related Commands

Detailed Description

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

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
IdString[]Filters the vSAN components by ID.falseFalse
ServerVIServer[]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 the Connect-VIServer cmdlet.falseFalse
VsanDiskVsanDisk[]Filters the vSAN components by specific vSAN disk .falseFalse
VsanObjectVsanObject[]Filters the vSAN components by specific vSAN object.falseFalse

Return Type

Notes

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 vsanDisk.

-------------------------- Example 4 --------------------------

Get-VsanComponent -VsanObject $vsanObject -VsanDisk $vsanDisk

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

Copyright © VMware, Inc. All rights reserved.