VMInfo

Document-based info.


Properties

boot Required

Boot configuration.


boot_devices Required

Boot device configuration. If the list has no entries, a server-specific default boot sequence is used.


cdroms Required

List of CD-ROMs. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.


cpu Required

CPU configuration.


disks Required

List of disks. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.


floppies Required

List of floppy drives. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.


guest_OS Required

Guest OS.


hardware Required

Virtual hardware version information.


identity Optional

Identity of the virtual machine. This field is optional because it was added in a newer version than its parent node.


boolean
instant_clone_frozen Optional

Indicates whether the virtual machine is frozen for instant clone, or not. This field is optional because it was added in a newer version than its parent node.


memory Required

Memory configuration.


string
name Required

Virtual machine name.


nics Required

List of Ethernet adapters. When clients pass a value of this structure as a parameter, the key in the field map 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 map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.


parallel_ports Required

List of parallel ports. When clients pass a value of this structure as a parameter, the key in the field map 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 map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.


power_state Required

Power state of the virtual machine.


sata_adapters Required

List of SATA adapters. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.


scsi_adapters Required

List of SCSI adapters. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter.


serial_ports Required

List of serial ports. When clients pass a value of this structure as a parameter, the key in the field map 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 map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Property Of

VMGetResponseBody

JSON Example

{
    "boot": {
        "delay": 0,
        "enter_setup_mode": false,
        "retry": false,
        "retry_delay": 0,
        "type": "enum"
    },
    "boot_devices": [
        {
            "type": "enum"
        }
    ],
    "cdroms": {
        "key": {
            "allow_guest_control": false,
            "backing": {
                "type": "enum"
            },
            "label": "string",
            "start_connected": false,
            "state": "enum",
            "type": "enum"
        }
    },
    "cpu": {
        "cores_per_socket": 0,
        "count": 0,
        "hot_add_enabled": false,
        "hot_remove_enabled": false
    },
    "disks": {
        "key": {
            "backing": {
                "type": "enum"
            },
            "label": "string",
            "type": "enum"
        }
    },
    "floppies": {
        "key": {
            "allow_guest_control": false,
            "backing": {
                "type": "enum"
            },
            "label": "string",
            "start_connected": false,
            "state": "enum"
        }
    },
    "guest_OS": "enum",
    "hardware": {
        "upgrade_policy": "enum",
        "upgrade_status": "enum",
        "version": "enum"
    },
    "memory": {
        "hot_add_enabled": false,
        "size_MiB": 0
    },
    "name": "string",
    "nics": {
        "key": {
            "allow_guest_control": false,
            "backing": {
                "type": "enum"
            },
            "label": "string",
            "mac_type": "enum",
            "start_connected": false,
            "state": "enum",
            "type": "enum",
            "wake_on_lan_enabled": false
        }
    },
    "parallel_ports": {
        "key": {
            "allow_guest_control": false,
            "backing": {
                "type": "enum"
            },
            "label": "string",
            "start_connected": false,
            "state": "enum"
        }
    },
    "power_state": "enum",
    "sata_adapters": {
        "key": {
            "bus": 0,
            "label": "string",
            "type": "enum"
        }
    },
    "scsi_adapters": {
        "key": {
            "label": "string",
            "scsi": {
                "bus": 0,
                "unit": 0
            },
            "sharing": "enum",
            "type": "enum"
        }
    },
    "serial_ports": {
        "key": {
            "allow_guest_control": false,
            "backing": {
                "type": "enum"
            },
            "label": "string",
            "start_connected": false,
            "state": "enum",
            "yield_on_poll": false
        }
    }
}
Feedback

Was this page helpful?