PhysicalNic

PhysicalNic
PhysicalNic

This data object type describes the physical network adapter as seen by the primary operating system.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": "string",
    "device": "string",
    "pci": "string",
    "driver": "string",
    "driverVersion": "string",
    "firmwareVersion": "string",
    "linkSpeed": {
        "_typeName": "string",
        "speedMb": 0,
        "duplex": false
    },
    "validLinkSpecification": [
        {
            "_typeName": "string",
            "speedMb": 0,
            "duplex": false
        }
    ],
    "spec": {
        "_typeName": "string",
        "ip": {
            "_typeName": "string",
            "dhcp": false,
            "ipAddress": "string",
            "subnetMask": "string",
            "ipV6Config": {
                "_typeName": "string",
                "ipV6Address": [
                    {
                        "_typeName": "string",
                        "ipAddress": "string",
                        "prefixLength": 0,
                        "origin": "string",
                        "dadState": "string",
                        "lifetime": "string",
                        "operation": "string"
                    }
                ],
                "autoConfigurationEnabled": false,
                "dhcpV6Enabled": false
            }
        },
        "linkSpeed": {
            "_typeName": "string",
            "speedMb": 0,
            "duplex": false
        },
        "enableEnhancedNetworkingStack": false,
        "ensInterruptEnabled": false
    },
    "wakeOnLanSupported": false,
    "mac": "string",
    "fcoeConfiguration": {
        "_typeName": "string",
        "priorityClass": 0,
        "sourceMac": "string",
        "vlanRange": [
            {
                "_typeName": "string",
                "vlanLow": 0,
                "vlanHigh": 0
            }
        ],
        "capabilities": {
            "_typeName": "string",
            "priorityClass": false,
            "sourceMacAddress": false,
            "vlanRange": false
        },
        "fcoeActive": false
    },
    "vmDirectPathGen2Supported": false,
    "vmDirectPathGen2SupportedMode": "string",
    "resourcePoolSchedulerAllowed": false,
    "resourcePoolSchedulerDisallowedReason": [
        "string"
    ],
    "autoNegotiateSupported": false,
    "enhancedNetworkingStackSupported": false,
    "ensInterruptSupported": false,
    "rdmaDevice": "string",
    "dpuId": "string"
}
string
key
Optional

The linkable identifier.

string
device
Required

The device name of the physical network adapter.

string
pci
Required

Device hash of the PCI device corresponding to this physical network adapter.

string
driver
Optional

The name of the driver.

From command line: esxcli network nic get

string
driverVersion
Optional

The version of the physical network adapter operating system driver.

Since: vSphere API Release 8.0.0.1

string
firmwareVersion
Optional

The version of the firmware running in the network adapter.

Since: vSphere API Release 8.0.0.1

linkSpeed
Optional

The current link state of the physical network adapter.

If this object is not set, then the link is down.

array of PhysicalNicLinkInfo
validLinkSpecification
Optional

The valid combinations of speed and duplexity for this physical network adapter.

The speed and the duplex settings usually must be configured as a pair. This array lists all the valid combinations available for a physical network adapter.

Autonegotiate is not listed as one of the combinations supported. If is implicitly supported by the physical network adapter unless autoNegotiateSupported is set to false.

spec
Required

The specification of the physical network adapter.

boolean
wakeOnLanSupported
Required

Flag indicating whether the NIC is wake-on-LAN capable

string
mac
Required

The media access control (MAC) address of the physical network adapter.

fcoeConfiguration
Optional

The FCoE configuration of the physical network adapter.

boolean
vmDirectPathGen2Supported
Optional

Deprecated as of vSphere API 8.0. VMDirectPath Gen 2 is no longer supported and there is no replacement.

Flag indicating whether the NIC supports VMDirectPath Gen 2.

Note that this is only an indicator of the capabilities of this NIC, not of the whole host.

If the host software is not capable of VMDirectPath Gen 2, this property will be unset, as the host cannot provide information on the NIC capability.

See also vmDirectPathGen2Supported.

string
vmDirectPathGen2SupportedMode
Optional

Deprecated as of vSphere API 8.0. VMDirectPath Gen 2 is no longer supported and there is no replacement.

If vmDirectPathGen2Supported is true, this property advertises the VMDirectPath Gen 2 mode supported by this NIC (chosen from PhysicalNicVmDirectPathGen2SupportedModeEnum).

A mode may require that the associated vSphere Distributed Switch have a particular ProductSpec in order for network passthrough to be possible.

boolean
resourcePoolSchedulerAllowed
Optional

Flag indicating whether the NIC allows resource pool based scheduling for network I/O control.

array of string
resourcePoolSchedulerDisallowedReason
Optional

If resourcePoolSchedulerAllowed is false, this property advertises the reason for disallowing resource scheduling on this NIC.

The reasons may be one of PhysicalNicResourcePoolSchedulerDisallowedReasonEnum

boolean
autoNegotiateSupported
Optional

If set the flag indicates if the physical network adapter supports autonegotiate.

boolean
enhancedNetworkingStackSupported
Optional

If set the flag indicates whether a physical nic supports Enhanced Networking Stack driver

boolean
ensInterruptSupported
Optional

If set the flag indicates whether a physical nic supports Enhanced Networking Stack interrupt mode

string
rdmaDevice
Optional

Associated RDMA device, if any.

string
dpuId
Optional

The identifier of the DPU by which the physical NIC is backed.

When physical NIC is not backed by DPU, dpuId will be unset.

Since: vSphere API Release 8.0.0.1

Property Of