Host Network System Remove Virtual Switch

Host Network System Remove Virtual Switch
Removes an existing virtual switch from the system.

Removes an existing virtual switch from the system.

Required privileges: Host.Config.Network

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/RemoveVirtualSwitch
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 HostNetworkSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.

Request Body
RemoveVirtualSwitchRequestType of type(s) application/json
Required 
{
    "vswitchName": "string"
}
string
vswitchName
Required

vswitchName

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

NotFound: if the virtual switch does not exist.

ResourceInUse: if there are virtual network adapters associated with the virtual switch.

HostConfigFault: for all other configuration failures.

MethodDisabled: if the host's current flavor of partial maintenance mode has been configured to block this operation.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault 
{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"vswitchName":"string"}' https://{api_host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/RemoveVirtualSwitch
On This Page
Virtual Infrastructure Operations
POST
Host Network System Add Port Group
POST
Host Network System Add Service Console Virtual Nic
POST
Host Network System Add Virtual Nic
POST
Host Network System Add Virtual Switch
POST
Host Network System Query Network Hint
POST
Host Network System Refresh Network System
POST
Host Network System Remove Port Group
POST
Host Network System Remove Service Console Virtual Nic
POST
Host Network System Remove Virtual Nic
POST
Host Network System Remove Virtual Switch
POST
Host Network System Restart Service Console Virtual Nic
POST
Host Network System Set Custom Value
POST
Host Network System Start Dpu Failover
POST
Host Network System Update Console Ip Route Config
POST
Host Network System Update Dns Config
Deprecated
POST
Host Network System Update Ip Route Config
Deprecated
POST
Host Network System Update Ip Route Table Config
Deprecated
POST
Host Network System Update Network Config
POST
Host Network System Update Physical Nic Link Speed
POST
Host Network System Update Port Group
POST
Host Network System Update Service Console Virtual Nic
POST
Host Network System Update Virtual Nic
POST
Host Network System Update Virtual Switch
GET
Host Network System Get Available Field
GET
Host Network System Get Capabilities
GET
Host Network System Get Console Ip Route Config
GET
Host Network System Get Dns Config
Deprecated
GET
Host Network System Get Ip Route Config
Deprecated
GET
Host Network System Get Network Config
GET
Host Network System Get Network Info
GET
Host Network System Get Offload Capabilities
Deprecated
GET
Host Network System Get Value