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

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the names of the resource pools you want to retrieve.	false	false
Id	String[]	Specifies the IDs of the resource pools 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.	true	false
Location	VIContainer[]	Specifies vSphere container objects (such as folders, datacenters, and clusters) you want to search for resource pools.	false	true (ByValue)
NoRecursion	SwitchParameter	Indicates that you want to disable the recursive behavior of the command.	false	false
RelatedObject	ResourcePoolRelatedObjectBase[]	Specifies objects to retrieve one or more ResourcePool objects that are related to them. This parameter accepts ProviderVdc and OMResource objects.	true	true (ByValue)
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.	false	false
Tag	Tag[]	Returns only the resource pools that are associated with any of the specified tags.	false	false
VM	VirtualMachine[]	Specifies virtual machines to filter the resource pools that contain at least one of them.	true	true (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.