The cbe_dump component dumps the meta-data of a CBE device (virtual block
device, free tree and meta tree) according to the configured parameters.
On success, the component exits with exit value 0, otherwise with exit
value -1.


Configuration
~~~~~~~~~~~~~

This is an example configuration of the component that will dump the
last valid superblock and the its last valid snapshot:

! <config>
!    <dump
!       max_superblocks="1"
!       max_snapshots="1"
!       vbd="yes"
!       free_tree="yes"
!       meta_tree="yes"
!       hashes="yes"/>
! </config>

This is a short description of the tags and attributes:

:config.free_tree:
  Dump free tree nodes.

:config.meta_tree:
  Dump meta tree nodes.

:config.hashes:
  Show hashes in all tree dumps.

:config.max_superblocks:
  Max number of superblocks to dump.

:config.max_snapshots:
  Max number of snapshot to dump per superblock.

:config.unused_nodes:
  Show unused nodes in all tree dumps.

:config.vbd:
  Dump virtual block device tree nodes.

:config.vbd_pba_filter:
  Only show sub-tree where the PBA matches.

:config.vbd_pba_filter_enabled:
  Enable PBA filter.

:config.vbd_vba_filter:
  Only show sub-tree where the VBA matches.

:config.vbd_vba_filter_enabled:
  Enable VBA filter.


Sessions
~~~~~~~~

This is an overview of the sessions required and provided by the
component apart from the environment sessions:

* Requires one Block session.


Examples
~~~~~~~~

An example of how to use the cbe_dump component can be found in the test script
'cbe/run/cbe_dump.run'.
