NetworkFilterSpec

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


Properties

array of string
datacenters Optional

Datacenters that must contain the network for the network to match the filter. 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.


array of string
folders Optional

Folders that must contain the network for the network to match the filter. 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.


array of string
names Optional

Names that networks must have to match the filter (see Network.Summary.name). If unset or empty, networks with any name match the filter.


array of string
networks Optional

Identifiers of networks that can match the filter. 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.


array of NetworkType Enum
types Optional

Types that networks must have to match the filter (see Network.Summary.type). If unset, networks with any type match the filter.

Parameter To

List Network

JSON Example

{
    "datacenters": [
        "string"
    ],
    "folders": [
        "string"
    ],
    "names": [
        "string"
    ],
    "networks": [
        "string"
    ],
    "types": "enum"
}
Feedback

Was this page helpful?