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

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

Avaliable Methods
public method	get_backing ()
public method	get_label ()
public method	set_start_connected ()
public method	set_label ()
public method	set_allow_guest_control ()
public method	set_state ()
public method	get_start_connected ()
public method	get_allow_guest_control ()
public method	new ()
public method	get_yield_on_poll ()
public method	set_backing ()
public method	get_state ()
public method	set_yield_on_poll ()

Detailed Description

The Com::Vmware::Vcenter::Vm::Hardware::Serial::Info class contains information about a virtual serial port.

Member Function Documentation

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::get_allow_guest_control

(

)

Gets the value of 'allow_guest_control' property.

Return values

allow_guest_control

- The current value of the field. Flag indicating whether the guest can connect and disconnect the device. boolean#

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::get_backing

(

)

Gets the value of 'backing' property.

Return values

backing

- The current value of the field. Physical resource backing for the virtual serial port. BackingInfo#

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::get_label

(

)

Gets the value of 'label' property.

Return values

label

- The current value of the field. Device label. String#

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::get_start_connected

(

)

Gets the value of 'start_connected' property.

Return values

start_connected

- The current value of the field. Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. boolean#

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::get_state

(

)

Gets the value of 'state' property.

Return values

state

- The current value of the field. Connection status of the virtual device. ConnectionState#

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::get_yield_on_poll

(

)

Gets the value of 'yield_on_poll' property.

Return values

yield_on_poll

- The current value of the field. CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host. boolean#

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::new

(

)

Constructor to initialize the Com::Vmware::Vcenter::Vm::Hardware::Serial::Info structure

Return values

Blessed

object

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::set_allow_guest_control

(

)

Sets the given value for 'allow_guest_control' property.

Parameters

allow_guest_control

- New value for the field. Flag indicating whether the guest can connect and disconnect the device.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::set_backing

(

)

Sets the given value for 'backing' property.

Parameters

backing

- New value for the field. Physical resource backing for the virtual serial port.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::set_label

(

)

Sets the given value for 'label' property.

Parameters

label

- New value for the field. Device label.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::set_start_connected

(

)

Sets the given value for 'start_connected' property.

Parameters

start_connected

- New value for the field. Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::set_state

(

)

Sets the given value for 'state' property.

Parameters

state

- New value for the field. Connection status of the virtual device.

Code:

public method Com::Vmware::Vcenter::Vm::Hardware::Serial::Info::set_yield_on_poll

(

)

Sets the given value for 'yield_on_poll' property.

Parameters

yield_on_poll

- New value for the field. CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host.

Code:

---

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

• Com/Vmware/Vcenter/Vm/Hardware/Serial.pm