Distributed Virtual Portgroup Destroy Network

Deprecated as of VI API 2.5 do not use this method. This method throws ResourceInUse. Networks are automatically removed when no longer in use, so this method is unnecessary.

Removes a network.

A network can be removed only if it is not used by any host or virtual machine.

Required privileges: Network.Delete

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/DistributedVirtualPortgroup/{moId}/DestroyNetwork

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 DistributedVirtualPortgroup/{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

204

No Content

Operation doesn't return any data structure

500

ResourceInUse: if one or more hosts or virtual machines are configured to use the network.

Returns ResourceInUse of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "type": "string",
    "name": "string"
}

string

type

Optional

Type of resource that is in use.

string

name

Optional

Name of the instance of the resource that is in use.

On This Page

Description

Request

Path Parameters