1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
----------------------------
xl Disk Configuration Option
----------------------------
This document provides a brief description of xl disk configuration
option, different attributes that can be passed through it and the
format in which they need to be specified.
At a higher level, xl disk configuration option takes the following
format:
disk = [ '[format:][path],vdev[:type],attrib',
'[format:][path],vdev[:type],attrib', ... ]
Not all attributes are required (the attributes enclosed within square
brackets above are optional) and some are deprecated. Following is a
brief description of each of the attribute along with information on
whether or not they are mandatory.
------------------
Attribute Details
------------------
format:
------
Description: Specifies the format of image file.
Supported values: raw, qcow, qcow2, vhd
Deprecated values: None
Mandatory: No. When not specified raw format is assumed.
For a physical block device the format must be
raw and need not be explicitly specified. For
an image file the format could be one of the
supported values and when not specified assumed
to be raw.
path:
----
Description: Block device or image file path. For a
physical block device a /dev will be prepended
when not specified and when the path doesn't
start with a '/'.
Supported values: N/A
Deprecated values: N/A
Mandatory: No. While a path is provided in most cases
there is an exception. For a cdrom device, lack
of this attribute would imply an empty cdrom
drive.
vdev:
----
Description: Virtual device as seen by the guest (also
referred to as guest drive designation in some
specifications). See docs/misc/vbd-interface.txt.
Supported values: hd[x], xvd[x], sd[x] etc. Please refer to the
above specification for further details.
Deprecated values: None
Mandatory: Yes
type:
----
Description: Qualifies virtual device type.
Supported values: cdrom
Deprecated values: None
Mandatory: No
attrib:
------
Description: Specified access control information. Whether
or not the block device is provided to the
guest in read-only or read-write mode depends
on this attribute.
Supported values: 'r', 'w'
Deprecated values: None
Mandatory: Yes
--------------
Example usages
--------------
disk = [ 'vhd:/path/to/dev,hda,w', '/path/to/iso,hdc:cdrom,r' ]
disk = [ 'path/to/phy/dev,hda,w', '/dev/cdrom,hdc:cdrom,r' ]
disk = [ 'qcow:/path/to/file,hda,w' ]
disk = [ 'qcow2:/path/to/file,hda,w', 'raw:/path/to/dev,hdc:cdrom,r' ]
-------------------------
Miscellaneous Information
-------------------------
---------------------
Deprecated Attributes
---------------------
Deprecated values are acceptable and will work the way they did
earlier except with a warning message printed to the xl log or screen.
However it's usage is supported purely for backward compatibility
purpose and not recommended. Also, support for these deprecated
attributes are likely to be dropped in future versions of xl.
The block-dev-type and access-type deprecated attributes described
below are prepended to the format attribute. Example - tap:aio:qcow
Further details on the deprecated attributes are below:
block-dev-type:
--------------
Description: Specifies the block device type.
Supported values: phy,file, tap, tap2
access-type:
-----------
Description: Backend implementation option to choose from
while accessing block device.
Example: tap:aio:vhd:/path/to/file
Supported values: 'aio', 'tapdisk', 'ioemu'
---------------------
Impementation Details
---------------------
Backend Details:
---------------
For 'phy' block device type, blkback is always used as the backend.
When the running dom0 instance does not support blkback, block device
access will fail. For block device type 'file' with format raw or
when no format specfied, tapdisk2 is used when present otherwise qemu
fallback option is used. For 'file', 'tap' or 'tap2' block device
type with format 'vhd', only tapdisk2 is used as qemu does not support
vhd format. Absence of tapdisk2 support in this case will result in
failure. When it comes to image format and how that affects the
backend choice, for qcow/qcow2 qemu backend is used as tapdisk2 does
not work with these formats. For raw format image file, tapdisk2 is
used and when not available qemu backend is used as fallback. For vhd
format, as mentioned earlier tapdisk2 is used and tapdisk2
unavailability will result in failure as qemu fallback option does not
support vhd file format.
|
