VMware vSphere Automation SDK Perl
The VMware vSphere Automation SDK for Perl supports the client-side vSphere Automation API for access to vSphere services and capabilities
 All Classes Files Functions
Classes | List of all members
Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata Class Reference
Inheritance diagram for Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata:
Com::Vmware::Vapi::Bindings::VapiInterface

Classes

class  CreateSpec
 
class  Info
 
class  Summary
 
class  Type
 

Avaliable Methods

public method create ()
 
public method delete ()
 
public method get ()
 
public method new ()
 
public method list ()
 

Detailed Description

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

Member Function Documentation

public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata::create ( )

Adds a virtual SATA 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 SATA adapter. . The value must be Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata::CreateSpec.
Return values
VirtualSATA adapter identifier. The value will be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.SataAdapter). The return type will be str
Exceptions
Com::Vmware::Vapi::Std::Errors::Errorif the system reports an error while responding to the request.
Com::Vmware::Vapi::Std::Errors::Errorif the system reported that the SATA 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::NotAllowedInCurrentStateif the virtual machine is suspended
Com::Vmware::Vapi::Std::Errors::NotFoundif the virtual machine is not found.
Com::Vmware::Vapi::Std::Errors::UnableToAllocateResourceif there are no more available SATA buses on the virtual machine.
Com::Vmware::Vapi::Std::Errors::ResourceInUseif the specified SATA bus or PCI address is in use.
Com::Vmware::Vapi::Std::Errors::InvalidArgumentif the specified SATA bus or PCI address is out of bounds.
Com::Vmware::Vapi::Std::Errors::ResourceBusyif the virtual machine is busy performing another operation.
Com::Vmware::Vapi::Std::Errors::ResourceInaccessibleif the virtual machine's configuration state cannot be accessed.
Com::Vmware::Vapi::Std::Errors::ServiceUnavailableif the system is unable to communicate with a service to complete the request.
Com::Vmware::Vapi::Std::Errors::Unauthenticatedif the user can not be authenticated.
Com::Vmware::Vapi::Std::Errors::Unauthorizedif the user doesn't have the required privileges.
Com::Vmware::Vapi::Std::Errors::Unsupportedif the guest operating system of the virtual machine is not supported and spec includes null fields that default to guest-specific values.
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata::delete ( )

Removes a virtual SATA 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 SATA adapter identifier. The value must be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.SataAdapter). . The value must be str.
Exceptions
Com::Vmware::Vapi::Std::Errors::Errorif the system reports an error while responding to the request.
Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentStateif the virtual machine is suspended
Com::Vmware::Vapi::Std::Errors::NotFoundif the virtual machine or virtual SATA adapter is not found.
Com::Vmware::Vapi::Std::Errors::ResourceBusyif the virtual machine is busy performing another operation.
Com::Vmware::Vapi::Std::Errors::ResourceInaccessibleif the virtual machine's configuration state cannot be accessed.
Com::Vmware::Vapi::Std::Errors::ServiceUnavailableif the system is unable to communicate with a service to complete the request.
Com::Vmware::Vapi::Std::Errors::Unauthenticatedif the user can not be authenticated.
Com::Vmware::Vapi::Std::Errors::Unauthorizedif the user doesn't have the required privileges.
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata::get ( )

Returns information about a virtual SATA 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 SATA adapter identifier. The value must be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.SataAdapter). . The value must be str.
Return values
Informationabout the specified virtual SATA adapter. The return type will be Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata::Info
Exceptions
Com::Vmware::Vapi::Std::Errors::Errorif the system reports an error while responding to the request.
Com::Vmware::Vapi::Std::Errors::NotFoundif the virtual machine or virtual SATA adapter is not found.
Com::Vmware::Vapi::Std::Errors::ResourceInaccessibleif the virtual machine's configuration state cannot be accessed.
Com::Vmware::Vapi::Std::Errors::ServiceUnavailableif the system is unable to communicate with a service to complete the request.
Com::Vmware::Vapi::Std::Errors::Unauthenticatedif the user can not be authenticated.
Com::Vmware::Vapi::Std::Errors::Unauthorizedif the user doesn't have the required privileges.
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata::list ( )

Returns commonly used information about the virtual SATA 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
Listof commonly used information about virtual SATA adapters. The return type will be Array of Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata::Summary
Exceptions
Com::Vmware::Vapi::Std::Errors::Errorif the system reports an error while responding to the request.
Com::Vmware::Vapi::Std::Errors::NotFoundif the virtual machine is not found.
Com::Vmware::Vapi::Std::Errors::ResourceInaccessibleif the virtual machine's configuration state cannot be accessed.
Com::Vmware::Vapi::Std::Errors::ServiceUnavailableif the system is unable to communicate with a service to complete the request.
Com::Vmware::Vapi::Std::Errors::Unauthenticatedif the user can not be authenticated.
Com::Vmware::Vapi::Std::Errors::Unauthorizedif the user doesn't have the required privileges.
Code:
click to view
public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata::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
Blessedobject
Code:
click to view

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