.\" Man page generated from reStructuredText. . .TH "RADOS" "8" "May 27, 2021" "dev" "Ceph" .SH NAME rados \- rados object storage utility . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH SYNOPSIS .nf \fBrados\fP [ \fIoptions\fP ] [ \fIcommand\fP ] .fi .sp .SH DESCRIPTION .sp \fBrados\fP is a utility for interacting with a Ceph object storage cluster (RADOS), part of the Ceph distributed storage system. .SH OPTIONS .INDENT 0.0 .TP .B \-p pool, \-\-pool pool Interact with the given pool. Required by most commands. .UNINDENT .INDENT 0.0 .TP .B \-\-pgid As an alternative to \fB\-\-pool\fP, \fB\-\-pgid\fP also allow users to specify the PG id to which the command will be directed. With this option, certain commands like \fBls\fP allow users to limit the scope of the command to the given PG. .UNINDENT .INDENT 0.0 .TP .B \-N namespace, \-\-namespace namespace Specify the rados namespace to use for the object. .UNINDENT .INDENT 0.0 .TP .B \-s snap, \-\-snap snap Read from the given pool snapshot. Valid for all pool\-specific read operations. .UNINDENT .INDENT 0.0 .TP .B \-i infile will specify an input file to be passed along as a payload with the command to the monitor cluster. This is only used for specific monitor commands. .UNINDENT .INDENT 0.0 .TP .B \-o outfile will write any payload returned by the monitor cluster with its reply to outfile. Only specific monitor commands (e.g. osd getmap) return a payload. .UNINDENT .INDENT 0.0 .TP .B \-c ceph.conf, \-\-conf=ceph.conf Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to determine monitor addresses during startup. .UNINDENT .INDENT 0.0 .TP .B \-m monaddress[:port] Connect to specified monitor (instead of looking through ceph.conf). .UNINDENT .INDENT 0.0 .TP .B \-b block_size Set the block size for put/get/append ops and for write benchmarking. .UNINDENT .INDENT 0.0 .TP .B \-\-striper Uses the striping API of rados rather than the default one. Available for stat, stat2, get, put, append, truncate, rm, ls and all xattr related operation .UNINDENT .INDENT 0.0 .TP .B \-O object_size Set the object size for put/get ops and for write benchmarking .UNINDENT .SH GLOBAL COMMANDS .INDENT 0.0 .TP \fBlspools\fP List object pools .TP \fBdf\fP Show utilization statistics, including disk usage (bytes) and object counts, over the entire system and broken down by pool. .TP \fBlist\-inconsistent\-pg\fP \fIpool\fP List inconsistent PGs in given pool. .TP \fBlist\-inconsistent\-obj\fP \fIpgid\fP List inconsistent objects in given PG. .TP \fBlist\-inconsistent\-snapset\fP \fIpgid\fP List inconsistent snapsets in given PG. .UNINDENT .SH POOL SPECIFIC COMMANDS .INDENT 0.0 .TP \fBget\fP \fIname\fP \fIoutfile\fP Read object name from the cluster and write it to outfile. .TP \fBput\fP \fIname\fP \fIinfile\fP [\-\-offset offset] Write object name with start offset (default:0) to the cluster with contents from infile. \fBWarning:\fP The put command creates a single RADOS object, sized just as large as your input file. Unless your objects are of reasonable and consistent sizes, that is probably not what you want \-\- consider using RGW/S3, CephFS, or RBD instead. .TP \fBappend\fP \fIname\fP \fIinfile\fP Append object name to the cluster with contents from infile. .TP \fBrm\fP \fIname\fP Remove object name. .TP \fBlistwatchers\fP \fIname\fP List the watchers of object name. .TP \fBls\fP \fIoutfile\fP List objects in the given pool and write to outfile. Instead of \fB\-\-pool\fP if \fB\-\-pgid\fP will be specified, \fBls\fP will only list the objects in the given PG. .TP \fBlssnap\fP List snapshots for given pool. .TP \fBclonedata\fP \fIsrcname\fP \fIdstname\fP \-\-object\-locator \fIkey\fP Clone object byte data from \fIsrcname\fP to \fIdstname\fP\&. Both objects must be stored with the locator key \fIkey\fP (usually either \fIsrcname\fP or \fIdstname\fP). Object attributes and omap keys are not copied or cloned. .TP \fBmksnap\fP \fIfoo\fP Create pool snapshot named \fIfoo\fP\&. .TP \fBrmsnap\fP \fIfoo\fP Remove pool snapshot named \fIfoo\fP\&. .TP \fBbench\fP \fIseconds\fP \fImode\fP [ \-b \fIobjsize\fP ] [ \-t \fIthreads\fP ] Benchmark for \fIseconds\fP\&. The mode can be \fIwrite\fP, \fIseq\fP, or \fIrand\fP\&. \fIseq\fP and \fIrand\fP are read benchmarks, either sequential or random. Before running one of the reading benchmarks, run a write benchmark with the \fI\-\-no\-cleanup\fP option. The default object size is 4 MB, and the default number of simulated threads (parallel writes) is 16. The \fI\-\-run\-name