# Data Object - HostVirtualNicSpec(vim.host.VirtualNic.Specification)

Property of
  ClusterComputeResourceHostVmkNicInfo, HostVirtualNic, HostVirtualNicConfig
Parameter to
  AddServiceConsoleVirtualNic, AddVirtualNic, UpdateServiceConsoleVirtualNic, UpdateVirtualNic
Extends
  DynamicData
See also
  DistributedVirtualSwitchPortConnection, HostIpConfig, HostVirtualNicIpRouteSpec, HostVirtualNicOpaqueNetworkSpec
Since
  2.0

## Data Object Description

The HostVirtualNicSpec data object describes the HostVirtualNic configuration containing both the configured properties on a virtual NIC and identification information.

Properties

Name | Type | Description
--- | --- | ---
distributedVirtualPort* | DistributedVirtualSwitchPortConnection | DistributedVirtualPort or DistributedVirtualPortgroup connection. To specify a port connection, set switchUuid and portKey properties. To specify a portgroup connection, set switchUuid and portgroupKey properties. 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 and opaqueNetwork Since vSphere API 4.0
dpuId* | xsd:string | The identifier of the DPU hosting the vmknic. If vmknic is on ESX host, dpuId will be unset. Since 8.0.0.1
externalId* | xsd:string | An ID assigned to the vmkernel adapter by external management plane. The value and format of this property is determined by external management plane, and vSphere doesn't do any validation. It's also up to external management plane to set, unset or maintain this property. This property is applicable only when opaqueNetwork property is set, otherwise it's value is ignored. Since vSphere API 6.0
ip* | HostIpConfig | IP configuration on the virtual network adapter.
ipRouteSpec* | HostVirtualNicIpRouteSpec | The ip route configuration used by the vmkernel adapter. This attribute allows the vmkernel adapter to specify its own default gateway. Since vSphere API 6.5
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. If not specified, the Server will use the system default value. Since vSphere API 4.0
netStackInstanceKey* | xsd:string | The NetStackInstance that the virtual NIC uses, the value of this property is default to be vim.host.NetStackInstance.SystemStackKey#defaultTcpipStack Since vSphere API 5.5
opaqueNetwork* | HostVirtualNicOpaqueNetworkSpec | Opaque network (HostOpaqueNetworkInfo) to which the virtual NIC is connected. 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 ensures that the virtual NIC will access external network only via the the specified physical NIC. This property is applicable only when opaqueNetwork property is set. If the vmkernel adapter is connected to a portgroup or dvPort, then such pinning can be achieved by configuring correct teaming policy on the portgroup or dvPort or dvPortgroup that is connected to virtual NIC. 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 and opaqueNetwork Since vSphere API 4.0
systemOwned* | xsd:boolean | Set to true when the vmkernel adapter is configured by other system indirectly other than by the user directly. Since vSphere API 7.0
tsoEnabled* | xsd:boolean | Flag enabling or disabling TCP segmentation offset for a virtual NIC. If not specified, a default value of true will 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"/> <element name="ipRouteSpec" type="vim25:HostVirtualNicIpRouteSpec" minOccurs="0"/> <element name="systemOwned" type="xsd:boolean" minOccurs="0"/> <element name="dpuId" type="xsd:string" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>