Com::Vmware::Vcenter::Vm::Hardware::Serial Class Reference

Inheritance diagram for Com::Vmware::Vcenter::Vm::Hardware::Serial:

Classes
class	BackingInfo
class	BackingSpec
class	BackingType
class	CreateSpec
class	Info
class	Summary
class	UpdateSpec

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

Detailed Description

The Com::Vmware::Vcenter::Vm::Hardware::Serial interface provides methods for configuring the virtual serial ports of a virtual machine. Constant String::RESOURCE_TYPE # Resource type for the virtual serial port device.

Member Function Documentation

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::connect

(

)

Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system.

For a powered-off virtual machine, the :func:Com::Vmware::Vcenter::Vm::Hardware::Serial.update method may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.

Parameters

vm	[REQUIRED] Virtual machine identifier. The value must be an identifier for the resource type getQualifiedName(VirtualMachine). . The value must be str.
port	[REQUIRED] Virtual serial port identifier. The value must be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.SerialPort). . 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::NotFound	if the virtual machine or virtual serial port is not found.
Com::Vmware::Vapi::Std::Errors::AlreadyInDesiredState	if the virtual serial port is already connected.
Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState	if the virtual machine is not powered on.
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::Serial::create

(

)

Adds a virtual serial port 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 serial port. . The value must be Com::Vmware::Vcenter::Vm::Hardware::Serial::CreateSpec.

Return values

Virtual

serial port identifier. The value will be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.SerialPort). The return type will be str

Exceptions

Com::Vmware::Vapi::Std::Errors::Error	if the system reported that the serial port device was created but was unable to confirm the creation because the identifier of the new device 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::NotFound	if the virtual machine is not found.
Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState	if the virtual machine is not powered off.
Com::Vmware::Vapi::Std::Errors::UnableToAllocateResource	if the virtual machine already has the maximum number of supported serial ports.
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::Serial::delete

(

)

Removes a virtual serial port 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.
port	[REQUIRED] Virtual serial port identifier. The value must be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.SerialPort). . 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::NotFound	if the virtual machine or virtual serial port is not found.
Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState	if 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.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::disconnect

(

)

Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing.

For a powered-off virtual machine, the :func:Com::Vmware::Vcenter::Vm::Hardware::Serial.update method may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.

Parameters

vm	[REQUIRED] Virtual machine identifier. The value must be an identifier for the resource type getQualifiedName(VirtualMachine). . The value must be str.
port	[REQUIRED] Virtual serial port identifier. The value must be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.SerialPort). . 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::NotFound	if the virtual machine or virtual serial port is not found.
Com::Vmware::Vapi::Std::Errors::AlreadyInDesiredState	if the virtual serial port is already disconnected.
Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState	if the virtual machine is not powered on.
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::Serial::get

(

)

Returns information about a virtual serial port.

Parameters

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

Return values

Information

about the specified virtual serial port. The return type will be Com::Vmware::Vcenter::Vm::Hardware::Serial::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 serial port 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::Serial::list

(

)

Returns commonly used information about the virtual serial ports 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 serial ports. The return type will be Array of Com::Vmware::Vcenter::Vm::Hardware::Serial::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::Serial::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::Serial::update

(

)

Updates the configuration of a virtual serial port.

Parameters

vm	[REQUIRED] Virtual machine identifier. The value must be an identifier for the resource type getQualifiedName(VirtualMachine). . The value must be str.
port	[REQUIRED] Virtual serial port identifier. The value must be an identifier for the resource type getQualifiedName(com.vmware.vcenter.vm.hardware.SerialPort). . The value must be str.
spec	[REQUIRED] Specification for updating the virtual serial port. . The value must be Com::Vmware::Vcenter::Vm::Hardware::Serial::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 serial port 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 serial port.
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/Serial.pm