Class: Com::Vmware::Vcenter::Vm::HardwareService

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

Overview

The ``Com::Vmware::Vcenter::Vm::Hardware`` class provides methods for configuring the virtual hardware of a virtual machine.

Defined Under Namespace

Classes: Info, UpdateSpec, UpgradePolicy, UpgradeStatus, Version

Instance Method Summary (collapse)

Constructor Details

- (HardwareService) initialize(config)

Constructs a new instance.

Parameters:

  • config (VAPI::Bindings::StubConfig) —

    A hash with the api provider details. 



104
105
106
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm.rb', line 104

def initialize(config)
    super(config, @@service_info)
end

Instance Method Details

- (Com::Vmware::Vcenter::Vm::Hardware::Info) get(vm)

Returns the virtual hardware settings of a virtual machine.

Parameters:

  • vm (String) —

    Virtual machine identifier.

Returns:

  • (Com::Vmware::Vcenter::Vm::Hardware::Info) —

    Virtual hardware settings of the virtual machine.

Raises:



127
128
129
130
131
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm.rb', line 127

def get(vm)
    invoke_with_info(@@get_info, {
        'vm' => vm,
    })
end

- (Void) update(vm, spec)

Updates the virtual hardware settings of a virtual machine.

Parameters:

  • vm (String) —

    Virtual machine identifier.

  • spec (Com::Vmware::Vcenter::Vm::Hardware::UpdateSpec) —

    Specification for updating the virtual hardware settings of the virtual machine.

Returns:

  • (Void)

Raises:



161
162
163
164
165
166
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm.rb', line 161

def update(vm, spec)
    invoke_with_info(@@update_info, {
        'vm' => vm,
        'spec' => spec,
    })
end

- (Void) upgrade(vm, version = nil)

Upgrades the virtual machine to a newer virtual hardware version.

Parameters:

  • vm (String) —

    Virtual machine identifier.

  • version (Com::Vmware::Vcenter::Vm::Hardware::Version, nil) (defaults to: nil) —

    New virtual machine version. If nil , defaults to the most recent virtual hardware version supported by the server.

Returns:

  • (Void)

Raises:



199
200
201
202
203
204
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm.rb', line 199

def upgrade(vm, version=nil)
    invoke_with_info(@@upgrade_info, {
        'vm' => vm,
        'version' => version,
    })
end