1. Types
  2. vcenter
  3. vm

vcenter VM: info

Document-based info.

Representation:

{
    "boot": {
        "delay": 1,
        "efi_legacy_boot": true,
        "enter_setup_mode": true,
        "network_protocol": "IPV4",
        "retry": true,
        "retry_delay": 1,
        "type": "BIOS"
    },
    "boot_devices": [
        {
            "disks": [
                "obj-103",
                "obj-103"
            ],
            "nic": "obj-103",
            "type": "CDROM"
        },
        {
            "disks": [
                "obj-103",
                "obj-103"
            ],
            "nic": "obj-103",
            "type": "CDROM"
        }
    ],
    "cdroms": [
        {
            "key": "obj-103",
            "value": {
                "allow_guest_control": true,
                "backing": {
                    "auto_detect": true,
                    "device_access_type": "EMULATION",
                    "host_device": "string",
                    "iso_file": "string",
                    "type": "ISO_FILE"
                },
                "ide": {
                    "master": true,
                    "primary": true
                },
                "label": "string",
                "sata": {
                    "bus": 1,
                    "unit": 1
                },
                "start_connected": true,
                "state": "CONNECTED",
                "type": "IDE"
            }
        }
    ],
    "cpu": {
        "cores_per_socket": 1,
        "count": 1,
        "hot_add_enabled": true,
        "hot_remove_enabled": true
    },
    "disks": [
        {
            "key": "obj-103",
            "value": {
                "backing": {
                    "type": "VMDK_FILE",
                    "vmdk_file": "string"
                },
                "capacity": 1,
                "ide": {
                    "master": true,
                    "primary": true
                },
                "label": "string",
                "sata": {
                    "bus": 1,
                    "unit": 1
                },
                "scsi": {
                    "bus": 1,
                    "unit": 1
                },
                "type": "IDE"
            }
        }
    ],
    "floppies": [
        {
            "key": "obj-103",
            "value": {
                "allow_guest_control": true,
                "backing": {
                    "auto_detect": true,
                    "host_device": "string",
                    "image_file": "string",
                    "type": "IMAGE_FILE"
                },
                "label": "string",
                "start_connected": true,
                "state": "CONNECTED"
            }
        }
    ],
    "guest_OS": "DOS",
    "hardware": {
        "upgrade_error": {},
        "upgrade_policy": "NEVER",
        "upgrade_status": "NONE",
        "upgrade_version": "VMX_03",
        "version": "VMX_03"
    },
    "memory": {
        "hot_add_enabled": true,
        "hot_add_increment_size_MiB": 1,
        "hot_add_limit_MiB": 1,
        "size_MiB": 1
    },
    "name": "string",
    "nics": [
        {
            "key": "obj-103",
            "value": {
                "allow_guest_control": true,
                "backing": {
                    "connection_cookie": 1,
                    "distributed_port": "string",
                    "distributed_switch_uuid": "string",
                    "host_device": "string",
                    "network": "obj-103",
                    "network_name": "string",
                    "opaque_network_id": "string",
                    "opaque_network_type": "string",
                    "type": "STANDARD_PORTGROUP"
                },
                "label": "string",
                "mac_address": "string",
                "mac_type": "MANUAL",
                "pci_slot_number": 1,
                "start_connected": true,
                "state": "CONNECTED",
                "type": "E1000",
                "upt_compatibility_enabled": true,
                "wake_on_lan_enabled": true
            }
        }
    ],
    "parallel_ports": [
        {
            "key": "obj-103",
            "value": {
                "allow_guest_control": true,
                "backing": {
                    "auto_detect": true,
                    "file": "string",
                    "host_device": "string",
                    "type": "FILE"
                },
                "label": "string",
                "start_connected": true,
                "state": "CONNECTED"
            }
        }
    ],
    "power_state": "POWERED_OFF",
    "sata_adapters": [
        {
            "key": "obj-103",
            "value": {
                "bus": 1,
                "label": "string",
                "pci_slot_number": 1,
                "type": "AHCI"
            }
        }
    ],
    "scsi_adapters": [
        {
            "key": "obj-103",
            "value": {
                "label": "string",
                "pci_slot_number": 1,
                "scsi": {
                    "bus": 1,
                    "unit": 1
                },
                "sharing": "NONE",
                "type": "BUSLOGIC"
            }
        }
    ],
    "serial_ports": [
        {
            "key": "obj-103",
            "value": {
                "allow_guest_control": true,
                "backing": {
                    "auto_detect": true,
                    "file": "string",
                    "host_device": "string",
                    "network_location": "http://myurl.com",
                    "no_rx_loss": true,
                    "pipe": "string",
                    "proxy": "http://myurl.com",
                    "type": "FILE"
                },
                "label": "string",
                "start_connected": true,
                "state": "CONNECTED",
                "yield_on_poll": true
            }
        }
    ]
}

