direct-io.hg

changeset 7860:88c2d4bbe7c9

This patch explains network-* options in xm.1, including the bits that are
currently not really working.

Signed off by: Sean Dague <sean@dague.net>
author emellor@leeni.uk.xensource.com
date Thu Nov 17 12:01:13 2005 +0100 (2005-11-17)
parents c2f0ed9158ad
children 9a8110cb09bd
files docs/man/xm.pod.1
line diff
     1.1 --- a/docs/man/xm.pod.1	Thu Nov 17 11:58:36 2005 +0100
     1.2 +++ b/docs/man/xm.pod.1	Thu Nov 17 12:01:13 2005 +0100
     1.3 @@ -550,10 +550,10 @@ will be allowed to run before being pree
     1.4  
     1.5  =item B<sched-sedf> I<period> I<slice> I<latency-hint> I<extratime> I<weight>
     1.6  
     1.7 -Set Simple EDF scheduler parameters.  This scheduler provides weighted
     1.8 -CPU sharing in an intuitive way and uses realtime-algorithms to ensure
     1.9 -time guarantees.  For more information see
    1.10 -docs/misc/sedf_scheduler_mini-HOWTO.txt in the Xen distribution.
    1.11 +Set Simple EDF (Earliest Deadline First) scheduler parameters.  This
    1.12 +scheduler provides weighted CPU sharing in an intuitive way and uses
    1.13 +realtime-algorithms to ensure time guarantees.  For more information
    1.14 +see docs/misc/sedf_scheduler_mini-HOWTO.txt in the Xen distribution.
    1.15  
    1.16  B<PARAMETERS>
    1.17  
    1.18 @@ -640,11 +640,54 @@ sexpression formatted.
    1.19  
    1.20  =head2 NETWORK DEVICES
    1.21  
    1.22 -=item B<network-attach> I<domain-id> I<[script=script]> I<[ip=ipaddr]>
    1.23 +=item B<network-attach> I<domain-id> I<[script=scriptname]> I<[ip=ipaddr]>
    1.24  I<[mac=macaddr]> I<[bridge=bridge-name]> I<[backend=bedomain-id]>
    1.25  
    1.26 +Creates a new network device in the domain specified by domain-id.  It
    1.27 +takes the following optional options:
    1.28 +
    1.29 +B<OPTIONS>
    1.30 +
    1.31 +=over 4
    1.32 +
    1.33 +=item I<script=scriptname>
    1.34 +
    1.35 +Use the specified script name to bring up the network.  Defaults to
    1.36 +the default setting in xend-config.sxp for I<vif-script>.
    1.37 +
    1.38 +=item I<ip=ipaddr>
    1.39 +
    1.40 +Passes the specified IP Address to the adapter on creation.  
    1.41 +
    1.42 +FIXME: this currently appears to be B<broken>.  I'm not sure under what
    1.43 +circumstances this should actually work.
    1.44 +
    1.45 +=item I<mac=macaddr>
    1.46 +
    1.47 +The MAC address that the domain will see on its ethernet device.  If
    1.48 +the device is not specified it will be randomly generated with the
    1.49 +00:16:3e vendor id prefix.
    1.50 +
    1.51 +=item I<bridge=bridge-name>
    1.52 +
    1.53 +The name of the bridge to attach the vif to, in case you have more
    1.54 +than one.  This defaults to 
    1.55 +
    1.56 +=item I<backend=bedomain-id>
    1.57 +
    1.58 +The backend domain id.  By default this is domain 0.
    1.59 +
    1.60 +=back
    1.61 +
    1.62  =item B<network-detach> I<domain-id> I<devid>
    1.63  
    1.64 +Removes the network device from the domain specified by I<domain-id>.
    1.65 +I<devid> is the virtual interface device number within the domain
    1.66 +(i.e. the 3 in vif22.3).
    1.67 +
    1.68 +FIXME: this is currently B<broken>.  Network devices aren't completely
    1.69 +removed from domain 0.
    1.70 +
    1.71  =item B<network-list> I<domain-id>
    1.72  
    1.73  List virtual network interfaces for a domain.  The returned output is