REST API - filter

vcenter resource pool: filter spec

The filter_spec structure contains fields used to filter the results when listing resource pools (see list). If multiple fields are specified, only resource pools matching all of the fields match the filter.

Representations:

JSON
XML

{
    "clusters": [
        "obj-103",
        "obj-103"
    ],
    "datacenters": [
        "obj-103",
        "obj-103"
    ],
    "hosts": [
        "obj-103",
        "obj-103"
    ],
    "names": [
        "string",
        "string"
    ],
    "parent_resource_pools": [
        "obj-103",
        "obj-103"
    ],
    "resource_pools": [
        "obj-103",
        "obj-103"
    ]
}

<?xml version="1.0" ?>
<ns0:FilterSpec xmlns:ns0="http://vmware.com/vcenter/resource_pool" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <resource_pools-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </resource_pools-array>
  <clusters-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </clusters-array>
  <datacenters-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </datacenters-array>
  <names-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </names-array>
  <hosts-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </hosts-array>
  <parent_resource_pools-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </parent_resource_pools-array>
</ns0:FilterSpec>

Attributes:

Name	Type	Description
Optional
resource_pools	string[]	Identifiers of resource pools that can match the filter. Optional. If unset or empty, resource pools with any identifier match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `ResourcePool`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `ResourcePool`.
names	string[]	Names that resource pools must have to match the filter (see vcenter.resource_pool.info.name). Optional. If unset or empty, resource pools with any name match the filter.
parent_resource_pools	string[]	Resource pools that must contain the resource pool for the resource pool to match the filter. Optional. If unset or empty, resource pools in any resource pool match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `ResourcePool`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `ResourcePool`.
datacenters	string[]	Datacenters that must contain the resource pool for the resource pool to match the filter. Optional. If unset or empty, resource pools in any datacenter match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `Datacenter`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `Datacenter`.
hosts	string[]	Hosts that must contain the resource pool for the resource pool to match the filter. Optional. If unset or empty, resource pools in any host match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `HostSystem`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `HostSystem`.
clusters	string[]	Clusters that must contain the resource pool for the resource pool to match the filter. Optional. If unset or empty, resource pools in any cluster match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `ClusterComputeResource`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `ClusterComputeResource`.