Data Object Description

Properties

Name	Type	Description
active*	xsd:boolean	If set, only the active ports are qualified.
connected*	xsd:boolean	If set, only the connected ports are qualified.
host*	ManagedObjectReference[] to a HostSystem[]	If set, only the ports that are present in one of the host are qualified. *Since* vSphere API 6.5
inside*	xsd:boolean	If unset, all ports in the switch are qualified. If set to true, only ports inside portgroupKey or any portgroup, if not set, are qualified. If set to false, only ports outside portgroupKey or any portgroup, if not set, are qualified.
nsxPort*	xsd:boolean	If set to true, only the NSX ports are qualified. If set to false, only non-NSX ports are qualified. NSX ports are ports of NSX port group. *Since* vSphere API 7.0
portgroupKey*	xsd:string[]	The keys of the portgroup that is used for the scope of inside. If this property is unset, it means any portgroup. If inside is unset, this property is ignored.
portKey*	xsd:string[]	If set, only the ports of which the key is in the array are qualified.
scope*	ManagedObjectReference to a ManagedEntity	Deprecated. as of vSphere API 5.5 If set, only the ports of which the scope covers the entity are qualified.
uplinkPort*	xsd:boolean	If set to true, only the uplink ports are qualified. If set to false, only non-uplink ports are qualified.
Properties inherited from DynamicData
None

Name

Type

Description

active*

xsd:boolean

If set, only the active ports are qualified.

connected*

xsd:boolean

If set, only the connected ports are qualified.

host*

ManagedObjectReference[]
to a HostSystem[]

If set, only the ports that are present in one of the host are qualified.

Since vSphere API 6.5

inside*

xsd:boolean

If unset, all ports in the switch are qualified. If set to true, only ports inside portgroupKey or any portgroup, if not set, are qualified. If set to false, only ports outside portgroupKey or any portgroup, if not set, are qualified.

nsxPort*

xsd:boolean

If set to true, only the NSX ports are qualified. If set to false, only non-NSX ports are qualified. NSX ports are ports of NSX port group.

Since vSphere API 7.0

portgroupKey*

xsd:string[]

The keys of the portgroup that is used for the scope of inside. If this property is unset, it means any portgroup. If inside is unset, this property is ignored.

portKey*

xsd:string[]

If set, only the ports of which the key is in the array are qualified.

scope*

ManagedObjectReference
to a ManagedEntity

Deprecated. as of vSphere API 5.5

If set, only the ports of which the scope covers the entity are qualified.

uplinkPort*

xsd:boolean

If set to true, only the uplink ports are qualified. If set to false, only non-uplink ports are qualified.

Properties inherited from DynamicData

None

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DistributedVirtualSwitchPortCriteria">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="connected" type="xsd:boolean" minOccurs="0"/>
                     <element name="active" type="xsd:boolean" minOccurs="0"/>
                     <element name="uplinkPort" type="xsd:boolean" minOccurs="0"/>
                     <element name="nsxPort" type="xsd:boolean" minOccurs="0"/>
                     <element name="scope" type="vim25:ManagedObjectReference" minOccurs="0"/>
                     <element name="portgroupKey" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="inside" type="xsd:boolean" minOccurs="0"/>
                     <element name="portKey" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="host" type="vim25:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - DistributedVirtualSwitchPortCriteria(vim.dvs.PortCriteria)

Data Object Description