Class: Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi

Inherits:

VAPI::Bindings::VapiService

Object
VAPI::Bindings::VapiService
Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi

show all

Defined in:

/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware/adapter.rb

Overview

The ``Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi`` class provides methods for configuring the virtual SCSI adapters of a virtual machine.

Defined Under Namespace

Classes: CreateSpec, Info, Sharing, Summary, Type, UpdateSpec

Constant Summary

RESOURCE_TYPE =

'com.vmware.vcenter.vm.hardware.ScsiAdapter'

Instance Method Summary (collapse)

- (String) create(vm, spec)
Adds a virtual SCSI adapter to the virtual machine.
- (Void) delete(vm, adapter)
Removes a virtual SCSI adapter from the virtual machine.
- (Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Info) get(vm, adapter)
Returns information about a virtual SCSI adapter.
- (Scsi) initialize(config) constructor
Constructs a new instance.
- (Array<Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Summary>) list(vm)
Returns commonly used information about the virtual SCSI adapters belonging to the virtual machine.
- (Void) update(vm, adapter, spec)
Updates the configuration of a virtual SCSI adapter.

Constructor Details

- (`Scsi`) initialize(config)

Constructs a new instance.

Parameters:

config (VAPI::Bindings::StubConfig) —
A hash with the api provider details.



565
566
567

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

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

Instance Method Details

- (`String`) create(vm, spec)

Adds a virtual SCSI adapter to the virtual machine.

Parameters:

vm (String) —
Virtual machine identifier.
spec (Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::CreateSpec) —
Specification for the new virtual SCSI adapter.

Returns:

(String) —
Virtual SCSI adapter identifier.

Raises:

(Com::Vmware::Vapi::Std::Errors::Error) —
if the system reported that the SCSI adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined.
(Com::Vmware::Vapi::Std::Errors::Error) —
if the system reports an error while responding to the request.
(Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState) —
if the virtual machine is suspended
(Com::Vmware::Vapi::Std::Errors::NotFound) —
if the virtual machine is not found.
(Com::Vmware::Vapi::Std::Errors::UnableToAllocateResource) —
if there are no more available SCSI buses on the virtual machine.
(Com::Vmware::Vapi::Std::Errors::ResourceInUse) —
if the specified SCSI bus is in use.
(Com::Vmware::Vapi::Std::Errors::InvalidArgument) —
if the specified SATA bus or PCI address is out of bounds.
(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.
(Com::Vmware::Vapi::Std::Errors::Unsupported) —
if the guest operating system of the virtual machine is not supported and spec includes nil fields that default to guest-specific values.

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

def create(vm, spec)
    invoke_with_info(@@create_info, {
        'vm' => vm,
        'spec' => spec,
    })
end

- (`Void`) delete(vm, adapter)

Removes a virtual SCSI adapter from the virtual machine.

Parameters:

vm (String) —
Virtual machine identifier.
adapter (String) —
Virtual SCSI adapter identifier.

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::NotAllowedInCurrentState) —
if the virtual machine is suspended
(Com::Vmware::Vapi::Std::Errors::NotFound) —
if the virtual machine or virtual SCSI adapter is not found.
(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.

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

def delete(vm, adapter)
    invoke_with_info(@@delete_info, {
        'vm' => vm,
        'adapter' => adapter,
    })
end

- (`Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Info`) get(vm, adapter)

Returns information about a virtual SCSI adapter.

Parameters:

vm (String) —
Virtual machine identifier.
adapter (String) —
Virtual SCSI adapter identifier.

Returns:

(Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Info) —
Information about the specified virtual SCSI adapter.

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 or virtual SCSI adapter 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.

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

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

- (`Array<Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Summary>`) list(vm)

Returns commonly used information about the virtual SCSI adapters belonging to the virtual machine.

Parameters:

vm (String) —
Virtual machine identifier.

Returns:

(Array<Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Summary>) —
List of commonly used information about virtual SCSI adapters.

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.

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

def list(vm)
    invoke_with_info(@@list_info, {
        'vm' => vm,
    })
end

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

Updates the configuration of a virtual SCSI adapter.

Parameters:

vm (String) —
Virtual machine identifier.
adapter (String) —
Virtual SCSI adapter identifier.
spec (Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::UpdateSpec) —
Specification for updating the virtual SCSI adapter.

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 or virtual SCSI adapter is not found.
(Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState) —
if one or more of the fields specified in the ``spec`` parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual SCSI adapter.
(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.

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

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

Class: Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi

Overview

Defined Under Namespace

Constant Summary

Instance Method Summary (collapse)

Constructor Details

- (Scsi) initialize(config)

Instance Method Details

- (String) create(vm, spec)

- (Void) delete(vm, adapter)

- (Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Info) get(vm, adapter)

- (Array<Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Summary>) list(vm)

- (Void) update(vm, adapter, spec)

- (`Scsi`) initialize(config)

- (`String`) create(vm, spec)

- (`Void`) delete(vm, adapter)

- (`Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Info`) get(vm, adapter)

- (`Array<Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Summary>`) list(vm)

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