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

Inherits:
VAPI::Bindings::VapiService
  • 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`` class provides methods for configuring the virtual serial ports of a virtual machine.

Defined Under Namespace

Classes: BackingInfo, BackingSpec, BackingType, CreateSpec, Info, Summary, UpdateSpec

Constant Summary

RESOURCE_TYPE = 
'com.vmware.vcenter.vm.hardware.SerialPort'

Instance Method Summary (collapse)

Constructor Details

- (Serial) initialize(config)

Constructs a new instance.

Parameters:

  • config (VAPI::Bindings::StubConfig) —

    A hash with the api provider details. 



5141
5142
5143
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5141

def initialize(config)
    super(config, @@service_info)
end

Instance Method Details

- (Void) connect(vm, port)

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 (String) —

    Virtual machine identifier.

  • port (String) —

    Virtual serial port identifier.

Returns:

  • (Void)

Raises:



5329
5330
5331
5332
5333
5334
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5329

def connect(vm, port)
    invoke_with_info(@@connect_info, {
        'vm' => vm,
        'port' => port,
    })
end

- (String) create(vm, spec)

Adds a virtual serial port to the virtual machine.

Parameters:

Returns:

  • (String) —

    Virtual serial port identifier.

Raises:



5229
5230
5231
5232
5233
5234
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5229

def create(vm, spec)
    invoke_with_info(@@create_info, {
        'vm' => vm,
        'spec' => spec,
    })
end

- (Void) delete(vm, port)

Removes a virtual serial port from the virtual machine.

Parameters:

  • vm (String) —

    Virtual machine identifier.

  • port (String) —

    Virtual serial port identifier.

Returns:

  • (Void)

Raises:



5294
5295
5296
5297
5298
5299
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5294

def delete(vm, port)
    invoke_with_info(@@delete_info, {
        'vm' => vm,
        'port' => port,
    })
end

- (Void) disconnect(vm, port)

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 (String) —

    Virtual machine identifier.

  • port (String) —

    Virtual serial port identifier.

Returns:

  • (Void)

Raises:



5364
5365
5366
5367
5368
5369
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5364

def disconnect(vm, port)
    invoke_with_info(@@disconnect_info, {
        'vm' => vm,
        'port' => port,
    })
end

- (Com::Vmware::Vcenter::Vm::Hardware::Serial::Info) get(vm, port)

Returns information about a virtual serial port.

Parameters:

  • vm (String) —

    Virtual machine identifier.

  • port (String) —

    Virtual serial port identifier.

Returns:

Raises:



5193
5194
5195
5196
5197
5198
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5193

def get(vm, port)
    invoke_with_info(@@get_info, {
        'vm' => vm,
        'port' => port,
    })
end

- (Array<Com::Vmware::Vcenter::Vm::Hardware::Serial::Summary>) list(vm)

Returns commonly used information about the virtual serial ports belonging to the virtual machine.

Parameters:

  • vm (String) —

    Virtual machine identifier.

Returns:

Raises:



5166
5167
5168
5169
5170
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5166

def list(vm)
    invoke_with_info(@@list_info, {
        'vm' => vm,
    })
end

- (Void) update(vm, port, spec)

Updates the configuration of a virtual serial port.

Parameters:

Returns:

  • (Void)

Raises:



5262
5263
5264
5265
5266
5267
5268
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5262

def update(vm, port, spec)
    invoke_with_info(@@update_info, {
        'vm' => vm,
        'port' => port,
        'spec' => spec,
    })
end