vSphere PowerCLI Reference

Get-Cluster

Synopsis

Retrieves the clusters available on a vSphere server.

Syntax

Get-Cluster [-VM <VirtualMachine[]>] [-VMHost <VMHost[]>] [-Location <VIContainer[]>] [[-Name] <String[]>] [-NoRecursion] [-Server <VIServer[]>] [<CommonParameters>]
Get-Cluster -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online version
Move-Cluster
New-Cluster
Remove-Cluster
Set-Cluster

Detailed Description

Retrieves the clusters available on a vSphere server. 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

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specify the names of the clusters you want to retrieve.falsefalse
IdString[]Specify the IDs of the clusters you want to retrieve.truefalse
LocationVIContainer[]Specify vSphere container objects (such as folders, datacenters, and clusters) you want to search for clusters.falsetrue (ByValue)
NoRecursionSwitchParameterIndicate that you want to disable the recursive behavior of the command.falsefalse
ServerVIServer[]Specify the vSphere servers 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 Connect-VIServer.falsefalse
VMVirtualMachine[]Specify virtual machines to filter the clusters that contain at least one of them.falsetrue (ByValue)
VMHostVMHost[]Specify hosts to filter the clusters that contain at least one of them.falsetrue (ByValue)

Return Type

Cluster

Notes

Examples

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

Get-Cluster -Location Folder

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


Copyright © 1998 - 2012 VMware, Inc. All rights reserved.