Host V Motion System Get Net Config

Host V Motion System Get Net Config

VMotion network configuration.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/HostVMotionSystem/{moId}/netConfig
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostVMotionSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns HostVMotionNetConfig of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "candidateVnic": [
        {
            "_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": {
                "_typeName": "string",
                "key": "string",
                "mac": [
                    "string"
                ],
                "type": "string"
            }
        }
    ],
    "selectedVnic": {
        "_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": {
            "_typeName": "string",
            "key": "string",
            "mac": [
                "string"
            ],
            "type": "string"
        }
    }
}
candidateVnic
Optional

List of VirtualNic objects that may be used for VMotion.

This will be a subset of the list of VirtualNics in HostNetworkInfo.vnic.

selectedVnic
Optional

The HostVirtualNic data object describes a virtual network adapter that connects to a virtual switch.

A host virtual NIC differs from a physical NIC:

  • A host virtual NIC is a virtual device that is connected to a virtual switch.
  • A physical NIC (pnic) corresponds to a physical device that is connected to the physical network.

A host virtual NIC provides access to the external network through a virtual switch that is bridged through a Physical NIC to a physical network.