.TH "RADOSGW-ADMIN" "8" "February 17, 2012" "dev" "Ceph"
.SH NAME
radosgw-admin \- rados REST gateway user administration 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 reStructeredText.
.
.SH SYNOPSIS
.nf
\fBradosgw\-admin\fP \fIcommand\fP [ \fIoptions\fP \fI...\fP ]
.fi
.sp
.SH DESCRIPTION
.sp
\fBradosgw\-admin\fP is a RADOS gateway user administration utility. It
allows creating and modifying users.
.SH COMMANDS
.sp
\fIcommand\fP can be one of the following options:
.INDENT 0.0
.TP
.B \fBuser create\fP
Create a new user
.TP
.B \fBuser modify\fP
Modify a user
.TP
.B \fBuser info\fP
Display information of a user
.TP
.B \fBuser rm\fP
Remove a user
.TP
.B \fBbucket list\fP
List all buckets
.TP
.B \fBbucket unlink\fP
Remove a bucket
.TP
.B \fBpolicy\fP
Display bucket/object policy
.TP
.B \fBlog show\fP
Show the log of a bucket (with a specified date)
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.B \-c ceph.conf, \-\-conf=ceph.conf
Use \fIceph.conf\fP configuration file instead of the default
\fB/etc/ceph/ceph.conf\fP 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 \-\-uid=uid
The S3 user/access key.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-secret=secret
The S3 secret.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-display\-name=name
Configure the display name of the user.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-email=email
The e\-mail address of the user
.UNINDENT
.INDENT 0.0
.TP
.B \-\-bucket=bucket
Specify the bucket name.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-object=object
Specify the object name.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-date=yyyy\-mm\-dd
The date need for some commands
.UNINDENT
.INDENT 0.0
.TP
.B \-\-os\-user=group:name
The OpenStack user (only needed for use with OpenStack)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-os\-secret=key
The OpenStack key
.UNINDENT
.INDENT 0.0
.TP
.B \-\-auth\-uid=auid
The librados auid
.UNINDENT
.SH EXAMPLES
.sp
Generate a new user:
.sp
.nf
.ft C
$ radosgw\-admin user gen \-\-display\-name="johnny rotten" \-\-email=johnny@rotten.com
User ID: CHBQFRTG26I8DGJDGQLW
Secret Key: QR6cI/31N+J0VKVgHSpEGVSfEEsmf6PyXG040KCB
Display Name: johnny rotten
.ft P
.fi
.sp
Remove a user:
.sp
.nf
.ft C
$ radosgw\-admin user rm \-\-uid=CHBQFRTG26I8DGJDGQLW
.ft P
.fi
.sp
Remove a bucket:
.sp
.nf
.ft C
$ radosgw\-admin bucket unlink \-\-bucket=foo
.ft P
.fi
.sp
Show the logs of a bucket from April 1st 2011:
.sp
.nf
.ft C
$ radosgw\-admin log show \-\-bucket=foo \-\-date=2011=04\-01
.ft P
.fi
.SH AVAILABILITY
.sp
\fBradosgw\-admin\fP is part of the Ceph distributed file system.  Please
refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
information.
.SH SEE ALSO
.sp
\fBceph\fP(8)
.SH COPYRIGHT
2011, New Dream Network
.\" Generated by docutils manpage writer.
.\" 
.