Skip to content

Latest commit

 

History

History
78 lines (61 loc) · 1.41 KB

reference_element_api_removevirtualnetwork.adoc

File metadata and controls

78 lines (61 loc) · 1.41 KB
permalink sidebar keywords summary
api/reference_element_api_removevirtualnetwork.html
sidebar
virtual,network,networks,remove,removing,removevirtualnetwork
You can use the RemoveVirtualNetwork method to remove a previously added virtual network.

RemoveVirtualNetwork

You can use the RemoveVirtualNetwork method to remove a previously added virtual network.

Note
This method requires either the virtualNetworkID or the virtualNetworkTag as a parameter, but not both.
Note
You cannot remove a virtual network if there are initiators associated with it. Disassociate the initiators first, and then remove the virtual network.

Parameters

This method has the following input parameters:

Name Description Type Default value Required

virtualNetworkID

Network ID that identifies the virtual network to remove.

integer

None

Yes

virtualNetworkTag

Network tag that identifies the virtual network to remove.

integer

None

Yes

Return values

This method has no return values.

Request example

Requests for this method are similar to the following example:

{
  "method": "RemoveVirtualNetwork",
  "params": {
     "virtualNetworkID": 5
    }
}

Response example

This method returns a response similar to the following example:

{
   "id": 1,
   "result": {}
}

New since version

9.6