[pve-docs.git] / pve-storage-iscsi.adoc

http://www.open-iscsi.org/[Open-iSCSI] initiator
------------------------------------------------
include::attributes.txt[]

Storage pool type: `iscsi`

iSCSI is a widely employed technology used to connect to storage
servers. Almost all storage vendors support iSCSI. There are also open
source iSCSI target solutions available,
e.g. http://www.openmediavault.org/[OpenMediaVault], which is based on
Debian.

To use this backend, you need to install the `open-iscsi`
package. This is a standard Debian package, but it is not installed by
default to save resources.

  # apt-get install open-iscsi

Low-level iscsi management task can be done using the `iscsiadm` tool.


Configuration
~~~~~~~~~~~~~

The backend supports the common storage properties `content`, `nodes`,
`disable`, and the following iSCSI specific properties:

portal::

iSCSI portal (IP or DNS name with optional port).

target::

iSCSI target.


.Configuration Example (`/etc/pve/storage.cfg`)
----
iscsi: mynas
     portal 10.10.10.1
     target iqn.2006-01.openfiler.com:tsn.dcb5aaaddd
     content none
----

TIP: If you want to use LVM on top of iSCSI, it make sense to set
`content none`. That way it is not possible to create VMs using iSCSI
LUNs directly.


File naming conventions
~~~~~~~~~~~~~~~~~~~~~~~

The iSCSI protocol does not define an interface to allocate or delete
data. Instead, that needs to be done on the target side and is vendor
specific. The target simply exports them as numbered LUNs. So {pve}
iSCSI volume names just encodes some information about the LUN as seen
by the linux kernel.


Storage Features
~~~~~~~~~~~~~~~~

iSCSI is a block level type storage, and provides no management
interface.  So it is usually best to export one big LUN, and setup LVM
on top of that LUN. You can then use the LVM plugin to manage the
storage on that iSCSI LUN.

.Storage features for backend `iscsi`
[width="100%",cols="m,m,3*d",options="header"]
|==============================================================================
|Content types  |Image formats  |Shared |Snapshots |Clones
|images none    |raw            |yes    |no        |no
|==============================================================================


Examples
~~~~~~~~

Scan a remote iSCSI portal, and returns a list of possible targets:

 pvesm iscsiscan -portal <HOST[:PORT]>

ifdef::wiki[]

See Also
~~~~~~~~

* link:/wiki/Storage[Storage]

endif::wiki[]
Commit	Line	Data
	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
	50	File naming conventions
	51	~~~~~~~~~~~~~~~~~~~~~~~
	52
	53	The iSCSI protocol does not define an interface to allocate or delete
	54	data. Instead, that needs to be done on the target side and is vendor
	55	specific. The target simply exports them as numbered LUNs. So {pve}
	56	iSCSI volume names just encodes some information about the LUN as seen
	57	by the linux kernel.
	58
	59
	60	Storage Features
	61	~~~~~~~~~~~~~~~~
	62
	63	iSCSI is a block level type storage, and provides no management
	64	interface. So it is usually best to export one big LUN, and setup LVM
	65	on top of that LUN. You can then use the LVM plugin to manage the
	66	storage on that iSCSI LUN.
	67
	68	.Storage features for backend `iscsi`
	69	[width="100%",cols="m,m,3*d",options="header"]
	70	\|==============================================================================
	71	\|Content types \|Image formats \|Shared \|Snapshots \|Clones
	72	\|images none \|raw \|yes \|no \|no
	73	\|==============================================================================
	74
	75
	76	Examples
	77	~~~~~~~~
	78
	79	Scan a remote iSCSI portal, and returns a list of possible targets:
	80
	81	pvesm iscsiscan -portal <HOST[:PORT]>
	82
	83	ifdef::wiki[]
	84
	85	See Also
	86	~~~~~~~~
	87
	88	* link:/wiki/Storage[Storage]
	89
	90	endif::wiki[]
	91
	92