view tools/control/doc/USAGE-cmdline @ 639:4515f4d0701f

bitkeeper revision 1.335 (3f0d61daWuAj1MdY8xaA6enqSDZSEg)

Documentation update.
date Thu Jul 10 12:53:46 2003 +0000 (2003-07-10)
children 4750dfc4d829
line source
1 General
2 -------
4 Invoking xenctl with no arguments, or with 'help' gives general usage
5 xenctl help command, or xenctl command -?, gives specific command help
7 Domain control
8 --------------
10 xenctl's command line interface is based on domctl. Defaults for domain
11 creation are found in /etc/domctl.xml.
13 Creating a domain: xenctl domain new <parameters>
14 All parameters may be omitted to get defaults from domctl.xml, see help
15 for ful details of available parameters.
17 Starting a domain: xenctl domain start -n<domain_no>
18 Stopping a domain: xenctl domain stop -n<domain_no>
19 Destroying a domain: xenctl domain destroy -n<domain_no> (add -f to force
20 destruction of a running domain)
22 Listing all domains: xenctl domain list
24 Physical disk access management
25 -------------------------------
27 Grant read-only access to a disk or partition:
28 xenctl physical grant -n<domain_no> -p<partition_name> (e.g. sda10, sdc..etc)
29 Grant read-write access to a disk or partition:
30 xenctl physical grant -w -n<domain_no> -p<partition_name>
31 (if you grant read-write to a domain which already has read for the same
32 partition, it will be upgraded quite happily, and vice versa)
33 Revoke access to a disk or partition:
34 xenctl physical revoke -n<domain_no> -p<partition_name>
35 List access a domain has:
36 xenctl physical list -n<domain_no>
37 will list all the physical disks/partitions which the given domain may access
38 and the rights assigned.
40 Virtual disk management
41 -----------------------
43 Add a disk partition as a XenoPartition (raw space to create VDs on):
44 xenctl partitions add -p<partition_name> -c<chunk_size>
45 adds the partition, splitting it up into chunks of the size given
46 Sizes can all be specified as k, m, g.
47 Lists partitions:
48 xenctl partitions list
49 XenoPartitions are shown in [ ]
51 Create a virtual disk:
52 xenctl vd create -n<name> -s<size> [-e<expiry>]
53 Name is for identification only and need not be unique. Expiry may be none.
54 Size can be in k, m, g
55 You will be given a 10-digit key for the disk which is its unique identifier.
56 Delete a virtual disk:
57 xenctl vd delete -k<key>
58 Virtual disks with VBDs mapped to them may not be deleted.
59 Refresh the expiry on a disk:
60 xenctl vd refresh -k<key> [-e<expiry>]
61 Sets a new expiry, may be none.
62 List virtual disks:
63 xenctl vd show
65 List space free:
66 xenctl vd free
67 Shows how much space has been added with partitions add, but not allocated
68 to a virtual disk.
70 Create a virtual block device:
71 xenctl vbd create -n<domain> -k<key> -v<vbd_number> [-w]
72 Maps the disk with the given key into the domain. -w allows read-write.
73 vbd number 0 = /dev/xvda, number 1 = /dev/xvdb, and so on.
74 Lists virtual block devices:
75 xenctl vbd show
77 Virtual block devices are automatically deleted when their domain is destroyed.