mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-08-06 11:27:33 +00:00
cleanup and improve CIFS documentation
Swap NFS reference left over from intial copying with CIFS. Add an CLI add example. Improve wording, grammar. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
parent
de14ebffd2
commit
0ddd42aa63
@ -1,3 +1,4 @@
|
|||||||
|
[[storage_cifs]]
|
||||||
CIFS Backend
|
CIFS Backend
|
||||||
-----------
|
-----------
|
||||||
ifdef::wiki[]
|
ifdef::wiki[]
|
||||||
@ -7,55 +8,54 @@ endif::wiki[]
|
|||||||
|
|
||||||
Storage pool type: `cifs`
|
Storage pool type: `cifs`
|
||||||
|
|
||||||
The CIFS backend is based on the directory backend, so it shares most
|
The CIFS backend extends the directory backend, so that no manual
|
||||||
properties. The directory layout and the file naming conventions are
|
setup of a CIFS mount is needed. Such a storage can be added directly
|
||||||
the same. The main advantage is that you can directly configure the
|
through the {pve} API or the WebUI, with all our backend advantages,
|
||||||
CIFS server, so the backend can mount the share automatically in
|
like server heartbeat check or comfortable selection of exported
|
||||||
the hole cluster. There is no need to modify `/etc/fstab`. The backend
|
shares.
|
||||||
can also test if the server is online, and provides a method to query
|
|
||||||
the server for exported shares.
|
|
||||||
|
|
||||||
Configuration
|
Configuration
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
The backend supports all common storage properties, except the shared
|
The backend supports all common storage properties, except the shared
|
||||||
flag, which is always set. Additionally, the following properties are
|
flag, which is always set. Additionally, the following CIFS special
|
||||||
used to configure the CIFS server:
|
properties are available:
|
||||||
|
|
||||||
server::
|
server::
|
||||||
|
|
||||||
Server IP or DNS name. To avoid DNS lookup delays, it is usually
|
Server IP or DNS name. Required.
|
||||||
preferable to use an IP address instead of a DNS name - unless you
|
|
||||||
have a very reliable DNS server, or list the server in the local
|
TIP: To avoid DNS lookup delays, it is usually preferable to use an IP
|
||||||
`/etc/hosts` file.
|
address instead of a DNS name - unless you have a very reliable DNS
|
||||||
|
server, or list the server in the local `/etc/hosts` file.
|
||||||
|
|
||||||
share::
|
share::
|
||||||
|
|
||||||
CIFS share (as listed by `pvesm cifsscan`).
|
CIFS share to use (get available ones with `pvesm cifsscan` or the WebUI).
|
||||||
|
Required.
|
||||||
Optional properties:
|
|
||||||
|
|
||||||
username::
|
username::
|
||||||
|
|
||||||
If not presents, "guest" is used.
|
The username for the CIFS storage. Optional, defaults to `guest'.
|
||||||
|
|
||||||
password::
|
password::
|
||||||
|
|
||||||
The user password.
|
The user password. Optional.
|
||||||
It will be saved in a private directory (/etc/pve/priv/<STORAGE_ID>.cred).
|
It will be saved in a file only readable by root
|
||||||
|
(`/etc/pve/priv/<STORAGE_ID>.cred`).
|
||||||
|
|
||||||
domain::
|
domain::
|
||||||
|
|
||||||
sets the domain (workgroup) of the user
|
Sets the user domain (workgroup) for this storage. Optional.
|
||||||
|
|
||||||
smbversion::
|
smbversion::
|
||||||
|
|
||||||
SMB protocol Version (default is `3`).
|
SMB protocol Version. Optional, default is `3`.
|
||||||
SMB1 is not supported due to security issues.
|
SMB1 is not supported due to security issues.
|
||||||
|
|
||||||
path::
|
path::
|
||||||
|
|
||||||
The local mount point (defaults to `/mnt/pve/<STORAGE_ID>/`).
|
The local mount point. Optional, defaults to `/mnt/pve/<STORAGE_ID>/`.
|
||||||
|
|
||||||
.Configuration Example (`/etc/pve/storage.cfg`)
|
.Configuration Example (`/etc/pve/storage.cfg`)
|
||||||
----
|
----
|
||||||
@ -72,14 +72,15 @@ cifs: backup
|
|||||||
Storage Features
|
Storage Features
|
||||||
~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
CIFS does not support snapshots, but the backend uses `qcow2` features
|
CIFS does not support snapshots on a storage level. But you may use
|
||||||
to implement snapshots and cloning.
|
`qcow2` backing files if you still want to have snapshots and cloning
|
||||||
|
features available.
|
||||||
|
|
||||||
.Storage features for backend `nfs`
|
.Storage features for backend `cifs`
|
||||||
[width="100%",cols="m,m,3*d",options="header"]
|
[width="100%",cols="m,m,3*d",options="header"]
|
||||||
|==============================================================================
|
|==============================================================================
|
||||||
|Content types |Image formats |Shared |Snapshots |Clones
|
|Content types |Image formats |Shared |Snapshots |Clones
|
||||||
|images rootdir vztmpl iso backup |raw qcow2 vmdk subvol |yes |qcow2 |qcow2
|
|images rootdir vztmpl iso backup |raw qcow2 vmdk |yes |qcow2 |qcow2
|
||||||
|==============================================================================
|
|==============================================================================
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
@ -87,7 +88,16 @@ Examples
|
|||||||
|
|
||||||
You can get a list of exported CIFS shares with:
|
You can get a list of exported CIFS shares with:
|
||||||
|
|
||||||
# pvesm cifsscan <server> [--username <username>] [--password]
|
----
|
||||||
|
# pvesm cifsscan <server> [--username <username>] [--password]
|
||||||
|
----
|
||||||
|
|
||||||
|
Then you could add this share as a storage to the whole {pve} cluster
|
||||||
|
with:
|
||||||
|
|
||||||
|
----
|
||||||
|
# pvesm add cifs <storagename> --server <server> --share <share> [--username <username>] [--password]
|
||||||
|
----
|
||||||
|
|
||||||
ifdef::wiki[]
|
ifdef::wiki[]
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user