xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-snapshot.8 (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1.\"
2.\" CDDL HEADER START
3.\"
4.\" The contents of this file are subject to the terms of the
5.\" Common Development and Distribution License (the "License").
6.\" You may not use this file except in compliance with the License.
7.\"
8.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9.\" or http://www.opensolaris.org/os/licensing.
10.\" See the License for the specific language governing permissions
11.\" and limitations under the License.
12.\"
13.\" When distributing Covered Code, include this CDDL HEADER in each
14.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15.\" If applicable, add the following below this CDDL HEADER, with the
16.\" fields enclosed by brackets "[]" replaced with your own identifying
17.\" information: Portions Copyright [yyyy] [name of copyright owner]
18.\"
19.\" CDDL HEADER END
20.\"
21.\"
22.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
23.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
24.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
25.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
27.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
28.\" Copyright (c) 2014 Integros [integros.com]
29.\" Copyright 2019 Richard Laager. All rights reserved.
30.\" Copyright 2018 Nexenta Systems, Inc.
31.\" Copyright 2019 Joyent, Inc.
32.\"
33.Dd June 30, 2019
34.Dt ZFS-SNAPSHOT 8
35.Os
36.Sh NAME
37.Nm zfs-snapshot
38.Nd Creates snapshots with the given names.
39.Sh SYNOPSIS
40.Nm zfs
41.Cm snapshot
42.Op Fl r
43.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
44.Ar filesystem Ns @ Ns Ar snapname Ns | Ns Ar volume Ns @ Ns Ar snapname Ns ...
45.Sh DESCRIPTION
46.Bl -tag -width ""
47.It Xo
48.Nm zfs
49.Cm snapshot
50.Op Fl r
51.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
52.Ar filesystem Ns @ Ns Ar snapname Ns | Ns Ar volume Ns @ Ns Ar snapname Ns ...
53.Xc
54All previous modifications by successful system calls to the file system are
55part of the snapshots.
56Snapshots are taken atomically, so that all snapshots correspond to the same
57moment in time.
58.Nm zfs Cm snap
59can be used as an alias for
60.Nm zfs Cm snapshot.
61See the
62.Em Snapshots
63section of
64.Xr zfsconcepts 8
65for details.
66.Bl -tag -width "-o"
67.It Fl o Ar property Ns = Ns Ar value
68Sets the specified property; see
69.Nm zfs Cm create
70for details.
71.It Fl r
72Recursively create snapshots of all descendent datasets
73.El
74.El
75.Sh SEE ALSO
76.Xr zfs-bookmark 8 ,
77.Xr zfs-clone 8 ,
78.Xr zfs-destroy 8 ,
79.Xr zfs-diff 8 ,
80.Xr zfs-hold 8 ,
81.Xr zfs-rename 8 ,
82.Xr zfs-rollback 8 ,
83.Xr zfs-send 8
84