VMware vSphere Automation SDK for .NET 6.5.0
vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec Class Reference

The Serial.UpdateSpec class describes the updates to be made to the configuration of a virtual serial port. More...

List of all members.

Public Member Functions

 UpdateSpec ()
 Creates a default new instance.
bool GetYieldOnPoll ()
 CPU yield behavior.
void SetYieldOnPoll (bool?yieldOnPoll)
 CPU yield behavior.
vmware.vcenter.vm.hardware.SerialTypes.BackingSpec GetBacking ()
 Physical resource backing for the virtual serial port.
void SetBacking (vmware.vcenter.vm.hardware.SerialTypes.BackingSpec backing)
 Physical resource backing for the virtual serial port.
bool GetStartConnected ()
 Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
void SetStartConnected (bool?startConnected)
 Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
bool GetAllowGuestControl ()
 Flag indicating whether the guest can connect and disconnect the device.
void SetAllowGuestControl (bool?allowGuestControl)
 Flag indicating whether the guest can connect and disconnect the device.
vmware.vapi.bindings.type.StructType _GetType ()
vmware.vapi.data.StructValue _GetDataValue ()
void _Validate ()
bool _HasTypeNameOf< T > ()
_ConvertTo< T > ()
override bool Equals (object obj)
override int GetHashCode ()
override string ToString ()

Detailed Description

The Serial.UpdateSpec class describes the updates to be made to the configuration of a virtual serial port.


Constructor & Destructor Documentation

vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::UpdateSpec ( ) [inline]

Creates a default new instance.


Member Function Documentation

T vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::_ConvertTo< T > ( ) [inline]
Type Constraints
T :vmware.vapi.bindings.IStructure 
vmware.vapi.data.StructValue vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::_GetDataValue ( ) [inline]
vmware.vapi.bindings.type.StructType vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::_GetType ( ) [inline]
bool vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::_HasTypeNameOf< T > ( ) [inline]
Type Constraints
T :vmware.vapi.bindings.IStructure 
void vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::_Validate ( ) [inline]
override bool vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::Equals ( object  obj) [inline]
bool vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::GetAllowGuestControl ( ) [inline]

Flag indicating whether the guest can connect and disconnect the device.

vmware.vcenter.vm.hardware.SerialTypes.BackingSpec vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::GetBacking ( ) [inline]

Physical resource backing for the virtual serial port.

This field may only be modified if the virtual machine is not powered on or the virtual serial port is not connected.

override int vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::GetHashCode ( ) [inline]
bool vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::GetStartConnected ( ) [inline]

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

bool vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::GetYieldOnPoll ( ) [inline]

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.

This field may be modified at any time, and changes applied to a connected virtual serial port take effect immediately.

void vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::SetAllowGuestControl ( bool?  allowGuestControl) [inline]

Flag indicating whether the guest can connect and disconnect the device.

void vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::SetBacking ( vmware.vcenter.vm.hardware.SerialTypes.BackingSpec  backing) [inline]

Physical resource backing for the virtual serial port.

This field may only be modified if the virtual machine is not powered on or the virtual serial port is not connected.

void vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::SetStartConnected ( bool?  startConnected) [inline]

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

void vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::SetYieldOnPoll ( bool?  yieldOnPoll) [inline]

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.

This field may be modified at any time, and changes applied to a connected virtual serial port take effect immediately.

override string vmware::vcenter::vm::hardware::SerialTypes::UpdateSpec::ToString ( ) [inline]

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