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.

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionCall_parameters"> <div class="card"> <div class="card-header" id="headingCall_parameters"> <h2 class="mb-0"> <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters"> <div class="card-body pl-5"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4> <h5>Parameter 1: id</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>ID of the virtual machine to get memory information for.</p> </span> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value"> <div class="card"> <div class="card-header" id="headingReturn_value"> <h2 class="mb-0"> <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button> </h2> </div> <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value"> <div class="card-body pl-5"> <h4>VMGetVmMemoryInfoResult</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>VMGetVmMemoryInfoResult return fields.</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_minimum_memory_requested"> <div class="card"> <div class="card-header" id="headingReturn_value_minimum_memory_requested"> <h2 class="mb-0"> <button aria-controls="Return_value_minimum_memory_requested" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_minimum_memory_requested" data-toggle="collapse" onclick="setAnchor('#Return_value_minimum_memory_requested')" type="button"><span class="property-name">minimum_memory_requested</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_minimum_memory_requested" class="collapse property-definition-div" data-parent="#accordionReturn_value_minimum_memory_requested" id="Return_value_minimum_memory_requested"> <div class="card-body pl-5"> <h4>Minimum Memory Requested</h4><br/> <span class="description"><p>Minimum memory requested by the VM</p> </span><div class="any-of-value" id="Return_value_minimum_memory_requested_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_minimum_memory_requested_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_minimum_memory_requested_anyOf_i0" id="Return_value_minimum_memory_requested_anyOf_i0" onclick="setAnchor('#Return_value_minimum_memory_requested_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_minimum_memory_requested_anyOf_i1" id="Return_value_minimum_memory_requested_anyOf_i1" onclick="setAnchor('#Return_value_minimum_memory_requested_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_minimum_memory_requested_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_minimum_memory_requested_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_total_memory_requested"> <div class="card"> <div class="card-header" id="headingReturn_value_total_memory_requested"> <h2 class="mb-0"> <button aria-controls="Return_value_total_memory_requested" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_total_memory_requested" data-toggle="collapse" onclick="setAnchor('#Return_value_total_memory_requested')" type="button"><span class="property-name">total_memory_requested</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_total_memory_requested" class="collapse property-definition-div" data-parent="#accordionReturn_value_total_memory_requested" id="Return_value_total_memory_requested"> <div class="card-body pl-5"> <h4>Total Memory Requested</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Maximum / total memory requested by the VM</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_overcommit_required"> <div class="card"> <div class="card-header" id="headingReturn_value_overcommit_required"> <h2 class="mb-0"> <button aria-controls="Return_value_overcommit_required" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_overcommit_required" data-toggle="collapse" onclick="setAnchor('#Return_value_overcommit_required')" type="button"><span class="property-name">overcommit_required</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_overcommit_required" class="collapse property-definition-div" data-parent="#accordionReturn_value_overcommit_required" id="Return_value_overcommit_required"> <div class="card-body pl-5"> <h4>Overcommit Required</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Overcommit of memory is required to start VM</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_memory_req_fulfilled_after_overcommit"> <div class="card"> <div class="card-header" id="headingReturn_value_memory_req_fulfilled_after_overcommit"> <h2 class="mb-0"> <button aria-controls="Return_value_memory_req_fulfilled_after_overcommit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_memory_req_fulfilled_after_overcommit" data-toggle="collapse" onclick="setAnchor('#Return_value_memory_req_fulfilled_after_overcommit')" type="button"><span class="property-name">memory_req_fulfilled_after_overcommit</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_memory_req_fulfilled_after_overcommit" class="collapse property-definition-div" data-parent="#accordionReturn_value_memory_req_fulfilled_after_overcommit" id="Return_value_memory_req_fulfilled_after_overcommit"> <div class="card-body pl-5"> <h4>Memory Req Fulfilled After Overcommit</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Memory requirements of VM are fulfilled if over-committing memory is specified</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_arc_to_shrink"> <div class="card"> <div class="card-header" id="headingReturn_value_arc_to_shrink"> <h2 class="mb-0"> <button aria-controls="Return_value_arc_to_shrink" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_arc_to_shrink" data-toggle="collapse" onclick="setAnchor('#Return_value_arc_to_shrink')" type="button"><span class="property-name">arc_to_shrink</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_arc_to_shrink" class="collapse property-definition-div" data-parent="#accordionReturn_value_arc_to_shrink" id="Return_value_arc_to_shrink"> <div class="card-body pl-5"> <h4>Arc To Shrink</h4><br/> <span class="description"><p>Size of ARC to shrink in bytes</p> </span><div class="any-of-value" id="Return_value_arc_to_shrink_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_arc_to_shrink_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_arc_to_shrink_anyOf_i0" id="Return_value_arc_to_shrink_anyOf_i0" onclick="setAnchor('#Return_value_arc_to_shrink_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_arc_to_shrink_anyOf_i1" id="Return_value_arc_to_shrink_anyOf_i1" onclick="setAnchor('#Return_value_arc_to_shrink_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_arc_to_shrink_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_arc_to_shrink_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_current_arc_max"> <div class="card"> <div class="card-header" id="headingReturn_value_current_arc_max"> <h2 class="mb-0"> <button aria-controls="Return_value_current_arc_max" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_current_arc_max" data-toggle="collapse" onclick="setAnchor('#Return_value_current_arc_max')" type="button"><span class="property-name">current_arc_max</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_current_arc_max" class="collapse property-definition-div" data-parent="#accordionReturn_value_current_arc_max" id="Return_value_current_arc_max"> <div class="card-body pl-5"> <h4>Current Arc Max</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Current size of max ARC in bytes</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_arc_min"> <div class="card"> <div class="card-header" id="headingReturn_value_arc_min"> <h2 class="mb-0"> <button aria-controls="Return_value_arc_min" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_arc_min" data-toggle="collapse" onclick="setAnchor('#Return_value_arc_min')" type="button"><span class="property-name">arc_min</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_arc_min" class="collapse property-definition-div" data-parent="#accordionReturn_value_arc_min" id="Return_value_arc_min"> <div class="card-body pl-5"> <h4>Arc Min</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Minimum size of ARC in bytes</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_arc_max_after_shrink"> <div class="card"> <div class="card-header" id="headingReturn_value_arc_max_after_shrink"> <h2 class="mb-0"> <button aria-controls="Return_value_arc_max_after_shrink" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_arc_max_after_shrink" data-toggle="collapse" onclick="setAnchor('#Return_value_arc_max_after_shrink')" type="button"><span class="property-name">arc_max_after_shrink</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_arc_max_after_shrink" class="collapse property-definition-div" data-parent="#accordionReturn_value_arc_max_after_shrink" id="Return_value_arc_max_after_shrink"> <div class="card-body pl-5"> <h4>Arc Max After Shrink</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Size of max ARC in bytes after shrinking</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_actual_vm_requested_memory"> <div class="card"> <div class="card-header" id="headingReturn_value_actual_vm_requested_memory"> <h2 class="mb-0"> <button aria-controls="Return_value_actual_vm_requested_memory" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_actual_vm_requested_memory" data-toggle="collapse" onclick="setAnchor('#Return_value_actual_vm_requested_memory')" type="button"><span class="property-name">actual_vm_requested_memory</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_actual_vm_requested_memory" class="collapse property-definition-div" data-parent="#accordionReturn_value_actual_vm_requested_memory" id="Return_value_actual_vm_requested_memory"> <div class="card-body pl-5"> <h4>Actual Vm Requested Memory</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>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.</p> </span> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* VM_READ