< Back
Get-VsanComponent
Post
NAME 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>]
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
-Id <String[]>
Filters the vSAN components by ID.
Required? false
Position? named
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 the Connect-VIServer cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VsanDisk <VsanDisk[]>
Filters the vSAN components by specific vSAN disk .
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VsanObject <VsanObject[]>
Filters the vSAN components by specific vSAN object.
Required? false
Position? named
Default value None
Accept pipeline input? False
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
NOTES
-------------------------- 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.
RELATED LINKS
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>]
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
-Id <String[]>
Filters the vSAN components by ID.
Required? false
Position? named
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 the Connect-VIServer cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VsanDisk <VsanDisk[]>
Filters the vSAN components by specific vSAN disk .
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VsanObject <VsanObject[]>
Filters the vSAN components by specific vSAN object.
Required? false
Position? named
Default value None
Accept pipeline input? False
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
NOTES
-------------------------- 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.
RELATED LINKS