Lines Matching +full:string +full:- +full:array +full:- +full:property

16 .Dt ZFS-PROGRAM 8
20 .Nm zfs-program
26 .Op Fl t Ar instruction-limit
27 .Op Fl m Ar memory-limit
52 .Bl -tag -width "-t"
53 .It Fl j , -json
55 When this flag is specified and standard output is empty -
59 Executes a read-only channel program, which runs faster.
60 The program cannot change on-disk state by calling functions from the
66 .It Fl t Ar instruction-limit
72 .It Fl m Ar memory-limit
92 accessible as an array stored in the argument table with the key 'argv':
93 .Bd -literal -compact -offset indent
96 -- argv == {1="arg1", 2="arg2", ...}
103 .Bd -literal -compact -offset indent
105 -- args == {"foo"="bar", "baz"={...}, ...}
108 Note that because Lua arrays are 1-indexed, arrays passed to Lua from the
113 in a C array passed to a channel program will be stored in
126 .Bd -literal -compact -offset indent
132 .Bd -literal -compact -offset indent
140 If the channel program encounters a fatal error while running, a non-zero exit
144 .Dl error: \&"error string, including Lua stack trace"
167 section below for function-specific details on error return codes.
172 and vice-versa.
180 	string	->	string
181 	number	->	int64
182 	boolean	->	boolean_value
183 	nil	->	boolean (no value)
184 	table	->	nvlist
187 Likewise, table keys are replaced by string equivalents as follows:
190 	string	->	no change
191 	number	->	signed decimal string ("%lld")
192 	boolean	->	"true" | "false"
195 Any collision of table key strings (for example, the string "true" and a
198 Lua numbers are represented internally as signed 64-bit integers.
201 The following Lua built-in base library functions are available:
212 .Em string ,
215 built-in submodules are also available.
231 For example, the destroy function takes a single positional string argument
264 .Bd -literal -compact -offset indent
288 .Bl -tag -width "xx"
293 .Dl dtrace -n 'zfs-dbgmsg{trace(stringof(arg0))}'
295 .Bl -tag -compact -width "property (string)"
296 .It Ar msg Pq string
308 .Bl -tag -compact -width "property (string)"
309 .It Ar dataset Pq string
313 .It Fn zfs.get_prop dataset property
315 First, a string, number or table containing the property value for the given
317 Second, a string containing the source of the property (i.e. the name of the
319 Throws a Lua error if the dataset is invalid or the property doesn't exist.
324 .Bl -tag -compact -width "property (string)"
325 .It Ar dataset Pq string
327 .It Ar property Pq string
328 Name of property to retrieve.
342 .Bl -tag -width "xx"
344 The sync submodule contains functions that modify the on-disk state.
348 .Bl -tag -width "xx"
355 .Bl -tag -compact -width "newbookmark (string)"
356 .It Ar dataset Pq string
363 .It Fn zfs.sync.inherit dataset property
364 Clears the specified property in the given dataset, causing it to be inherited
365 from an ancestor, or restored to the default if no ancestor property is set.
369 Returns 0 on success, or a nonzero error code if the property could not be
372 .Bl -tag -compact -width "newbookmark (string)"
373 .It Ar dataset Pq string
374 Filesystem or snapshot containing the property to clear.
375 .It Ar property Pq string
376 The property to clear.
384 If EEXIST is returned, the second return value will be an array of the clone's
387 .Bl -tag -compact -width "newbookmark (string)"
388 .It Ar dataset Pq string
398 .Bl -tag -compact -width "newbookmark (string)"
399 .It Ar filesystem Pq string
402 .It Fn zfs.sync.set_prop dataset property value
403 Sets the given property on a dataset.
405 Returns 0 if the property was set, or a nonzero error code otherwise.
407 .Bl -tag -compact -width "newbookmark (string)"
408 .It Ar dataset Pq string
409 The dataset where the property will be set.
410 .It Ar property Pq string
411 The property to set.
412 .It Ar value Pq string
413 The value of the property to be set.
423 .Bl -tag -compact -width "newbookmark (string)"
424 .It Ar dataset Pq string
432 .Bl -tag -compact -width "newbookmark (string)"
433 .It Ar dataset Pq string
435 .It Ar oldsnapname Pq string
437 .It Ar newsnapname Pq string
447 .Bl -tag -compact -width "newbookmark (string)"
448 .It Ar source Pq string
450 .It Ar newbookmark Pq string
463 or a non-zero error code if it would fail, along with any other error details.
475 .Bl -tag -compact -width "xx"
479 .It Fn zfs.check.set_property dataset property value
487 .Bd -literal -compact -offset indent
496 .Bl -tag -width "xx"
500 .Bl -tag -compact -width "snapshot (string)"
501 .It Ar snapshot Pq string
506 Each snapshot is returned as a string containing the full dataset name,
509 .Bl -tag -compact -width "snapshot (string)"
510 .It Ar dataset Pq string
515 Each child is returned as a string containing the full dataset name,
518 .Bl -tag -compact -width "snapshot (string)"
519 .It Ar dataset Pq string
524 Each bookmark is returned as a string containing the full dataset name,
527 .Bl -tag -compact -width "snapshot (string)"
528 .It Ar dataset Pq string
537 .Bl -tag -compact -width "snapshot (string)"
538 .It Ar snapshot Pq string
544 .Bl -tag -compact -width "snapshot (string)"
545 .It Ar dataset Pq string
550 For each step of the iteration, output the property name, its value,
554 .Bl -tag -compact -width "snapshot (string)"
555 .It Ar dataset Pq string
559 Returns an array of strings, the names of the valid system (non-user defined)
563 .Bl -tag -compact -width "snapshot (string)"
564 .It Ar dataset Pq string
576 .Bd -literal -offset indent
593 .Bd -literal -offset indent
631 .Bd -literal -offset indent