aboutsummaryrefslogtreecommitdiffstats
path: root/man/man8/zfs-program.8
diff options
context:
space:
mode:
authorJason King <[email protected]>2020-01-22 19:03:17 -0600
committerBrian Behlendorf <[email protected]>2020-01-22 17:03:17 -0800
commite2ef1cbf04c713fcdba33f8183e6a61a18f61119 (patch)
tree2b36d80a1fa639052d441758d7dc2ecb2c6e908f /man/man8/zfs-program.8
parent79add96766f03e7382f9a4b356e7a06f66b600f8 (diff)
Support inheriting properties in channel programs
This adds support in channel programs to inherit properties analogous to `zfs inherit` by adding `zfs.sync.inherit` and `zfs.check.inherit` functions to the ZFS LUA API. Reviewed-by: Brian Behlendorf <[email protected]> Signed-off-by: Jason King <[email protected]> Closes #9738
Diffstat (limited to 'man/man8/zfs-program.8')
-rw-r--r--man/man8/zfs-program.824
1 files changed, 23 insertions, 1 deletions
diff --git a/man/man8/zfs-program.8 b/man/man8/zfs-program.8
index 7c58af0d2..f953cf18f 100644
--- a/man/man8/zfs-program.8
+++ b/man/man8/zfs-program.8
@@ -9,8 +9,9 @@
.\"
.\"
.\" Copyright (c) 2016, 2019 by Delphix. All Rights Reserved.
+.\" Copyright 2020 Joyent, Inc.
.\"
-.Dd February 26, 2019
+.Dd January 15, 2020
.Dt ZFS-PROGRAM 8
.Os
.Sh NAME
@@ -364,6 +365,27 @@ Valid only for destroying snapshots.
If set to true, and the snapshot has holds or clones, allows the snapshot to be
marked for deferred deletion rather than failing.
.Ed
+.It Em zfs.sync.inherit(dataset, property)
+Clears the specified property in the given dataset, causing it to be inherited
+from an ancestor, or restored to the default if no ancestor property is set.
+The
+.Ql zfs inherit -S
+option has not been implemented.
+Returns 0 on success, or a nonzero error code if the property could not be
+cleared.
+.Pp
+dataset (string)
+.Bd -ragged -compact -offset "xxxx"
+Filesystem or snapshot containing the property to clear.
+.Ed
+.Pp
+property (string)
+.Bd -ragged -compact -offset "xxxx"
+The property to clear.
+Allowed properties are the same as those for the
+.Nm zfs Cm inherit
+command.
+.Ed
.It Em zfs.sync.promote(dataset)
Promote the given clone to a filesystem.
Returns 0 on successful promotion, or a nonzero error code otherwise.