DistributedVirtualSwitchHostMember

DistributedVirtualSwitchHostMember
DistributedVirtualSwitchHostMember

The DistributedVirtualSwitchHostMember data object represents an ESXi host that is a member of a distributed virtual switch.

When you add a host to a switch (DistributedVirtualSwitchHostMemberConfigSpec.host), the Server creates a proxy switch (HostProxySwitch). The host member object contains information about the configuration and state of the proxy.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "dynamicProperty": [
        {
            "_typeName": "string",
            "name": "string",
            "val": {
                "_typeName": "string"
            }
        }
    ],
    "runtimeState": {
        "_typeName": "string",
        "currentMaxProxySwitchPorts": 0
    },
    "config": {
        "_typeName": "string",
        "host": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "maxProxySwitchPorts": 0,
        "vendorSpecificConfig": [
            {
                "_typeName": "string",
                "key": "string",
                "opaqueData": "string"
            }
        ],
        "backing": {
            "_typeName": "string"
        },
        "nsxSwitch": false,
        "ensEnabled": false,
        "ensInterruptEnabled": false,
        "transportZones": [
            {
                "_typeName": "string",
                "uuid": "string",
                "type": "string"
            }
        ],
        "nsxtUsedUplinkNames": [
            "string"
        ],
        "networkOffloadingEnabled": false
    },
    "productInfo": {
        "_typeName": "string",
        "name": "string",
        "vendor": "string",
        "version": "string",
        "build": "string",
        "forwardingClass": "string",
        "bundleId": "string",
        "bundleUrl": "string"
    },
    "uplinkPortKey": [
        "string"
    ],
    "status": "string",
    "statusDetail": "string"
}
dynamicProperty
Optional

Set of dynamic properties.

This property is optional because only the properties of an object that are unknown to a client will be part of this set. This property is not readonly just in case we want to send such properties from a client in the future.

runtimeState
Optional

Runtime state of a host member.

config
Required

The DistributedVirtualSwitchHostMemberConfigInfo data object contains membership configuration information for the ESXi host.

productInfo
Optional

This data object type is a subset of AboutInfo.

An object of this type can be used to describe the specification for a proxy switch module of a DistributedVirtualSwitch.

array of string
uplinkPortKey
Optional

Port keys of the uplink ports created for the host member.

These ports will be deleted after the host leaves the switch.

string
status
Required

Deprecated as of vSphere API 5.1, use HostMemberRuntimeInfo.status instead.

The host DistributedVirtualSwitch component status.

See HostComponentState for valid values.

string
statusDetail
Optional

Deprecated as of vSphere API 5.1, use HostMemberRuntimeInfo.statusDetail instead.

Additional information regarding the host's current status.