Vcenter NamespaceManagement Networks Nsx DistributedSwitches FilterSpec

The Vcenter NamespaceManagement Networks Nsx DistributedSwitches FilterSpec schema contains properties used to filter the results when listing Distributed Switches (see GET /vcenter/namespace-management/networks/nsx/distributed-switches).

This schema was added in vSphere API 8.0.0.1.

JSON Example

{
    "compatible": false,
    "cluster": "string"
}

boolean

compatible

Optional

Compatibility criteria. If true, only Distributed Switches compatible with the vSphere Namespaces will be returned. If false, only Distributed Switches incompatible with the vSphere Namespaces will be returned.

This property was added in vSphere API 8.0.0.1.

If missing or null, both compatible and incompatible Distributed Switches will be returned.

string

cluster

Optional

If specified, distributed switches across the hosts in the cluster will be returned. This must not be specified if Vcenter NamespaceManagement Networks Nsx DistributedSwitches FilterSpec.zones is specified.

This property was added in vSphere API 9.1.0.0.

If missing or null, filtering on a particular cluster will not occur.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.