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

Inherits:
VAPI::Bindings::VapiStruct
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb

Overview

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

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Info) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

  • ruby_values (Hash) (defaults to: nil) —

    a map of initial property values (optional)

  • struct_value (VAPI::Data::StructValue) (defaults to: nil) —

    a raw StructValue from the wire (optional) 



4214
4215
4216
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4214

def initialize(ruby_values=nil, struct_value=nil)
    super(self.class.binding_type, ruby_values, struct_value)
end

Instance Attribute Details

- (Boolean) hot_add_enabled

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.

Returns:

  • (Boolean) 


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4185

class Info < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.memory.info',
                {
                    'size_MiB' => VAPI::Bindings::IntegerType.instance,
                    'hot_add_enabled' => VAPI::Bindings::BooleanType.instance,
                    'hot_add_increment_size_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'hot_add_limit_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :size_mib,
                  :hot_add_enabled,
                  :hot_add_increment_size_mib,
                  :hot_add_limit_mib

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Fixnum?) hot_add_increment_size_mib

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 {\@link>hotAddIncrementSize}.

Only set when :attr:`Com::Vmware::Vcenter::Vm::Hardware::Memory::Info.hot_add_enabled` is true and the virtual machine is running.

Returns:

  • (Fixnum, nil) 


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4185

class Info < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.memory.info',
                {
                    'size_MiB' => VAPI::Bindings::IntegerType.instance,
                    'hot_add_enabled' => VAPI::Bindings::BooleanType.instance,
                    'hot_add_increment_size_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'hot_add_limit_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :size_mib,
                  :hot_add_enabled,
                  :hot_add_increment_size_mib,
                  :hot_add_limit_mib

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Fixnum?) hot_add_limit_mib

The maximum amount of memory, in mebibytes, that can be added to a running virtual machine. Only set when :attr:`Com::Vmware::Vcenter::Vm::Hardware::Memory::Info.hot_add_enabled` is true and the virtual machine is running.

Returns:

  • (Fixnum, nil) 


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4185

class Info < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.memory.info',
                {
                    'size_MiB' => VAPI::Bindings::IntegerType.instance,
                    'hot_add_enabled' => VAPI::Bindings::BooleanType.instance,
                    'hot_add_increment_size_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'hot_add_limit_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :size_mib,
                  :hot_add_enabled,
                  :hot_add_increment_size_mib,
                  :hot_add_limit_mib

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Fixnum) size_mib

Memory size in mebibytes.

Returns:

  • (Fixnum) 


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4185

class Info < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.memory.info',
                {
                    'size_MiB' => VAPI::Bindings::IntegerType.instance,
                    'hot_add_enabled' => VAPI::Bindings::BooleanType.instance,
                    'hot_add_increment_size_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'hot_add_limit_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :size_mib,
                  :hot_add_enabled,
                  :hot_add_increment_size_mib,
                  :hot_add_limit_mib

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

Class Method Details

+ (VAPI::Bindings::StructType) binding_type

Holds (gets or creates) the binding type metadata for this structure type.

Returns:

  • (VAPI::Bindings::StructType) —

    the binding type 



4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4191

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.vm.hardware.memory.info',
        {
            'size_MiB' => VAPI::Bindings::IntegerType.instance,
            'hot_add_enabled' => VAPI::Bindings::BooleanType.instance,
            'hot_add_increment_size_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
            'hot_add_limit_MiB' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
        },
        Info,
        false,
        nil)
end