Type: unix-hotplug
Description: Unix hotplug devices make the requested Unix device appear as a device in the container (under/dev). If the device exists on the host system, you can read from it and write to it. The implementatio...

Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# Type: `unix-hotplug`

▶ Watch on YouTube

Note

The `unix-hotplug` device type is supported for containers. It supports hotplugging.

Unix hotplug devices make the requested Unix device appear as a device in the container (under `/dev`). If the device exists on the host system, you can read from it and write to it.

The implementation depends on `systemd-udev` to be run on the host.

## Device options

`unix-hotplug` devices have the following device options:

`gid`

GID of the device owner in the container

Key: | `gid`
Type: | integer
Default: | `0`

`mode`

Mode of the device in the container

Key: | `mode`
Type: | integer
Default: | `0660`

`ownership.inherit`

Whether this device inherits ownership (GID and/or UID) from the host

Key: | `ownership.inherit`
Type: | bool
Default: | `false`

`productid`

Product ID of the Unix device

Key: | `productid`
Type: | string

`required`

Whether this device is required to start the container

Key: | `required`
Type: | bool
Default: | `false`

The default is `false`, which means that all devices can be hotplugged.

`subsystem`

Subsystem of the Unix device

Key: | `subsystem`
Type: | string

`uid`

UID of the device owner in the container

Key: | `uid`
Type: | integer
Default: | `0`

`vendorid`

Vendor ID of the Unix device

Key: | `vendorid`
Type: | string

## Configuration examples

Add a `unix-hotplug` device to an instance by specifying its vendor ID, product ID, and/or subsystem:

    lxc config device add <instance_name> <device_name> unix-hotplug vendorid=<vendor_ID> productid=<product_ID> subsystem=<subsystem>

See Configure devices for more information.