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

Inherits:
VAPI::Bindings::VapiStruct
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb

Overview

The ``Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingInfo`` class contains information about the physical resource backing a virtual serial port.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (BackingInfo) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

  • ruby_values (Hash) (defaults to: nil) —

    a map of initial property values (optional)

  • struct_value (VAPI::Data::StructValue) (defaults to: nil) —

    a raw StructValue from the wire (optional) 



5446
5447
5448
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5446

def initialize(ruby_values=nil, struct_value=nil)
    super(self.class.binding_type, ruby_values, struct_value)
end

Instance Attribute Details

- (Boolean) auto_detect

Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device. This field is optional and it is only relevant when the value of ``type`` is :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.HOST_DEVICE` .

Returns:

  • (Boolean) 


5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5409

class BackingInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.serial.backing_info',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                    'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect,
                  :pipe,
                  :no_rx_loss,
                  :network_location,
                  :proxy

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String) file

Path of the file backing the virtual serial port. This field is optional and it is only relevant when the value of ``type`` is :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.FILE` .

Returns:

  • (String) 


5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5409

class BackingInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.serial.backing_info',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                    'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect,
                  :pipe,
                  :no_rx_loss,
                  :network_location,
                  :proxy

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String?) host_device

Name of the device backing the virtual serial port. This field will be nil if ``autoDetect`` is true and the virtual serial port is not connected or no suitable device is available on the host.

Returns:

  • (String, nil) 


5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5409

class BackingInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.serial.backing_info',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                    'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect,
                  :pipe,
                  :no_rx_loss,
                  :network_location,
                  :proxy

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (URI) network_location

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


  * If   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingInfo.type`   is   :attr:`Com::Vmware::Vcenter::Vm::Hardware::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   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingInfo.type`   is   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.NETWORK_CLIENT`  , this  field  is the location used by the virtual machine to connect to the remote server.

This field is optional and it is only relevant when the value of ``type`` is one of :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.NETWORK_SERVER` or :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.NETWORK_CLIENT` .

Returns:

  • (URI) 


5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5409

class BackingInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.serial.backing_info',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                    'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect,
                  :pipe,
                  :no_rx_loss,
                  :network_location,
                  :proxy

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Boolean) no_rx_loss

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. This field is optional and it is only relevant when the value of ``type`` is one of :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.PIPE_SERVER` or :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.PIPE_CLIENT` .

Returns:

  • (Boolean) 


5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5409

class BackingInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.serial.backing_info',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                    'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect,
                  :pipe,
                  :no_rx_loss,
                  :network_location,
                  :proxy

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String) pipe

Name of the pipe backing the virtual serial port. This field is optional and it is only relevant when the value of ``type`` is one of :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.PIPE_SERVER` or :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.PIPE_CLIENT` .

Returns:

  • (String) 


5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5409

class BackingInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.serial.backing_info',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                    'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect,
                  :pipe,
                  :no_rx_loss,
                  :network_location,
                  :proxy

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (URI?) proxy

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. If nil , no proxy service is configured.

Returns:

  • (URI, nil) 


5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5409

class BackingInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.serial.backing_info',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                    'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect,
                  :pipe,
                  :no_rx_loss,
                  :network_location,
                  :proxy

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType) type

Backing type for the virtual serial port.

Returns:



5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5409

class BackingInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.serial.backing_info',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                    'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect,
                  :pipe,
                  :no_rx_loss,
                  :network_location,
                  :proxy

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

Class Method Details

+ (VAPI::Bindings::StructType) binding_type

Holds (gets or creates) the binding type metadata for this structure type.

Returns:

  • (VAPI::Bindings::StructType) —

    the binding type 



5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5415

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.vm.hardware.serial.backing_info',
        {
            'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
            'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
            'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
            'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
            'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
        },
        BackingInfo,
        false,
        nil)
end