rados(8) - f14

1RADOS(8)                    System Manager's Manual                   RADOS(8)
2
3
4

NAME

6       rados - rados object storage utility
7

SYNOPSIS

9       rados  [  -m  monaddr  ] [ -p | --pool pool ] [ -s | --snap snap ] [ -i
10       infile ] [ -o outfile ] command ...
11
12

DESCRIPTION

14       rados is a utility for interacting with a Ceph object  storage  cluster
15       (RADOS), part of the Ceph distributed file system.
16

OPTIONS

18       -p pool, --pool pool
19              Interact with the given pool.  Required by most commands.
20
21       -s snap, --snap snap
22              Read  from the given pool snapshot.  Valid for all pool-specific
23              read operations.
24
25       -i infile
26              will specify an input file to be passed along as a payload  with
27              the  command to the monitor cluster.  This is only used for spe‐
28              cific monitor commands.
29
30       -o outfile
31              will write any payload returned by the monitor cluster with  its
32              reply  to  outfile.   Only  specific  monitor commands (e.g. osd
33              getmap) return a payload.
34
35       -c ceph.conf, --conf=ceph.conf
36              Use  ceph.conf  configuration  file  instead  of   the   default
37              /etc/ceph/ceph.conf   to   determine  monitor  addresses  during
38              startup.
39
40       -m monaddress[:port]
41              Connect  to  specified  monitor  (instead  of  looking   through
42              ceph.conf).
43

GLOBAL COMMANDS

45       lspools
46              List object pools
47
48       df     Show  utilization  statistics,  including disk usage (bytes) and
49              object counts, over the entire system and broken down by pool.
50

POOL SPECIFIC COMMANDS

52       get name outfile
53              Read object name from the cluster and write it to outfile.
54
55       put name infile
56              Write object name to the cluster with contents from infile.
57
58       rm name
59              Remove object name.
60
61       ls outfile
62              List objects in given pool and write to outfile.
63
64       lssnap List snapshots for given pool.
65
66       mksnap foo
67              Create pool snapshot named foo.
68
69       rmsnap foo
70              Remove pool snapshot names foo.
71
72       bench seconds mode [ -b objsize ] [ -t threads ]
73              Benchmark for seconds.  The mode can  be  write  or  read.   The
74              default object size is 4 KB, and the default number of simulated
75              threads (parallel writes) is 16.
76

EXAMPLES

78       To view cluster utilization:
79
80              rados df
81
82       To get a list object in pool foo sent to stdout:
83
84              rados -p foo ls -
85
86       To write an object:
87
88              rados -p foo put myobject blah.txt
89
90       To create a snapshot:
91
92              rados -p foo mksnap mysnap
93
94       To delete the object:
95
96              rados -p foo rm myobject
97
98       To read a previously snapshotted version of an object:
99
100              rados -p foo -s mysnap get myobject blah.txt.old
101

AVAILABILITY

103       rados is part of the Ceph distributed file system.  Please refer to the
104       Ceph wiki at http://ceph.newdream.net/wiki for more information.
105