You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
235 lines
6.0 KiB
Groff
235 lines
6.0 KiB
Groff
'\" t
|
|
.\" Title: vfs_shadow_copy2
|
|
.\" Author: [see the "AUTHOR" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
|
.\" Date: 09/18/2013
|
|
.\" Manual: System Administration tools
|
|
.\" Source: Samba 3.6
|
|
.\" Language: English
|
|
.\"
|
|
.TH "VFS_SHADOW_COPY2" "8" "09/18/2013" "Samba 3\&.6" "System Administration tools"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
vfs_shadow_copy2 \- Expose snapshots to Windows clients as shadow copies\&.
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\ 'u
|
|
vfs objects = shadow_copy2
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
This VFS module is part of the
|
|
\fBsamba\fR(7)
|
|
suite\&.
|
|
.PP
|
|
The
|
|
vfs_shadow_copy2
|
|
VFS module functionality that is similar to Microsoft Shadow Copy services\&. When setup properly, this module allows Microsoft Shadow Copy clients to browse "shadow copies" on Samba shares\&.
|
|
.PP
|
|
This is a 2nd implementation of a shadow copy module\&. This version has the following features:
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04' 1.\h'+01'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP " 1." 4.2
|
|
.\}
|
|
You don\*(Aqt need to populate your shares with symlinks to the snapshots\&. This can be very important when you have thousands of shares, or use [homes]\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04' 2.\h'+01'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP " 2." 4.2
|
|
.\}
|
|
The inode number of the files is altered so it is different from the original\&. This allows the \*(Aqrestore\*(Aq button to work without a sharing violation\&.
|
|
.RE
|
|
.sp
|
|
.RE
|
|
.PP
|
|
This module is stackable\&.
|
|
.SH "CONFIGURATION"
|
|
.PP
|
|
vfs_shadow_copy2
|
|
relies on a filesystem snapshot implementation\&. Many common filesystems have native support for this\&.
|
|
.PP
|
|
Filesystem snapshots must be mounted on specially named directories in order to be recognized by
|
|
vfs_shadow_copy2\&. The snapshot mount points must be immediate children of a the directory being shared\&.
|
|
.PP
|
|
The snapshot naming convention is @GMT\-YYYY\&.MM\&.DD\-hh\&.mm\&.ss, where:
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
YYYY
|
|
is the 4 digit year
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
MM
|
|
is the 2 digit month
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
DD
|
|
is the 2 digit day
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
hh
|
|
is the 2 digit hour
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
mm
|
|
is the 2 digit minute
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
ss
|
|
is the 2 digit second\&.
|
|
.RE
|
|
.sp
|
|
.RE
|
|
.PP
|
|
The
|
|
vfs_shadow_copy2
|
|
snapshot naming convention can be produced with the following
|
|
\fBdate\fR(1)
|
|
command:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
TZ=GMT date +@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.SH "OPTIONS"
|
|
.PP
|
|
shadow:snapdir = SNAPDIR
|
|
.RS 4
|
|
Path to the directory where snapshots are kept\&.
|
|
.RE
|
|
.PP
|
|
shadow:basedir = BASEDIR
|
|
.RS 4
|
|
Path to the base directory that snapshots are from\&.
|
|
.RE
|
|
.PP
|
|
shadow:sort = asc/desc, or not specified for unsorted (default)
|
|
.RS 4
|
|
By this parameter one can specify that the shadow copy directories should be sorted before they are sent to the client\&. This can be beneficial as unix filesystems are usually not listed alphabetically sorted\&. If enabled, you typically want to specify descending order\&.
|
|
.RE
|
|
.PP
|
|
shadow:localtime = yes/no
|
|
.RS 4
|
|
This is an optional parameter that indicates whether the snapshot names are in UTC/GMT or in local time\&. By default UTC is expected\&.
|
|
.RE
|
|
.PP
|
|
shadow:format = format specification for snapshot names
|
|
.RS 4
|
|
This is an optional parameter that specifies the format specification for the naming of snapshots\&. The format must be compatible with the conversion specifications recognized by str[fp]time\&. The default value is "@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S"\&.
|
|
.RE
|
|
.PP
|
|
shadow:fixinodes = yes/no
|
|
.RS 4
|
|
If you enable
|
|
shadow:fixinodes
|
|
then this module will modify the apparent inode number of files in the snapshot directories using a hash of the files path\&. This is needed for snapshot systems where the snapshots have the same device:inode number as the original files (such as happens with GPFS snapshots)\&. If you don\*(Aqt set this option then the \*(Aqrestore\*(Aq button in the shadow copy UI will fail with a sharing violation\&.
|
|
.RE
|
|
.SH "EXAMPLES"
|
|
.PP
|
|
Add shadow copy support to user home directories:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
\fI[homes]\fR
|
|
\m[blue]\fBvfs objects = shadow_copy2\fR\m[]
|
|
\m[blue]\fBshadow:snapdir = /data/snapshots\fR\m[]
|
|
\m[blue]\fBshadow:basedir = /data/home\fR\m[]
|
|
\m[blue]\fBshadow:sort = desc\fR\m[]
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.SH "CAVEATS"
|
|
.PP
|
|
This is not a backup, archival, or version control solution\&.
|
|
.PP
|
|
With Samba or Windows servers,
|
|
vfs_shadow_copy2
|
|
is designed to be an end\-user tool only\&. It does not replace or enhance your backup and archival solutions and should in no way be considered as such\&. Additionally, if you need version control, implement a version control system\&.
|
|
.SH "VERSION"
|
|
.PP
|
|
This man page is correct for version 3\&.2\&.7 of the Samba suite\&.
|
|
.SH "AUTHOR"
|
|
.PP
|
|
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\&.
|