Create NIC Device

Create NIC Device

Creates a network adapter in the VM

Request
URI
POST
https://{api_host}/api/vms/{id}/nic
COPY
Path Parameters
string
id
Required

ID of VM

Request Body

Parameters of network adapter to create

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

Authentication
This operation uses the following authentication methods.
Responses
201

Information of the network adapter created

Returns NICDevice of type(s) application/vnd.vmware.vmw.rest-v1+json 
"NICDevice Object"
integer As int32 As int32
index
Required
Constraints: default: 1

Index of Network Adapters

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 
"ErrorModel Object"
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 
"ErrorModel Object"
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 
"ErrorModel Object"
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 
"ErrorModel Object"
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 
"ErrorModel Object"
integer As int32 As int32
code
Required

code

string
message
Required

message


409

Resource state conflicts

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json 
"ErrorModel Object"
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 
"ErrorModel Object"
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 
"ErrorModel Object"
integer As int32 As int32
code
Required

code

string
message
Required

message


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/vnd.vmware.vmw.rest-v1+json' -d '{"type:"string","vmnet:"string"}' https://{api_host}/api/vms/{id}/nic
On This Page
Vm Network Adapters Management Operations
GET
Get All NIC Devices
POST
Create NIC Device
DELETE
Delete NIC Device
PUT
Update NIC Device
GET
Get IP Address