| 1 | =head1 NAME |
|---|
| 2 | |
|---|
| 3 | xend-config.sxp - Xen daemon configuration file |
|---|
| 4 | |
|---|
| 5 | =head1 SYNOPSIS |
|---|
| 6 | |
|---|
| 7 | /etc/xen/xend-config.sxp |
|---|
| 8 | |
|---|
| 9 | =head1 DESCRIPTION |
|---|
| 10 | |
|---|
| 11 | The xend(1) program requires xend-config.sxp to specify operating |
|---|
| 12 | parameters which determine the behavior of the daemon at runtime. |
|---|
| 13 | |
|---|
| 14 | The parameters are specified in S-expression format. See the example |
|---|
| 15 | configuration file in I</etc/xen/xend-config.sxp> for details. |
|---|
| 16 | |
|---|
| 17 | =head1 OPTIONS |
|---|
| 18 | |
|---|
| 19 | The following lists the daemon configuration parameters: |
|---|
| 20 | |
|---|
| 21 | =over 4 |
|---|
| 22 | |
|---|
| 23 | =item I<logfile> |
|---|
| 24 | |
|---|
| 25 | The location of the file to record runtime log messages. Defaults to |
|---|
| 26 | I</var/log/xen/xend.log>. |
|---|
| 27 | |
|---|
| 28 | =item I<loglevel> |
|---|
| 29 | |
|---|
| 30 | Filters out messages below the specified level. Possible values are |
|---|
| 31 | DEBUG, INFO, WARNING, ERROR, CRITICAL. Defaults to I<DEBUG>. |
|---|
| 32 | |
|---|
| 33 | =item I<xend-http-server> |
|---|
| 34 | |
|---|
| 35 | A boolean value that tells xend whether or not to start the http |
|---|
| 36 | stream socket management server. Defaults to I<no>. |
|---|
| 37 | |
|---|
| 38 | =item I<xend-unix-server> |
|---|
| 39 | |
|---|
| 40 | A boolean value that tells xend whether or not to start the unix |
|---|
| 41 | domain socket management server. This is required for the CLI tools |
|---|
| 42 | to operate. Defaults to I<yes>. |
|---|
| 43 | |
|---|
| 44 | =item I<xend-relocation-server> |
|---|
| 45 | |
|---|
| 46 | A boolean value that tells xend whether or not to start the relocation |
|---|
| 47 | server. This is required for cross-machine migrations. Defaults to |
|---|
| 48 | I<no>. |
|---|
| 49 | |
|---|
| 50 | =item I<xend-unix-path> |
|---|
| 51 | |
|---|
| 52 | The location of the unix domain socket the xend-unix-server will use |
|---|
| 53 | to communicate with the management tools. Defaults to |
|---|
| 54 | I</var/lib/xend/xend-socket>. |
|---|
| 55 | |
|---|
| 56 | =item I<xend-port> |
|---|
| 57 | |
|---|
| 58 | The port that will be used by the http management server. Defaults to |
|---|
| 59 | I<8000>. |
|---|
| 60 | |
|---|
| 61 | =item I<xend-relocation-port> |
|---|
| 62 | |
|---|
| 63 | The port that will be used by the relocation server. Defaults to |
|---|
| 64 | I<8002>. |
|---|
| 65 | |
|---|
| 66 | =item I<xend-address> |
|---|
| 67 | |
|---|
| 68 | The address to which the http management server will bind. Defaults |
|---|
| 69 | to I<''> which means "all interfaces". |
|---|
| 70 | |
|---|
| 71 | =item I<xend-relocation-address> |
|---|
| 72 | |
|---|
| 73 | The address to which the relocation server will bind. Defaults to |
|---|
| 74 | I<''> which means "all interfaces". |
|---|
| 75 | |
|---|
| 76 | =item I<console-limit> |
|---|
| 77 | |
|---|
| 78 | The kilobyte buffer limit that will be enforced by the console server. |
|---|
| 79 | This limit is set per-domain, and is needed to prevent a single domain |
|---|
| 80 | from overwhelming the console server with massive amounts of data. |
|---|
| 81 | Defaults to I<1024>. |
|---|
| 82 | |
|---|
| 83 | =item I<network-script> |
|---|
| 84 | |
|---|
| 85 | The name of the script in I</etc/xen/scripts> that will be run to |
|---|
| 86 | setup the networking environment. This can be any name, but in |
|---|
| 87 | general is either I<network-bridge> or I<network-route>. |
|---|
| 88 | |
|---|
| 89 | =item I<vif-script> |
|---|
| 90 | |
|---|
| 91 | The name of the script in I</etc/xen/scripts> that will be run to |
|---|
| 92 | setup a virtual interface when it is created or destroyed. This needs |
|---|
| 93 | to (in general) work in unison with the I<network-script>. |
|---|
| 94 | |
|---|
| 95 | =item I<dom0-min-mem> |
|---|
| 96 | |
|---|
| 97 | This specifies the minimum number of megabytes that will be reserved |
|---|
| 98 | for Domain0. If this value is positive, Domain0 will be automatically |
|---|
| 99 | ballooned down to this limit to make space for new domains. If this |
|---|
| 100 | is set to 0, Domain0 will not be automatically ballooned. |
|---|
| 101 | |
|---|
| 102 | =item I<dom0-cpus> |
|---|
| 103 | |
|---|
| 104 | This specifies the number of CPUs that Domain0 will be allowed to use. |
|---|
| 105 | If the value is 0, all available CPUs will be used by Domain0. |
|---|
| 106 | |
|---|
| 107 | =item I<enable-dump> |
|---|
| 108 | |
|---|
| 109 | A boolean value that tells xend whether or not core dumps of guest |
|---|
| 110 | domains should be saved when a crash occurs. Defaults to I<no>. |
|---|
| 111 | |
|---|
| 112 | =item I<external-migration-tool> |
|---|
| 113 | |
|---|
| 114 | The name of an application or script that can handle external device |
|---|
| 115 | migration, such as for example virtual TPM migration. An example |
|---|
| 116 | script is I</etc/xen/scripts/external-device-migrate>. |
|---|
| 117 | |
|---|
| 118 | =back |
|---|
| 119 | |
|---|
| 120 | =head1 EXAMPLES |
|---|
| 121 | |
|---|
| 122 | An example configuration with relocation enabled for the local network: |
|---|
| 123 | |
|---|
| 124 | =over 4 |
|---|
| 125 | |
|---|
| 126 | (xend-relocation-server yes) |
|---|
| 127 | (xend-relocation-address 192.168.1.1) |
|---|
| 128 | (network-script network-bridge) |
|---|
| 129 | (vif-script vif-bridge) |
|---|
| 130 | (dom0-min-mem 0) |
|---|
| 131 | (dom0-cpus 0) |
|---|
| 132 | |
|---|
| 133 | =back |
|---|
| 134 | |
|---|
| 135 | =head1 CAVEATS |
|---|
| 136 | |
|---|
| 137 | Note that relocation is currently unsecured and is very dangerous if |
|---|
| 138 | left enabled. No authentication is performed, and very little sanity |
|---|
| 139 | checking takes place. Enable at your own risk. |
|---|
| 140 | |
|---|
| 141 | =head1 SEE ALSO |
|---|
| 142 | |
|---|
| 143 | B<xend>(1) |
|---|
| 144 | |
|---|
| 145 | =head1 AUTHOR |
|---|
| 146 | |
|---|
| 147 | Dan Smith <danms@us.ibm.com> |
|---|
| 148 | |
|---|