Folder Create DVS Task
Create a DistributedVirtualSwitch in the folder according to the specified DVSCreateSpec.
The specified Folder must be a Network entity folder.
Required privileges: DVSwitch.Create
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/Folder/{moId}/CreateDVS_Task
COPY
Path Parameters
string
moId
Required
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case Folder/{moId}.
string
release
Required
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
Request Body
CreateDVSRequestType of type(s) application/json
Required
Show optional properties
{
"spec": {
"configSpec": {}
}
}{
"spec": {
"_typeName": "string",
"configSpec": {
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"configVersion": "string",
"name": "string",
"numStandalonePorts": 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"
}
}
],
"operation": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"backing": {
"_typeName": "string"
},
"maxProxySwitchPorts": 0,
"vendorSpecificConfig": [
{
"_typeName": "string",
"key": "string",
"opaqueData": "string"
}
]
}
],
"extensionKey": "string",
"description": "string",
"policy": {
"_typeName": "string",
"autoPreInstallAllowed": false,
"autoUpgradeAllowed": false,
"partialUpgradeAllowed": false
},
"vendorSpecificConfig": [
{
"_typeName": "string",
"key": "string",
"opaqueData": "string"
}
],
"contact": {
"_typeName": "string",
"name": "string",
"contact": "string"
},
"switchIpAddress": "string",
"defaultProxySwitchMaxNumPorts": 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"
},
"productInfo": {
"_typeName": "string",
"name": "string",
"vendor": "string",
"version": "string",
"build": "string",
"forwardingClass": "string",
"bundleId": "string",
"bundleUrl": "string"
},
"capability": {
"_typeName": "string",
"dvsOperationSupported": false,
"dvPortGroupOperationSupported": false,
"dvPortOperationSupported": false,
"compatibleHostComponentProductInfo": [
{
"_typeName": "string",
"productLineId": "string",
"version": "string"
}
],
"featuresSupported": {
"_typeName": "string",
"networkResourceManagementSupported": false,
"vmDirectPathGen2Supported": false,
"nicTeamingPolicy": [
"string"
],
"networkResourcePoolHighShareValue": 0,
"networkResourceManagementCapability": {
"_typeName": "string",
"networkResourceManagementSupported": false,
"networkResourcePoolHighShareValue": 0,
"qosSupported": false,
"userDefinedNetworkResourcePoolsSupported": false,
"networkResourceControlVersion3Supported": false,
"userDefinedInfraTrafficPoolSupported": false
},
"healthCheckCapability": {
"_typeName": "string"
},
"rollbackCapability": {
"_typeName": "string",
"rollbackSupported": false
},
"backupRestoreCapability": {
"_typeName": "string",
"backupRestoreSupported": false
},
"networkFilterSupported": false,
"macLearningSupported": false
}
}
}
}
Responses
200
This method returns a Task object with which to monitor the operation. After successful completion, the Task.info.result property contains the newly registered DistributedVirtualSwitch.
Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject
{
"_typeName": "string",
"type": "string",
"value": "string"
}
500
NotSupported: if called directly on a host.
DvsNotAuthorized: if login-session's extension key does not match (extensionKey).
Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
On This Page
Virtual Infrastructure Operations
POST
Folder Add Standalone Host Task
POST
Folder Batch Add Hosts To Cluster Task
POST
Folder Batch Add Standalone Hosts Task
POST
Folder Create Cluster
POST
Folder Create Cluster Ex
POST
Folder Create Datacenter
POST
Folder Create DVS Task
POST
Folder Create Folder
POST
Folder Create Storage Pod
POST
Folder Create VM Task
POST
Folder Destroy Task
GET
Folder Get Alarm Actions Enabled
GET
Folder Get Available Field
GET
Folder Get Child Entity
GET
Folder Get Child Type
GET
Folder Get Config Issue
GET
Folder Get Config Status
GET
Folder Get Custom Value
GET
Folder Get Declared Alarm State
GET
Folder Get Disabled Method
GET
Folder Get Effective Role
GET
Folder Get Name
GET
Folder Get Namespace
GET
Folder Get Overall Status
GET
Folder Get Parent
GET
Folder Get Permission
GET
Folder Get Recent Task
GET
Folder Get Tag
GET
Folder Get Triggered Alarm State
GET
Folder Get Value
POST
Folder Move Into Folder Task
POST
Folder Register VM Task
POST
Folder Reload
POST
Folder Rename Task
POST
Folder Set Custom Value
POST
Folder Unregister And Destroy Task