Get-VsanObject

Synopsis

Syntax

Related Commands

Online Version

Detailed Description

Parameters

Name	Type	Description	Required?	Pipeline Input	Default Value
Cluster	Cluster[]	Specifies the clusters from which to retrieve the vSAN objects.	false	True (ByValue)
Id	String[]	Specifies the vSAN UUID of that vSAN objects that you want to retrieve.	true	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.	false	False
Type	VsanObjectType[]	Specifies the types of the vSAN objects to be retrieved.	false	False
VM	VirtualMachine[]	Specifies the virtual machines to which the vSAN objects you want to retrieve belong.	false	False
VsanDisk	VsanDisk[]	Specifies the vSAN disk on which the vSAN objects you want to retrieve reside.	false	False

Name

Type

Description

Required?

Pipeline Input

Default Value

Cluster

Cluster[]

Specifies the clusters from which to retrieve the vSAN objects.

false

True (ByValue)

String[]

Specifies the vSAN UUID of that vSAN objects that you want to retrieve.

true

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.

false

False

Type

VsanObjectType[]

Specifies the types of the vSAN objects to be retrieved.

false

False

VirtualMachine[]

Specifies the virtual machines to which the vSAN objects you want to retrieve belong.

false

False

VsanDisk

VsanDisk[]

Specifies the vSAN disk on which the vSAN objects you want to retrieve reside.

false

False

Return Type

Notes

Examples

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

PowerCLI Reference

Synopsis