Get-ResourcePool

NAME Get-ResourcePool



SYNOPSIS

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





SYNTAX

Get-ResourcePool -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]



Get-ResourcePool [[-Name] <String[]>] [-Location <VIContainer[]>] [-NoRecursion] [-Server <VIServer[]>] [-Tag

<Tag[]>] [<CommonParameters>]



Get-ResourcePool [[-Name] <String[]>] [-Server <VIServer[]>] [-Tag <Tag[]>] -VM <VirtualMachine[]>

[<CommonParameters>]



Get-ResourcePool -RelatedObject <ResourcePoolRelatedObjectBase[]> [<CommonParameters>]





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

-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.



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

resource pools.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Name <String[]>

Specifies the names of the resource pools 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 <ResourcePoolRelatedObjectBase[]>

Specifies objects to retrieve one or more ResourcePool objects that are related to them. This parameter

accepts ProviderVdc and OMResource objects.



Required? true

Position? named

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 resource pools 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 resource pools that contain at least one of them.



Required? true

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 ResourcePool objects







NOTES









-------------------------- 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.



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... ePool.html

New-ResourcePool

Remove-ResourcePool

Set-ResourcePool

Move-ResourcePool