Create VM

Creates a virtual machine. if you do not have all of the privileges described as follows: - The resource Folder referenced by the attribute VM.InventoryPlacementSpec.folder requires VirtualMachine.Inventory.Create. - The resource ResourcePool referenced by the attribute VM.ComputePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource Datastore referenced by the attribute VM.StoragePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Network referenced by the attribute Ethernet.BackingSpec.network requires Network.Assign.

Request

URL

POST

https://{api_host}/rest/vcenter/vm

Request Body

Contains CreateRequestBody of type application/json (required)

Show optional properties

{
    "spec": {
        "guest_OS": "enum",
        "placement": {
            "datastore": "string",
            "folder": "string"
        }
    }
}

{
    "spec": {
        "boot": {
            "delay": 0,
            "efi_legacy_boot": false,
            "enter_setup_mode": false,
            "network_protocol": "enum",
            "retry": false,
            "retry_delay": 0,
            "type": "enum"
        },
        "boot_devices": [
            {
                "type": "enum"
            }
        ],
        "cdroms": [
            {
                "allow_guest_control": false,
                "backing": {
                    "device_access_type": "enum",
                    "host_device": "string",
                    "iso_file": "string",
                    "type": "enum"
                },
                "ide": {
                    "master": false,
                    "primary": false
                },
                "sata": {
                    "bus": 0,
                    "unit": 0
                },
                "start_connected": false,
                "type": "enum"
            }
        ],
        "cpu": {
            "cores_per_socket": 0,
            "count": 0,
            "hot_add_enabled": false,
            "hot_remove_enabled": false
        },
        "disks": [
            {
                "backing": {
                    "type": "enum",
                    "vmdk_file": "string"
                },
                "ide": {
                    "master": false,
                    "primary": false
                },
                "new_vmdk": {
                    "capacity": 0,
                    "name": "string",
                    "storage_policy": {
                        "policy": "string"
                    }
                },
                "sata": {
                    "bus": 0,
                    "unit": 0
                },
                "scsi": {
                    "bus": 0,
                    "unit": 0
                },
                "type": "enum"
            }
        ],
        "floppies": [
            {
                "allow_guest_control": false,
                "backing": {
                    "host_device": "string",
                    "image_file": "string",
                    "type": "enum"
                },
                "start_connected": false
            }
        ],
        "guest_OS": "enum",
        "hardware_version": "enum",
        "memory": {
            "hot_add_enabled": false,
            "size_MiB": 0
        },
        "name": "string",
        "nics": [
            {
                "allow_guest_control": false,
                "backing": {
                    "distributed_port": "string",
                    "network": "string",
                    "type": "enum"
                },
                "mac_address": "string",
                "mac_type": "enum",
                "pci_slot_number": 0,
                "start_connected": false,
                "type": "enum",
                "upt_compatibility_enabled": false,
                "wake_on_lan_enabled": false
            }
        ],
        "parallel_ports": [
            {
                "allow_guest_control": false,
                "backing": {
                    "file": "string",
                    "host_device": "string",
                    "type": "enum"
                },
                "start_connected": false
            }
        ],
        "placement": {
            "cluster": "string",
            "datastore": "string",
            "folder": "string",
            "host": "string",
            "resource_pool": "string"
        },
        "sata_adapters": [
            {
                "bus": 0,
                "pci_slot_number": 0,
                "type": "enum"
            }
        ],
        "scsi_adapters": [
            {
                "bus": 0,
                "pci_slot_number": 0,
                "sharing": "enum",
                "type": "enum"
            }
        ],
        "serial_ports": [
            {
                "allow_guest_control": false,
                "backing": {
                    "file": "string",
                    "host_device": "string",
                    "network_location": "string",
                    "no_rx_loss": false,
                    "pipe": "string",
                    "proxy": "string",
                    "type": "enum"
                },
                "start_connected": false,
                "yield_on_poll": false
            }
        ],
        "storage_policy": {
            "policy": "string"
        }
    }
}

Required	Property Name	Type	Description
required	spec	VMCreateSpec	Virtual machine specification.

Response

Response Body

200 OK returns CreateResponseBody of type application/json

This structure was autogenerated to hold a response body. It contains: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine.

{
    "value": "string"
}

Property Name	Type	Description
value	string	ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine.

Errors

Code	Returns	Description
507	Error	com.vmware.vapi.std.errors.unable_to_allocate_resource : if any of the resources needed to create the virtual machine could not be allocated.
default	Error	Not available
400	Error	com.vmware.vapi.std.errors.invalid_argument : if any of the specified parameters are invalid.
401	Error	com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. \| com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
409	Error	com.vmware.vapi.std.errors.already_exists : if a virtual machine with the specified name already exists. \| com.vmware.vapi.std.errors.resource_in_use : if any of the specified storage addresses (eg. IDE, SATA, SCSI, NVMe) result in a storage address conflict.
404	Error	com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. \| com.vmware.vapi.std.errors.not_found : if any of the resources specified in spec could not be found \| com.vmware.vapi.std.errors.resource_inaccessible : if a specified resource (eg. host) is not accessible.
405	Error	com.vmware.vapi.std.errors.unsupported : if VM.CreateSpec.guest-os is not supported for the requested virtual hardware version and spec includes unset fields that default to guest-specific values.
503	Error	com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.

VM Operations

post

Create VM

get

List VM

get

Get VM

delete

Delete VM

post

Relocate VM

post

Relocate Task VM

post

Unregister VM

post

Clone VM

post

Clone Task VM

post

Instant Clone VM

post

Create VM

On This Page

Request

URL

Request Body

Response

Response Body

Errors

On This Page

VM Operations

Was this page helpful?