You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

91 lines

  1. [[storage_nfs]]
  2. NFS Backend
  3. -----------
  4. ifdef::wiki[]
  5. :pve-toplevel:
  6. :title: Storage: NFS
  7. endif::wiki[]
  8. Storage pool type: `nfs`
  9. The NFS backend is based on the directory backend, so it shares most
  10. properties. The directory layout and the file naming conventions are
  11. the same. The main advantage is that you can directly configure the
  12. NFS server properties, so the backend can mount the share
  13. automatically. There is no need to modify `/etc/fstab`. The backend
  14. can also test if the server is online, and provides a method to query
  15. the server for exported shares.
  16. Configuration
  17. ~~~~~~~~~~~~~
  18. The backend supports all common storage properties, except the shared
  19. flag, which is always set. Additionally, the following properties are
  20. used to configure the NFS server:
  21. server::
  22. Server IP or DNS name. To avoid DNS lookup delays, it is usually
  23. preferable to use an IP address instead of a DNS name - unless you
  24. have a very reliable DNS server, or list the server in the local
  25. `/etc/hosts` file.
  26. export::
  27. NFS export path (as listed by `pvesm nfsscan`).
  28. You can also set NFS mount options:
  29. path::
  30. The local mount point (defaults to `/mnt/pve/<STORAGE_ID>/`).
  31. options::
  32. NFS mount options (see `man nfs`).
  33. .Configuration Example (`/etc/pve/storage.cfg`)
  34. ----
  35. nfs: iso-templates
  36. path /mnt/pve/iso-templates
  37. server
  38. export /space/iso-templates
  39. options vers=3,soft
  40. content iso,vztmpl
  41. ----
  42. TIP: After an NFS request times out, NFS request are retried
  43. indefinitely by default. This can lead to unexpected hangs on the
  44. client side. For read-only content, it is worth to consider the NFS
  45. `soft` option, which limits the number of retries to three.
  46. Storage Features
  47. ~~~~~~~~~~~~~~~~
  48. NFS does not support snapshots, but the backend uses `qcow2` features
  49. to implement snapshots and cloning.
  50. .Storage features for backend `nfs`
  51. [width="100%",cols="m,m,3*d",options="header"]
  52. |==============================================================================
  53. |Content types |Image formats |Shared |Snapshots |Clones
  54. |images rootdir vztmpl iso backup snippets |raw qcow2 vmdk |yes |qcow2 |qcow2
  55. |==============================================================================
  56. Examples
  57. ~~~~~~~~
  58. You can get a list of exported NFS shares with:
  59. # pvesm nfsscan <server>
  60. ifdef::wiki[]
  61. See Also
  62. ~~~~~~~~
  63. * link:/wiki/Storage[Storage]
  64. endif::wiki[]