blkzone(8) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | COMMANDS | OPTIONS | AUTHORS | SEE ALSO | REPORTING BUGS | AVAILABILITY

BLKZONE(8)                System Administration               BLKZONE(8)

NAME         top

       blkzone - run zone command on a device

SYNOPSIS         top

       blkzone command [options] device

DESCRIPTION         top

       blkzone is used to run zone command on device that support the
       Zoned Block Commands (ZBC) or Zoned-device ATA Commands (ZAC).
       The zones to operate on can be specified using the offset, count
       and length options.

       The device argument is the pathname of the block device.

COMMANDS         top

   report
       The command blkzone report is used to report device zone
       information.

       By default, the command will report all zones from the start of
       the block device. Options may be used to modify this behavior,
       changing the starting zone or the size of the report, as
       explained below.

       Report output:
       ┌─────────┬──────────────────────────┐
       │         │                          │
       │ start   │ Zone start sector        │
       ├─────────┼──────────────────────────┤
       │         │                          │
       │ len     │ Zone length in number of │
       │         │ sectors                  │
       ├─────────┼──────────────────────────┤
       │         │                          │
       │ cap     │ Zone capacity in number  │
       │         │ of sectors               │
       ├─────────┼──────────────────────────┤
       │         │                          │
       │ wptr    │ Zone write pointer       │
       │         │ position                 │
       ├─────────┼──────────────────────────┤
       │         │                          │
       │ reset   │ Reset write pointer      │
       │         │ recommended              │
       ├─────────┼──────────────────────────┤
       │         │                          │
       │ non-seq │ Non-sequential write     │
       │         │ resources active         │
       ├─────────┼──────────────────────────┤
       │         │                          │
       │ cond    │ Zone condition           │
       ├─────────┼──────────────────────────┤
       │         │                          │
       │ type    │ Zone type                │
       └─────────┴──────────────────────────┘

       Zone conditions:
       ┌────┬──────────────────────────┐
       │    │                          │
       │ cl │ Closed                   │
       ├────┼──────────────────────────┤
       │    │                          │
       │ nw │ Not write pointer        │
       ├────┼──────────────────────────┤
       │    │                          │
       │ em │ Empty                    │
       ├────┼──────────────────────────┤
       │    │                          │
       │ fu │ Full                     │
       ├────┼──────────────────────────┤
       │    │                          │
       │ oe │ Explicitly opened        │
       ├────┼──────────────────────────┤
       │    │                          │
       │ oi │ Implicitly opened        │
       ├────┼──────────────────────────┤
       │    │                          │
       │ ol │ Offline                  │
       ├────┼──────────────────────────┤
       │    │                          │
       │ ro │ Read only                │
       ├────┼──────────────────────────┤
       │    │                          │
       │ x? │ Reserved conditions      │
       │    │ (should not be reported) │
       └────┴──────────────────────────┘

   capacity
       The command blkzone capacity is used to report device capacity
       information.

       By default, the command will report the sum, in number of
       sectors, of all zone capacities on the device. Options may be
       used to modify this behavior, changing the starting zone or the
       size of the report, as explained below.

   reset
       The command blkzone reset is used to reset one or more zones.
       Unlike sg_reset_wp(8), this command operates from the block layer
       and can reset a range of zones.

   open
       The command blkzone open is used to explicitly open one or more
       zones. Unlike sg_zone(8), open action, this command operates from
       the block layer and can open a range of zones.

   close
       The command blkzone close is used to close one or more zones.
       Unlike sg_zone(8), close action, this command operates from the
       block layer and can close a range of zones.

   finish
       The command blkzone finish is used to finish (transition to full
       condition) one or more zones. Unlike sg_zone(8), finish action,
       this command operates from the block layer and can finish a range
       of zones.

       By default, the reset, open, close and finish commands will
       operate from the zone at device sector 0 and operate on all
       zones. Options may be used to modify this behavior as explained
       below.

OPTIONS         top

       The offset and length option arguments may be followed by the
       multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on
       for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g.,
       "K" has the same meaning as "KiB") or the suffixes KB (=1000), MB
       (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB.
       Additionally, the 0x prefix can be used to specify offset and
       length in hex.

       -o, --offset sector
           The starting zone specified as a sector offset. The provided
           offset in sector units (512 bytes) should match the start of
           a zone. The default value is zero.

       -l, --length sectors
           The maximum number of sectors the command should operate on.
           The default value is the number of sectors remaining after
           offset. This option cannot be used together with the option
           --count.

       -c, --count count
           The maximum number of zones the command should operate on.
           The default value is the number of zones starting from
           offset. This option cannot be used together with the option
           --length.

       -f, --force
           Enforce commands to change zone status on block devices used
           by the system.

       -v, --verbose
           Display the number of zones returned in the report or the
           range of sectors reset.

       -h, --help
           Display help text and exit.

       -V, --version
           Print version and exit.

AUTHORS         top

       Shaun Tancheff <[email protected]>, Karel Zak <[email protected]>

SEE ALSO         top

       sg_rep_zones(8)

REPORTING BUGS         top

       For bug reports, use the issue tracker at
       https://github.com/util-linux/util-linux/issues.

AVAILABILITY         top

       The blkzone command is part of the util-linux package which can
       be downloaded from Linux Kernel Archive
       <https://www.kernel.org/pub/linux/utils/util-linux/>. This page
       is part of the util-linux (a random collection of Linux
       utilities) project. Information about the project can be found at
       ⟨https://www.kernel.org/pub/linux/utils/util-linux/⟩. If you have
       a bug report for this manual page, send it to
       [email protected]. This page was obtained from the
       project's upstream Git repository
       ⟨git://git.kernel.org/pub/scm/utils/util-linux/util-linux.git⟩ on
       2024-06-14. (At that time, the date of the most recent commit
       that was found in the repository was 2024-06-10.) If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in
       this COLOPHON (which is not part of the original manual page),
       send a mail to [email protected]

util-linux 2.39.594-1e0ad      2023-07-19                     BLKZONE(8)