-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
275 additions
and
79 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Propolis CLI | ||
|
||
The `propolis-cli` utility provides a user-friendly frontend to the | ||
[`propolis-server`](../propolis-server) REST API. | ||
|
||
## Getting started | ||
|
||
The easiest way to launch a VM via the CLI is to write a TOML file describing | ||
the VM's configuration. An example of such a file might be the following: | ||
|
||
```toml | ||
[block_dev.alpine_iso] | ||
type = "file" | ||
path = "/path/to/alpine-extended-3.12.0-x86_64.iso" | ||
|
||
[dev.block0] | ||
driver = "pci-virtio-block" | ||
block_dev = "alpine_iso" | ||
pci-path = "0.4.0" | ||
|
||
[dev.net0] | ||
driver = "pci-virtio-viona" | ||
vnic = "vnic_name" | ||
pci-path = "0.5.0" | ||
``` | ||
|
||
To create and run a Propolis VM using this configuration: | ||
|
||
``` | ||
# propolis-cli -s <server ip> -p <port> new --config-toml <path> <VM name> | ||
# propolis-cli -s <server ip> -p <port> state run | ||
``` | ||
|
||
To connect to the VM's serial console: | ||
|
||
``` | ||
# propolis-cli -s <server ip> -p <port> serial | ||
``` | ||
|
||
Run `propolis-cli --help` to see the full list of supported commands and their | ||
arguments. |
Oops, something went wrong.