Attributes:

Name Type Description
Required
guest_OS string Guest OS.

Defines the valid guest operating system types used for configuring a virtual machine. Value is one of:
DOS: MS-DOS.
WIN_31: Windows 3.1
WIN_95: Windows 95
WIN_98: Windows 98
WIN_ME: Windows Millennium Edition
WIN_NT: Windows NT 4
WIN_2000_PRO: Windows 2000 Professional
WIN_2000_SERV: Windows 2000 Server
WIN_2000_ADV_SERV: Windows 2000 Advanced Server
WIN_XP_HOME: Windows XP Home Edition
WIN_XP_PRO: Windows XP Professional
WIN_XP_PRO_64: Windows XP Professional Edition (64 bit)
WIN_NET_WEB: Windows Server 2003, Web Edition
WIN_NET_STANDARD: Windows Server 2003, Standard Edition
WIN_NET_ENTERPRISE: Windows Server 2003, Enterprise Edition
WIN_NET_DATACENTER: Windows Server 2003, Datacenter Edition
WIN_NET_BUSINESS: Windows Small Business Server 2003
WIN_NET_STANDARD_64: Windows Server 2003, Standard Edition (64 bit)
WIN_NET_ENTERPRISE_64: Windows Server 2003, Enterprise Edition (64 bit)
WIN_LONGHORN: Windows Longhorn (experimental)
WIN_LONGHORN_64: Windows Longhorn (64 bit) (experimental)
WIN_NET_DATACENTER_64: Windows Server 2003, Datacenter Edition (64 bit) (experimental)
WIN_VISTA: Windows Vista
WIN_VISTA_64: Windows Vista (64 bit)
WINDOWS_7: Windows 7
WINDOWS_7_64: Windows 7 (64 bit)
WINDOWS_7_SERVER_64: Windows Server 2008 R2 (64 bit)
WINDOWS_8: Windows 8
WINDOWS_8_64: Windows 8 (64 bit)
WINDOWS_8_SERVER_64: Windows 8 Server (64 bit)
WINDOWS_9: Windows 10
WINDOWS_9_64: Windows 10 (64 bit)
WINDOWS_9_SERVER_64: Windows 10 Server (64 bit)
WINDOWS_HYPERV: Windows Hyper-V
FREEBSD: FreeBSD 10 or earlier
FREEBSD_64: FreeBSD 10 x64 or earlier
FREEBSD_11: FreeBSD 11. This constant was added in vSphere API 6.7
FREEBSD_12: FreeBSD 12 or later. This constant was added in vSphere API 6.7
FREEBSD_11_64: FreeBSD 11 x64. This constant was added in vSphere API 6.7
FREEBSD_12_64: FreeBSD 12 x64 or later. This constant was added in vSphere API 6.7
REDHAT: Red Hat Linux 2.1
RHEL_2: Red Hat Enterprise Linux 2
RHEL_3: Red Hat Enterprise Linux 3
RHEL_3_64: Red Hat Enterprise Linux 3 (64 bit)
RHEL_4: Red Hat Enterprise Linux 4
RHEL_4_64: Red Hat Enterprise Linux 4 (64 bit)
RHEL_5: Red Hat Enterprise Linux 5
RHEL_5_64: Red Hat Enterprise Linux 5 (64 bit) (experimental)
RHEL_6: Red Hat Enterprise Linux 6
RHEL_6_64: Red Hat Enterprise Linux 6 (64 bit)
RHEL_7: Red Hat Enterprise Linux 7
RHEL_7_64: Red Hat Enterprise Linux 7 (64 bit)
RHEL_8_64: Red Hat Enterprise Linux 8 (64 bit). This constant was added in vSphere API 6.7
CENTOS: CentOS 4/5
CENTOS_64: CentOS 4/5 (64-bit)
CENTOS_6: CentOS 6
CENTOS_6_64: CentOS 6 (64-bit)
CENTOS_7: CentOS 7
CENTOS_7_64: CentOS 7 (64-bit)
CENTOS_8_64: CentOS 8 (64-bit). This constant was added in vSphere API 6.7
ORACLE_LINUX: Oracle Linux 4/5
ORACLE_LINUX_64: Oracle Linux 4/5 (64-bit)
ORACLE_LINUX_6: Oracle Linux 6
ORACLE_LINUX_6_64: Oracle Linux 6 (64-bit)
ORACLE_LINUX_7: Oracle Linux 7
ORACLE_LINUX_7_64: Oracle Linux 7 (64-bit)
ORACLE_LINUX_8_64: Oracle Linux 8 (64-bit). This constant was added in vSphere API 6.7
SUSE: Suse Linux
SUSE_64: Suse Linux (64 bit)
SLES: Suse Linux Enterprise Server 9
SLES_64: Suse Linux Enterprise Server 9 (64 bit)
SLES_10: Suse linux Enterprise Server 10
SLES_10_64: Suse Linux Enterprise Server 10 (64 bit) (experimental)
SLES_11: Suse linux Enterprise Server 11
SLES_11_64: Suse Linux Enterprise Server 11 (64 bit)
SLES_12: Suse linux Enterprise Server 12
SLES_12_64: Suse Linux Enterprise Server 12 (64 bit)
SLES_15_64: Suse Linux Enterprise Server 15 (64 bit). This constant was added in vSphere API 6.7
NLD_9: Novell Linux Desktop 9
OES: Open Enterprise Server
SJDS: Sun Java Desktop System
MANDRAKE: Mandrake Linux
MANDRIVA: Mandriva Linux
MANDRIVA_64: Mandriva Linux (64 bit)
TURBO_LINUX: Turbolinux
TURBO_LINUX_64: Turbolinux (64 bit)
UBUNTU: Ubuntu Linux
UBUNTU_64: Ubuntu Linux (64 bit)
DEBIAN_4: Debian GNU/Linux 4
DEBIAN_4_64: Debian GNU/Linux 4 (64 bit)
DEBIAN_5: Debian GNU/Linux 5
DEBIAN_5_64: Debian GNU/Linux 5 (64 bit)
DEBIAN_6: Debian GNU/Linux 6
DEBIAN_6_64: Debian GNU/Linux 6 (64 bit)
DEBIAN_7: Debian GNU/Linux 7
DEBIAN_7_64: Debian GNU/Linux 7 (64 bit)
DEBIAN_8: Debian GNU/Linux 8
DEBIAN_8_64: Debian GNU/Linux 8 (64 bit)
DEBIAN_9: Debian GNU/Linux 9
DEBIAN_9_64: Debian GNU/Linux 9 (64 bit)
DEBIAN_10: Debian GNU/Linux 10
DEBIAN_10_64: Debian GNU/Linux 10 (64 bit)
ASIANUX_3: Asianux Server 3
ASIANUX_3_64: Asianux Server 3 (64 bit)
ASIANUX_4: Asianux Server 4
ASIANUX_4_64: Asianux Server 4 (64 bit)
ASIANUX_5_64: Asianux Server 5 (64 bit)
ASIANUX_7_64: Asianux Server 7 (64 bit)
ASIANUX_8_64: Asianux Server 8 (64 bit). This constant was added in vSphere API 6.7
OPENSUSE: OpenSUSE Linux
OPENSUSE_64: OpenSUSE Linux (64 bit)
FEDORA: Fedora Linux
FEDORA_64: Fedora Linux (64 bit)
COREOS_64: CoreOS Linux (64 bit)
VMWARE_PHOTON_64: VMware Photon (64 bit)
OTHER_24X_LINUX: Linux 2.4x Kernel
OTHER_24X_LINUX_64: Linux 2.4x Kernel (64 bit) (experimental)
OTHER_26X_LINUX: Linux 2.6x Kernel
OTHER_26X_LINUX_64: Linux 2.6x Kernel (64 bit) (experimental)
OTHER_3X_LINUX: Linux 3.x Kernel
OTHER_3X_LINUX_64: Linux 3.x Kernel (64 bit)
OTHER_4X_LINUX: Linux 4.x Kernel. This constant was added in vSphere API 6.7
OTHER_4X_LINUX_64: Linux 4.x Kernel (64 bit). This constant was added in vSphere API 6.7
OTHER_LINUX: Linux 2.2x Kernel
GENERIC_LINUX: Other Linux
OTHER_LINUX_64: Linux (64 bit) (experimental)
SOLARIS_6: Solaris 6
SOLARIS_7: Solaris 7
SOLARIS_8: Solaris 8
SOLARIS_9: Solaris 9
SOLARIS_10: Solaris 10 (32 bit) (experimental)
SOLARIS_10_64: Solaris 10 (64 bit) (experimental)
SOLARIS_11_64: Solaris 11 (64 bit)
OS2: OS/2
ECOMSTATION: eComStation 1.x
ECOMSTATION_2: eComStation 2.0
NETWARE_4: Novell NetWare 4
NETWARE_5: Novell NetWare 5.1
NETWARE_6: Novell NetWare 6.x
OPENSERVER_5: SCO OpenServer 5
OPENSERVER_6: SCO OpenServer 6
UNIXWARE_7: SCO UnixWare 7
DARWIN: Mac OS 10.5
DARWIN_64: Mac OS 10.5 (64 bit)
DARWIN_10: Mac OS 10.6
DARWIN_10_64: Mac OS 10.6 (64 bit)
DARWIN_11: Mac OS 10.7
DARWIN_11_64: Mac OS 10.7 (64 bit)
DARWIN_12_64: Mac OS 10.8 (64 bit)
DARWIN_13_64: Mac OS 10.9 (64 bit)
DARWIN_14_64: Mac OS 10.10 (64 bit)
DARWIN_15_64: Mac OS 10.11 (64 bit)
DARWIN_16_64: Mac OS 10.12 (64 bit)
DARWIN_17_64: Mac OS 10.13 (64 bit). This constant was added in vSphere API 6.7
DARWIN_18_64: Mac OS 10.14 (64 bit). This constant was added in vSphere API 6.7
VMKERNEL: VMware ESX 4
VMKERNEL_5: VMware ESX 5
VMKERNEL_6: VMware ESX 6
VMKERNEL_65: VMware ESX 6.5
OTHER: Other Operating System
OTHER_64: Other Operating System (64 bit) (experimental)
name string Virtual machine name.
power_state string Power state of the virtual machine.

Defines the valid power states for a virtual machine. Value is one of:
POWERED_OFF: The virtual machine is powered off.
POWERED_ON: The virtual machine is powered on.
SUSPENDED: The virtual machine is suspended.
hardware info Virtual hardware version information.
boot info Boot configuration.
boot_devices entry[] Boot device configuration. If the array has no entries, a server-specific default boot sequence is used.
cpu info CPU configuration.
memory info Memory configuration.
disks list List of disks.

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.Disk. 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.Disk.List of {"key": string, "value": info}
nics list List of Ethernet adapters.

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.List of {"key": string, "value": info}
cdroms list List of CD-ROMs.

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.Cdrom. 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.Cdrom.List of {"key": string, "value": info}
floppies list List of floppy drives.

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.Floppy. 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.Floppy.List of {"key": string, "value": info}
parallel_ports list List of parallel ports.

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.List of {"key": string, "value": info}
serial_ports list List of serial ports.

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.List of {"key": string, "value": info}
sata_adapters list List of SATA adapters.

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.SataAdapter. 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.SataAdapter.List of {"key": string, "value": info}
scsi_adapters list List of SCSI adapters.

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.ScsiAdapter. 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.ScsiAdapter.List of {"key": string, "value": info}