REST API - get

vcenter vm hardware memory: get

Returns the memory-related settings of a virtual machine.

Request:

HTTP request

GET https://{server}/rest/vcenter/vm/{vm}/hardware/memory

Path Parameters

Name	Type	Description
Required
vm	string	Virtual machine identifier.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "hot_add_increment_size_MiB" : 1,
        "size_MiB" : 1,
        "hot_add_enabled" : true,
        "hot_add_limit_MiB" : 1
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	Memory-related settings of the virtual machine.
value.size_MiB	long	Memory size in mebibytes.
value.hot_add_enabled	boolean	Flag indicating whether adding memory while the virtual machine is running is enabled. Some guest operating systems may consume more resources or perform less efficiently when they run on hardware that supports adding memory while the machine is running.
value.hot_add_increment_size_MiB	long	The granularity, in mebibytes, at which memory can be added to a running virtual machine. When adding memory to a running virtual machine, the amount of memory added must be at least vcenter.vm.hardware.memory.info.hot_add_increment_size_MiB and the total memory size of the virtual machine must be a multiple of {@link>hotAddIncrementSize}. Optional. Only set when vcenter.vm.hardware.memory.info.hot_add_enabled is true and the virtual machine is running.
value.hot_add_limit_MiB	long	The maximum amount of memory, in mebibytes, that can be added to a running virtual machine. Optional. Only set when vcenter.vm.hardware.memory.info.hot_add_enabled is true and the virtual machine is running.

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request.
404	not_found	if the virtual machine is not found.
500	resource_inaccessible	if the virtual machine's configuration state cannot be accessed.
503	service_unavailable	if the system is unable to communicate with a service to complete the request.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user doesn't have the required privileges.