Struct crosvm::crosvm::sys::unix::cmdline::DevicesCommand

pub struct DevicesCommand {
    pub async_executor: Option<ExecutorKind>,
    pub disable_sandbox: bool,
    pub jail: JailConfig,
    pub serial: Vec<VhostUserParams<SerialParameters>>,
    pub block: Vec<VhostUserParams<DiskOption>>,
    pub vsock: Vec<VhostUserParams<VsockConfig>>,
    pub net: Vec<VhostUserParams<NetParameters>>,
    pub control_socket: Option<PathBuf>,
}

Start one or several jailed device processes.

Fields

async_executor: Option<ExecutorKind>

configure async executor backend to “uring” or “epoll” (default).

disable_sandbox: bool

disable sandboxing. Will nullify the –jail option if it was present.

jail: JailConfig

set up the jail configuration.
Possible key values:
pivot-root=/path - Path to empty directory to use for
sandbox pivot root.
seccomp-policy-dir=/path - Path to seccomp .policy files seccomp-log-failures=(true|false) - Log seccomp filter
failures instead of them being fatal.

serial: Vec<VhostUserParams<SerialParameters>>

start a serial device.
Possible key values:
vhost=PATH - Path to a vhost-user endpoint to listen to. This parameter must be given in first position.
type=(stdout,syslog,sink,file) - Where to route the
serial device
hardware=(serial,virtio-console) - Which type of serial hardware to emulate. Defaults to 8250 UART (serial). num=(1,2,3,4) - Serial Device Number. If not provided,
num will default to 1.
path=PATH - The path to the file to write to when
type=file
input=PATH - The path to the file to read from when not stdin
console - Use this serial device as the guest console.
Can only be given once. Will default to first
serial port if not provided.
earlycon - Use this serial device as the early console. Can only be given once.
stdin - Direct standard input to this serial device.
Can only be given once. Will default to first serial port if not provided.

block: Vec<VhostUserParams<DiskOption>>

start a block device.
Possible key values:
vhost=PATH - Path to a vhost-user endpoint to listen to. This parameter must be given in first position.
block options:
See help from crosvm run command.

vsock: Vec<VhostUserParams<VsockConfig>>

start a vsock device.
Possible key values:
vhost=PATH - Path to a vhost-user endpoint to listen to. This parameter must be given in first position.
cid=CID - CID to use for the device.
device=VHOST_DEVICE - path to the vhost-vsock device to use (Linux only). Defaults to /dev/vhost-vsock.

net: Vec<VhostUserParams<NetParameters>>

start a network device.
Possible key values:
vhost=PATH - Path to a vhost-user endpoint to listen to. This parameter must be given in first position.
network options:
See help from the crosvm run command.

control_socket: Option<PathBuf>

path to put the control socket.

Trait Implementations

impl Debug for DevicesCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgs for DevicesCommand

fn from_args(__cmd_name: &[&str], __args: &[&str]) -> Result<Self, EarlyExit>

Construct the type from an input set of arguments.

fn redact_arg_values(
    __cmd_name: &[&str],
    __args: &[&str]
) -> Result<Vec<String>, EarlyExit>

Get a String with just the argument names, e.g., options, flags, subcommands, etc, but without the values of the options and arguments. This can be useful as a means to capture anonymous usage statistics without revealing the content entered by the end user.

impl SubCommand for DevicesCommand

const COMMAND: &'static CommandInfo = _

Information about the subcommand.