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.

110 lines
2.5KB

  1. [[storage_cifs]]
  2. CIFS Backend
  3. -----------
  4. ifdef::wiki[]
  5. :pve-toplevel:
  6. :title: Storage: CIFS
  7. endif::wiki[]
  8. Storage pool type: `cifs`
  9. The CIFS backend extends the directory backend, so that no manual
  10. setup of a CIFS mount is needed. Such a storage can be added directly
  11. through the {pve} API or the WebUI, with all our backend advantages,
  12. like server heartbeat check or comfortable selection of exported
  13. shares.
  14. Configuration
  15. ~~~~~~~~~~~~~
  16. The backend supports all common storage properties, except the shared
  17. flag, which is always set. Additionally, the following CIFS special
  18. properties are available:
  19. server::
  20. Server IP or DNS name. Required.
  21. TIP: To avoid DNS lookup delays, it is usually preferable to use an IP
  22. address instead of a DNS name - unless you have a very reliable DNS
  23. server, or list the server in the local `/etc/hosts` file.
  24. share::
  25. CIFS share to use (get available ones with `pvesm cifsscan` or the WebUI).
  26. Required.
  27. username::
  28. The username for the CIFS storage. Optional, defaults to `guest'.
  29. password::
  30. The user password. Optional.
  31. It will be saved in a file only readable by root
  32. (`/etc/pve/priv/<STORAGE_ID>.cred`).
  33. domain::
  34. Sets the user domain (workgroup) for this storage. Optional.
  35. smbversion::
  36. SMB protocol Version. Optional, default is `3`.
  37. SMB1 is not supported due to security issues.
  38. path::
  39. The local mount point. Optional, defaults to `/mnt/pve/<STORAGE_ID>/`.
  40. .Configuration Example (`/etc/pve/storage.cfg`)
  41. ----
  42. cifs: backup
  43. path /mnt/pve/backup
  44. server 10.0.0.11
  45. share VMData
  46. content backup
  47. username anna
  48. smbversion 3
  49. ----
  50. Storage Features
  51. ~~~~~~~~~~~~~~~~
  52. CIFS does not support snapshots on a storage level. But you may use
  53. `qcow2` backing files if you still want to have snapshots and cloning
  54. features available.
  55. .Storage features for backend `cifs`
  56. [width="100%",cols="m,m,3*d",options="header"]
  57. |==============================================================================
  58. |Content types |Image formats |Shared |Snapshots |Clones
  59. |images rootdir vztmpl iso backup snippets |raw qcow2 vmdk |yes |qcow2 |qcow2
  60. |==============================================================================
  61. Examples
  62. ~~~~~~~~
  63. You can get a list of exported CIFS shares with:
  64. ----
  65. # pvesm cifsscan <server> [--username <username>] [--password]
  66. ----
  67. Then you could add this share as a storage to the whole {pve} cluster
  68. with:
  69. ----
  70. # pvesm add cifs <storagename> --server <server> --share <share> [--username <username>] [--password]
  71. ----
  72. ifdef::wiki[]
  73. See Also
  74. ~~~~~~~~
  75. * link:/wiki/Storage[Storage]
  76. endif::wiki[]