< Back
Get-Cluster
Post
NAME 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>]
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
-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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Location <VIContainer[]>
Specifies vSphere container objects (such as folders, datacenters, and clusters) you want to search for
clusters.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Name <String[]>
Specifies the names of the clusters you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-NoRecursion [<SwitchParameter>]
Indicates that you want to disable the recursive behavior of the command.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RelatedObject <ClusterRelatedObjectBase[]>
Specifies objects to retrieve one or more Cluster objects that are related to them. This parameter accepts
OMResource objects.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Tag <Tag[]>
Returns only the clusters that are associated with any of the specified tags.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VM <VirtualMachine[]>
Specifies virtual machines to filter the clusters that contain at least one of them.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-VMHost <VMHost[]>
Specifies hosts to filter the clusters that contain at least one of them.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more Cluster objects
NOTES
-------------------------- Example 1 --------------------------
Get-Cluster -Location Folder
Get a list of the available clusters in the Folder folder.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... uster.html
Move-Cluster
New-Cluster
Remove-Cluster
Set-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>]
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
-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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Location <VIContainer[]>
Specifies vSphere container objects (such as folders, datacenters, and clusters) you want to search for
clusters.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Name <String[]>
Specifies the names of the clusters you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-NoRecursion [<SwitchParameter>]
Indicates that you want to disable the recursive behavior of the command.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RelatedObject <ClusterRelatedObjectBase[]>
Specifies objects to retrieve one or more Cluster objects that are related to them. This parameter accepts
OMResource objects.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Tag <Tag[]>
Returns only the clusters that are associated with any of the specified tags.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VM <VirtualMachine[]>
Specifies virtual machines to filter the clusters that contain at least one of them.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-VMHost <VMHost[]>
Specifies hosts to filter the clusters that contain at least one of them.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more Cluster objects
NOTES
-------------------------- Example 1 --------------------------
Get-Cluster -Location Folder
Get a list of the available clusters in the Folder folder.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... uster.html
Move-Cluster
New-Cluster
Remove-Cluster
Set-Cluster