manual/util-linux/original/man8/blkzone.8

   1 '\" t
   2 .\"     Title: blkzone
   3 .\"    Author: [see the "AUTHOR(S)" section]
   4 .\" Generator: Asciidoctor 2.0.15
   5 .\"      Date: 2022-02-14
   6 .\"    Manual: System Administration
   7 .\"    Source: util-linux 2.37.4
   8 .\"  Language: English
   9 .\"
  10 .TH "BLKZONE" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration"
  11 .ie \n(.g .ds Aq \(aq
  12 .el       .ds Aq '
  13 .ss \n[.ss] 0
  14 .nh
  15 .ad l
  16 .de URL
  17 \fI\\$2\fP <\\$1>\\$3
  18 ..
  19 .als MTO URL
  20 .if \n[.g] \{\
  21 .  mso www.tmac
  22 .  am URL
  23 .    ad l
  24 .  .
  25 .  am MTO
  26 .    ad l
  27 .  .
  28 .  LINKSTYLE blue R < >
  29 .\}
  30 .SH "NAME"
  31 blkzone \- run zone command on a device
  32 .SH "SYNOPSIS"
  33 .sp
  34 \fBblkzone\fP \fIcommand\fP [options] \fIdevice\fP
  35 .SH "DESCRIPTION"
  36 .sp
  37 \fBblkzone\fP 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.
  38 .sp
  39 The \fIdevice\fP argument is the pathname of the block device.
  40 .SH "COMMANDS"
  41 .SS "report"
  42 .sp
  43 The command \fBblkzone report\fP is used to report device zone information.
  44 .sp
  45 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.
  46 .sp
  47 Report output:
  48 .TS
  49 allbox tab(:);
  50 lt lt.
  51 T{
  52 .sp
  53 start
  54 T}:T{
  55 .sp
  56 Zone start sector
  57 T}
  58 T{
  59 .sp
  60 len
  61 T}:T{
  62 .sp
  63 Zone length in number of sectors
  64 T}
  65 T{
  66 .sp
  67 cap
  68 T}:T{
  69 .sp
  70 Zone capacity in number of sectors
  71 T}
  72 T{
  73 .sp
  74 wptr
  75 T}:T{
  76 .sp
  77 Zone write pointer position
  78 T}
  79 T{
  80 .sp
  81 reset
  82 T}:T{
  83 .sp
  84 Reset write pointer recommended
  85 T}
  86 T{
  87 .sp
  88 non\-seq
  89 T}:T{
  90 .sp
  91 Non\-sequential write resources active
  92 T}
  93 T{
  94 .sp
  95 cond
  96 T}:T{
  97 .sp
  98 Zone condition
  99 T}
 100 T{
 101 .sp
 102 type
 103 T}:T{
 104 .sp
 105 Zone type
 106 T}
 107 .TE
 108 .sp
 109 .sp
 110 Zone conditions:
 111 .TS
 112 allbox tab(:);
 113 lt lt.
 114 T{
 115 .sp
 116 cl
 117 T}:T{
 118 .sp
 119 Closed
 120 T}
 121 T{
 122 .sp
 123 nw
 124 T}:T{
 125 .sp
 126 Not write pointer
 127 T}
 128 T{
 129 .sp
 130 em
 131 T}:T{
 132 .sp
 133 Empty
 134 T}
 135 T{
 136 .sp
 137 fu
 138 T}:T{
 139 .sp
 140 Full
 141 T}
 142 T{
 143 .sp
 144 oe
 145 T}:T{
 146 .sp
 147 Explicitly opened
 148 T}
 149 T{
 150 .sp
 151 oi
 152 T}:T{
 153 .sp
 154 Implicitly opened
 155 T}
 156 T{
 157 .sp
 158 ol
 159 T}:T{
 160 .sp
 161 Offline
 162 T}
 163 T{
 164 .sp
 165 ro
 166 T}:T{
 167 .sp
 168 Read only
 169 T}
 170 T{
 171 .sp
 172 x?
 173 T}:T{
 174 .sp
 175 Reserved conditions (should not be reported)
 176 T}
 177 .TE
 178 .sp
 179 .SS "capacity"
 180 .sp
 181 The command \fBblkzone capacity\fP is used to report device capacity information.
 182 .sp
 183 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.
 184 .SS "reset"
 185 .sp
 186 The command \fBblkzone reset\fP is used to reset one or more zones. Unlike \fBsg_reset_wp\fP(8), this command operates from the block layer and can reset a range of zones.
 187 .SS "open"
 188 .sp
 189 The command \fBblkzone open\fP is used to explicitly open one or more zones. Unlike \fBsg_zone\fP(8), open action, this command operates from the block layer and can open a range of zones.
 190 .SS "close"
 191 .sp
 192 The command \fBblkzone close\fP is used to close one or more zones. Unlike \fBsg_zone\fP(8), close action, this command operates from the block layer and can close a range of zones.
 193 .SS "finish"
 194 .sp
 195 The command \fBblkzone finish\fP is used to finish (transition to full condition) one or more zones. Unlike \fBsg_zone\fP(8), finish action, this command operates from the block layer and can finish a range of zones.
 196 .sp
 197 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.
 198 .SH "OPTIONS"
 199 .sp
 200 The \fIoffset\fP and \fIlength\fP 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 \fIoffset\fP and \fIlength\fP in hex.
 201 .sp
 202 \fB\-o\fP, \fB\-\-offset\fP \fIsector\fP
 203 .RS 4
 204 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.
 205 .RE
 206 .sp
 207 \fB\-l\fP, \fB\-\-length\fP \fIsectors\fP
 208 .RS 4
 209 The maximum number of sectors the command should operate on. The default value is the number of sectors remaining after \fIoffset\fP. This option cannot be used together with the option \fB\-\-count\fP.
 210 .RE
 211 .sp
 212 \fB\-c\fP, \fB\-\-count\fP \fIcount\fP
 213 .RS 4
 214 The maximum number of zones the command should operate on. The default value is the number of zones starting from \fIoffset\fP. This option cannot be used together with the option \fB\-\-length\fP.
 215 .RE
 216 .sp
 217 \fB\-f\fP, \fB\-\-force\fP
 218 .RS 4
 219 Enforce commands to change zone status on block devices used by the system.
 220 .RE
 221 .sp
 222 \fB\-v\fP, \fB\-\-verbose\fP
 223 .RS 4
 224 Display the number of zones returned in the report or the range of sectors reset.
 225 .RE
 226 .sp
 227 \fB\-V\fP, \fB\-\-version\fP
 228 .RS 4
 229 Display version information and exit.
 230 .RE
 231 .sp
 232 \fB\-h\fP, \fB\-\-help\fP
 233 .RS 4
 234 Display help text and exit.
 235 .RE
 236 .SH "AUTHORS"
 237 .sp
 238 .MTO "shaun\(attancheff.com" "Shaun Tancheff" ","
 239 .MTO "kzak\(atredhat.com" "Karel Zak" ""
 240 .SH "SEE ALSO"
 241 .sp
 242 \fBsg_rep_zones\fP(8)
 243 .SH "REPORTING BUGS"
 244 .sp
 245 For bug reports, use the issue tracker at \c
 246 .URL "https://github.com/karelzak/util\-linux/issues" "" "."
 247 .SH "AVAILABILITY"
 248 .sp
 249 The \fBblkzone\fP command is part of the util\-linux package which can be downloaded from \c
 250 .URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."