vSphere PowerCLI Reference

Get-ResourcePool

Synopsis

This cmdlet retrieves the resource pools available on a vCenter Server system.

Syntax

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

Related Commands

Online version
New-ResourcePool
Remove-ResourcePool
Set-ResourcePool
Move-ResourcePool

Detailed Description

Retrieves the resource pools available on a vCenter Server system. 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.

Parameters

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

Return Type

Zero or more ResourcePool objects

Notes

Examples

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

$server = Connect-VIServer -Server 10.23.112.235

Get-ResourcePool -Server $server -VM VM

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


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