Distributed Virtual Switch Get Summary

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.2.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

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.

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.

hostMember
Optional

The names of the hosts that join the switch.

vm
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.

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.

contact
Optional

Contact information of a human operator.

integer As int32 As int32
numHosts
Optional

The number of hosts in the switch.

The value of this property is not affected by the privileges granted to the current user.


Distributed Virtual Switch Operations
POST
Distributed Virtual Switch Add DV Portgroup Task
POST
Distributed Virtual Switch Add Network Resource Pool
POST
Distributed Virtual Switch Create DV Portgroup Task
POST
Distributed Virtual Switch Destroy Task
POST
Distributed Virtual Switch Dvs Reconfigure Vm Vnic Network Resource Pool Task
POST
Distributed Virtual Switch DVS Rollback Task
POST
Distributed Virtual Switch Enable Network Resource Management
POST
Distributed Virtual Switch Fetch DV Port Keys
POST
Distributed Virtual Switch Fetch DV Ports
GET
Distributed Virtual Switch Get Alarm Actions Enabled
GET
Distributed Virtual Switch Get Available Field
GET
Distributed Virtual Switch Get Capability
GET
Distributed Virtual Switch Get Config
GET
Distributed Virtual Switch Get Config Issue
GET
Distributed Virtual Switch Get Config Status
GET
Distributed Virtual Switch Get Custom Value
GET
Distributed Virtual Switch Get Declared Alarm State
GET
Distributed Virtual Switch Get Disabled Method
GET
Distributed Virtual Switch Get Effective Role
GET
Distributed Virtual Switch Get Name
GET
Distributed Virtual Switch Get Network Resource Pool
GET
Distributed Virtual Switch Get Overall Status
GET
Distributed Virtual Switch Get Parent
GET
Distributed Virtual Switch Get Permission
GET
Distributed Virtual Switch Get Portgroup
GET
Distributed Virtual Switch Get Recent Task
GET
Distributed Virtual Switch Get Runtime
GET
Distributed Virtual Switch Get Summary
GET
Distributed Virtual Switch Get Tag
GET
Distributed Virtual Switch Get Triggered Alarm State
GET
Distributed Virtual Switch Get Uuid
GET
Distributed Virtual Switch Get Value
POST
Distributed Virtual Switch Lookup Dv Port Group
POST
Distributed Virtual Switch Merge Dvs Task
POST
Distributed Virtual Switch Move DV Port Task
POST
Distributed Virtual Switch Perform Dvs Product Spec Operation Task
POST
Distributed Virtual Switch Query Used Vlan Id In Dvs
POST
Distributed Virtual Switch Reconfigure DV Port Task
POST
Distributed Virtual Switch Reconfigure Dvs Task
POST
Distributed Virtual Switch Rectify Dvs Host Task
POST
Distributed Virtual Switch Refresh DV Port State
POST
Distributed Virtual Switch Reload
POST
Distributed Virtual Switch Remove Network Resource Pool
POST
Distributed Virtual Switch Rename Task
POST
Distributed Virtual Switch Set Custom Value
POST
Distributed Virtual Switch Update Dvs Capability
POST
Distributed Virtual Switch Update DVS Health Check Config Task
POST
Distributed Virtual Switch Update Network Resource Pool