pve-storage-cifs.adoc

   1 CIFS Backend
   2 -----------
   3 ifdef::wiki[]
   4 :pve-toplevel:
   5 :title: Storage: CIFS
   6 endif::wiki[]
   7
   8 Storage pool type: `cifs`
   9
  10 The CIFS backend is based on the directory backend, so it shares most
  11 properties. The directory layout and the file naming conventions are
  12 the same. The main advantage is that you can directly configure the
  13 CIFS server, so the backend can mount the share automatically in
  14 the hole cluster. There is no need to modify `/etc/fstab`. The backend
  15 can also test if the server is online, and provides a method to query
  16 the server for exported shares.
  17
  18 Configuration
  19 ~~~~~~~~~~~~~
  20
  21 The backend supports all common storage properties, except the shared
  22 flag, which is always set. Additionally, the following properties are
  23 used to configure the CIFS server:
  24
  25 server::
  26
  27 Server IP or DNS name. To avoid DNS lookup delays, it is usually
  28 preferable to use an IP address instead of a DNS name - unless you
  29 have a very reliable DNS server, or list the server in the local
  30 `/etc/hosts` file.
  31
  32 share::
  33
  34 CIFS share (as listed by `pvesm cifsscan`).
  35
  36 Optional properties:
  37
  38 username::
  39
  40 If not presents, "guest" is used.
  41
  42 password::
  43
  44 The user password.
  45 It will be saved in a private directory (/etc/pve/priv/<STORAGE_ID>.cred).
  46
  47 domain::
  48
  49 sets the domain (workgroup) of the user
  50
  51 smbversion::
  52
  53 SMB protocol Version (default is `3`).
  54 SMB1 is not supported due to security issues.
  55
  56 path::
  57
  58 The local mount point (defaults to `/mnt/pve/<STORAGE_ID>/`).
  59
  60 .Configuration Example (`/etc/pve/storage.cfg`)
  61 ----
  62 cifs: backup
  63         path /mnt/pve/backup
  64         server 10.0.0.11
  65         share VMData
  66         content backup
  67         username anna
  68         smbversion 3
  69
  70 ----
  71
  72 Storage Features
  73 ~~~~~~~~~~~~~~~~
  74
  75 CIFS does not support snapshots, but the backend uses `qcow2` features
  76 to implement snapshots and cloning.
  77
  78 .Storage features for backend `nfs`
  79 [width="100%",cols="m,m,3*d",options="header"]
  80 |==============================================================================
  81 |Content types                     |Image formats         |Shared |Snapshots |Clones
  82 |images rootdir vztmpl iso backup  |raw qcow2 vmdk subvol |yes    |qcow2     |qcow2
  83 |==============================================================================
  84
  85 Examples
  86 ~~~~~~~~
  87
  88 You can get a list of exported CIFS shares with:
  89
  90  # pvesm cifsscan <server> [--username <username>] [--password]
  91
  92 ifdef::wiki[]
  93
  94 See Also
  95 ~~~~~~~~
  96
  97 * link:/wiki/Storage[Storage]
  98
  99 endif::wiki[]