External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-07-31 22:17:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

virsh: clean up attach-interface paragraph in man page

Browse Source 
This makes the paragaph about attach-interface more descriptive and
correct, adding in a few bits of information that were previously
missing, e.g. --script is only allowed for bridge interfaces of Xen
domains, target name is regenerated if it starts with vnet, mac
address will be autogenerated if not specified.

(I did this in response to an email asking why a script couldn't be
specified for a bridge interface of a qemu domain, and why an
interface of type='ethernet' couldn't be created with
attach-interface)
This commit is contained in:
Laine Stump 2014-08-07 10:50:21 -04:00
parent 2381af474b
commit f91aa93149
1 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
tools/virsh.pod
View File

@ -2202,19 +2202,29 @@ Likewise, I<--shareable> is an alias for I<--mode shareable>.
[I<--target target>] [I<--mac mac>] [I<--script script>] [I<--model model>] [I<--target target>] [I<--mac mac>] [I<--script script>] [I<--model model>]
[I<--config>] [I<--inbound average,peak,burst>] [I<--outbound average,peak,burst>] [I<--config>] [I<--inbound average,peak,burst>] [I<--outbound average,peak,burst>]
Attach a new network interface to the domain. I<type> can be either I<network> Attach a new network interface to the domain. I<type> can be either
to indicate a physical network device or I<bridge> to indicate a bridge to a I<network> to indicate connection via a libvirt virtual network or
device. I<source> indicates the source device. I<target> allows to indicate I<bridge> to indicate connection via a bridge device on the host.
the target device in the guest. Names starting with 'vnet' are considered as I<source> indicates the source of the connection (either the name of a
auto-generated an hence blanked out. I<mac> allows to specify the MAC address network, or of a bridge device). I<target> is used to specify the
of the network interface. I<script> allows to specify a path to a script tap/macvtap device to be used to connect the domain to the
handling a bridge instead of the default one. I<model> allows to specify the source. Names starting with 'vnet' are considered as auto-generated
model type. I<inbound> and I<outbound> control the bandwidth of the interface. and are blanked out/regenerated each time the interface is attached.
I<peak> and I<burst> are optional, so "average,peak", "average,,burst" and I<mac> specifies the MAC address of the network interface; if a MAC
"average" are also legal. Values for I<average> and I<peak> are address is not given, a new address will be automatically generated
expressed in kilobytes per second, while I<burst> is expressed in kilobytes (and stored in the persistent configuration if "--config" is given on
in a single burst at -I<peak> speed as described in the Network XML the commandline). I<script> is used to specify a path to a custom
documentation at L<http://libvirt.org/formatnetwork.html#elementQoS>. script to be called while attaching to a bridge - this will be called
instead of the default script not in addition to it; --script is valid
only for interfaces of type I<bridge> and only for Xen domains.
I<model> specifies the network device model to be presented to the
domain. I<inbound> and I<outbound> control the bandwidth of the
interface. I<peak> and I<burst> are optional, so "average,peak",
"average,,burst" and "average" are also legal. Values for I<average>
and I<peak> are expressed in kilobytes per second, while I<burst> is
expressed in kilobytes in a single burst at -I<peak> speed as
described in the Network XML documentation at
L<http://libvirt.org/formatnetwork.html#elementQoS>.
If I<--live> is specified, affect a running domain. If I<--live> is specified, affect a running domain.
If I<--config> is specified, affect the next startup of a persistent domain. If I<--config> is specified, affect the next startup of a persistent domain.