REST API - instant_clone

vcenter VM: instant clone spec

Document-based InstantClone spec. This structure was added in vSphere API 6.7.1.

Representation:

JSON
LEGACY JSON

{
    "disconnect_all_nics" : true,
    "nics_to_update" : {
        "obj-103" : {
            "start_connected" : true,
            "backing" : {
                "distributed_port" : "string",
                "type" : "STANDARD_PORTGROUP",
                "network" : "obj-103"
            },
            "mac_address" : "string",
            "mac_type" : "MANUAL",
            "allow_guest_control" : true,
            "wake_on_lan_enabled" : true,
            "upt_compatibility_enabled" : true
        }
    },
    "serial_ports_to_update" : {
        "obj-103" : {
            "start_connected" : true,
            "backing" : {
                "proxy" : "http://myurl.com",
                "file" : "string",
                "pipe" : "string",
                "type" : "FILE",
                "host_device" : "string",
                "no_rx_loss" : true,
                "network_location" : "http://myurl.com"
            },
            "allow_guest_control" : true,
            "yield_on_poll" : true
        }
    },
    "parallel_ports_to_update" : {
        "obj-103" : {
            "start_connected" : true,
            "backing" : {
                "file" : "string",
                "type" : "FILE",
                "host_device" : "string"
            },
            "allow_guest_control" : true
        }
    },
    "name" : "string",
    "source" : "obj-103",
    "placement" : {
        "folder" : "obj-103",
        "datastore" : "obj-103",
        "resource_pool" : "obj-103"
    },
    "bios_uuid" : "string"
}

{
    "disconnect_all_nics" : true,
    "nics_to_update" : [
        {
            "value" : {
                "start_connected" : true,
                "backing" : {
                    "distributed_port" : "string",
                    "type" : "STANDARD_PORTGROUP",
                    "network" : "obj-103"
                },
                "mac_address" : "string",
                "mac_type" : "MANUAL",
                "allow_guest_control" : true,
                "wake_on_lan_enabled" : true,
                "upt_compatibility_enabled" : true
            },
            "key" : "obj-103"
        }
    ],
    "serial_ports_to_update" : [
        {
            "value" : {
                "start_connected" : true,
                "backing" : {
                    "proxy" : "http://myurl.com",
                    "file" : "string",
                    "pipe" : "string",
                    "type" : "FILE",
                    "host_device" : "string",
                    "no_rx_loss" : true,
                    "network_location" : "http://myurl.com"
                },
                "allow_guest_control" : true,
                "yield_on_poll" : true
            },
            "key" : "obj-103"
        }
    ],
    "parallel_ports_to_update" : [
        {
            "value" : {
                "start_connected" : true,
                "backing" : {
                    "file" : "string",
                    "type" : "FILE",
                    "host_device" : "string"
                },
                "allow_guest_control" : true
            },
            "key" : "obj-103"
        }
    ],
    "name" : "string",
    "source" : "obj-103",
    "placement" : {
        "folder" : "obj-103",
        "datastore" : "obj-103",
        "resource_pool" : "obj-103"
    },
    "bios_uuid" : "string"
}

Attributes:

