Com::Vmware::Vcenter::Vm::Hardware::Memory::Info Class Reference

Inheritance diagram for Com::Vmware::Vcenter::Vm::Hardware::Memory::Info:

Avaliable Methods
public method	set_size_MiB ()
public method	set_hot_add_limit_MiB ()
public method	set_hot_add_enabled ()
public method	set_hot_add_increment_size_MiB ()
public method	get_hot_add_enabled ()
public method	get_hot_add_increment_size_MiB ()
public method	get_size_MiB ()
public method	get_hot_add_limit_MiB ()
public method	new ()

Detailed Description

The Com::Vmware::Vcenter::Vm::Hardware::Memory::Info class contains memory-related information about a virtual machine.

Member Function Documentation

public method Com::Vmware::Vcenter::Vm::Hardware::Memory::Info::get_hot_add_enabled

(

)

Gets the value of 'hot_add_enabled' property.

Return values

hot_add_enabled

- The current value of the field. 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.

boolean#

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Memory::Info::get_hot_add_increment_size_MiB

(

)

Gets the value of 'hot_add_increment_size_MiB' property.

Return values

hot_add_increment_size_MiB

- The current value of the field. 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 :attr:Com::Vmware::Vcenter::Vm::Hardware::Memory::Info.hot_add_increment_size_mib and the total memory size of the virtual machine must be a multiple of hotAddIncrementSize}.

Optional#

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Memory::Info::get_hot_add_limit_MiB

(

)

Gets the value of 'hot_add_limit_MiB' property.

Return values

hot_add_limit_MiB

- The current value of the field. The maximum amount of memory, in mebibytes, that can be added to a running virtual machine. Optional#

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Memory::Info::get_size_MiB

(

)

Gets the value of 'size_MiB' property.

Return values

size_MiB

- The current value of the field. Memory size in mebibytes. long#

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Memory::Info::new

(

)

Constructor to initialize the Com::Vmware::Vcenter::Vm::Hardware::Memory::Info structure

Return values

Blessed

object

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Memory::Info::set_hot_add_enabled

(

)

Sets the given value for 'hot_add_enabled' property.

Parameters

hot_add_enabled

- New value for the field. 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.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Memory::Info::set_hot_add_increment_size_MiB

(

)

Sets the given value for 'hot_add_increment_size_MiB' property.

Parameters

hot_add_increment_size_MiB

- New value for the field. 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 :attr:Com::Vmware::Vcenter::Vm::Hardware::Memory::Info.hot_add_increment_size_mib and the total memory size of the virtual machine must be a multiple of hotAddIncrementSize}.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Memory::Info::set_hot_add_limit_MiB

(

)

Sets the given value for 'hot_add_limit_MiB' property.

Parameters

hot_add_limit_MiB

- New value for the field. The maximum amount of memory, in mebibytes, that can be added to a running virtual machine.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Memory::Info::set_size_MiB

(

)

Sets the given value for 'size_MiB' property.

Parameters

size_MiB

- New value for the field. Memory size in mebibytes.

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Vcenter/Vm/Hardware/Memory.pm