REST API - filter

vcenter network: filter spec

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

Representations:

JSON
XML

{
    "datacenters": [
        "obj-103",
        "obj-103"
    ],
    "folders": [
        "obj-103",
        "obj-103"
    ],
    "names": [
        "string",
        "string"
    ],
    "networks": [
        "obj-103",
        "obj-103"
    ],
    "types": [
        "STANDARD_PORTGROUP",
        "STANDARD_PORTGROUP"
    ]
}

<?xml version="1.0" ?>
<ns0:FilterSpec xmlns:ns0="http://vmware.com/vcenter/network" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <networks-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </networks-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>
  <folders-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </folders-array>
  <types-array>
    <array-item>STANDARD_PORTGROUP</array-item>
    <array-item>STANDARD_PORTGROUP</array-item>
  </types-array>
</ns0:FilterSpec>

Attributes:

Name	Type	Description
Optional
networks	string[]	Identifiers of networks that can match the filter. Optional. If unset or empty, networks 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: `Network`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `Network`.
names	string[]	Names that networks must have to match the filter (see vcenter.network.summary.name). Optional. If unset or empty, networks with any name match the filter.
types	string[]	Types that networks must have to match the filter (see vcenter.network.summary.type). Optional. If unset, networks with any type match the filter.
folders	string[]	Folders that must contain the network for the network to match the filter. Optional. If unset or empty, networks in any folder match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `Folder`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `Folder`.
datacenters	string[]	Datacenters that must contain the network for the network to match the filter. Optional. If unset or empty, networks 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`.