Name	Type	Description
Required
-.source	string	Virtual machine to InstantClone from. This attribute was added in vSphere API 6.7.1. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `VirtualMachine`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `VirtualMachine`.
-.name	string	Name of the new virtual machine. This attribute was added in vSphere API 6.7.1.
Optional
-.placement	instant_clone_placement_spec	Virtual machine placement information. This attribute was added in vSphere API 6.7.1. Optional. If this field is unset, the system will use the values from the source virtual machine. If specified, each field will be used for placement. If the fields result in disjoint placement the operation will fail. If the fields along with the placement values of the source virtual machine result in disjoint placement the operation will fail.
-.placement.folder	string	Virtual machine folder into which the InstantCloned virtual machine should be placed. This attribute was added in vSphere API 6.7.1. Optional. If field is unset, the system will use the virtual machine folder of the source virtual machine.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Folder`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Folder`.
-.placement.resource_pool	string	Resource pool into which the InstantCloned virtual machine should be placed. This attribute was added in vSphere API 6.7.1. Optional. If field is unset, the system will use the resource pool of the source virtual machine.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `ResourcePool`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `ResourcePool`.
-.placement.datastore	string	Datastore on which the InstantCloned virtual machine's configuration state should be stored. This datastore will also be used for any virtual disks that are created as part of the virtual machine InstantClone operation. This attribute was added in vSphere API 6.7.1. Optional. If field is unset, the system will use the datastore of the source virtual machine.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Datastore`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore`.
-.nics_to_update	object	Map of NICs to update. This attribute was added in vSphere API 6.7.1. Optional. If unset, no NICs will be updated.When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Ethernet`. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Ethernet`.
-.disconnect_all_nics	boolean	Indicates whether all NICs on the destination virtual machine should be disconnected from the newtwork. This attribute was added in vSphere API 6.7.1. Optional. If unset, connection status of all NICs on the destination virtual machine will be the same as on the source virtual machine.
-.parallel_ports_to_update	object	Map of parallel ports to Update. This attribute was added in vSphere API 6.7.1. Optional. If unset, no parallel ports will be updated.When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.ParallelPort`. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.ParallelPort`.
-.serial_ports_to_update	object	Map of serial ports to Update. This attribute was added in vSphere API 6.7.1. Optional. If unset, no serial ports will be updated.When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.SerialPort`. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.SerialPort`.
-.bios_uuid	string	128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format. This attribute was added in vSphere API 6.7.1. Optional. If unset, will be generated.

Attributes:

Name	Type	Description
Required
source	string	Virtual machine to InstantClone from. This attribute was added in vSphere API 6.7.1. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `VirtualMachine`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `VirtualMachine`.
name	string	Name of the new virtual machine. This attribute was added in vSphere API 6.7.1.
Optional
placement	instant_clone_placement_spec	Virtual machine placement information. This attribute was added in vSphere API 6.7.1. Optional. If this field is unset, the system will use the values from the source virtual machine. If specified, each field will be used for placement. If the fields result in disjoint placement the operation will fail. If the fields along with the placement values of the source virtual machine result in disjoint placement the operation will fail.
placement.folder	string	Virtual machine folder into which the InstantCloned virtual machine should be placed. This attribute was added in vSphere API 6.7.1. Optional. If field is unset, the system will use the virtual machine folder of the source virtual machine.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Folder`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Folder`.
placement.resource_pool	string	Resource pool into which the InstantCloned virtual machine should be placed. This attribute was added in vSphere API 6.7.1. Optional. If field is unset, the system will use the resource pool of the source virtual machine.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `ResourcePool`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `ResourcePool`.
placement.datastore	string	Datastore on which the InstantCloned virtual machine's configuration state should be stored. This datastore will also be used for any virtual disks that are created as part of the virtual machine InstantClone operation. This attribute was added in vSphere API 6.7.1. Optional. If field is unset, the system will use the datastore of the source virtual machine.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Datastore`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore`.
nics_to_update	list	Map of NICs to update. This attribute was added in vSphere API 6.7.1. Optional. If unset, no NICs will be updated.When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Ethernet`. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Ethernet`.
disconnect_all_nics	boolean	Indicates whether all NICs on the destination virtual machine should be disconnected from the newtwork. This attribute was added in vSphere API 6.7.1. Optional. If unset, connection status of all NICs on the destination virtual machine will be the same as on the source virtual machine.
parallel_ports_to_update	list	Map of parallel ports to Update. This attribute was added in vSphere API 6.7.1. Optional. If unset, no parallel ports will be updated.When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.ParallelPort`. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.ParallelPort`.
serial_ports_to_update	list	Map of serial ports to Update. This attribute was added in vSphere API 6.7.1. Optional. If unset, no serial ports will be updated.When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.SerialPort`. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.SerialPort`.
bios_uuid	string	128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format. This attribute was added in vSphere API 6.7.1. Optional. If unset, will be generated.