Class List Method List File List

# Class: Com::Vmware::Vcenter::Vm::Hardware::Cpu

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Vcenter::Vm::Hardware::Cpu
  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::Cpu`` class provides methods for configuring the CPU settings of a virtual machine.

## Defined Under Namespace

Classes: Info, UpdateSpec

## Instance Method Summary (collapse)

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

  Returns the CPU-related settings of a virtual machine.

- - (Cpu) initialize(config) constructor

  Constructs a new instance.

- - (Void) update(vm, spec)

  Updates the CPU-related settings of a virtual machine.

## Constructor Details

### - (`Cpu`) initialize(config)

Constructs a new instance.

Parameters:

- config (`VAPI::Bindings::StubConfig`) —

  A hash with the api provider details.

    1415
    1416
    1417
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1415

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

## Instance Method Details

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

Returns the CPU-related settings of a virtual machine.

Parameters:

- vm (`String`) —

  Virtual machine identifier.

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::Cpu::Info`) —

  CPU-related settings of the virtual machine.

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  if the system reports an error while responding to the request.

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the virtual machine is not found.

- (`Com::Vmware::Vapi::Std::Errors::ResourceInaccessible`) —

  if the virtual machine’s configuration state cannot be accessed.

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

  if the system is unable to communicate with a service to complete the request.

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    1438
    1439
    1440
    1441
    1442
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1438

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

### - (`Void`) update(vm, spec)

Updates the CPU-related settings of a virtual machine.

Parameters:

- vm (`String`) —

  Virtual machine identifier.

- spec (`Com::Vmware::Vcenter::Vm::Hardware::Cpu::UpdateSpec`) —

  Specification for updating the CPU-related settings of the virtual machine.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  if the system reports an error while responding to the request.

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the virtual machine is not found.

- (`Com::Vmware::Vapi::Std::Errors::InvalidArgument`) —

  if one of the provided settings is not permitted; for example, specifying a negative value for ``count`` .

- (`Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState`) —

  if ``hotAddEnabled`` or ``hotRemoveEnabled`` is specified and the virtual machine is not powered off.

- (`Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState`) —

  if ``count`` is specified and is greater than ``count`` , ``hotAddEnabled`` is false, and the virtual machine is not powered off.

- (`Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState`) —

  if ``count`` is specified and is less than ``count`` , ``hotRemoveEnabled`` is false, and the virtual machine is not powered off.

- (`Com::Vmware::Vapi::Std::Errors::ResourceBusy`) —

  if the virtual machine is busy performing another operation.

- (`Com::Vmware::Vapi::Std::Errors::ResourceInaccessible`) —

  if the virtual machine’s configuration state cannot be accessed.

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

  if the system is unable to communicate with a service to complete the request.

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    1474
    1475
    1476
    1477
    1478
    1479
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1474

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