Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
EpiJunkie committed May 6, 2016
2 parents 002cfb2 + 4cdcfa6 commit 0a21e97
Show file tree
Hide file tree
Showing 13 changed files with 312 additions and 271 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ resize <name> <diskN> <size>
disks <name>
snap <name>@<snap>
roll <name>@<snap>
clone [-c | -r] <name> <clonename>
clone [-r] <name> <clonename>
export <name>
snaplist
taplist
Expand Down
4 changes: 2 additions & 2 deletions UPDATING
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@

- The `autogrub` property is no longer supported. You can now run what
is in your `autogrub` property in a `grub.cfg` if you set
the `os` property to `os=custom`. More information can be found on the README
https://github.com/pr1ntf/iohyve#use-your-own-custom-grubcfg-and-devicemap-files
the `os` property to `os=custom`. More information can be found on the README
https://github.com/pr1ntf/iohyve#use-your-own-custom-grubcfg-and-devicemap-files
8 changes: 5 additions & 3 deletions iohyve
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ else
exit 1
fi

. /etc/rc.subr

. "${LIB}/ioh-cmd"
. "${LIB}/ioh-setup"
. "${LIB}/ioh-zfs"
Expand All @@ -34,10 +36,10 @@ __version() {
__help() {
cat << 'EOT'
iohyve version
setup <pool=poolname> [kmod=0|1] [net=iface]
list [-l]
setup <pool=poolname> [kmod=0|1] [net=iface]
list [-l]
info [-vsdl]
isolist
isolist
fwlist
fetchiso <URL>
cpiso <path>
Expand Down
28 changes: 14 additions & 14 deletions iohyve.8
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" Text automatically generated by txt2man
.TH iohyve 8 "28 April 2016" "" "FreeBSD System Manager's Manual"
.TH iohyve 8 "30 April 2016" "" "FreeBSD System Manager's Manual"
.SH NAME
\fBiohyve(8) \fP- bhyve manager/launcher v0.7.5 "Tennessee Cherry Moonshine Edition"
\fB
Expand Down Expand Up @@ -41,7 +41,7 @@
\fBiohyve\fP \fIdisks\fP <name>
\fBiohyve\fP \fIsnap\fP <name>@<\fIsnap\fP>
\fBiohyve\fP \fIroll\fP <name>@<\fIsnap\fP>
\fBiohyve\fP \fIclone\fP [\fB-c\fP | \fB-r\fP] <name> <clonename>
\fBiohyve\fP \fIclone\fP [\fB-r\fP] <name> <clonename>
\fBiohyve\fP \fIexport\fP <name>
\fBiohyve\fP \fIsnaplist\fP
\fBiohyve\fP \fItaplist\fP
Expand Down Expand Up @@ -75,11 +75,11 @@ Prints the current running \fIversion\fP of \fBiohyve\fP
.B
\fIsetup\fP
Installs required zfs datasets and kernel modules for \fBiohyve\fP.
Usage: '\fBiohyve\fP \fIsetup\fP <\fIpool\fP=poolname> [kmod=0|1] [\fInet=iface\fP]'
Usage: '\fBiohyve\fP \fIsetup\fP <\fIpool\fP=poolname> [kmod=0|1] [\fInet=iface\fP]'
where <poolname> is the \fIpool\fP you want to \fIinstall\fP \fBiohyve\fP on,
kmod=<0|1> is if you want \fBiohyve\fP to \fIload\fP or unload the
kernel modules required by \fBiohyve\fP. 1 is \fIload\fP. net=<iface>
will \fIset\fP up the network bridge to the specified interface.
will \fIset\fP up the network bridge to the specified interface.
Multiple pools are supported, additional pools \fIget\fP mounted
in /\fBiohyve\fP/poolname
.TP
Expand Down Expand Up @@ -236,7 +236,7 @@ of the guest operating system.
\fIforcekill\fP
Forces the guest to \fIstop\fP. Runs kill \fB-9\fP and destroys the guest
in VMM. USE WITH EXTREME CAUTION AND AS A LAST RESORT. Can be
used to kill guests stuck at the GRUB \fIconsole\fP that you
used to kill guests stuck at the GRUB \fIconsole\fP that you
do not have access to.
.TP
.B
Expand Down Expand Up @@ -280,7 +280,7 @@ Multiple tap : \fBiohyve\fP \fIset\fP [name] tap=tap0,tap1,tap2,tap3
size=size of block device
mac_tap[n]=[MAC Address]
[n] is a generic number to specify the tap interface to use
Forces a specific MAC address to be attached to the
Forces a specific MAC address to be attached to the
network adapter in the guest OS. \fBiohyve\fP does not check
for a valid MAC address, so double check the property.
pcidev:[n]=<spec>
Expand All @@ -305,7 +305,7 @@ property you want to view. (See '\fBiohyve\fP \fIset\fP' \fIinfo\fP)
Removes a pcidev from the guest
Usage: '\fBiohyve\fP \fIrmpci\fP <name> <pcidev:N>' where <name> is the name
of the guest operating system. <pcidev:N> is the PCI
device you want removed. Ex: 'pcidev:3' If [\fB-f\fP] is supplied
device you want removed. Ex: 'pcidev:3' If [\fB-f\fP] is supplied
before the <name>, there is no prompt to \fIremove\fP.
.TP
.B
Expand Down Expand Up @@ -368,19 +368,19 @@ Clone a guest. Note that this will \fIclone\fP all of the properties.
If you want to use the \fIclone\fP and the original guest at the
same time you will need to change the tap and nmdm properties
or use the \fB-r\fP option to have \fBiohyve\fP do this for you
Usage: '\fBiohyve\fP \fIclone\fP [\fB-c\fP | \fB-r\fP] <name> <clonename>' where <name>
Usage: '\fBiohyve\fP \fIclone\fP [\fB-r\fP] <name> <clonename>' where <name>
is the name of the guest and <clonename> is what you would
like to name the new \fIclone\fP.
.TP
.B
\fIexport\fP
Export a guest with all of it's properties and \fIdisks\fP to a
GZip'd tarball. Property file is in a ucl-type format.
Export a guest with all of it's properties and \fIdisks\fP to a
GZip'd tarball. Property file is in a ucl-type format.
Disks output to a raw file, allowing for other managers using
ahci-hd emulation to use them. Tarball is put in the guest
dataset ex: /\fBiohyve\fP/guestname/guestname.tar.gz
Usage: '\fBiohyve\fP \fIexport\fP <name>' where <name> is the name of the
guest.
Usage: '\fBiohyve\fP \fIexport\fP <name>' where <name> is the name of the
guest.
.TP
.B
\fIsnaplist\fP
Expand Down Expand Up @@ -411,7 +411,7 @@ uses \fBcu\fP(1), you will need to press the tilde (~) twice
then period (.) to exit the \fIconsole\fP.
(Think typing ~~. real fast to exit \fIconsole\fP)
If that fails to work, try pressing tilde (~) then press
Control + D (^D). Note that on some machines, you cannot
Control + D (^D). Note that on some machines, you cannot
escape the \fIconsole\fP. See \fIconreset\fP below to escape all consoles.
Usage: '\fBiohyve\fP \fIconsole\fP <name>' where <name> is the name
of the guest operating system.
Expand Down Expand Up @@ -507,5 +507,5 @@ Make an independent \fIclone\fP of a guest:
.SH AUTHOR
Trent -- @pr1ntf
.SH SEE ALSO
\fBbhyve\fP(8), \fBbhyveload\fP(8), \fBzfs\fP(8), \fBnmdm\fP(4),
\fBbhyve\fP(8), \fBbhyveload\fP(8), \fBzfs\fP(8), \fBnmdm\fP(4),
\fBcu\fP(1), \fBif_bridge\fP(4), grub2-\fBbhyve\fP(8)
32 changes: 16 additions & 16 deletions iohyve.8.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ iohyve resize <name> <diskN> <size>
iohyve disks <name>
iohyve snap <name>@<snap>
iohyve roll <name>@<snap>
iohyve clone [-c | -r] <name> <clonename>
iohyve clone [-r] <name> <clonename>
iohyve export <name>
iohyve snaplist
iohyve taplist
Expand All @@ -61,19 +61,19 @@ OPTIONS
version Prints the current running version of iohyve

setup Installs required zfs datasets and kernel modules for iohyve.
Usage: 'iohyve setup <pool=poolname> [kmod=0|1] [net=iface]'
Usage: 'iohyve setup <pool=poolname> [kmod=0|1] [net=iface]'
where <poolname> is the pool you want to install iohyve on,
kmod=<0|1> is if you want iohyve to load or unload the
kernel modules required by iohyve. 1 is load. net=<iface>
will set up the network bridge to the specified interface.
will set up the network bridge to the specified interface.
Multiple pools are supported, additional pools get mounted
in /iohyve/poolname

list Lists the name, status for VMM, active bhyve (Running), boot
on start flag (rcboot), and description for each guest.

-l flag pipes the final output to less

info Lists properties about the guests and their disks using flags
to control level of output. Fields include CPU count, RAM, Disk
Size, Pool, OS, Loader, Tap, Console, VMM status, Running status,
Expand All @@ -88,7 +88,7 @@ info Lists properties about the guests and their disks using flags
-d is for description. Shows the guest description.

-l is for less and pipes the final output to less.

Order of flags is not important. The proper syntax is to use
the flags contiguiously. So "-ld" is the correct way to display
the base output plus description, and then have the output
Expand Down Expand Up @@ -180,7 +180,7 @@ stop Gracefully stops guest operating system.

forcekill Forces the guest to stop. Runs kill -9 and destroys the guest
in VMM. USE WITH EXTREME CAUTION AND AS A LAST RESORT. Can be
used to kill guests stuck at the GRUB console that you
used to kill guests stuck at the GRUB console that you
do not have access to.

scram Gracefully stop all bhyve guests. Does not destroy resources.
Expand Down Expand Up @@ -214,7 +214,7 @@ set Sets ZFS properties for guests one at a time
size=size of block device
mac_tap[n]=[MAC Address]
[n] is a generic number to specify the tap interface to use
Forces a specific MAC address to be attached to the
Forces a specific MAC address to be attached to the
network adapter in the guest OS. iohyve does not check
for a valid MAC address, so double check the property.
pcidev:[n]=<spec>
Expand All @@ -235,7 +235,7 @@ get Gets ZFS properties for guests one at a time
rmpci Removes a pcidev from the guest
Usage: 'iohyve rmpci <name> <pcidev:N>' where <name> is the name
of the guest operating system. <pcidev:N> is the PCI
device you want removed. Ex: 'pcidev:3' If [-f] is supplied
device you want removed. Ex: 'pcidev:3' If [-f] is supplied
before the <name>, there is no prompt to remove.

getall Gets all the ZFS properties for a guest
Expand Down Expand Up @@ -282,17 +282,17 @@ clone Clone a guest. Note that this will clone all of the properties.
If you want to use the clone and the original guest at the
same time you will need to change the tap and nmdm properties
or use the -r option to have iohyve do this for you
Usage: 'iohyve clone [-c | -r] <name> <clonename>' where <name>
Usage: 'iohyve clone [-r] <name> <clonename>' where <name>
is the name of the guest and <clonename> is what you would
like to name the new clone.

export Export a guest with all of it's properties and disks to a
GZip'd tarball. Property file is in a ucl-type format.
export Export a guest with all of it's properties and disks to a
GZip'd tarball. Property file is in a ucl-type format.
Disks output to a raw file, allowing for other managers using
ahci-hd emulation to use them. Tarball is put in the guest
dataset ex: /iohyve/guestname/guestname.tar.gz
Usage: 'iohyve export <name>' where <name> is the name of the
guest.
Usage: 'iohyve export <name>' where <name> is the name of the
guest.

snaplist List all of the snapshots for all the guests. Does not show
snapshots of disks (they are there, though).
Expand All @@ -313,7 +313,7 @@ console Consoles into a guest operating system. Utilizes nmdm(4) and
then period (.) to exit the console.
(Think typing ~~. real fast to exit console)
If that fails to work, try pressing tilde (~) then press
Control + D (^D). Note that on some machines, you cannot
Control + D (^D). Note that on some machines, you cannot
escape the console. See conreset below to escape all consoles.
Usage: 'iohyve console <name>' where <name> is the name
of the guest operating system.
Expand Down Expand Up @@ -408,5 +408,5 @@ AUTHOR
Trent -- @pr1ntf

SEE ALSO
bhyve(8), bhyveload(8), zfs(8), nmdm(4),
bhyve(8), bhyveload(8), zfs(8), nmdm(4),
cu(1), if_bridge(4), grub2-bhyve(8)
Loading

0 comments on commit 0a21e97

Please sign in to comment.