HostNetworkInfo
HostNetworkInfo
This data object type describes networking host configuration data objects.
AllOf
This class requires all of the following:
JSON Example
{
"_typeName": "string",
"vswitch": [
{
"_typeName": "string",
"name": "string",
"key": "string",
"numPorts": 0,
"numPortsAvailable": 0,
"mtu": 0,
"portgroup": [
"string"
],
"pnic": [
"string"
],
"spec": {
"_typeName": "string",
"numPorts": 0,
"bridge": {
"_typeName": "string"
},
"policy": {
"_typeName": "string",
"security": {
"_typeName": "string",
"allowPromiscuous": false,
"macChanges": false,
"forgedTransmits": false
},
"nicTeaming": {
"_typeName": "string",
"policy": "string",
"reversePolicy": false,
"notifySwitches": false,
"rollingOrder": false,
"failureCriteria": {
"_typeName": "string",
"checkSpeed": "string",
"speed": 0,
"checkDuplex": false,
"fullDuplex": false,
"checkErrorPercent": false,
"percentage": 0,
"checkBeacon": false
},
"nicOrder": {
"_typeName": "string",
"activeNic": [
"string"
],
"standbyNic": [
"string"
]
}
},
"offloadPolicy": {
"_typeName": "string",
"csumOffload": false,
"tcpSegmentation": false,
"zeroCopyXmit": false
},
"shapingPolicy": {
"_typeName": "string",
"enabled": false,
"averageBandwidth": 0,
"peakBandwidth": 0,
"burstSize": 0
}
},
"mtu": 0
}
}
],
"proxySwitch": [
{
"_typeName": "string",
"dvsUuid": "string",
"dvsName": "string",
"key": "string",
"numPorts": 0,
"configNumPorts": 0,
"numPortsAvailable": 0,
"uplinkPort": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
],
"mtu": 0,
"pnic": [
"string"
],
"spec": {
"_typeName": "string",
"backing": {
"_typeName": "string"
}
},
"hostLag": [
{
"_typeName": "string",
"lagKey": "string",
"lagName": "string",
"uplinkPort": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
]
}
],
"networkReservationSupported": false,
"nsxtEnabled": false,
"ensEnabled": false,
"ensInterruptEnabled": false,
"transportZones": [
{
"_typeName": "string",
"uuid": "string",
"type": "string"
}
],
"nsxUsedUplinkPort": [
"string"
],
"nsxtStatus": "string",
"nsxtStatusDetail": "string",
"ensInfo": {
"_typeName": "string",
"opsVersion": 0,
"numPSOps": 0,
"numLcoreOps": 0,
"errorStatus": 0,
"lcoreStatus": 0
},
"networkOffloadingEnabled": false,
"hostUplinkState": [
{
"_typeName": "string",
"uplinkName": "string",
"state": "string"
}
]
}
],
"portgroup": [
{
"_typeName": "string",
"key": "string",
"port": [
{
"_typeName": "string",
"key": "string",
"mac": [
"string"
],
"type": "string"
}
],
"vswitch": "string",
"computedPolicy": {
"_typeName": "string",
"security": {
"_typeName": "string",
"allowPromiscuous": false,
"macChanges": false,
"forgedTransmits": false
},
"nicTeaming": {
"_typeName": "string",
"policy": "string",
"reversePolicy": false,
"notifySwitches": false,
"rollingOrder": false,
"failureCriteria": {
"_typeName": "string",
"checkSpeed": "string",
"speed": 0,
"checkDuplex": false,
"fullDuplex": false,
"checkErrorPercent": false,
"percentage": 0,
"checkBeacon": false
},
"nicOrder": {
"_typeName": "string",
"activeNic": [
"string"
],
"standbyNic": [
"string"
]
}
},
"offloadPolicy": {
"_typeName": "string",
"csumOffload": false,
"tcpSegmentation": false,
"zeroCopyXmit": false
},
"shapingPolicy": {
"_typeName": "string",
"enabled": false,
"averageBandwidth": 0,
"peakBandwidth": 0,
"burstSize": 0
}
},
"spec": {
"_typeName": "string",
"name": "string",
"vlanId": 0,
"vswitchName": "string",
"policy": {
"_typeName": "string",
"security": {
"_typeName": "string",
"allowPromiscuous": false,
"macChanges": false,
"forgedTransmits": false
},
"nicTeaming": {
"_typeName": "string",
"policy": "string",
"reversePolicy": false,
"notifySwitches": false,
"rollingOrder": false,
"failureCriteria": {
"_typeName": "string",
"checkSpeed": "string",
"speed": 0,
"checkDuplex": false,
"fullDuplex": false,
"checkErrorPercent": false,
"percentage": 0,
"checkBeacon": false
},
"nicOrder": {
"_typeName": "string",
"activeNic": [
"string"
],
"standbyNic": [
"string"
]
}
},
"offloadPolicy": {
"_typeName": "string",
"csumOffload": false,
"tcpSegmentation": false,
"zeroCopyXmit": false
},
"shapingPolicy": {
"_typeName": "string",
"enabled": false,
"averageBandwidth": 0,
"peakBandwidth": 0,
"burstSize": 0
}
}
}
}
],
"pnic": [
{
"_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"
}
],
"rdmaDevice": [
{
"_typeName": "string",
"key": "string",
"device": "string",
"driver": "string",
"description": "string",
"backing": {
"_typeName": "string"
},
"connectionInfo": {
"_typeName": "string",
"state": "string",
"mtu": 0,
"speedInMbps": 0
},
"capability": {
"_typeName": "string",
"roceV1Capable": false,
"roceV2Capable": false,
"iWarpCapable": false
}
}
],
"vnic": [
{
"_typeName": "string",
"device": "string",
"key": "string",
"portgroup": "string",
"spec": {
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_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
}
},
"mac": "string",
"distributedVirtualPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"portgroup": "string",
"mtu": 0,
"tsoEnabled": false,
"netStackInstanceKey": "string",
"opaqueNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
},
"externalId": "string",
"pinnedPnic": "string",
"ipRouteSpec": {
"_typeName": "string",
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
}
},
"systemOwned": false,
"dpuId": "string"
},
"port": "string",
"owner": "string"
}
],
"consoleVnic": [
{
"_typeName": "string",
"device": "string",
"key": "string",
"portgroup": "string",
"spec": {
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_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
}
},
"mac": "string",
"distributedVirtualPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"portgroup": "string",
"mtu": 0,
"tsoEnabled": false,
"netStackInstanceKey": "string",
"opaqueNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
},
"externalId": "string",
"pinnedPnic": "string",
"ipRouteSpec": {
"_typeName": "string",
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
}
},
"systemOwned": false,
"dpuId": "string"
},
"port": "string",
"owner": "string"
}
],
"dnsConfig": {
"_typeName": "string",
"dhcp": false,
"virtualNicDevice": "string",
"ipv6VirtualNicDevice": "string",
"hostName": "string",
"domainName": "string",
"address": [
"string"
],
"searchDomain": [
"string"
]
},
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
},
"consoleIpRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
},
"routeTableInfo": {
"_typeName": "string",
"ipRoute": [
{
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
],
"ipv6Route": [
{
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
]
},
"dhcp": [
{
"_typeName": "string",
"key": "string",
"spec": {
"_typeName": "string",
"virtualSwitch": "string",
"defaultLeaseDuration": 0,
"leaseBeginIp": "string",
"leaseEndIp": "string",
"maxLeaseDuration": 0,
"unlimitedLease": false,
"ipSubnetAddr": "string",
"ipSubnetMask": "string"
}
}
],
"nat": [
{
"_typeName": "string",
"key": "string",
"spec": {
"_typeName": "string",
"virtualSwitch": "string",
"activeFtp": false,
"allowAnyOui": false,
"configPort": false,
"ipGatewayAddress": "string",
"udpTimeout": 0,
"portForward": [
{
"_typeName": "string",
"type": "string",
"name": "string",
"hostPort": 0,
"guestPort": 0,
"guestIpAddress": "string"
}
],
"nameService": {
"_typeName": "string",
"dnsAutoDetect": false,
"dnsPolicy": "string",
"dnsRetries": 0,
"dnsTimeout": 0,
"dnsNameServer": [
"string"
],
"nbdsTimeout": 0,
"nbnsRetries": 0,
"nbnsTimeout": 0
}
}
}
],
"ipV6Enabled": false,
"atBootIpV6Enabled": false,
"netStackInstance": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"dnsConfig": {
"_typeName": "string",
"dhcp": false,
"virtualNicDevice": "string",
"ipv6VirtualNicDevice": "string",
"hostName": "string",
"domainName": "string",
"address": [
"string"
],
"searchDomain": [
"string"
]
},
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
},
"requestedMaxNumberOfConnections": 0,
"congestionControlAlgorithm": "string",
"ipV6Enabled": false,
"routeTableConfig": {
"_typeName": "string",
"ipRoute": [
{
"_typeName": "string",
"changeOperation": "string",
"route": {
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
}
],
"ipv6Route": [
{
"_typeName": "string",
"changeOperation": "string",
"route": {
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
}
]
},
"owner": "string"
}
],
"opaqueSwitch": [
{
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"key": "string",
"name": "string",
"pnic": [
"string"
],
"pnicZone": [
{
"_typeName": "string",
"key": "string",
"pnicDevice": [
"string"
]
}
],
"status": "string",
"vtep": [
{
"_typeName": "string",
"device": "string",
"key": "string",
"portgroup": "string",
"spec": {
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_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
}
},
"mac": "string",
"distributedVirtualPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"portgroup": "string",
"mtu": 0,
"tsoEnabled": false,
"netStackInstanceKey": "string",
"opaqueNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
},
"externalId": "string",
"pinnedPnic": "string",
"ipRouteSpec": {
"_typeName": "string",
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
}
},
"systemOwned": false,
"dpuId": "string"
},
"port": "string",
"owner": "string"
}
],
"extraConfig": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"featureCapability": [
{
"_typeName": "string",
"key": "string",
"featureName": "string",
"value": "string"
}
]
}
],
"opaqueNetwork": [
{
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"opaqueNetworkId": "string",
"opaqueNetworkName": "string",
"opaqueNetworkType": "string",
"pnicZone": [
"string"
],
"capability": {
"_typeName": "string",
"networkReservationSupported": false
},
"extraConfig": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
]
}
],
"nsxTransportNodeId": "string",
"nvdsToVdsMigrationRequired": false,
"migrationStatus": "string"
}
array of
PhysicalNic
pnic
Optional
Physical network adapters as seen by the primary operating system.
array of
HostRdmaDevice
rdmaDevice
Optional
Remote direct memory access devices, if any are present on the host.
array of
HostVirtualNic
vnic
Optional
Virtual network adapters configured on the host (hosted products) or the vmkernel.
In the hosted architecture, these network adapters are used by the host to communicate with the virtual machines running on that host. In the VMkernel architecture, these virtual network adapters provide the ESX Server with external network access through a virtual switch that is bridged to a physical network adapter. The VMkernel uses these network adapters for features such as VMotion, NAS, iSCSI, and remote MKS connections.
array of
HostVirtualNic
consoleVnic
Optional
Virtual network adapters configured for use by the service console.
The service console uses this network access for system management and bootstrapping services like network boot. The two sets of virtual network adapters are mutually exclusive. A virtual network adapter in this list cannot be used for things like VMotion. Likewise, a virtual network adapter in the other list cannot be used by the service console.
dnsConfig
Optional
Deprecated as of vSphere API 5.5, which is moved to each NetStackInstance. For this property in NetworkInfo, Get operation will only return its value of default NetStackInstance.
Client-side DNS configuration.
ipRouteConfig
Optional
Deprecated as of vSphere API 5.5, which is moved to each NetStackInstance. For this property in NetworkInfo, Get operation will only return its value of default NetStackInstance.
IP route configuration.
consoleIpRouteConfig
Optional
IP route configuration of the service console.
routeTableInfo
Optional
Deprecated as of vSphere API 5.5, which is moved to each NetStackInstance. For this property in NetworkInfo, Get operation will only return its value of default NetStackInstance.
IP routing table
boolean
ipV6Enabled
Optional
Enable or disable IPv6 protocol on this system.
boolean
atBootIpV6Enabled
Optional
If true then dual IPv4/IPv6 stack enabled else IPv4 only.
string
nsxTransportNodeId
Optional
The nsx transport node Id
boolean
nvdsToVdsMigrationRequired
Optional
Whether NSX N-VDS to VDS migration is required
Since: vSphere API Release 7.0.2.0
string
migrationStatus
Optional
Current status of NVDS to VDS migration.
See HostNetworkConfig.HostNetworkConfigMigrationStatusEnum for supported values.
Since: vSphere API Release 7.0.2.0