VMInfo

Document-based info.


Properties

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.


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.

Possible values are: DOSWIN_31WIN_95WIN_98WIN_MEWIN_NTWIN_2000_PROWIN_2000_SERVWIN_2000_ADV_SERVWIN_XP_HOMEWIN_XP_PROWIN_XP_PRO_64WIN_NET_WEBWIN_NET_STANDARDWIN_NET_ENTERPRISEWIN_NET_DATACENTERWIN_NET_BUSINESSWIN_NET_STANDARD_64WIN_NET_ENTERPRISE_64WIN_LONGHORNWIN_LONGHORN_64WIN_NET_DATACENTER_64WIN_VISTAWIN_VISTA_64WINDOWS_7WINDOWS_7_64WINDOWS_7_SERVER_64WINDOWS_8WINDOWS_8_64WINDOWS_8_SERVER_64WINDOWS_9WINDOWS_9_64WINDOWS_9_SERVER_64WINDOWS_HYPERVWINDOWS_SERVER_2019WINDOWS_SERVER_2021FREEBSDFREEBSD_64FREEBSD_11FREEBSD_12FREEBSD_13FREEBSD_11_64FREEBSD_12_64FREEBSD_13_64REDHATRHEL_2RHEL_3RHEL_3_64RHEL_4RHEL_4_64RHEL_5RHEL_5_64RHEL_6RHEL_6_64RHEL_7RHEL_7_64RHEL_8_64RHEL_9_64CENTOSCENTOS_64CENTOS_6CENTOS_6_64CENTOS_7CENTOS_7_64CENTOS_8_64CENTOS_9_64ORACLE_LINUXORACLE_LINUX_64ORACLE_LINUX_6ORACLE_LINUX_6_64ORACLE_LINUX_7ORACLE_LINUX_7_64ORACLE_LINUX_8_64ORACLE_LINUX_9_64SUSESUSE_64SLESSLES_64SLES_10SLES_10_64SLES_11SLES_11_64SLES_12SLES_12_64SLES_15_64SLES_16_64NLD_9OESSJDSMANDRAKEMANDRIVAMANDRIVA_64TURBO_LINUXTURBO_LINUX_64UBUNTUUBUNTU_64DEBIAN_4DEBIAN_4_64DEBIAN_5DEBIAN_5_64DEBIAN_6DEBIAN_6_64DEBIAN_7DEBIAN_7_64DEBIAN_8DEBIAN_8_64DEBIAN_9DEBIAN_9_64DEBIAN_10DEBIAN_10_64DEBIAN_11DEBIAN_11_64ASIANUX_3ASIANUX_3_64ASIANUX_4ASIANUX_4_64ASIANUX_5_64ASIANUX_7_64ASIANUX_8_64ASIANUX_9_64OPENSUSEOPENSUSE_64FEDORAFEDORA_64COREOS_64VMWARE_PHOTON_64OTHER_24X_LINUXOTHER_24X_LINUX_64OTHER_26X_LINUXOTHER_26X_LINUX_64OTHER_3X_LINUXOTHER_3X_LINUX_64OTHER_4X_LINUXOTHER_4X_LINUX_64OTHER_5X_LINUXOTHER_5X_LINUX_64OTHER_LINUXGENERIC_LINUXOTHER_LINUX_64SOLARIS_6SOLARIS_7SOLARIS_8SOLARIS_9SOLARIS_10SOLARIS_10_64SOLARIS_11_64OS2ECOMSTATIONECOMSTATION_2NETWARE_4NETWARE_5NETWARE_6OPENSERVER_5OPENSERVER_6UNIXWARE_7DARWINDARWIN_64DARWIN_10DARWIN_10_64DARWIN_11DARWIN_11_64DARWIN_12_64DARWIN_13_64DARWIN_14_64DARWIN_15_64DARWIN_16_64DARWIN_17_64DARWIN_18_64DARWIN_19_64DARWIN_20_64DARWIN_21_64VMKERNELVMKERNEL_5VMKERNEL_6VMKERNEL_65VMKERNEL_7AMAZONLINUX2_64AMAZONLINUX3_64CRXPOD_1OTHEROTHER_64


hardware Required

Virtual hardware version information.


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.


boot Required

Boot configuration.


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.

Possible values are: POWERED_OFFPOWERED_ONSUSPENDED


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.


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.

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
        }
    }
}
Returned By

Get VM
Feedback

Was this page helpful?