Get-Cluster

This cmdlet retrieves the clusters available on a vCenter Server system. Returns a set of clusters that correspond to the filter criteria defined by the cmdlet parameters. To specify a server different from the default one, use the Server parameter.

Syntax

Get-Cluster

-Id < String[] >

[-ProgressAction < ActionPreference > ]

[-Server < VIServer[] > ]

[CommonParameters]

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Id	String[]	named	wildcards	Specifies the IDs of the clusters you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.
optional	ProgressAction	ActionPreference	named
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 Connect-VIServer.

Required	Parameter Name	Type	Position	Features	Description
required	RelatedObject	ClusterRelatedObjectBase[]	named	pipeline	Specifies objects to retrieve one or more Cluster objects that are related to them. This parameter accepts OMResource objects.
optional	ProgressAction	ActionPreference	named

Required	Parameter Name	Type	Position	Features	Description
optional	Location	VIContainer[]	named	pipeline wildcards	Specifies vSphere container objects (such as folders, datacenters, and clusters) you want to search for clusters.
optional	Name	String[]	named	wildcards	Specifies the names of the clusters you want to retrieve.
optional	NoRecursion	SwitchParameter	named		Indicates that you want to deactivate the recursive behavior of the command.
optional	ProgressAction	ActionPreference	named
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 Connect-VIServer.
optional	Tag	Tag[]	named		Returns only the clusters that are associated with any of the specified tags.

Required	Parameter Name	Type	Position	Features	Description
optional	Name	String[]	named	wildcards	Specifies the names of the clusters you want to retrieve.
optional	ProgressAction	ActionPreference	named
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 Connect-VIServer.
optional	Tag	Tag[]	named		Returns only the clusters that are associated with any of the specified tags.
optional	VM	VirtualMachine[]	named	pipeline wildcards	Specifies virtual machines to filter the clusters that contain at least one of them.
optional	VMHost	VMHost[]	named	pipeline wildcards	Specifies hosts to filter the clusters that contain at least one of them.

Output

VMware.VimAutomation.ViCore.Types.V1.Inventory.Cluster

Examples

Example 1

Get-Cluster -Location Folder

Get a list of the available clusters in the Folder folder.

Related Commands

Cluster

Get-Cluster

This cmdlet retrieves the clusters available on a vCenter Server system.

Move-Cluster

This cmdlet moves a vCenter Server cluster from one location to another.

New-Cluster

This cmdlet creates a new cluster.

Remove-Cluster

This cmdlet deletes the specified clusters.

Set-Cluster

This cmldlet modifies the configuration of a cluster.