sys-utils/blkzone.8.adoc

   1 = blkzone(8)
   2 :doctype: manpage
   3 :man manual: User commands
   4 :man source: util-linux {release-version}
   5 :page-layout: base
   6 :command: blkzone
   7
   8 == NAME
   9
  10 blkzone - run zone command on a device
  11
  12 == SYNOPSIS
  13
  14 *blkzone* _command_ [_options_] _device_
  15
  16 == DESCRIPTION
  17
  18 *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.
  19
  20 The _device_ argument is the pathname of the block device.
  21
  22 == COMMANDS
  23
  24 === report
  25
  26 The command *blkzone report* is used to report device zone information.
  27
  28 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.
  29
  30 .Report output
  31 [cols=",",]
  32 |===
  33 |start |Zone start sector
  34 |len |Zone length in number of sectors
  35 |cap |Zone capacity in number of sectors
  36 |wptr |Zone write pointer position
  37 |reset |Reset write pointer recommended
  38 |non-seq |Non-sequential write resources active
  39 |cond |Zone condition
  40 |type |Zone type
  41 |===
  42
  43 .Zone conditions
  44 [cols=",",]
  45 |===
  46 |cl |Closed
  47 |nw |Not write pointer
  48 |em |Empty
  49 |fu |Full
  50 |oe |Explicitly opened
  51 |oi |Implicitly opened
  52 |ol |Offline
  53 |ro |Read only
  54 |x? |Reserved conditions (should not be reported)
  55 |===
  56
  57 === capacity
  58
  59 The command *blkzone capacity* is used to report device capacity information.
  60
  61 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.
  62
  63 === reset
  64
  65 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.
  66
  67 === open
  68
  69 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.
  70
  71 === close
  72
  73 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.
  74
  75 === finish
  76
  77 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.
  78
  79 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.
  80
  81 == OPTIONS
  82
  83 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.
  84
  85 *-o*, *--offset* _sector_::
  86   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.
  87
  88 *-l*, *--length* _sectors_::
  89   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*.
  90
  91 *-c*, *--count* _count_::
  92   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*.
  93
  94 *-f*, *--force*::
  95   Enforce commands to change zone status on block devices used by the system.
  96
  97 *-v*, *--verbose*::
  98   Display the number of zones returned in the report or the range of sectors reset.
  99
 100 *-V*, *--version*::
 101   Display version information and exit.
 102
 103 *-h*, *--help*::
 104   Display help text and exit.
 105
 106 == AUTHORS
 107
 108 mailto:shaun@tancheff.com[Shaun Tancheff] +
 109 mailto:kzak@redhat.com[Karel Zak]
 110
 111 == SEE ALSO
 112
 113 *sg_rep_zones*(8)
 114
 115 include::../man-common/bugreports.adoc[]
 116
 117 include::../man-common/footer.adoc[]
 118
 119 ifdef::translation[]
 120 include::../man-common/translation.adoc[]
 121 endif::[]