afe1db96fabac4db34976f08c2d149e4d2ec94ae
[pve-docs.git] / pve-storage-iscsi.adoc
1 http://www.open-iscsi.org/[Open-iSCSI] initiator
2 ------------------------------------------------
3 include::attributes.txt[]
4
5 Storage pool type: `iscsi`
6
7 iSCSI is a widely employed technology used to connect to storage
8 servers. Almost all storage vendors support iSCSI. There are also open
9 source iSCSI target solutions available,
10 e.g. http://www.openmediavault.org/[OpenMediaVault], which is based on
11 Debian.
12
13 To use this backend, you need to install the 'open-iscsi'
14 package. This is a standard Debian package, but it is not installed by
15 default to save resources.
16
17   # apt-get install open-iscsi
18
19 Low-level iscsi management task can be done using the 'iscsiadm' tool.
20
21
22 Configuration
23 ~~~~~~~~~~~~~
24
25 The backend supports the common storage properties `content`, `nodes`,
26 `disable`, and the following iSCSI specific properties:
27
28 portal::
29
30 iSCSI portal (IP or DNS name with optional port).
31
32 target::
33
34 iSCSI target.
35
36
37 .Configuration Example ('/etc/pve/storage.cfg')
38 ----
39 iscsi: mynas
40      portal 10.10.10.1
41      target iqn.2006-01.openfiler.com:tsn.dcb5aaaddd
42      content none
43 ----
44
45 TIP: If you want to use LVM on top of iSCSI, it make sense to set
46 `content none`. That way it is not possible to create VMs using iSCSI
47 LUNs directly.
48
49 File naming conventions
50 ~~~~~~~~~~~~~~~~~~~~~~~
51
52 The iSCSI protocol does not define an interface to allocate or delete
53 data. Instead, that needs to be done on the target side and is vendor
54 specific. The target simply exports them as numbered LUNs. So {pve}
55 iSCSI volume names just encodes some information about the LUN as seen
56 by the linux kernel.
57
58
59 Storage Features
60 ~~~~~~~~~~~~~~~~
61
62 iSCSI is a block level type storage, and provides no management
63 interface.  So it is usually best to export one big LUN, and setup LVM
64 on top of that LUN. You can then use the LVM plugin to manage the
65 storage on that iSCSI LUN.
66
67 .Storage features for backend `iscsi`
68 [width="100%",cols="m,m,3*d",options="header"]
69 |==============================================================================
70 |Content types  |Image formats  |Shared |Snapshots |Clones
71 |images none    |raw            |yes    |no        |no
72 |==============================================================================
73
74
75 Examples
76 ~~~~~~~~
77
78 Scan a remote iSCSI portal, and returns a list of possible targets:
79
80  pvesm iscsiscan -portal <HOST[:PORT]>
81
82 ifdef::wiki[]
83
84 See Also
85 ~~~~~~~~
86
87 * link:/index.php/Storage[Storage]
88
89 endif::wiki[]
90
91