Syntax
Get-Cluster [-VM <VirtualMachine[]>] [-VMHost <VMHost[]>] [-Location <VIContainer[]>] [[-Name] <String[]>] [-Id <String[]>] [-NoRecursion] [-Server <VIServer[]>] [<CommonParameters>]Related Commands
Online versionDetailed 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
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String[] | Specify the names of the clusters you want to retrieve. | false | false | |
| Id | String[] | Specify the IDs of the clusters you want to retrieve. | false | false | |
| Location | VIContainer[] | Specify vSphere container objects (such as folders, datacenters, and clusters) you want to search for clusters. | false | true (ByValue) | |
| NoRecursion | SwitchParameter | Indicate that you want to disable the recursive behavior of the command. | false | false | |
| Server | VIServer[] | 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. | false | false | |
| VM | VirtualMachine[] | Specify virtual machines to filter the clusters that contain at least one of them. | false | true (ByValue) | |
| VMHost | VMHost[] | Specify hosts to filter the clusters that contain at least one of them. | false | true (ByValue) |
Return Type
ClusterNotes
Examples
-------------- Example 1 --------------
Get-Cluster -Location Folder
Get a list of the available clusters in the Folder folder.