Commit 085dfc6e authored by Paul John King's avatar Paul John King

Update and generate README

parent 3c937a5a
......@@ -12,10 +12,11 @@ Pool Commands
The command call
kvm_tool create pool «name» «path»
kvm_tool create pool [-x] «name» «path»
creates a directory-type storage pool with the name `«name»` under the path
`«path»`.
`«path»`. The `-x` option outputs to standard output the `libvirt` XML
that would be used to create the pool, but does not create it.
The command call
......@@ -53,11 +54,13 @@ Volume Commands
The command call
kvm_tool create volume «name» «pool» «path»
kvm_tool create volume [-x] «name» «pool» «path»
creates a qcow2 storage volume with the name `«name»` in the storage pool
`«pool»` with the qcow2 file-system image at the path `«path»` as its backing
storage volume.
`«pool»` and the qcow2 file-system image at the path `«path»` as its
backing storage volume. The `-x` option outputs to standard output the
`libvirt` XML that would be used to create the volume, but does not create
it.
The command call
......@@ -98,21 +101,29 @@ Domain Commands
The command call
kvm_tool create domain [-m «mac_address»] «name» «cpu_count» «ram» «path» «bridge»
kvm_tool create domain [-c «connection_1»] ... [-c «connection_n»] [-s] [-a] [-x] «name» «socket_count» «core_count» «thread_count» «ram» «path»
creates a KVM domain with the name `«name»`, `«cpu_count»` CPUs, `«ram»` MiB of
RAM, the file-system image at the path `«path»`, and a connection to the bridge
device `«bridge»` (with the MAC address `«mac_address»` if the `-m` option is
used).
creates a KVM domain with the name `«name»`, `«socket_count»` CPU sockets,
`«core_count»` cores per CPU socket, `«thread_count»` threads per core,
`«ram»` MiB of RAM, and the file-system image at the path `«path»`. The
option
-c «bridge»[,«mac_address»]
adds a connection to the bridge `«bridge»`, and optionally gives the
connecting device the MAC address `«mac_address»`. The option can be used
any number of times. The option `-s` starts the domain after creation. The
option `-a` configures `libvirt` to automatically start the domain when the
KVM host boots. The `-x` option outputs to standard output the XML that
`libvirt` would use to create the domain, but does not create it.
The command call
kvm_tool examine domain «name»
outputs the CPU count, the RAM, the RAM units, a path to the file-system image,
the bridge device and the MAC address of the KVM domain with the name `«name»`
as Bourne-shell variable assignments (suitable for shell evaluation) and
returns
outputs the CPU socket, core and thread counts, the RAM, the RAM units, and a
path to the file-system image of the KVM domain with the name `«name»` as
Bourne-shell variable assignments (suitable for shell evaluation) and returns
* 0 if the domain exists, and
......@@ -120,14 +131,13 @@ returns
The command call
kvm_tool verify domain [-m «mac_address»] «name» «cpu_count» «ram» «path» «bridge»
kvm_tool verify domain «name» «socket_count» «core_count» «thread_count» «ram» «path»
returns
* 0 if a KVM domain with the name `«name»`, `«cpu_count»` CPUs, `«ram»` MiB
of RAM, the file-system image at the path `«path»`, and a connection to the
bridge device `«bridge»` (with the MAC address `«mac_address»` if the `-m`
option is used) exists,
* 0 if a KVM domain with the name `«name»`, `«socket_count»` CPU sockets,
`«core_count»` cores per CPU socket, `«thread_count»` threads per core,
`«ram»` MiB of RAM, and the file-system image at the path `«path»` exists,
* 1 if a KVM domain with the name `«name»` but other parameters exists, and
......@@ -135,41 +145,48 @@ returns
The command call
kvm_tool destroy domain «name»
kvm_tool destroy domain [-s] «name»
destroys the domain with the name `«name»`, as well as any managed save image
and snapshots. If the domain is running then it continues to run but will be
destroyed when stopped.
and snapshots. The option `-s` shuts the domain down before destruction,
otherwise if the domain is running then it continues to run but will be
destroyed when eventually shut down.
Machine Commands
----------------
The command call
kvm_tool create machine [-i «ipv4_address»] «name» «cpu_count» «ram» «path» «bridge»
kvm_tool create machine [-c «connection_1»] ... [-c «connection_n»] [-s] [-a] [-x] «name» «socket_count» «core_count» «thread_count» «ram» «pool» «path»
creates a KVM domain with the name `«name»`, cpu_count»` CPUs, `«ram»` MiB of
RAM, a qcow2 storage volume with the name `«name»` in the `default` storage
pool with the qcow2 file-system image at the path `«path»` as its backing
storage volume, and a connection to the bridge device `«bridge»` (with the MAC
address output by
creates a KVM domain with the name `«name»`, socket_count»` CPU sockets,
`«core_count»` cores per CPU socket, `«thread_count»` threads per core,
`«ram»` MiB of RAM, and a qcow2 storage volume with the name `«name»` in
the storage pool `«pool»` and the qcow2 file-system image at the path
`«path»` as its backing storage volume. The option
kvm_tool get mac address «ipv4_address»
-c «bridge»[,«ipv4_address»]
if the `-i` option is used - run
adds a connection to the bridge `«bridge»`, and optionally gives the
connecting device the MAC address `«mac_address»`, where `«mac_address»` is
that output by
kvm_tool help utility
kvm_tool get mac address «ipv4_address»
for details).
The option can be used any number of times. The option `-s` starts the
domain after creation. The option `-a` configures `libvirt` to
automatically start the domain when the KVM host boots. The `-x` option
outputs to standard output the XML that `libvirt` would use to create the
domain, but does not create it.
The command call
kvm_tool examine machine «name»
outputs the CPU count, the RAM, the RAM units, a path to the file-system image,
a path to the backing file-sytem image, the bridge device and the MAC address
of the KVM domain with the name `«name»` as Bourne-shell variable assignments
(suitable for shell evaluation) and returns
outputs the CPU socket, core and thread counts, the RAM, the RAM units, and
paths to the file-system image and the backing file-sytem image of the KVM
domain with the name `«name»` as Bourne-shell variable assignments (suitable
for shell evaluation) and returns
* 0 if the domain exists, and
......@@ -177,34 +194,29 @@ of the KVM domain with the name `«name»` as Bourne-shell variable assignments
The command call
kvm_tool verify machine [-i «ipv4_address»] «name» «cpu_count» «ram» «path» «bridge»
kvm_tool verify machine «name» «socket_count» «core_count» «thread_count» «ram» «pool» «path»
returns
* 0 if a KVM domain with the name `«name»`, `«cpu_count»` CPUs, `«ram»` MiB
of RAM, a qcow2 storage volume with the name `«name»` in the `default`
storage pool with the qcow2 file-system image at the path `«path»` as its
backing storage volume, and a connection to the bridge device `«bridge»`
(with the MAC address output by
kvm_tool get mac address «ipv4_address»
* 0 if a KVM domain with the name `«name»`, `«socket_count»` CPU sockets,
`«core_count»` cores per CPU socket, `«thread_count»` threads per core,
`«ram»` MiB of RAM, and a qcow2 storage volume with the name `«name»` in
the storage pool `«pool»` with the qcow2 file-system image at the path
`«path»` as its backing storage volume exists,
if the `-i` option is used - run
kvm_tool help utility
for details) exists,
* 1 is a KVM domain with the name `«name»` but other parameters exists, and
* 1 if a KVM domain with the name `«name»` but other parameters exists, and
* 2 if no KVM domain with the name `«name»` exists.
The command call
kvm_tool destroy machine «name»
kvm_tool destroy machine [-s] «name»
destroys the domain with the name `«name»` and the storage volume with the
name `«name»` in the `default` storage pool.
name `«name»` in the `default` storage pool, as well as any managed save
image and snapshot. The option `-s` shuts the domain down before
destruction, otherwise if the domain is running then it continues to run but
will be destroyed when eventually shut down.
Utility Commands
----------------
......@@ -214,9 +226,9 @@ The command call
kvm_tool get connection uri [«user»@]«host»
outputs Bourne-shell instructions that first assign a `virsh` SSH-connection
URI for the host `«host»` (optionally, as the user `«user»`) to the variable
`VIRSH_DEFAULT_CONNECT_URI`, and then export the variable. Evaluating the
output of the the call, for example, by running the command
URI for the host `«host»` (optionally, as the user `«user»`) to the
variable `VIRSH_DEFAULT_CONNECT_URI`, and then export the variable.
Evaluating the output of the the call, for example, by running the command
eval $(kvm_tool get connection uri fred@flintstone.bedrock.bc)
......
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment