vSphere PowerCLI Reference



Retrieves the resource pools available on a vSphere server.


Get-ResourcePool [-VM <VirtualMachine[]>] [-Location <VIContainer[]>] [[-Name] <String[]>] [-NoRecursion] [-Server <VIServer[]>] [<CommonParameters>]
Get-ResourcePool -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]
Get-ResourcePool -RelatedObject <ResourcePoolRelatedObjectBase[]> [<CommonParameters>]

Related Commands

Online version

Detailed Description

Retrieves the resource pools available on a vSphere server. The cmdlet returns a set of resource pools that correspond to the filter criteria provided by the cmdlet parameters. Virtual machine hosts have a hidden resource pool named Resources, which is a parent of all resource pools of the host. To specify a server different from the default one, use the -Server parameter.


NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specify the names of the resource pools you want to retrieve.falsefalse
IdString[]Specify the IDs of the resource pools you want to retrieve.truefalse
LocationVIContainer[]Specify vSphere container objects (such as folders, datacenters, and clusters) you want to search for resource pools.falsetrue (ByValue)
NoRecursionSwitchParameterIndicate that you want to disable the recursive behavior of the command.falsefalse
RelatedObjectResourcePoolRelatedObjectBase[]Specify objects to retrieve one or more ResourcePool objects that are related to them. This parameter accepts ProviderVdc objects.truetrue (ByValue)
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 resource pools that contain at least one of them.falsetrue (ByValue)

Return Type




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

$server = Connect-VIServer -Server

Get-ResourcePool -Server $server -VM VM

Retrieves information of the resource pool to which the virtual machine MS Win belongs.

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