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

The Serial.BackingInfo class contains information about the physical resource backing a virtual serial port. More...

List of all members.

Public Member Functions

 BackingInfo ()
 Creates a default new instance.
vmware.vcenter.vm.hardware.SerialTypes.BackingType Get_Type ()
 Backing type for the virtual serial port.
void SetType (vmware.vcenter.vm.hardware.SerialTypes.BackingType type)
 Backing type for the virtual serial port.
string GetFile ()
 Path of the file backing the virtual serial port.
void SetFile (string file)
 Path of the file backing the virtual serial port.
string GetHostDevice ()
 Name of the device backing the virtual serial port.
void SetHostDevice (string hostDevice)
 Name of the device backing the virtual serial port.
bool GetAutoDetect ()
 Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device.
void SetAutoDetect (bool?autoDetect)
 Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device.
string GetPipe ()
 Name of the pipe backing the virtual serial port.
void SetPipe (string pipe)
 Name of the pipe backing the virtual serial port.
bool GetNoRxLoss ()
 Flag that enables optimized data transfer over the pipe.
void SetNoRxLoss (bool?noRxLoss)
 Flag that enables optimized data transfer over the pipe.
global::System.Uri GetNetworkLocation ()
 URI specifying the location of the network service backing the virtual serial port.
void SetNetworkLocation (global::System.Uri networkLocation)
 URI specifying the location of the network service backing the virtual serial port.
global::System.Uri GetProxy ()
 Proxy service that provides network access to the network backing.
void SetProxy (global::System.Uri proxy)
 Proxy service that provides network access to the network backing.
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.BackingInfo class contains information about the physical resource backing a virtual serial port.


Constructor & Destructor Documentation

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

Creates a default new instance.


Member Function Documentation

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

Backing type for the virtual serial port.

bool vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::GetAutoDetect ( ) [inline]

Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device.

string vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::GetFile ( ) [inline]

Path of the file backing the virtual serial port.

override int vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::GetHashCode ( ) [inline]
string vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::GetHostDevice ( ) [inline]

Name of the device backing the virtual serial port.

global::System.Uri vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::GetNetworkLocation ( ) [inline]

URI specifying the location of the network service backing the virtual serial port.

  • If Serial.BackingInfo.type is Serial.BackingType.NETWORK_SERVER , this field is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running.
  • If Serial.BackingInfo.type is Serial.BackingType.NETWORK_CLIENT , this field is the location used by the virtual machine to connect to the remote server.
bool vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::GetNoRxLoss ( ) [inline]

Flag that enables optimized data transfer over the pipe.

When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss.

string vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::GetPipe ( ) [inline]

Name of the pipe backing the virtual serial port.

global::System.Uri vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::GetProxy ( ) [inline]

Proxy service that provides network access to the network backing.

If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy.

void vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::SetAutoDetect ( bool?  autoDetect) [inline]

Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device.

void vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::SetFile ( string  file) [inline]

Path of the file backing the virtual serial port.

void vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::SetHostDevice ( string  hostDevice) [inline]

Name of the device backing the virtual serial port.

void vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::SetNetworkLocation ( global::System.Uri  networkLocation) [inline]

URI specifying the location of the network service backing the virtual serial port.

  • If Serial.BackingInfo.type is Serial.BackingType.NETWORK_SERVER , this field is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running.
  • If Serial.BackingInfo.type is Serial.BackingType.NETWORK_CLIENT , this field is the location used by the virtual machine to connect to the remote server.
void vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::SetNoRxLoss ( bool?  noRxLoss) [inline]

Flag that enables optimized data transfer over the pipe.

When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss.

void vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::SetPipe ( string  pipe) [inline]

Name of the pipe backing the virtual serial port.

void vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::SetProxy ( global::System.Uri  proxy) [inline]

Proxy service that provides network access to the network backing.

If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy.

void vmware::vcenter::vm::hardware::SerialTypes::BackingInfo::SetType ( vmware.vcenter.vm.hardware.SerialTypes.BackingType  type) [inline]

Backing type for the virtual serial port.

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

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