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

Inheritance diagram for Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi:

Classes
class	CreateSpec
class	Info
class	Sharing
class	Summary
class	Type
class	UpdateSpec

Avaliable Methods
public method	create ()
public method	delete ()
public method	get ()
public method	new ()
public method	update ()
public method	list ()

Detailed Description

The Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi interface provides methods* for configuring the virtual SCSI adapters of a virtual machine. Constant String::RESOURCE_TYPE # Resource type for the virtual SCSI adapter device.

Member Function Documentation

public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::create

(

)

Adds a virtual SCSI adapter to the virtual machine.

Parameters

vm	[REQUIRED] Virtual machine identifier. The value must be an identifier for the resource type getQualifiedName(VirtualMachine). . The value must be str.
spec	[REQUIRED] Specification for the new virtual SCSI adapter. . The value must be Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::CreateSpec.

Return values

Virtual

SCSI adapter identifier. The value will be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.ScsiAdapter). The return type will be str

Exceptions

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 null fields that default to guest-specific values.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::delete

(

)

Removes a virtual SCSI adapter from the virtual machine.

Parameters

vm	[REQUIRED] Virtual machine identifier. The value must be an identifier for the resource type getQualifiedName(VirtualMachine). . The value must be str.
adapter	[REQUIRED] Virtual SCSI adapter identifier. The value must be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.ScsiAdapter). . The value must be str.

Exceptions

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.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::get

(

)

Returns information about a virtual SCSI adapter.

Parameters

vm	[REQUIRED] Virtual machine identifier. The value must be an identifier for the resource type getQualifiedName(VirtualMachine). . The value must be str.
adapter	[REQUIRED] Virtual SCSI adapter identifier. The value must be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.ScsiAdapter). . The value must be str.

Return values

Information

about the specified virtual SCSI adapter. The return type will be Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Info

Exceptions

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.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::list

(

)

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

Parameters

vm	[REQUIRED] Virtual machine identifier. The value must be an identifier for the resource type getQualifiedName(VirtualMachine). . The value must be str.

Return values

List	of commonly used information about virtual SCSI adapters. The return type will be Array of Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::Summary

Exceptions

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.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::new

(

)

Constructor to initialize the object

Parameters

api_provider	- protocol connection to use with stubs created by this factory
StubConfig	- Stub's additional configuration

Return values

Blessed

object

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::update

(

)

Updates the configuration of a virtual SCSI adapter.

Parameters

vm	[REQUIRED] Virtual machine identifier. The value must be an identifier for the resource type getQualifiedName(VirtualMachine). . The value must be str.
adapter	[REQUIRED] Virtual SCSI adapter identifier. The value must be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.ScsiAdapter). . The value must be str.
spec	[REQUIRED] Specification for updating the virtual SCSI adapter. . The value must be Com::Vmware::Vcenter::Vm::Hardware::Adapter::Scsi::UpdateSpec.

Exceptions

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.

Code:

---

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

• Com/Vmware/Vcenter/Vm/Hardware/Adapter/Scsi.pm