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

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

Parameters

Required Parameter Name Type Position Features Description
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.

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

    Parameters

    Required Parameter Name Type Position Features Description
    optional
    Id
    String[] named
  • wildcards
  • Filters vSAN components by ID.
    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.

    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.

    Related Commands

    Feedback

    Was this page helpful?