Distributed Virtual Switch Get Summary

Summary of the switch.

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/DistributedVirtualSwitch/{moId}/summary

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 DistributedVirtualSwitch/{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.

Session

Responses

200

Returns DVSSummary of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "name": "string",
    "uuid": "string",
    "numPorts": 0,
    "productInfo": {
        "_typeName": "string",
        "name": "string",
        "vendor": "string",
        "version": "string",
        "build": "string",
        "forwardingClass": "string",
        "bundleId": "string",
        "bundleUrl": "string"
    },
    "hostMember": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "vm": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "host": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "portgroupName": [
        "string"
    ],
    "description": "string",
    "contact": {
        "_typeName": "string",
        "name": "string",
        "contact": "string"
    },
    "numHosts": 0
}

string

name

Required

The name of the switch.

string

uuid

Required

The generated UUID of the switch.

integer As int32 As int32

numPorts

Required

Current number of ports, not including conflict ports.

DistributedVirtualSwitchProductSpec

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 MoRefHostSystem

hostMember

Optional

The names of the hosts that join the switch.

array of MoRefVirtualMachine

Optional

The Virtual Machines with Virtual NICs that connect to the switch.

In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Since this property is on a DataObject, an update returned by WaitForUpdatesEx may contain values for this property when some other property on the DataObject changes. If this update is a result of a call to WaitForUpdatesEx with a non-empty version parameter, the value for this property may not be current.

array of MoRefHostSystem

host

Optional

The hosts with Virtual NICs that connect to the switch.

array of string

portgroupName

Optional

The names of the portgroups that are defined on the switch.

string

description

Optional

A description string of the switch.