HostProxySwitch

HostProxySwitch
HostProxySwitch

The HostProxySwitch is a software entity which represents the component of a DistributedVirtualSwitch on a particular host.

AllOf
This class requires all of the following:
JSON Example 
{
    "_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"
        }
    ],
    "autoDeployOwned": false,
    "hostPerfNicOffloadState": {
        "_typeName": "string",
        "enabled": false,
        "runtimeStatus": "string",
        "statusDescription": "string"
    },
    "teplessMode": false
}
string
dvsUuid
Required

The uuid of the DistributedVirtualSwitch that the HostProxySwitch is a part of.

string
dvsName
Required

The name of the DistributedVirtualSwitch that the HostProxySwitch is part of.

string
key
Required

The proxy switch key.

integer As int32 As int32
numPorts
Required

The number of ports that this switch currently has.

integer As int32 As int32
configNumPorts
Optional

The configured number of ports that this switch has.

If configured number of ports is changed, a host reboot is required for the new value to take effect.

integer As int32 As int32
numPortsAvailable
Required

The number of ports that are available on this virtual switch.

array of KeyValue
uplinkPort
Optional

The list of ports that can be potentially used by physical nics.

This property contains the keys and names of such ports.

integer As int32 As int32
mtu
Optional

The maximum transmission unit (MTU) associated with this switch in bytes.

array of string
pnic
Optional

The set of physical network adapters associated with this switch.

spec
Required

The specification of the switch.

array of HostProxySwitchHostLagConfig
hostLag
Optional

The Link Aggregation Control Protocol group and Uplink ports in the group.

boolean
networkReservationSupported
Optional

Indicates whether network reservation is supported on this switch

boolean
nsxtEnabled
Optional

Indicate whether NSX-T is enabled on this switch

boolean
ensEnabled
Optional

Is ENS enabled on this switch

boolean
ensInterruptEnabled
Optional

Is ENS interrupt mode enabled on this switch

array of DistributedVirtualSwitchHostMemberTransportZoneInfo
transportZones
Optional

Transport Zones this switch joined

array of string
nsxUsedUplinkPort
Optional

Uplink port names used by NSX-T

string
nsxtStatus
Optional

NSX-T proxy switch status

string
nsxtStatusDetail
Optional

Additional information regarding the NSX-T proxy switch status

ensInfo
Optional

ENS Status From VmKernel.

Since: vSphere API Release 8.0.0.1

boolean
networkOffloadingEnabled
Optional

Indicate if network offloading is enabled on the proxy switch of this host.

Unset implies that network offloading is disabled.

Since: vSphere API Release 8.0.0.1

array of DistributedVirtualSwitchHostMemberHostUplinkState
hostUplinkState
Optional

Indicates the runtime state of uplinks on the host.

Only set when networkOffloadingEnabled is true.

Since: vSphere API Release 8.0.3.0

boolean
autoDeployOwned
Optional

A flag indicating whether the VDS is created specifically for vSphere Auto Deploy on this host.

This is a temporary switch created by the ESX network plugin to restore the network connectivity to the vCenter. If this flag is not set, it implies that it is not created for vSphere Auto Deploy.

Since: vSphere API Release 9.1.0.0

hostPerfNicOffloadState
Optional

Indicates the runtime state of performance NIC offloading on the host.

If unset, performance NIC offloading is considered disabled.

Since: vSphere API Release 9.1.0.0

boolean
teplessMode
Optional

Indicates whether this host member is configured to operate in NSX tepless mode.

Tepless mode refers to a specific NSX overlay network configuration where the host does not have a Virtual Tunnel End Point (VTEP). This property is only effective when nsxtEnabled is true. If this property is unset, the host member is not in NSX tepless mode.

Since: vSphere API Release 9.1.0.0

Property Of