← Back to branch summary

~ubuntu-branches/ubuntu/quantal/ceph/quantal

« back to all changes in this revision

Viewing changes to doc/man/8/osdmaptool.rst

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2012-07-16 09:56:24 UTC
  • mfrom: (0.3.11)
  • mto: This revision was merged to the branch mainline in revision 17.
  • Revision ID: package-import@ubuntu.com-20120716095624-azr2w4hbhei1rxmx
Tags: upstream-0.48
Import upstream version 0.48

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/8/osdmaptool.rst
 
1
======================================================
 
2
 osdmaptool -- ceph osd cluster map manipulation tool
 
3
======================================================
 
4
 
 
5
.. program:: osdmaptool
 
6
 
 
7
Synopsis
 
8
========
 
9
 
 
10
| **osdmaptool** *mapfilename* [--print] [--createsimple *numosd*
 
11
  [--pgbits *bitsperosd* ] ] [--clobber]
 
12
 
 
13
 
 
14
Description
 
15
===========
 
16
 
 
17
**osdmaptool** is a utility that lets you create, view, and manipulate
 
18
OSD cluster maps from the Ceph distributed file system. Notably, it
 
19
lets you extract the embedded CRUSH map or import a new CRUSH map.
 
20
 
 
21
 
 
22
Options
 
23
=======
 
24
 
 
25
.. option:: --print
 
26
 
 
27
   will simply make the tool print a plaintext dump of the map, after
 
28
   any modifications are made.
 
29
 
 
30
.. option:: --clobber
 
31
 
 
32
   will allow osdmaptool to overwrite mapfilename if changes are made.
 
33
 
 
34
.. option:: --import-crush mapfile
 
35
 
 
36
   will load the CRUSH map from mapfile and embed it in the OSD map.
 
37
 
 
38
.. option:: --export-crush mapfile
 
39
 
 
40
   will extract the CRUSH map from the OSD map and write it to
 
41
   mapfile.
 
42
 
 
43
.. option:: --createsimple numosd [--pgbits bitsperosd]
 
44
 
 
45
   will create a relatively generic OSD map with the numosd devices.
 
46
   If --pgbits is specified, the initial placement group counts will
 
47
   be set with bitsperosd bits per OSD. That is, the pg_num map
 
48
   attribute will be set to numosd shifted by bitsperosd.
 
49
 
 
50
 
 
51
Example
 
52
=======
 
53
 
 
54
To create a simple map with 16 devices::
 
55
 
 
56
        osdmaptool --createsimple 16 osdmap --clobber
 
57
 
 
58
To view the result::
 
59
 
 
60
        osdmaptool --print osdmap
 
61
 
 
62
 
 
63
Availability
 
64
============
 
65
 
 
66
**osdmaptool** is part of the Ceph distributed file system.  Please
 
67
refer to the Ceph wiki at http://ceph.newdream.net/wiki for more
 
68
information.
 
69
 
 
70
 
 
71
See also
 
72
========
 
73
 
 
74
:doc:`ceph <ceph>`\(8),
 
75
:doc:`crushtool <crushtool>`\(8),
 
76
:doc:`mkcephfs <mkcephfs>`\(8)