.\" Text automatically generated by txt2man
.TH thin_metadata_size 8 "Device Mapper Tools" "System Manager's Manual"
.SH NAME
\fBthin_metadata_size \fP- thin provisioning metadata device/file size calculator.
\fB
.SH SYNOPSIS
.nf
.fam C
\fBthin_metadata_size\fP [\fIoptions\fP]

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBthin_metadata_size\fP calculates the size of the thin provisioning metadata
based on the block size of the thin provisioned devices, the size of the thin
provisioning pool and the maximum number of all thin provisioned devices and
snapshots. Because thin provisioning pools are holding widely variable
contents, this tool is needed to provide sensible initial default size.
.SH OPTIONS
.TP
.B
\fB-h\fP, \fB--help\fP
Print help and exit.
.TP
.B
\fB-V\fP, \fB--version\fP
Print version information and exit.
.TP
.B
\fB-b\fP, \fB--block-size\fP {BLOCKSIZE[bskKmMgGtTpPeEzZyY]}
Set block size.
.PP
.nf
.fam C
    Block size of thin provisioned devices in units of bytes, sectors,
    kibibytes, kilobytes, \.\.\. respectively. Default is in sectors without a
    block size unit specifier. Size/number option arguments can be followed by
    unit specifiers in short one character and long form (eg. -b1m or
    -b1mebibytes).

.fam T
.fi
.TP
.B
\fB-s\fP, \fB--pool-size\fP {POOLSIZE[bskKmMgGtTpPeEzZyY]}
Set pool size.
.PP
.nf
.fam C
    Thin provisioning pool size in units of bytes, sectors, kibibytes,
    kilobytes, \.\.\. respectively. Default is in sectors without a pool size
    unit specifier.

.fam T
.fi
.TP
.B
\fB-m\fP, \fB--max-thins\fP {count[bskKmMgGtTpPeEzZyY]}
Set max thins.
.PP
.nf
.fam C
    Maximum sum of all thin provisioned devices and snapshots. Unit identifier
    supported to allow for convenient entry of large quantities, eg. 1000000 =
    1M. Default is absolute quantity without a number unit specifier.

.fam T
.fi
\fB-u\fP, \fB--unit\fP {bskKmMgGtTpPeEzZyY}
.PP
.nf
.fam C
    Output unit specifier in units of bytes, sectors, kibibytes, kilobytes, \.\.\.
    respectively. Default is in sectors without an output unit specifier.

.fam T
.fi
.TP
.B
\fB-n\fP, \fB--numeric-only\fP {short|long}
Limit output to just the size number.
.SH EXAMPLES
Calculates the thin provisioning metadata device size for block size 64
kibibytes, pool size 1 tebibytes and maximum number of thin provisioned
devices and snapshots of 1000 in units of sectors with long output:
.PP
.nf
.fam C
    $ thin_metadata_size -b64k -s1t -m1000

.fam T
.fi
Or (using the long \fIoptions\fP instead) for block size 1 gibibyte, pool size 1
petabyte and maximum number of thin provisioned devices and snapshots of 1
million with numeric-only output in units of gigabytes:
.PP
.nf
.fam C
    $ thin_metadata_size --block-size=1g --pool-size=1P --max-thins=1M --unit=G --numeric-only

.fam T
.fi
Same as before (1g, 1P, 1M, numeric-only) but with unit specifier character
appended:
.PP
.nf
.fam C
    $ thin_metadata_size --block-size=1gibi --pool-size=1petabytes --max-thins=1mega --unit=G --numeric-only=short

.fam T
.fi
Or with unit specifier string appended:
.PP
.nf
.fam C
    $ thin_metadata_size --block-size=1gibi --pool-size=1petabytes --max-thins=1mega --unit=G -nlong

.fam T
.fi
.SH DIAGNOSTICS

\fBthin_metadata_size\fP returns an exit code of 0 for success or 1 for error.
.SH SEE ALSO
\fBthin_dump\fP(8), \fBthin_check\fP(8), \fBthin_repair\fP(8), \fBthin_restore\fP(8), \fBthin_rmap\fP(8)
.SH AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>