Get-ResourcePool

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.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
optional
Location
VIContainer[] named
  • wildcards
  • pipeline
  • Specifies vSphere container objects (such as folders, datacenters, and clusters) you want to search for resource pools.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the names of the resource pools you want to retrieve.
    optional
    NoRecursion
    SwitchParameter named Indicates that you want to disable the recursive behavior of the command.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.
    optional
    Tag
    Tag[] named Returns only the resource pools that are associated with any of the specified tags.

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

    Parameters

    Required Parameter Name Type Position Features Description
    required
    VM
    VirtualMachine[] named
  • wildcards
  • pipeline
  • Specifies virtual machines to filter the resource pools that contain at least one of them.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the names of the resource pools you want to retrieve.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.
    optional
    Tag
    Tag[] named Returns only the resource pools that are associated with any of the specified tags.

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

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named
  • wildcards
  • Specifies the IDs of the resource pools you want to retrieve.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.

    -RelatedObject  <ResourcePoolRelatedObjectBase[]>
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    RelatedObject
    ResourcePoolRelatedObjectBase[] named
  • pipeline
  • Specifies objects to retrieve one or more ResourcePool objects that are related to them. This parameter accepts ProviderVdc and OMResource objects.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Inventory.ResourcePool

    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.

    Related Commands

    Feedback

    Was this page helpful?