VMware Workstation API 1.2.1 Data Structures

CreateVmnetParameter

JSON Example

{
    "name": "string",
    "type": "string"
}

string

name

Required

The host network name

string

type

Optional

The host network type

Parameter To

Create Network

ErrorModel

JSON Example

{
    "code": "integer",
    "message": "string"
}

integer As int32 As int32

code

Required

code

string

message

Required

message

Returned By

Get All V Ms

Create VM

Get VM

Update VM

Delete VM

Get Power State

Change Power State

Get All Shared Folders

Create Shared Folder

Delete Shared Folder

Updata Shared Folder

Get All NIC Devices

Create NIC Device

Delete NIC Device

Update NIC Device

Get IP Address

Create Network

Get All Networks

Get Portforwards

Get MAC To I Ps

Update Mac To IP

Update Portforward

Delete Portforward

MACToIP

The MAC to IP setting

JSON Example

{
    "vmnet": "string",
    "mac": "string",
    "ip": "string"
}

string

vmnet

Required

vmnet

string

mac

Required

mac

string

ip

Required

ip

Property Of

MACToIPs

The list of MAC to IP settings

JSON Example

{
    "num": "integer",
    "mactoips": [
        {
            "vmnet": "string",
            "mac": "string",
            "ip": "string"
        }
    ]
}

Number

num

Required

num

array of MACToIP

mactoips

Optional

The list of MAC to IP settings

Returned By

Get MAC To I Ps

MacToIPParameter

JSON Example

{
    "IP": "string"
}

string

IP

Required

IP

Parameter To

Update Mac To IP

NICDevice

JSON Example

{
    "index": "integer",
    "type": "string",
    "vmnet": "string",
    "macAddress": "string"
}

NICIndex

index

Required

index

string

type

Required

The network type of network adapter

string

vmnet

Required

The vmnet name

string

macAddress

Required

Mac address

Property Of

NICDevices

Returned By

Create NIC Device

Update NIC Device

NICDeviceParameter

JSON Example

{
    "type": "string",
    "vmnet": "string"
}

string

type

Required

The network type of network adapter

string

vmnet

Required

The vmnet name, it should only be used while type is custom

Parameter To

Create NIC Device

Update NIC Device

NICDevices

The list of network adapters

JSON Example

{
    "num": "integer",
    "nics": [
        {
            "index": "integer",
            "type": "string",
            "vmnet": "string",
            "macAddress": "string"
        }
    ]
}

NICNumber

num

Required

num

array of NICDevice

nics

Required

The network adapter added to this VM

Returned By

Get All NIC Devices

NICIndex

Index of Network Adapters

This data structure has no properties.

Property Of

NICDevice

NICNumber

Number of NIC devices

This data structure has no properties.

Property Of

NICDevices

Network

The virtual network

JSON Example

{
    "name": "string",
    "type": "string",
    "dhcp": "string",
    "subnet": "string",
    "mask": "string"
}

string

name

Required

Name of virtual network

string

type

Required

type

string

dhcp

Required

dhcp

string

subnet

Required

subnet

string

mask

Required

mask

Property Of

Networks

Returned By

Create Network

Networks

The list of virtual networks

JSON Example

{
    "num": "integer",
    "vmnets": [
        {
            "name": "string",
            "type": "string",
            "dhcp": "string",
            "subnet": "string",
            "mask": "string"
        }
    ]
}

Number

num

Required

num

array of Network

vmnets

Required

The list of virtual networks

Returned By

Get All Networks

Number

Number of items

This data structure has no properties.

Property Of

Networks

Portforwards

MACToIPs

Port

port of communication

This data structure has no properties.

Property Of

PortforwardParameter

Portforward

The port forwarding

JSON Example

{
    "port": "integer",
    "protocol": "string",
    "desc": "string",
    "guest": {
        "ip": "string",
        "port": "integer"
    }
}

Port

port

Required

port

string

protocol

Required

protocol

string

desc

Required

desc

guest

Required

guest

Property Of

Portforwards

PortforwardParameter

JSON Example

{
    "guestIp": "string",
    "guestPort": "integer",
    "desc": "string"
}

string

guestIp

Required

guestIp

Port

guestPort

Required

guestPort

string

desc

Optional

desc

Parameter To

Update Portforward

Portforwards

The list of port forwarding

JSON Example

{
    "num": "integer",
    "port_forwardings": [
        {
            "port": "integer",
            "protocol": "string",
            "desc": "string",
            "guest": {
                "ip": "string",
                "port": "integer"
            }
        }
    ]
}

Number

num

Required

num

array of Portforward

port_forwardings

Required

The list of port forwardings

Returned By

Get Portforwards

SharedFolder

JSON Example

{
    "folder_id": "string",
    "host_path": "string",
    "flags": "integer"
}

string

folder_id

Required

ID of folder which be mounted to the host

string

host_path

Required

Path of the host shared folder

integer

flags

Required

The flags property specifies how the folder will be accessed by the VM. There is only one flag supported which is "4" and means read/write access.

Parameter To

Create Shared Folder

Returned By

Get All Shared Folders

Create Shared Folder

Updata Shared Folder

SharedFolderParameter

JSON Example

{
    "host_path": "string",
    "flags": "integer"
}

string

host_path

Required

Path of the host shared folder

integer

flags

Required

The flags property specifies how the folder will be accessed by the VM. There is only one flag supported which is "4" and means read/write access.

Parameter To

Updata Shared Folder

SharedFolders

The shared folders mounted to this VM

This class is array of

JSON Example

[
    {
        "folder_id": "string",
        "host_path": "string",
        "flags": "integer"
    }
]

VMCPU

The CPU information of VM

JSON Example

{
    "processors": "integer"
}

VMProcessors

processors

Optional

processors

Property Of

VMInformation

VMCloneParameter

JSON Example

{
    "name": "string",
    "parentId": "string"
}

string

name

Required

New VM name

string

parentId

Required

Existing VM ID to clone.

Parameter To

Create VM

VMID

JSON Example

{
    "id": "string",
    "path": "string"
}

string

id

Required

ID of the VM

string

path

Required

Path of the VM

VMInformation

JSON Example

{
    "id": "string",
    "cpu": {
        "processors": "integer"
    },
    "memory": "integer"
}

string

id

Required

id

VMCPU

cpu

Optional

cpu

VMMemory

memory

Optional

memory

Returned By

Create VM

Get VM

Update VM

VMMemory

Memory size in mega bytes

This data structure has no properties.

Property Of

VMInformation

VMParameter

JSON Example

{
    "processors": "integer",
    "memory": "integer"
}

VMProcessors

processors

Optional

processors

VMMemory

memory

Optional

memory

Parameter To

Update VM

VMPowerOperation

This data structure has no properties.

Enumeration: on, off, shutdown, suspend, pause, unpause,

VMPowerState

JSON Example

{
    "power_state": "string"
}

string

power_state

Required

power_state

Returned By

Get Power State

Change Power State

VMProcessors

Number of processor cores

This data structure has no properties.

Property Of

VMParameter

VMCPU