forked from ceph/ceph
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ceph.8
124 lines (124 loc) · 2.91 KB
/
ceph.8
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
.TH "CEPH" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph \- ceph file system control 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
..
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
\fBceph\fP [ \-m \fImonaddr\fP ] [ \-w | \fIcommand\fP ... ]
.fi
.sp
.SH DESCRIPTION
.sp
\fBceph\fP is a control utility for communicating with the monitor
cluster of a running Ceph distributed file system.
.sp
There are three basic modes of operation.
.SS Interactive mode
.sp
To start in interactive mode, no arguments are necessary. Control\-d or
\(aqquit\(aq will exit.
.SS Watch mode
.sp
Watch mode shows cluster state changes as they occur. For example:
.sp
.nf
.ft C
ceph \-w
.ft P
.fi
.SS Command line mode
.sp
Finally, to send a single instruction to the monitor cluster (and wait
for a response), the command can be specified on the command line.
.SH OPTIONS
.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
.SH EXAMPLES
.sp
To grab a copy of the current OSD map:
.sp
.nf
.ft C
ceph \-m 1.2.3.4:6789 osd getmap \-o osdmap
.ft P
.fi
.sp
To get a dump of placement group (PG) state:
.sp
.nf
.ft C
ceph pg dump \-o pg.txt
.ft P
.fi
.SH MONITOR COMMANDS
.sp
A more complete summary of commands understood by the monitor cluster can be found in the
online documentation, at
.INDENT 0.0
.INDENT 3.5
\fI\%http://ceph.com/docs/master/rados/operations/control\fP
.UNINDENT
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\fP is part of the Ceph distributed file system. Please refer to the Ceph documentation at
\fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
\fBmkcephfs\fP(8)
.SH COPYRIGHT
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.