Update NIC Device
Updates a network adapter in the VM
Request
URI
PUT
https://{api_host}/api/vms/{id}/nic/{index}
COPY
Path Parameters
string
id
Required
ID of VM
string
index
Required
Index of VM network adapter
Request Body
Parameters of network adapter to update to
NICDeviceParameter of type(s) application/vnd.vmware.vmw.rest-v1+json
Required
{
"type": "string",
"vmnet": "string"
}
string
type
Required
The network type of network adapter
Possible values are : custom, bridged, nat, hostonly,
string
vmnet
Required
The vmnet name, it should only be used while type is custom
Responses
200
Information of the network adapter updated to
Returns NICDevice of type(s) application/vnd.vmware.vmw.rest-v1+json
{
"index": 0,
"type": "string",
"vmnet": "string",
"macAddress": "string"
}
string
type
Required
The network type of network adapter
Possible values are : bridged, nat, hostonly, custom,
string
vmnet
Required
The vmnet name
string
macAddress
Required
Mac address
400
Invalid parameters
Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json
{
"code": 0,
"message": "string"
}
integer As int32 As int32
code
Required
code
string
message
Required
message
401
Authentication failed
Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json
{
"code": 0,
"message": "string"
}
integer As int32 As int32
code
Required
code
string
message
Required
message
403
Permission denied
Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json
{
"code": 0,
"message": "string"
}
integer As int32 As int32
code
Required
code
string
message
Required
message
404
No such resource
Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json
{
"code": 0,
"message": "string"
}
integer As int32 As int32
code
Required
code
string
message
Required
message
406
Content type was not supported
Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json
{
"code": 0,
"message": "string"
}
integer As int32 As int32
code
Required
code
string
message
Required
message
500
Server error
Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json
{
"code": 0,
"message": "string"
}
integer As int32 As int32
code
Required
code
string
message
Required
message
default
Unexpected error
Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json
{
"code": 0,
"message": "string"
}
integer As int32 As int32
code
Required
code
string
message
Required
message
On This Page
VM Network Adapters Management Operations
POST
Create NIC Device
DELETE
Delete NIC Device
GET
Get All NIC Devices
GET
Get IP Address
PUT
Update NIC Device