|
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
|
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 () |
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.
| public method Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata::create | ( | ) |
Adds a virtual SATA adapter to the virtual machine.
| 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. |
| Virtual | SATA 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 |
| Com::Vmware::Vapi::Std::Errors::Error | if the system reports an error while responding to the request. |
| Com::Vmware::Vapi::Std::Errors::Error | if 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::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 SATA buses on the virtual machine. |
| Com::Vmware::Vapi::Std::Errors::ResourceInUse | if the specified SATA bus or PCI address 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::Sata::delete | ( | ) |
Removes a virtual SATA adapter from the virtual machine.
| 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. |
| 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 SATA 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::Sata::get | ( | ) |
Returns information about a virtual SATA adapter.
| 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. |
| Information | about the specified virtual SATA adapter. The return type will be Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata::Info |
| 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 SATA 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::Sata::list | ( | ) |
Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.
| vm | [REQUIRED] Virtual machine identifier. The value must be an identifier for the resource type getQualifiedName(VirtualMachine). . The value must be str. |
| List | of commonly used information about virtual SATA adapters. The return type will be Array of Com::Vmware::Vcenter::Vm::Hardware::Adapter::Sata::Summary |
| 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::Sata::new | ( | ) |
Constructor to initialize the object
| api_provider | - protocol connection to use with stubs created by this factory |
| StubConfig | - Stub's additional configuration |
| Blessed | object |
Code: