Print this page
10473 zfs(1M) missing cross-reference to zfs-program(1M)


1970            @       Symbolic link
1971            P       Event port
1972            =       Socket
1973            F       Regular file
1974 
1975        -H  Give more parsable tab-separated output, without header lines and
1976            without arrows.
1977 
1978        -t  Display the path's inode change time as the first column of output.
1979 
1980      zfs program [-jn] [-t timeout] [-m memory_limit] pool script [arg1 ...]
1981        Executes script as a ZFS channel program on pool.  The ZFS channel
1982        program interface allows ZFS administrative operations to be run
1983        programmatically via a Lua script.  The entire script is executed
1984        atomically, with no other administrative operations taking effect
1985        concurrently.  A library of ZFS calls is made available to channel
1986        program scripts.  Channel programs may only be run with root
1987        privileges.
1988 
1989        For full documentation of the ZFS channel program interface, see the
1990        manual page for
1991 
1992        -j
1993          Display channel program output in JSON format.  When this flag is
1994          specified and standard output is empty - channel program encountered
1995          an error.  The details of such an error will be printed to standard
1996          error in plain text.
1997 
1998        -n
1999          Executes a read-only channel program, which runs faster.  The program
2000          cannot change on-disk state by calling functions from the zfs.sync
2001          submodule.  The program can be used to gather information such as
2002          properties and determining if changes would succeed (zfs.check.*).
2003          Without this flag, all pending changes must be synced to disk before
2004          a channel program can complete.
2005 
2006        -t timeout
2007          Execution time limit, in milliseconds.  If a channel program executes
2008          for longer than the provided timeout, it will be stopped and an error
2009          will be returned.  The default timeout is 1000 ms, and can be set to
2010          a maximum of 10000 ms.


2297                group staff @pset
2298 
2299      Example 22 Showing the differences between a snapshot and a ZFS Dataset
2300        The following example shows how to see what has changed between a prior
2301        snapshot of a ZFS dataset and its current state.  The -F option is used
2302        to indicate type information for the files affected.
2303 
2304        # zfs diff -F tank/test@before tank/test
2305        M       /       /tank/test/
2306        M       F       /tank/test/linked      (+1)
2307        R       F       /tank/test/oldname -> /tank/test/newname
2308        -       F       /tank/test/deleted
2309        +       F       /tank/test/created
2310        M       F       /tank/test/modified
2311 
2312 INTERFACE STABILITY
2313      Committed.
2314 
2315 SEE ALSO
2316      gzip(1), ssh(1), mount(1M), share(1M), sharemgr(1M), unshare(1M),
2317      zonecfg(1M), zpool(1M), chmod(2), stat(2), write(2), fsync(3C),
2318      dfstab(4), acl(5), attributes(5)
2319 
2320 illumos                         January 5, 2019                        illumos


1970            @       Symbolic link
1971            P       Event port
1972            =       Socket
1973            F       Regular file
1974 
1975        -H  Give more parsable tab-separated output, without header lines and
1976            without arrows.
1977 
1978        -t  Display the path's inode change time as the first column of output.
1979 
1980      zfs program [-jn] [-t timeout] [-m memory_limit] pool script [arg1 ...]
1981        Executes script as a ZFS channel program on pool.  The ZFS channel
1982        program interface allows ZFS administrative operations to be run
1983        programmatically via a Lua script.  The entire script is executed
1984        atomically, with no other administrative operations taking effect
1985        concurrently.  A library of ZFS calls is made available to channel
1986        program scripts.  Channel programs may only be run with root
1987        privileges.
1988 
1989        For full documentation of the ZFS channel program interface, see the
1990        manual page for zfs-program(1M).
1991 
1992        -j
1993          Display channel program output in JSON format.  When this flag is
1994          specified and standard output is empty - channel program encountered
1995          an error.  The details of such an error will be printed to standard
1996          error in plain text.
1997 
1998        -n
1999          Executes a read-only channel program, which runs faster.  The program
2000          cannot change on-disk state by calling functions from the zfs.sync
2001          submodule.  The program can be used to gather information such as
2002          properties and determining if changes would succeed (zfs.check.*).
2003          Without this flag, all pending changes must be synced to disk before
2004          a channel program can complete.
2005 
2006        -t timeout
2007          Execution time limit, in milliseconds.  If a channel program executes
2008          for longer than the provided timeout, it will be stopped and an error
2009          will be returned.  The default timeout is 1000 ms, and can be set to
2010          a maximum of 10000 ms.


2297                group staff @pset
2298 
2299      Example 22 Showing the differences between a snapshot and a ZFS Dataset
2300        The following example shows how to see what has changed between a prior
2301        snapshot of a ZFS dataset and its current state.  The -F option is used
2302        to indicate type information for the files affected.
2303 
2304        # zfs diff -F tank/test@before tank/test
2305        M       /       /tank/test/
2306        M       F       /tank/test/linked      (+1)
2307        R       F       /tank/test/oldname -> /tank/test/newname
2308        -       F       /tank/test/deleted
2309        +       F       /tank/test/created
2310        M       F       /tank/test/modified
2311 
2312 INTERFACE STABILITY
2313      Committed.
2314 
2315 SEE ALSO
2316      gzip(1), ssh(1), mount(1M), share(1M), sharemgr(1M), unshare(1M),
2317      zfs-program(1M), zonecfg(1M), zpool(1M), chmod(2), stat(2), write(2),
2318      fsync(3C), dfstab(4), acl(5), attributes(5)
2319 
2320 illumos                        February 26, 2019                       illumos