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