Data Object Description

HostVirtualNicSpec

HostVirtualNic

Properties

Name	Type	Description
distributedVirtualPort*	DistributedVirtualSwitchPortConnection	DistributedVirtualPort or DistributedVirtualPortgroup connection. To specify a port connection, set the portKey property. To specify a portgroup connection, set the portgroupKey property. *Since* vSphere API 4.0
externalId*	xsd:string	An ID assigned to the vmkernel adapter by external management plane or controller. The value and format of this property is determined by external management plane or controller, and vSphere doesn't do any validation. It's also up to external management plane or controller to set, unset or maintain this property. Setting this property with an empty string value will unset the property. This property is applicable only when opaqueNetwork field is set, otherwise it's value is ignored. *Since* vSphere API 6.0
ip*	HostIpConfig	IP configuration on the virtual network adapter.
mac*	xsd:string	Media access control (MAC) address of the virtual network adapter.
mtu*	xsd:int	Maximum transmission unit for packets size in bytes for the virtual NIC. This property is applicable to VMkernel virtual NICs and will be ignored if specified for service console virtual NICs. If not specified, the Server will use the system default value. *Since* vSphere API 4.0
netStackInstanceKey*	xsd:string	The NetStackInstance that the vNic uses, the value of this property is default to be defaultTcpipStack *Since* vSphere API 5.5
opaqueNetwork*	HostVirtualNicOpaqueNetworkSpec	The opaque network that the vNic uses. When reconfiguring a virtual NIC, this property indicates the specification of opaque network to which the virtual NIC should connect. You can specify this property only if you do not specify distributedVirtualPort and portgroup. *Since* vSphere API 6.0
pinnedPnic*	xsd:string	The physical nic to which the vmkernel adapter is pinned. Setting this value basically pins the vmkernel adpater to a specific physical nic. Similar to externalId, this property is applicable only when opaqueNetwork field is set. If the vmkernel adapter is connected to a portgroup or dvPort, then this pinning can be achieved by configuring correct teaming policy on the vSwitch or DVSwitch. Therefore, pinnedPnic value will be ignored if opaqueNetwork is unset. *Since* vSphere API 6.0
portgroup*	xsd:string	Portgroup (HostPortGroup) to which the virtual NIC is connected. When reconfiguring a virtual NIC, this property indicates the new portgroup to which the virtual NIC should connect. You can specify this property only if you do not specify distributedVirtualPort. *Since* vSphere API 4.0
tsoEnabled*	xsd:boolean	Flag enabling or disabling TCP segmentation offset for a virtual NIC. This property is applicable to VMkernel virtual NICs and will be ignored if specified for service console vitual nics. If not specified, a default value of true shall be used. *Since* vSphere API 4.0
Properties inherited from DynamicData
None

Name

Type

Description

distributedVirtualPort*

DistributedVirtualPort or DistributedVirtualPortgroup connection. To specify a port connection, set the portKey property. To specify a portgroup connection, set the portgroupKey property.

Since vSphere API 4.0

externalId*

xsd:string

An ID assigned to the vmkernel adapter by external management plane or controller. The value and format of this property is determined by external management plane or controller, and vSphere doesn't do any validation. It's also up to external management plane or controller to set, unset or maintain this property. Setting this property with an empty string value will unset the property.

This property is applicable only when opaqueNetwork field is set, otherwise it's value is ignored.

Since vSphere API 6.0

ip*

HostIpConfig

IP configuration on the virtual network adapter.

mac*

xsd:string

Media access control (MAC) address of the virtual network adapter.

mtu*

xsd:int

Maximum transmission unit for packets size in bytes for the virtual NIC. This property is applicable to VMkernel virtual NICs and will be ignored if specified for service console virtual NICs. If not specified, the Server will use the system default value.

Since vSphere API 4.0

netStackInstanceKey*

xsd:string

The NetStackInstance that the vNic uses, the value of this property is default to be defaultTcpipStack

Since vSphere API 5.5

opaqueNetwork*

HostVirtualNicOpaqueNetworkSpec

The opaque network that the vNic uses.

When reconfiguring a virtual NIC, this property indicates the specification of opaque network to which the virtual NIC should connect. You can specify this property only if you do not specify distributedVirtualPort and portgroup.

Since vSphere API 6.0

pinnedPnic*

xsd:string

The physical nic to which the vmkernel adapter is pinned. Setting this value basically pins the vmkernel adpater to a specific physical nic.

Similar to externalId, this property is applicable only when opaqueNetwork field is set. If the vmkernel adapter is connected to a portgroup or dvPort, then this pinning can be achieved by configuring correct teaming policy on the vSwitch or DVSwitch. Therefore, pinnedPnic value will be ignored if opaqueNetwork is unset.

Since vSphere API 6.0

portgroup*

xsd:string

Portgroup (HostPortGroup) to which the virtual NIC is connected.

When reconfiguring a virtual NIC, this property indicates the new portgroup to which the virtual NIC should connect. You can specify this property only if you do not specify distributedVirtualPort.

Since vSphere API 4.0

tsoEnabled*

xsd:boolean

Flag enabling or disabling TCP segmentation offset for a virtual NIC. This property is applicable to VMkernel virtual NICs and will be ignored if specified for service console vitual nics. If not specified, a default value of true shall be used.

Since vSphere API 4.0

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="HostVirtualNicSpec">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="ip" type="vim25:HostIpConfig" minOccurs="0"/>
                     <element name="mac" type="xsd:string" minOccurs="0"/>
                     <element name="distributedVirtualPort" type="vim25:DistributedVirtualSwitchPortConnection" minOccurs="0"/>
                     <element name="portgroup" type="xsd:string" minOccurs="0"/>
                     <element name="mtu" type="xsd:int" minOccurs="0"/>
                     <element name="tsoEnabled" type="xsd:boolean" minOccurs="0"/>
                     <element name="netStackInstanceKey" type="xsd:string" minOccurs="0"/>
                     <element name="opaqueNetwork" type="vim25:HostVirtualNicOpaqueNetworkSpec" minOccurs="0"/>
                     <element name="externalId" type="xsd:string" minOccurs="0"/>
                     <element name="pinnedPnic" type="xsd:string" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - HostVirtualNicSpec

Data Object Description