PowerCLI Reference

Get-Cluster

Synopsis

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

Syntax

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

Get-Cluster [[-Name] <String[]>] [-Location <VIContainer[]>] [-NoRecursion] [-Server <VIServer[]>] [-Tag <Tag[]>] [<CommonParameters>]

Get-Cluster [[-Name] <String[]>] [-Server <VIServer[]>] [-Tag <Tag[]>] [-VM <VirtualMachine[]>] [-VMHost <VMHost[]>] [<CommonParameters>]

Get-Cluster [-RelatedObject] <ClusterRelatedObjectBase[]> [<CommonParameters>]

Related Commands

Online Version
Move-Cluster
New-Cluster
Remove-Cluster
Set-Cluster

Detailed Description

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.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the names of the clusters you want to retrieve.	false	False
RelatedObject	ClusterRelatedObjectBase[]	Specifies objects to retrieve one or more Cluster objects that are related to them. This parameter accepts OMResource objects.	true	True (ByValue)
Id	String[]	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.	true	False
Location	VIContainer[]	Specifies vSphere container objects (such as folders, datacenters, and clusters) you want to search for clusters.	false	True (ByValue)
NoRecursion	SwitchParameter	Indicates that you want to disable the recursive behavior of the command.	false	False
Server	VIServer[]	Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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.	false	False
Tag	Tag[]	Returns only the clusters that are associated with any of the specified tags.	false	False
VM	VirtualMachine[]	Specifies virtual machines to filter the clusters that contain at least one of them.	false	True (ByValue)
VMHost	VMHost[]	Specifies hosts to filter the clusters that contain at least one of them.	false	True (ByValue)

Return Type

Zero or more Cluster objects

Notes

Examples

-------------------------- Example 1 --------------------------

Get-Cluster -Location Folder

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