ia64/xen-unstable

changeset 18537:c6f80d1227cb

xm docs: Added new,delete,dump-core,resume,suspend,uptime and fixed others

Signed-off-by: Bill Rieske <brieske@novell.com>
author Keir Fraser <keir.fraser@citrix.com>
date Wed Sep 24 10:17:18 2008 +0100 (2008-09-24)
parents f4552d9f6afb
children 2842dbc5679c
files docs/man/xm.pod.1
line diff
     1.1 --- a/docs/man/xm.pod.1	Tue Sep 23 17:11:33 2008 +0100
     1.2 +++ b/docs/man/xm.pod.1	Wed Sep 24 10:17:18 2008 +0100
     1.3 @@ -67,13 +67,12 @@ The attached console will perform much l
     1.4  so running curses based interfaces over the console B<is not
     1.5  advised>.  Vi tends to get very odd when using it over this interface.
     1.6  
     1.7 -=item B<create> [B<-c>] I<configfile> [I<name>=I<value>]..
     1.8 +=item B<create> I<configfile> [I<OPTIONS>] [I<vars>]..
     1.9  
    1.10 -The create sub command requires a config file and can optionally take a
    1.11 -series of name value pairs that add to or override variables defined
    1.12 +The create subcommand requires a config file and can optionally take a
    1.13 +series of I<vars> that add to or override variables defined
    1.14  in the config file.  See L<xmdomain.cfg> for full details of that file
    1.15 -format, and possible options used in either the configfile or
    1.16 -I<name>=I<value> combinations.
    1.17 +format, and possible options used in either the configfile or for I<vars>.
    1.18  
    1.19  I<configfile> can either be an absolute path to a file, or a relative
    1.20  path to a file located in /etc/xen.
    1.21 @@ -86,9 +85,65 @@ B<OPTIONS>
    1.22  
    1.23  =over 4 
    1.24  
    1.25 -=item B<-c>
    1.26 +=item B<--help_config>
    1.27  
    1.28 -Attache console to the domain as soon as it has started.  This is
    1.29 +Print the available configuration variables I<vars>.  These variables may be
    1.30 +used on the command line or in the configuration file I<configfile>.
    1.31 +
    1.32 +=item B<-q>, B<--quiet>
    1.33 +
    1.34 +No console output.
    1.35 +
    1.36 +=item B<--path>
    1.37 +
    1.38 +Search path for configuration scripts. The value of PATH is a 
    1.39 +colon-separated directory list.
    1.40 +
    1.41 +=item B<-f=FILE>, B<--defconfig=FILE>
    1.42 +
    1.43 +Use the given Python configuration script. The configuration 
    1.44 +script is loaded after arguments have been processed. Each 
    1.45 +command-line option sets a configuration variable named after 
    1.46 +its long option name, and these variables are placed in the
    1.47 +environment of the script before it is loaded. Variables 
    1.48 +for options that may be repeated have list values. Other 
    1.49 +variables can be set using name=value on the command line. 
    1.50 +After the script is loaded, option values that were not set 
    1.51 +on the command line are replaced by the values set in the script.
    1.52 +
    1.53 +=item B<-F=FILE>, B<--config=FILE>
    1.54 +
    1.55 +Use the given SXP formated configuration script.
    1.56 +SXP is the underlying configuration format used by Xen.
    1.57 +SXP configuration scripts can be hand-written or generated
    1.58 +from Python configuration scripts, using the -n
    1.59 +(dryrun) option to print the configuration.  An SXP formatted
    1.60 +configuration file may also be generated for a given I<domain-id> by 
    1.61 +redirecting the output from the the B<xm list --long I<domain-id>> 
    1.62 +to a file.
    1.63 +
    1.64 +=item B<-n>, B<--dryrun>
    1.65 +
    1.66 +Dry run - prints the resulting configuration in SXP
    1.67 +but does not create the domain.
    1.68 +
    1.69 +=item B<-x>, B<--xmldryrun>
    1.70 +
    1.71 +XML dry run - prints the resulting configuration in
    1.72 +XML but does not create the domain.
    1.73 +
    1.74 +=item B<-s>, B<--skipdtd>
    1.75 +
    1.76 +Skip DTD checking - skips checks on XML before
    1.77 +creating. Experimental. Can decrease create time.
    1.78 +
    1.79 +=item B<-p>, B<--paused>
    1.80 +
    1.81 +Leave the domain paused after it is created.
    1.82 +
    1.83 +=item B<-c>, B<--console_autoconnect>
    1.84 +
    1.85 +Attach console to the domain as soon as it has started.  This is
    1.86  useful for determining issues with crashing domains.
    1.87  
    1.88  =back
    1.89 @@ -118,6 +173,11 @@ virtual networking.  (This example comes
    1.90  
    1.91  =back
    1.92  
    1.93 +=item B<delete>
    1.94 +
    1.95 +Remove a domain from Xend domain management. The B<xm list> command
    1.96 +shows the domain names.
    1.97 +
    1.98  =item B<destroy> I<domain-id>
    1.99  
   1.100  Immediately terminate the domain I<domain-id>.  This doesn't give the
   1.101 @@ -133,6 +193,28 @@ Converts a domain name to a domain id us
   1.102  
   1.103  Converts a domain id to a domain name using xend's internal mapping.
   1.104  
   1.105 +=item B<dump-core> [I<OPTIONS>] I<domain-id> [I<filename>]
   1.106 +
   1.107 +Dumps the virtual machine's memory for the specified domain to the
   1.108 +I<filename> specified.  The dump file will be written to a distribution
   1.109 +specific directory for dump files.  Such as: /var/lib/xen/dump or 
   1.110 +/var/xen/dump  Defaults to dumping the core without pausing the domain
   1.111 +if no I<OPTIONS> are specified.
   1.112 +
   1.113 +B<OPTIONS>
   1.114 +
   1.115 +=over 4
   1.116 +
   1.117 +=item B<-L>, B<--live>
   1.118 +
   1.119 +Dump core without pausing the domain.
   1.120 +
   1.121 +=item B<-C>, B<--crash>
   1.122 +
   1.123 +Crash domain after dumping core.
   1.124 +
   1.125 +=back
   1.126 +
   1.127  =item B<help> [B<--long>]
   1.128  
   1.129  Displays the short help message (i.e. common commands).
   1.130 @@ -140,11 +222,36 @@ Displays the short help message (i.e. co
   1.131  The B<--long> option prints out the complete set of B<xm> subcommands,
   1.132  grouped by function.
   1.133  
   1.134 -=item B<list> [B<--long> | B<--label>] [I<domain-id> ...]
   1.135 +=item B<list> [I<OPTIONS>] [I<domain-id> ...]
   1.136  
   1.137  Prints information about one or more domains.  If no domains are
   1.138  specified it prints out information about all domains.
   1.139  
   1.140 +
   1.141 +B<OPTIONS>
   1.142 +
   1.143 +=over 4
   1.144 +
   1.145 +=item B<-l>, B<--long>
   1.146 +
   1.147 +The output for B<xm list> is not the table view shown below, but 
   1.148 +instead presents the data in SXP format.
   1.149 +
   1.150 +=item B<--label>
   1.151 +
   1.152 +Security labels are added to the output of xm list and the lines 
   1.153 +are sorted by the labels (ignoring case). 
   1.154 +See the ACCESS CONTROL SUBCOMMAND section of this man page for more 
   1.155 +information about labels.
   1.156 +
   1.157 +=item B<--state=<state>>
   1.158 +
   1.159 +Output information for VMs in the specified state.
   1.160 +
   1.161 +=back
   1.162 +
   1.163 +B<EXAMPLE>
   1.164 +
   1.165  An example format for the list is as follows:
   1.166  
   1.167      Name                         ID Mem(MiB) VCPUs State  Time(s)
   1.168 @@ -164,11 +271,11 @@ Xen.
   1.169  
   1.170  B<STATES>
   1.171  
   1.172 -=over 4
   1.173 -
   1.174  The State field lists 6 states for a Xen domain, and which ones the
   1.175  current domain is in.
   1.176  
   1.177 +=over 4
   1.178 +
   1.179  =item B<r - running>
   1.180  
   1.181  The domain is currently running on a CPU.
   1.182 @@ -205,32 +312,6 @@ FIXME: Is this right?
   1.183  
   1.184  =back
   1.185  
   1.186 -B<LONG OUTPUT>
   1.187 -
   1.188 -=over 4
   1.189 -
   1.190 -If B<--long> is specified, the output for B<xm list> is not the table
   1.191 -view shown above, but instead is an S-Expression representing all
   1.192 -information known about all domains asked for.  This is mostly only
   1.193 -useful for external programs to parse the data.
   1.194 -
   1.195 -B<Note:> There is no stable guarantees on the format of this data.
   1.196 -Use at your own risk.
   1.197 -
   1.198 -=back
   1.199 -
   1.200 -B<LABEL OUTPUT>
   1.201 -
   1.202 -=over 4
   1.203 -
   1.204 -If B<--label> is specified, the security labels are added to the
   1.205 -output of B<xm list> and the lines are sorted by the labels (ignoring
   1.206 -case). The B<--long> option prints the labels by default and cannot be
   1.207 -combined with B<--label>. See the ACCESS CONTROL SUBCOMMAND section of
   1.208 -this man page for more information about labels.
   1.209 -
   1.210 -==back
   1.211 -
   1.212  B<NOTES>
   1.213  
   1.214  =over 4
   1.215 @@ -296,6 +377,90 @@ attempting to do other useful work.
   1.216  
   1.217  =back
   1.218  
   1.219 +=item B<new> I<configfile> [I<OPTIONS>] [I<vars>]...
   1.220 +
   1.221 +Adds a domain to Xend domain management.
   1.222 +
   1.223 +The new subcommand requires a config file and can optionally 
   1.224 +take a series of I<vars> that add to or override variables 
   1.225 +defined in the config file.  See xmdomain.cfg for full details of that 
   1.226 +file format, and possible options used in either the configfile or for
   1.227 +I<vars>.
   1.228 +
   1.229 +I<configfile> can either be an absolute path to a file, or a relative 
   1.230 +path to a file located in /etc/xen.
   1.231 +
   1.232 +The new subcommand will return without starting the domain.  The 
   1.233 +domain needs to be started using the B<xm start> command.
   1.234 +
   1.235 +B<OPTIONS>
   1.236 +
   1.237 +=over 4
   1.238 +
   1.239 +=item B<--help_config>
   1.240 +
   1.241 +Print the available configuration variables I<vars>.  These variables may be
   1.242 +used on the command line or in the configuration file I<configfile>.
   1.243 +
   1.244 +=item B<-q>, B<--quiet>
   1.245 +
   1.246 +No console output.
   1.247 +
   1.248 +=item B<--path>
   1.249 +
   1.250 +Search path for configuration scripts. The value of PATH is a 
   1.251 +colon-separated directory list.
   1.252 +
   1.253 +=item B<-f=FILE>, B<--defconfig=FILE>
   1.254 +
   1.255 +
   1.256 +Use the given Python configuration script. The configuration 
   1.257 +script is loaded after arguments have been processed. Each 
   1.258 +command-line option sets a configuration variable named after 
   1.259 +its long option name, and these variables are placed in the
   1.260 +environment of the script before it is loaded. Variables 
   1.261 +for options that may be repeated have list values. Other 
   1.262 +variables can be set using name=value on the command line. 
   1.263 +After the script is loaded, option values that were not set 
   1.264 +on the command line are replaced by the values set in the script.
   1.265 +
   1.266 +=item B<-F=FILE>, B<--config=FILE>
   1.267 +
   1.268 +Use the given SXP formated configuration script.
   1.269 +SXP is the underlying configuration format used by Xen.
   1.270 +SXP configuration scripts can be hand-written or generated
   1.271 +from Python configuration scripts, using the -n
   1.272 +(dryrun) option to print the configuration.  An SXP formatted
   1.273 +configuration file may also be generated for a given I<domain-id> by 
   1.274 +redirecting the output from the the B<xm list --long I<domain-id>> 
   1.275 +to a file.
   1.276 +
   1.277 +=item B<-n>, B<--dryrun>
   1.278 +
   1.279 +Dry run - prints the resulting configuration in SXP
   1.280 +but does not create the domain.
   1.281 +
   1.282 +=item B<-x>, B<--xmldryrun>
   1.283 +
   1.284 +XML dry run - prints the resulting configuration in
   1.285 +XML but does not create the domain.
   1.286 +
   1.287 +=item B<-s>, B<--skipdtd>
   1.288 +
   1.289 +Skip DTD checking - skips checks on XML before
   1.290 +creating. Experimental. Can decrease create time.
   1.291 +
   1.292 +=item B<-p>, B<--paused>
   1.293 +
   1.294 +Leave the domain paused after it is created.
   1.295 +
   1.296 +=item B<-c>, B<--console_autoconnect>
   1.297 +
   1.298 +Attach console to the domain as soon as it has started.  This is
   1.299 +useful for determining issues with crashing domains.
   1.300 +
   1.301 +=back
   1.302 +
   1.303  =item B<pause> I<domain-id>
   1.304  
   1.305  Pause a domain.  When in a paused state the domain will still consume
   1.306 @@ -332,6 +497,22 @@ as all services in the domain will have 
   1.307  
   1.308  Build a domain from an B<xm save> state file.  See B<save> for more info.
   1.309  
   1.310 +=item B<resume> I<domain-name> [I<OPTIONS>]
   1.311 +
   1.312 +Moves a domain out of the suspended state and back into memory.  
   1.313 +
   1.314 +B<OPTIONS>
   1.315 +
   1.316 +=over 4
   1.317 +
   1.318 +=item B<-p>, <--paused>
   1.319 +
   1.320 +Moves a domain back into memory but leaves the domain in a paused state.
   1.321 +The B<xm unpause> subcommand may then be used to bring it out of the 
   1.322 +paused state.
   1.323 +
   1.324 +=back
   1.325 +
   1.326  =item B<save> I<domain-id> I<state-file>
   1.327  
   1.328  Saves a running domain to a state file so that it can be restored
   1.329 @@ -370,6 +551,31 @@ Wait for the domain to complete shutdown
   1.330  
   1.331  =back
   1.332  
   1.333 +=item B<start> I<domain-name> [I<OPTIONS>]
   1.334 +
   1.335 +Start a Xend managed domain that was added using the B<xm new> command.
   1.336 +
   1.337 +
   1.338 +B<OPTIONS>
   1.339 +
   1.340 +=over 4
   1.341 +
   1.342 +=item B<-p>, B<--paused>
   1.343 +
   1.344 +Do not unpause domain after starting it.
   1.345 +
   1.346 +=item B<-c>, B<--console_autoconnect>
   1.347 +
   1.348 +Connect to the console after the domain is created.
   1.349 +
   1.350 +=back
   1.351 +
   1.352 +=item B<suspend> I<domain-name>
   1.353 +
   1.354 +Suspend a domain to a state file so that it can be later
   1.355 +resumed using the B<xm resume> subcommand.  Similar to the B<xm save> 
   1.356 +subcommand although the state file may not be specified.
   1.357 +
   1.358  =item B<sysrq> I<domain-id> I<letter>
   1.359  
   1.360  Send a I<Magic System Request> signal to the domain.  For more
   1.361 @@ -477,11 +683,11 @@ page more readable):
   1.362  
   1.363  B<FIELDS>
   1.364  
   1.365 -=over 4
   1.366 -
   1.367  Not all fields will be explained here, but some of the less obvious
   1.368  ones deserve explanation:
   1.369  
   1.370 +=over 4
   1.371 +
   1.372  =item B<hw_caps>
   1.373  
   1.374  A vector showing what hardware capabilities are supported by your
   1.375 @@ -515,6 +721,10 @@ Executes the B<xentop> command, which pr
   1.376  domains.  Xentop is a curses interface, and reasonably self
   1.377  explanatory.
   1.378  
   1.379 +=item B<uptime>
   1.380 +
   1.381 +Prints the current uptime of the domains running.
   1.382 +
   1.383  =back
   1.384  
   1.385  =head1 SCHEDULER SUBCOMMANDS
   1.386 @@ -698,14 +908,20 @@ in the domain.
   1.387  List virtual block devices for a domain.  The returned output is
   1.388  formatted as a list or as an S-Expression if the B<--long> option was given.
   1.389  
   1.390 +=back
   1.391 +
   1.392  =head2 NETWORK DEVICES
   1.393  
   1.394 +=over 4
   1.395 +
   1.396  =item B<network-attach> I<domain-id> [B<script=>I<scriptname>] [B<ip=>I<ipaddr>]
   1.397  [B<mac=>I<macaddr>] [B<bridge=>I<bridge-name>] [B<backend=>I<bedomain-id>]
   1.398  
   1.399  Creates a new network device in the domain specified by I<domain-id>.  It
   1.400  takes the following optional options:
   1.401  
   1.402 +=back
   1.403 +
   1.404  B<OPTIONS>
   1.405  
   1.406  =over 4
   1.407 @@ -739,6 +955,8 @@ The backend domain id.  By default this 
   1.408  
   1.409  =back
   1.410  
   1.411 +=over 4
   1.412 +
   1.413  =item B<network-detach> I<domain-id> I<devid>
   1.414  
   1.415  Removes the network device from the domain specified by I<domain-id>.
   1.416 @@ -753,8 +971,12 @@ removed from domain 0.
   1.417  List virtual network interfaces for a domain.  The returned output is
   1.418  formatted as a list or as an S-Expression if the B<--long> option was given.
   1.419  
   1.420 +=back
   1.421 +
   1.422  =head2 VIRTUAL TPM DEVICES
   1.423  
   1.424 +=over 4
   1.425 +
   1.426  =item B<vtpm-list> [B<-l>|B<--long>] I<domain-id>
   1.427  
   1.428  Show the virtual TPM device for a domain.  The returned output is
   1.429 @@ -828,6 +1050,8 @@ security in Xen, you must compile Xen wi
   1.430  described under "Configuring Security" below. There, you will find
   1.431  also examples of each subcommand described here.
   1.432  
   1.433 +=over 4
   1.434 +
   1.435  =item B<setpolicy> ACM I<policy>
   1.436  
   1.437  Makes the given ACM policy available to xend as a I<xend-managed policy>.
   1.438 @@ -836,6 +1060,8 @@ version of the policy is created. The po
   1.439  bootloader is prepared to boot the system with this policy the next time
   1.440  it is started.
   1.441  
   1.442 +=back
   1.443 +
   1.444  =over 4
   1.445  
   1.446  I<policy> is a dot-separated list of names. The last part is the file
   1.447 @@ -849,6 +1075,8 @@ global policy root directory.
   1.448  
   1.449  =back
   1.450  
   1.451 +=over 4
   1.452 +
   1.453  =item B<resetpolicy>
   1.454  
   1.455  Reset the system's policy to the default state where the DEFAULT policy
   1.456 @@ -1155,6 +1383,8 @@ their binary identifiers (ssidrefs) used
   1.457  
   1.458  =back
   1.459  
   1.460 +=back
   1.461 +
   1.462  =head1 SEE ALSO
   1.463  
   1.464  B<xmdomain.cfg>(5), B<xentop>(1)