| 1 | '\" t
|
|---|
| 2 | .\" Title: vfs_fileid
|
|---|
| 3 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 4 | .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
|---|
| 5 | .\" Date: 10/25/2016
|
|---|
| 6 | .\" Manual: System Administration tools
|
|---|
| 7 | .\" Source: Samba 4.4
|
|---|
| 8 | .\" Language: English
|
|---|
| 9 | .\"
|
|---|
| 10 | .TH "VFS_FILEID" "8" "10/25/2016" "Samba 4\&.4" "System Administration tools"
|
|---|
| 11 | .\" -----------------------------------------------------------------
|
|---|
| 12 | .\" * Define some portability stuff
|
|---|
| 13 | .\" -----------------------------------------------------------------
|
|---|
| 14 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 15 | .\" http://bugs.debian.org/507673
|
|---|
| 16 | .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|---|
| 17 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 18 | .ie \n(.g .ds Aq \(aq
|
|---|
| 19 | .el .ds Aq '
|
|---|
| 20 | .\" -----------------------------------------------------------------
|
|---|
| 21 | .\" * set default formatting
|
|---|
| 22 | .\" -----------------------------------------------------------------
|
|---|
| 23 | .\" disable hyphenation
|
|---|
| 24 | .nh
|
|---|
| 25 | .\" disable justification (adjust text to left margin only)
|
|---|
| 26 | .ad l
|
|---|
| 27 | .\" -----------------------------------------------------------------
|
|---|
| 28 | .\" * MAIN CONTENT STARTS HERE *
|
|---|
| 29 | .\" -----------------------------------------------------------------
|
|---|
| 30 | .SH "NAME"
|
|---|
| 31 | vfs_fileid \- Generates file_id structs with unique device id values for cluster setups
|
|---|
| 32 | .SH "SYNOPSIS"
|
|---|
| 33 | .HP \w'\ 'u
|
|---|
| 34 | vfs objects = fileid
|
|---|
| 35 | .SH "DESCRIPTION"
|
|---|
| 36 | .PP
|
|---|
| 37 | This VFS module is part of the
|
|---|
| 38 | \fBsamba\fR(7)
|
|---|
| 39 | suite\&.
|
|---|
| 40 | .PP
|
|---|
| 41 | Samba uses file_id structs to uniquely identify files for locking purpose\&. By default the file_id contains the device and inode number returned by the
|
|---|
| 42 | stat()
|
|---|
| 43 | system call\&. As the file_id is a unique identifier of a file, it must be the same on all nodes in a cluster setup\&. This module overloads the
|
|---|
| 44 | SMB_VFS_FILE_ID_CREATE()
|
|---|
| 45 | operation and generates the device number based on the configured algorithm (see the "fileid:algorithm" option)\&.
|
|---|
| 46 | .SH "OPTIONS"
|
|---|
| 47 | .PP
|
|---|
| 48 | fileid:algorithm = ALGORITHM
|
|---|
| 49 | .RS 4
|
|---|
| 50 | Available algorithms are
|
|---|
| 51 | fsname
|
|---|
| 52 | and
|
|---|
| 53 | fsid\&. The default value is
|
|---|
| 54 | fsname\&.
|
|---|
| 55 | .sp
|
|---|
| 56 | The
|
|---|
| 57 | fsname
|
|---|
| 58 | algorithm generates device id by hashing the kernel device name\&.
|
|---|
| 59 | .sp
|
|---|
| 60 | The
|
|---|
| 61 | fsid
|
|---|
| 62 | algorithm generates the device id from the
|
|---|
| 63 | f_fsid
|
|---|
| 64 | returned from the
|
|---|
| 65 | statfs()
|
|---|
| 66 | syscall\&.
|
|---|
| 67 | .RE
|
|---|
| 68 | .PP
|
|---|
| 69 | fileid:mapping = ALGORITHM
|
|---|
| 70 | .RS 4
|
|---|
| 71 | This option is the legacy version of the
|
|---|
| 72 | fileid:algorithm
|
|---|
| 73 | option, which was used in earlier versions of fileid mapping feature in custom Samba 3\&.0 versions\&.
|
|---|
| 74 | .RE
|
|---|
| 75 | .SH "EXAMPLES"
|
|---|
| 76 | .PP
|
|---|
| 77 | Usage of the
|
|---|
| 78 | fileid
|
|---|
| 79 | module with the
|
|---|
| 80 | fsid
|
|---|
| 81 | algorithm:
|
|---|
| 82 | .sp
|
|---|
| 83 | .if n \{\
|
|---|
| 84 | .RS 4
|
|---|
| 85 | .\}
|
|---|
| 86 | .nf
|
|---|
| 87 | \fI[global]\fR
|
|---|
| 88 | \m[blue]\fBvfs objects = fileid\fR\m[]
|
|---|
| 89 | \m[blue]\fBfileid:algorithm = fsid\fR\m[]
|
|---|
| 90 | .fi
|
|---|
| 91 | .if n \{\
|
|---|
| 92 | .RE
|
|---|
| 93 | .\}
|
|---|
| 94 | .SH "VERSION"
|
|---|
| 95 | .PP
|
|---|
| 96 | This man page is correct for version 3\&.2 of the Samba suite\&.
|
|---|
| 97 | .SH "AUTHOR"
|
|---|
| 98 | .PP
|
|---|
| 99 | The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
|
|---|
