< Back
Get-VsanObject
Post
NAME Get-VsanObject
SYNOPSIS
This cmdlet retrieves vSAN objects based on the specified filters.
SYNTAX
Get-VsanObject [[-Cluster] <Cluster[]>] [-Type <VsanObjectType[]>] [-VM <VirtualMachine[]>] [-VsanDisk
<VsanDisk[]>] [-Server <VIServer[]>] [<CommonParameters>]
Get-VsanObject [-Id] <String[]> [-Server <VIServer[]>] [<CommonParameters>]
DESCRIPTION
This cmdlet retrieves vSAN objects based on the specified filters.
PARAMETERS
-Cluster <Cluster[]>
Specifies the clusters from which to retrieve the vSAN objects.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Type <VsanObjectType[]>
Specifies the types of the vSAN objects to be retrieved.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VM <VirtualMachine[]>
Specifies the virtual machines to which the vSAN objects you want to retrieve belong.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VsanDisk <VsanDisk[]>
Specifies the vSAN disk on which the vSAN objects you want to retrieve reside.
Required? false
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 the Connect-VIServer cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Id <String[]>
Specifies the vSAN UUID of that vSAN objects that you want to retrieve.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<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 vSAN objects
NOTES
-------------------------- Example 1 --------------------------
Get-VsanObject -Cluster $clusters
Retrieves information of all vSAN objects from the specified clusters.
-------------------------- Example 2 --------------------------
Get-VsanObject -Cluster $clusters -VM $vms
Retrieves information of the vSAN objects in the specified clusters. The vSAN objects should associate with the
specified virtual machines.
-------------------------- Example 3 --------------------------
Get-VsanObject -Cluster $clusters -VsanDisk $disks
Retrieves information of the vSAN objects in the specified clusters. The vSAN objects should reside in the
specified vSAN disks.
-------------------------- Example 4 --------------------------
Get-VsanObject -Cluster $clusters -VM $vms -type VDisk
Retrieves information of the VMDK type vSAN objects in the specified clusters. The vSAN objects should associate
with the specified virtual machines.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... scsiTarget .html
SYNOPSIS
This cmdlet retrieves vSAN objects based on the specified filters.
SYNTAX
Get-VsanObject [[-Cluster] <Cluster[]>] [-Type <VsanObjectType[]>] [-VM <VirtualMachine[]>] [-VsanDisk
<VsanDisk[]>] [-Server <VIServer[]>] [<CommonParameters>]
Get-VsanObject [-Id] <String[]> [-Server <VIServer[]>] [<CommonParameters>]
DESCRIPTION
This cmdlet retrieves vSAN objects based on the specified filters.
PARAMETERS
-Cluster <Cluster[]>
Specifies the clusters from which to retrieve the vSAN objects.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Type <VsanObjectType[]>
Specifies the types of the vSAN objects to be retrieved.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VM <VirtualMachine[]>
Specifies the virtual machines to which the vSAN objects you want to retrieve belong.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VsanDisk <VsanDisk[]>
Specifies the vSAN disk on which the vSAN objects you want to retrieve reside.
Required? false
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 the Connect-VIServer cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Id <String[]>
Specifies the vSAN UUID of that vSAN objects that you want to retrieve.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<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 vSAN objects
NOTES
-------------------------- Example 1 --------------------------
Get-VsanObject -Cluster $clusters
Retrieves information of all vSAN objects from the specified clusters.
-------------------------- Example 2 --------------------------
Get-VsanObject -Cluster $clusters -VM $vms
Retrieves information of the vSAN objects in the specified clusters. The vSAN objects should associate with the
specified virtual machines.
-------------------------- Example 3 --------------------------
Get-VsanObject -Cluster $clusters -VsanDisk $disks
Retrieves information of the vSAN objects in the specified clusters. The vSAN objects should reside in the
specified vSAN disks.
-------------------------- Example 4 --------------------------
Get-VsanObject -Cluster $clusters -VM $vms -type VDisk
Retrieves information of the VMDK type vSAN objects in the specified clusters. The vSAN objects should associate
with the specified virtual machines.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... scsiTarget .html