mirror of
				https://git.proxmox.com/git/pve-docs
				synced 2025-10-31 14:25:12 +00:00 
			
		
		
		
	 500faf0743
			
		
	
	
		500faf0743
		
	
	
	
	
		
			
			Make the text for `pvesm scan` and `pvesm add` command examples more consistent by introducing `pvesm scan` with "You can get ... with", as it is already done for other storage plugins, and changing from past tense to present tense in existing descriptions for the `pvesm add` as recommended in the Technical Writing Style Guide for instructions [0]. While at it, replace the term "share" with the more appropriate "datastore" for the example in the PBS section. [0] https://pve.proxmox.com/wiki/Technical_Writing_Style_Guide#Second_person_imperative_mood Signed-off-by: Daniel Kral <d.kral@proxmox.com> Link: https://lore.proxmox.com/20250304100915.55114-1-d.kral@proxmox.com
		
			
				
	
	
		
			98 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
			
		
		
	
	
			98 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
| [[storage_open_iscsi]]
 | |
| Open-iSCSI initiator
 | |
| --------------------
 | |
| ifdef::wiki[]
 | |
| :pve-toplevel:
 | |
| :title: Storage: iSCSI
 | |
| endif::wiki[]
 | |
| 
 | |
| 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. https://www.openmediavault.org/[OpenMediaVault], which is based on
 | |
| Debian.
 | |
| 
 | |
| To use this backend, you need to install the
 | |
| https://www.open-iscsi.com/[Open-iSCSI] (`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
 | |
| ~~~~~~~~
 | |
| 
 | |
| You can scan a remote iSCSI portal and get a list of possible targets with:
 | |
| 
 | |
|  pvesm scan iscsi <HOST[:PORT]>
 | |
| 
 | |
| ifdef::wiki[]
 | |
| 
 | |
| See Also
 | |
| ~~~~~~~~
 | |
| 
 | |
| * link:/wiki/Storage[Storage]
 | |
| 
 | |
| endif::wiki[]
 | |
| 
 | |
| 
 |