vm.get_vm_memory_info

Returns memory information for vm_id VM if it is going to be started.

All memory attributes are expressed in bytes.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the virtual machine to get memory information for.

Return value

VMGetVmMemoryInfoResult

Type: object

VMGetVmMemoryInfoResult return fields.

No Additional Properties

minimum_memory_requested Required

Minimum Memory Requested

Minimum memory requested by the VM

Any of

• Option 1
• Option 2

Type: integer

Type: null

total_memory_requested Required

Total Memory Requested

Type: integer

Maximum / total memory requested by the VM

overcommit_required Required

Overcommit Required

Type: boolean

Overcommit of memory is required to start VM

memory_req_fulfilled_after_overcommit Required

Memory Req Fulfilled After Overcommit

Type: boolean

Memory requirements of VM are fulfilled if over-committing memory is specified

arc_to_shrink Required

Arc To Shrink

Size of ARC to shrink in bytes

Any of

• Option 1
• Option 2

Type: integer

Type: null

current_arc_max Required

Current Arc Max

Type: integer

Current size of max ARC in bytes

arc_min Required

Arc Min

Type: integer

Minimum size of ARC in bytes

arc_max_after_shrink Required

Arc Max After Shrink

Type: integer

Size of max ARC in bytes after shrinking

actual_vm_requested_memory Required

Actual Vm Requested Memory

Type: integer

VM memory in bytes to consider when making calculations for available/required memory. If VM ballooning is specified for the VM, the minimum VM memory specified by user will be taken into account otherwise total VM memory requested will be taken into account.

Required roles: VM_READ