xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-snapshot.8 (revision 77013d11e6483b970af25e13c9b892075742f7e5)
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.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
22.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
23.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
24.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
25.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
26.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
27.\" Copyright (c) 2014 Integros [integros.com]
28.\" Copyright 2019 Richard Laager. All rights reserved.
29.\" Copyright 2018 Nexenta Systems, Inc.
30.\" Copyright 2019 Joyent, Inc.
31.\"
32.Dd May 27, 2021
33.Dt ZFS-SNAPSHOT 8
34.Os
35.
36.Sh NAME
37.Nm zfs-snapshot
38.Nd create snapshots of ZFS datasets
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 dataset Ns @ Ns Ar snapname Ns …
45.
46.Sh DESCRIPTION
47All previous modifications by successful system calls to the file system are
48part of the snapshots.
49Snapshots are taken atomically, so that all snapshots correspond to the same
50moment in time.
51.Nm zfs Cm snap
52can be used as an alias for
53.Nm zfs Cm snapshot .
54See the
55.Sx Snapshots
56section of
57.Xr zfsconcepts 7
58for details.
59.Bl -tag -width "-o"
60.It Fl o Ar property Ns = Ns Ar value
61Set the specified property; see
62.Nm zfs Cm create
63for details.
64.It Fl r
65Recursively create snapshots of all descendent datasets
66.El
67.
68.Sh SEE ALSO
69.Xr zfs-bookmark 8 ,
70.Xr zfs-clone 8 ,
71.Xr zfs-destroy 8 ,
72.Xr zfs-diff 8 ,
73.Xr zfs-hold 8 ,
74.Xr zfs-rename 8 ,
75.Xr zfs-rollback 8 ,
76.Xr zfs-send 8
77