Lines Matching +full:sync +full:- +full:flag
1 .\" SPDX-License-Identifier: CDDL-1.0
21 .Nm zfs-program
27 .Op Fl t Ar instruction-limit
28 .Op Fl m Ar memory-limit
53 .Bl -tag -width "-t"
54 .It Fl j , -json
56 When this flag is specified and standard output is empty -
60 Executes a read-only channel program, which runs faster.
61 The program cannot change on-disk state by calling functions from the
62 zfs.sync submodule.
65 Without this flag, all pending changes must be synced to disk before a
67 .It Fl t Ar instruction-limit
73 .It Fl m Ar memory-limit
94 .Bd -literal -compact -offset indent
97 -- argv == {1="arg1", 2="arg2", ...}
104 .Bd -literal -compact -offset indent
106 -- args == {"foo"="bar", "baz"={...}, ...}
109 Note that because Lua arrays are 1-indexed, arrays passed to Lua from the
127 .Bd -literal -compact -offset indent
133 .Bd -literal -compact -offset indent
141 If the channel program encounters a fatal error while running, a non-zero exit
168 section below for function-specific details on error return codes.
173 and vice-versa.
181 string -> string
182 number -> int64
183 boolean -> boolean_value
184 nil -> boolean (no value)
185 table -> nvlist
191 string -> no change
192 number -> signed decimal string ("%lld")
193 boolean -> "true" | "false"
199 Lua numbers are represented internally as signed 64-bit integers.
202 The following Lua built-in base library functions are available:
216 built-in submodules are also available.
237 .Dl Sy zfs.sync.destroy Ns Pq \&"rpool@snap"
242 .Dl Sy zfs.sync.destroy Ns Pq {1="rpool@snap", defer=true}
246 .Dl Sy zfs.sync.snapshot Ns {"rpool@snap", defer=true}
262 .Dl errno = Sy zfs.sync.promote Ns Pq dataset
265 .Bd -literal -compact -offset indent
266 .No errno, details = Sy zfs.sync.promote Ns Pq dataset
289 .Bl -tag -width "xx"
294 .Dl dtrace -n 'zfs-dbgmsg{trace(stringof(arg0))}'
296 .Bl -tag -compact -width "property (string)"
309 .Bl -tag -compact -width "property (string)"
325 .Bl -tag -compact -width "property (string)"
343 .Bl -tag -width "xx"
344 .It Sy zfs.sync submodule
345 The sync submodule contains functions that modify the on-disk state.
348 The available sync submodule functions are as follows:
349 .Bl -tag -width "xx"
350 .It Sy zfs.sync.destroy Ns Pq Ar dataset , Op Ar defer Ns = Ns Sy true Ns | Ns Sy false
356 .Bl -tag -compact -width "newbookmark (string)"
364 .It Fn zfs.sync.inherit dataset property
373 .Bl -tag -compact -width "newbookmark (string)"
382 .It Fn zfs.sync.promote dataset
388 .Bl -tag -compact -width "newbookmark (string)"
392 .It Fn zfs.sync.rollback filesystem
399 .Bl -tag -compact -width "newbookmark (string)"
403 .It Fn zfs.sync.set_prop dataset property value
408 .Bl -tag -compact -width "newbookmark (string)"
416 .It Fn zfs.sync.snapshot dataset
424 .Bl -tag -compact -width "newbookmark (string)"
428 .It Fn zfs.sync.rename_snapshot dataset oldsnapname newsnapname
433 .Bl -tag -compact -width "newbookmark (string)"
441 .It Fn zfs.sync.bookmark source newbookmark
448 .Bl -tag -compact -width "newbookmark (string)"
457 .Sy zfs.sync
462 .Sy zfs.sync
464 or a non-zero error code if it would fail, along with any other error details.
465 That is, each has the same behavior as the corresponding sync function except
470 .Fn zfs.sync.destroy \&"fs"
476 .Bl -tag -compact -width "xx"
488 .Bd -literal -compact -offset indent
497 .Bl -tag -width "xx"
501 .Bl -tag -compact -width "snapshot (string)"
510 .Bl -tag -compact -width "snapshot (string)"
519 .Bl -tag -compact -width "snapshot (string)"
528 .Bl -tag -compact -width "snapshot (string)"
538 .Bl -tag -compact -width "snapshot (string)"
545 .Bl -tag -compact -width "snapshot (string)"
555 .Bl -tag -compact -width "snapshot (string)"
560 Returns an array of strings, the names of the valid system (non-user defined)
564 .Bl -tag -compact -width "snapshot (string)"
577 .Bd -literal -offset indent
583 zfs.sync.destroy(snap)
585 zfs.sync.destroy(root)
594 .Bd -literal -offset indent
603 err = zfs.sync.destroy(snap)
610 err = zfs.sync.destroy(root)
632 .Bd -literal -offset indent
638 zfs.sync.destroy(ds .. "@" .. snap)
643 return zfs.sync.promote(ds)