io7m | single-page | multi-page
3.7. vm-add-e1000-network-device
Previous
3. Command-Line Interface
Up
3.9. vm-add-lpc-device
Next
3.8

# vm-add-framebuffer-device

- 3.8. vm-add-framebuffer-device
  - 3.8.1. Name
  - 3.8.2. Description
  - 3.8.3. Example

3.8.1

## Name

1
vm-add-framebuffer-device - Add a framebuffer device to a virtual machine
3.8.2

## Description

1
The vm-add-framebuffer-device command adds a framebuffer device to a virtual machine.
2

### 3.8.2.2 Parameters

Parameter | Type | Required | Description
--- | --- | --- | ---
--comment | String | false | A comment describing the new device
--configuration | Path | false | The path to the configuration file (environment variable: $WAXMILL_CONFIGURATION_FILE)
--device-slot | Device Slot | true | The slot to which the device will be attached.
--height | Integer | false | The framebuffer height
--listen-address | String | false | The VNC server listen address
--listen-port | Integer | false | The VNC server listen port
--machine | UUID | true | The ID of the virtual machine
--verbose | Log Level | false | Set the minimum logging verbosity level.
--vga-configuration | VGAConfiguration | false | The guest VGA configuration
--wait-for-vnc | Boolean | false | Will cause the machine to wait for a VNC connection before booting
--width | Integer | false | The framebuffer width
--replace | Boolean | false | true if an existing device in the given slot should be replaced.

3

### 3.8.2.3 Device Slot Syntax

    bus        = ? [0 .. 255] ? ;
    slot       = ? [0 .. 31] ? ;
    function   = ? [0 .. 7] ? ;
    deviceSlot = bus , ":" , slot , ":" , function ;

    Examples:
      0:0:0
      255:31:7

4

### 3.8.2.4 Address Syntax

    ipv4Part = ? [0 .. 255]{1,3} ? ;
    ipv4     = ipv4Part , ".", ipv4Part , "." , ipv4Part , "." , ipv4Part , ;
    ipv6     = ? Any https://tools.ietf.org/html/rfc4291 IPv6 address ? ;
    name     = ? Any host name ? ;
    address  = ipv4 | ipv6 | name ;

    Examples:
      127.0.0.1
      [::1]
      [2600:1417:6000:198::255e]
      localhost
      www.example.com

3.8.3

## Example

1

### 3.8.3.1 Example

    $ waxmill vm-add-framebuffer-device \
      --machine de17174a-1b3c-4ebc-80af-cb239aa18cbd \
      --device-slot 0:4:0 \
      --wait-for-vnc true \
      --width 1024 \
      --height 768 \
      --listen-address [::1] \
      --listen-port 5901 \
      --vga-configuration OFF

3.7. vm-add-e1000-network-device
Previous
3. Command-Line Interface
Up
3.9. vm-add-lpc-device
Next
io7m | single-page | multi-page