Vmware Distributed Virtual Switch Get Config

Vmware Distributed Virtual Switch Get Config

Switch configuration data.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/VmwareDistributedVirtualSwitch/{moId}/config
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 VmwareDistributedVirtualSwitch/{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 DVSConfigInfo of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "uuid": "string",
    "name": "string",
    "numStandalonePorts": 0,
    "numPorts": 0,
    "maxPorts": 0,
    "uplinkPortPolicy": {
        "_typeName": "string"
    },
    "uplinkPortgroup": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "defaultPortConfig": {
        "_typeName": "string",
        "blocked": {
            "_typeName": "string",
            "inherited": false,
            "value": false
        },
        "vmDirectPathGen2Allowed": {
            "_typeName": "string",
            "inherited": false,
            "value": false
        },
        "inShapingPolicy": {
            "_typeName": "string",
            "inherited": false,
            "enabled": {
                "_typeName": "string",
                "inherited": false,
                "value": false
            },
            "averageBandwidth": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            },
            "peakBandwidth": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            },
            "burstSize": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            }
        },
        "outShapingPolicy": {
            "_typeName": "string",
            "inherited": false,
            "enabled": {
                "_typeName": "string",
                "inherited": false,
                "value": false
            },
            "averageBandwidth": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            },
            "peakBandwidth": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            },
            "burstSize": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            }
        },
        "vendorSpecificConfig": {
            "_typeName": "string",
            "inherited": false,
            "keyValue": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "opaqueData": "string"
                }
            ]
        },
        "networkResourcePoolKey": {
            "_typeName": "string",
            "inherited": false,
            "value": "string"
        },
        "filterPolicy": {
            "_typeName": "string",
            "inherited": false,
            "filterConfig": [
                {
                    "_typeName": "string",
                    "inherited": false,
                    "key": "string",
                    "agentName": "string",
                    "slotNumber": "string",
                    "parameters": {
                        "_typeName": "string",
                        "parameters": [
                            "string"
                        ]
                    },
                    "onFailure": "string"
                }
            ]
        }
    },
    "host": [
        {
            "_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"
        }
    ],
    "productInfo": {
        "_typeName": "string",
        "name": "string",
        "vendor": "string",
        "version": "string",
        "build": "string",
        "forwardingClass": "string",
        "bundleId": "string",
        "bundleUrl": "string"
    },
    "targetInfo": {
        "_typeName": "string",
        "name": "string",
        "vendor": "string",
        "version": "string",
        "build": "string",
        "forwardingClass": "string",
        "bundleId": "string",
        "bundleUrl": "string"
    },
    "extensionKey": "string",
    "vendorSpecificConfig": [
        {
            "_typeName": "string",
            "key": "string",
            "opaqueData": "string"
        }
    ],
    "policy": {
        "_typeName": "string",
        "autoPreInstallAllowed": false,
        "autoUpgradeAllowed": false,
        "partialUpgradeAllowed": false
    },
    "description": "string",
    "configVersion": "string",
    "contact": {
        "_typeName": "string",
        "name": "string",
        "contact": "string"
    },
    "switchIpAddress": "string",
    "createTime": "string",
    "networkResourceManagementEnabled": false,
    "defaultProxySwitchMaxNumPorts": 0,
    "healthCheckConfig": [
        {
            "_typeName": "string",
            "enable": false,
            "interval": 0
        }
    ],
    "infrastructureTrafficResourceConfig": [
        {
            "_typeName": "string",
            "key": "string",
            "description": "string",
            "allocationInfo": {
                "_typeName": "string",
                "limit": 0,
                "shares": {
                    "_typeName": "string",
                    "shares": 0,
                    "level": "string"
                },
                "reservation": 0
            }
        }
    ],
    "netResourcePoolTrafficResourceConfig": [
        {
            "_typeName": "string",
            "key": "string",
            "description": "string",
            "allocationInfo": {
                "_typeName": "string",
                "limit": 0,
                "shares": {
                    "_typeName": "string",
                    "shares": 0,
                    "level": "string"
                },
                "reservation": 0
            }
        }
    ],
    "networkResourceControlVersion": "string",
    "vmVnicNetworkResourcePool": [
        {
            "_typeName": "string",
            "key": "string",
            "name": "string",
            "description": "string",
            "configVersion": "string",
            "allocationInfo": {
                "_typeName": "string",
                "reservationQuota": 0
            }
        }
    ],
    "pnicCapacityRatioForReservation": 0
}
string
uuid
Required

Generated UUID of the switch.

Unique across vCenter Server inventory and instances.

string
name
Required

Name of the switch.

integer As int32 As int32
numStandalonePorts
Required

Number of standalone ports in the switch.

Standalone ports are ports that do not belong to any portgroup.

integer As int32 As int32
numPorts
Required

Current number of ports, not including conflict ports.

integer As int32 As int32
maxPorts
Required

Maximum number of ports allowed in the switch, not including conflict ports.

uplinkPortPolicy
Required

The base class for uplink port policy.

uplinkPortgroup
Optional

List of uplink portgroups.

When adding host members, the server uses the DVSConfigInfo.uplinkPortPolicy to create a number of uplink ports for the host. If portgroups are shown here, those uplink ports will be added to the portgroups, with uplink ports evenly spread among the portgroups.

defaultPortConfig
Required

The DVPortSetting data object describes the network configuration of a DistributedVirtualPort.

host
Optional

Hosts that join the switch.

productInfo
Required

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.

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

string
extensionKey
Optional

Key of the extension registered by the remote server that controls the switch.

vendorSpecificConfig
Optional

Opaque binary blob that stores vendor specific configuration.

policy
Optional

The switch usage policy types

string
description
Optional

Description string for the switch.

string
configVersion
Required

Version string of the configuration.

contact
Required

Contact information of a human operator.

string
switchIpAddress
Optional

IP address for the switch, specified using IPv4 dot notation.

The utility of this address is defined by other switch features.

string As date-time As date-time
createTime
Required

Create time of the switch.

boolean
networkResourceManagementEnabled
Required

Boolean to indicate if network I/O control is enabled on the switch.

integer As int32 As int32
defaultProxySwitchMaxNumPorts
Optional

Default host proxy switch maximum port number

healthCheckConfig
Optional

VDS health check configuration.

infrastructureTrafficResourceConfig
Optional

Host infrastructure traffic class resource configuration.

netResourcePoolTrafficResourceConfig
Optional

Dynamic Host infrastructure traffic class resource configuration.

string
networkResourceControlVersion
Optional

Network resource control version of the switch.

Possible value can be of DistributedVirtualSwitchNetworkResourceControlVersionEnum.

vmVnicNetworkResourcePool
Optional

The Virtual NIC network resource pool information for the switch.

integer As int32 As int32
pnicCapacityRatioForReservation
Optional

The percentage of physical nic link speed PhysicalNicLinkInfo.speedMb available for infrastructure traffic reservation.

If this value is 75, then for a 1Gbps physical nic, only 750Mbps is allowed for all infrastructure traffic reservations.


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