1RADOS(8) Ceph RADOS(8)
2
6 rados - rados object storage utility
7
9 rados [ -m monaddr ] [ mkpool | rmpool foo ] [ -p | --pool
10 pool ] [ -s | --snap snap ] [ -i infile ] [ -o outfile ]
11 command ...
12
15 rados is a utility for interacting with a Ceph object storage cluster
16 (RADOS), part of the Ceph distributed storage system.
17
19 -p pool, --pool pool
20 Interact with the given pool. Required by most commands.
21 -s snap, --snap snap
23 Read from the given pool snapshot. Valid for all pool-specific
24 read operations.
25 -i infile
27 will specify an input file to be passed along as a payload with
28 the command to the monitor cluster. This is only used for spe‐
29 cific monitor commands.
30 -o outfile
32 will write any payload returned by the monitor cluster with its
33 reply to outfile. Only specific monitor commands (e.g. osd
34 getmap) return a payload.
35 -c ceph.conf, --conf=ceph.conf
37 Use ceph.conf configuration file instead of the default
38 /etc/ceph/ceph.conf to determine monitor addresses during
39 startup.
40 -m monaddress[:port]
42 Connect to specified monitor (instead of looking through
43 ceph.conf).
44 -b block_size
46 Set the block size for put/get ops and for write benchmarking.
47 --striper
49 Uses the striping API of rados rather than the default one.
50 Available for stat, get, put, truncate, rm, ls and all xattr
51 related operation
52
54 lspools
55 List object pools
56 df Show utilization statistics, including disk usage (bytes) and
58 object counts, over the entire system and broken down by pool.
59 mkpool foo
61 Create a pool with name foo.
62 rmpool foo [ foo --yes-i-really-really-mean-it ]
64 Delete the pool foo (and all its data)
65
67 get name outfile
68 Read object name from the cluster and write it to outfile.
69 put name infile
71 Write object name to the cluster with contents from infile.
72 rm name
74 Remove object name.
75 listwatchers name
77 List the watchers of object name.
78 ls outfile
80 List objects in given pool and write to outfile.
81 lssnap List snapshots for given pool.
83 clonedata srcname dstname --object-locator key
85 Clone object byte data from srcname to dstname. Both objects
86 must be stored with the locator key key (usually either srcname
87 or dstname). Object attributes and omap keys are not copied or
88 cloned.
89 mksnap foo
91 Create pool snapshot named foo.
92 rmsnap foo
94 Remove pool snapshot named foo.
95 bench seconds mode [ -b objsize ] [ -t threads ]
97 Benchmark for seconds. The mode can be write, seq, or rand. seq
98 and rand are read benchmarks, either sequential or random.
99 Before running one of the reading benchmarks, run a write bench‐
100 mark with the --no-cleanup option. The default object size is 4
101 MB, and the default number of simulated threads (parallel
102 writes) is 16. The --run-name <label> option is useful for
103 benchmarking a workload test from multiple clients. The <label>
104 is an arbitrary object name. It is "benchmark_last_metadata" by
105 default, and is used as the underlying object name for "read"
106 and "write" ops. Note: -b objsize option is valid only in write
107 mode.
108 cleanup
110 listomapkeys name
112 List all the keys stored in the object map of object name.
113 listomapvals name
115 List all key/value pairs stored in the object map of object
116 name. The values are dumped in hexadecimal.
117 getomapval name key
119 Dump the hexadecimal value of key in the object map of object
120 name.
121 setomapval name key value
123 Set the value of key in the object map of object name.
124 rmomapkey name key
126 Remove key from the object map of object name.
127 getomapheader name
129 Dump the hexadecimal value of the object map header of object
130 name.
131 setomapheader name value
133 Set the value of the object map header of object name.
134
136 To view cluster utilization:
137 rados df
139 To get a list object in pool foo sent to stdout:
141 rados -p foo ls -
143 To write an object:
145 rados -p foo put myobject blah.txt
147 To create a snapshot:
149 rados -p foo mksnap mysnap
151 To delete the object:
153 rados -p foo rm myobject
155 To read a previously snapshotted version of an object:
157 rados -p foo -s mysnap get myobject blah.txt.old
159
161 rados is part of Ceph, a massively scalable, open-source, distributed
162 storage system. Please refer to the Ceph documentation at
163 http://ceph.com/docs for more information.
164
166 ceph(8)
167
169 2010-2014, Inktank Storage, Inc. and contributors. Licensed under Cre‐
170 ative Commons BY-SA
171dev October 30, 2018 RADOS(8)