powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-Cluster



NAME
Get-Cluster

SYNOPSIS
Retrieves the clusters available on a vSphere server.

SYNTAX
Get-Cluster [-VM ] [-VMHost ] [-Location ] [[-Name] ] [-Id ring[]>] [-NoRecursion] [-Server ] []


DESCRIPTION
Retrieves the clusters available on a vSphere server. Returns a set of clusters that correspond to the filter crite
ria defined by the cmdlet parameters. To specify a server different from the default one, use the -Server parameter
.


PARAMETERS
-VM
Specify virtual machines to filter the clusters that contain at least one of them.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-VMHost
Specify hosts to filter the clusters that contain at least one of them.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Location
Specify vSphere container objects (such as folders, datacenters, and clusters) you want to search for clusters.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Name
Specify the names of the clusters you want to retrieve.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Id
Specify the IDs of the clusters you want to retrieve.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-NoRecursion
Indicate that you want to disable the recursive behavior of the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
Cluster


NOTES




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

C:\PS>Get-Cluster -Location Folder


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






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Get-Cluster.html
Move-Cluster
New-Cluster
Remove-Cluster
Set-Cluster