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

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

Parameters

Required Parameter Name Type Position Features Description
optional
Location
VIContainer[] named
  • wildcards
  • pipeline
  • 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 disable the recursive behavior of the command.
    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.

    -Id  <String[]>
    [-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.
    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.

    -RelatedObject  <ClusterRelatedObjectBase[]>
    [CommonParameters]

    Parameters

    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.

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

    Parameters

    Required Parameter Name Type Position Features Description
    optional
    Name
    String[] named
  • wildcards
  • Specifies the names of the clusters you want to retrieve.
    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
  • wildcards
  • pipeline
  • Specifies virtual machines to filter the clusters that contain at least one of them.
    optional
    VMHost
    VMHost[] named
  • wildcards
  • pipeline
  • 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

    Feedback

    Was this page helpful?