sys-utils/blkzone.8

   1 .TH BLKZONE 8 "February 2017" "util-linux" "System Administration"
   2 .SH NAME
   3 blkzone \- run zone command on a device
   4 .SH SYNOPSIS
   5 .B blkzone
   6 .I command
   7 [options]
   8 .I device
   9 .SH DESCRIPTION
  10 .B blkzone
  11 is used to run zone command on device that support the Zoned Block Commands
  12 (ZBC) or Zoned-device ATA Commands (ZAC). The zones to operate on can be
  13 specified using the offset, count and length options.
  14 .PP
  15 The
  16 .I device
  17 argument is the pathname of the block device.
  18 .SH COMMANDS
  19 .SS report
  20 The command \fBblkzone report\fP is used to report device zone information.
  21 .PP
  22 By default, the command will report all zones from the start of the
  23 block device. Options may be used to modify this behavior, changing the
  24 starting zone or the size of the report, as explained below.
  25
  26 .B Report output
  27 .TS
  28 tab(:);
  29 l l.
  30 start:Zone start sector
  31 len:Zone length in number of sectors
  32 wptr:Zone write pointer position
  33 reset:Reset write pointer recommended
  34 non-seq:Non-sequential write resources active
  35 cond:Zone condition
  36 type:Zone type
  37 .TE
  38
  39 .B Zone conditions
  40 .TS
  41 tab(:);
  42 l l.
  43 cl:Closed
  44 nw:Not write pointer
  45 em:Empty
  46 fu:Full
  47 oe:Explicitly opened
  48 oi:Implicitly opened
  49 ol:Offline
  50 ro:Read only
  51 x?:Reserved conditions (should not be reported)
  52 .TE
  53
  54 .SS reset
  55 The command \fBblkzone reset\fP is used to reset one or more zones. Unlike
  56 .BR sg_reset_wp (8),
  57 this command operates from the block layer and can reset a range of zones.
  58 .PP
  59 By default, the command will operate from the zone at device
  60 sector 0 and reset all zones. Options may be used to modify this behavior
  61 as well as specify the operation to be performed on the zone, as explained below.
  62
  63 .SH OPTIONS
  64 The
  65 .I offset
  66 and
  67 .I length
  68 option arguments may be followed by the multiplicative suffixes KiB (=1024),
  69 MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is
  70 optional, e.g., "K" has the same meaning as "KiB") or the suffixes
  71 KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB.
  72 Additionally, the 0x prefix can be used to specify \fIoffset\fR and
  73 \fIlength\fR in hex.
  74 .TP
  75 .BR \-o , " \-\-offset "\fIsector\fP
  76 The starting zone specified as a sector offset. The provided offset in sector
  77 units (512 bytes) should match the start of a zone. The default value is zero.
  78 .TP
  79 .BR \-l , " \-\-length "\fIsectors\fP
  80 The maximum number of sectors the command should operate on. The default value
  81 is the number of sectors remaining after \fIoffset\fR. This option cannot be
  82 used together with the option \fB\-\-count\fP.
  83 .TP
  84 .BR \-c , " \-\-count "\fIcount\fP
  85 The maximum number of zones the command should operate on. The default value
  86 is the number of zones starting from \fIoffset\fR. This option cannot be
  87 used together with the option \fB\-\-length\fP.
  88 .TP
  89 .BR \-v , " \-\-verbose"
  90 Display the number of zones returned in the report or the range of sectors
  91 reset..
  92 .TP
  93 .BR \-V , " \-\-version"
  94 Display version information and exit.
  95 .TP
  96 .BR \-h , " \-\-help"
  97 Display help text and exit.
  98 .SH AUTHORS
  99 .nf
 100 Shaun Tancheff <shaun@tancheff.com>
 101 Karel Zak <kzak@redhat.com>
 102 .fi
 103 .SH SEE ALSO
 104 .BR sg_rep_zones (8)
 105 .SH AVAILABILITY
 106 The blkzone command is part of the util-linux package and is available from
 107 .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
 108 Linux Kernel Archive
 109 .UE .