.\" Man page generated from reStructuredText.
.
.TH "RADOSGW-ADMIN" "8" "Mar 03, 2019" "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
..
.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
\fBradosgw\-admin\fP utility uses many commands for administration purpose
which are as follows:
.INDENT 0.0
.TP
\fBuser create\fP
Create a new user.
.TP
\fBuser modify\fP
Modify a user.
.TP
\fBuser info\fP
Display information of a user, and any potentially available
subusers and keys.
.TP
\fBuser rm\fP
Remove a user.
.TP
\fBuser suspend\fP
Suspend a user.
.TP
\fBuser enable\fP
Re\-enable user after suspension.
.TP
\fBuser check\fP
Check user info.
.TP
\fBuser stats\fP
Show user stats as accounted by quota subsystem.
.TP
\fBcaps add\fP
Add user capabilities.
.TP
\fBcaps rm\fP
Remove user capabilities.
.TP
\fBsubuser create\fP
Create a new subuser (primarily useful for clients using the Swift API).
.TP
\fBsubuser modify\fP
Modify a subuser.
.TP
\fBsubuser rm\fP
Remove a subuser.
.TP
\fBkey create\fP
Create access key.
.TP
\fBkey rm\fP
Remove access key.
.TP
\fBbucket list\fP
List all buckets.
.TP
\fBbucket link\fP
Link bucket to specified user.
.TP
\fBbucket unlink\fP
Unlink bucket from specified user.
.TP
\fBbucket stats\fP
Returns bucket statistics.
.TP
\fBbucket rm\fP
Remove a bucket.
.TP
\fBbucket check\fP
Check bucket index.
.TP
\fBobject rm\fP
Remove an object.
.TP
\fBobject unlink\fP
Unlink object from bucket index.
.TP
\fBquota set\fP
Set quota params.
.TP
\fBquota enable\fP
Enable quota.
.TP
\fBquota disable\fP
Disable quota.
.TP
\fBregion get\fP
Show region info.
.TP
\fBregion list\fP
List all regions set on this cluster.
.TP
\fBregion set\fP
Set region info (requires infile).
.TP
\fBregion default\fP
Set default region.
.TP
\fBregion\-map get\fP
Show region\-map.
.TP
\fBregion\-map set\fP
Set region\-map (requires infile).
.TP
\fBzone get\fP
Show zone cluster params.
.TP
\fBzone set\fP
Set zone cluster params (requires infile).
.TP
\fBzone list\fP
List all zones set on this cluster.
.TP
\fBsync error list\fP
list sync error.
.TP
\fBsync error trim\fP
trim sync error.
.TP
\fBpool add\fP
Add an existing pool for data placement.
.TP
\fBpool rm\fP
Remove an existing pool from data placement set.
.TP
\fBpools list\fP
List placement active set.
.TP
\fBpolicy\fP
Display bucket/object policy.
.TP
\fBlog list\fP
List log objects.
.TP
\fBlog show\fP
Dump a log from specific object or (bucket + date + bucket\-id).
(NOTE: required to specify formatting of date to "YYYY\-MM\-DD\-hh")
.TP
\fBlog rm\fP
Remove log object.
.TP
\fBusage show\fP
Show the usage information (with optional user and date range).
.TP
\fBusage trim\fP
Trim usage information (with optional user and date range).
.TP
\fBgc list\fP
Dump expired garbage collection objects (specify \-\-include\-all to list all
entries, including unexpired).
.TP
\fBgc process\fP
Manually process garbage.
.TP
\fBmetadata get\fP
Get metadata info.
.TP
\fBmetadata put\fP
Put metadata info.
.TP
\fBmetadata rm\fP
Remove metadata info.
.TP
\fBmetadata list\fP
List metadata info.
.TP
\fBmdlog list\fP
List metadata log.
.TP
\fBmdlog trim\fP
Trim metadata log.
.TP
\fBbilog list\fP
List bucket index log.
.TP
\fBbilog trim\fP
Trim bucket index log (use start\-marker, end\-marker).
.TP
\fBdatalog list\fP
List data log.
.TP
\fBdatalog trim\fP
Trim data log.
.TP
\fBopstate list\fP
List stateful operations entries (use client_id, op_id, object).
.TP
\fBopstate set\fP
Set state on an entry (use client_id, op_id, object, state).
.TP
\fBopstate renew\fP
Renew state on an entry (use client_id, op_id, object).
.TP
\fBopstate rm\fP
Remove entry (use client_id, op_id, object).
.TP
\fBreplicalog get\fP
Get replica metadata log entry.
.TP
\fBreplicalog delete\fP
Delete replica metadata log entry.
.TP
\fBorphans find\fP
Init and run search for leaked rados objects
.TP
\fBorphans finish\fP
Clean up search for leaked rados objects
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.B \-c ceph.conf, \-\-conf=ceph.conf
Use \fBceph.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 radosgw user ID.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-subuser=<name>
Name of the subuser.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-email=email
The e\-mail address of the user.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-display\-name=name
Configure the display name of the user.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-access\-key=<key>
S3 access key.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-gen\-access\-key
Generate random access key (for S3).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-secret=secret
The secret associated with a given key.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-gen\-secret
Generate random secret key.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-key\-type=<type>
key type, options are: swift, s3.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-temp\-url\-key[\-2]=<key>
Temporary url key.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-system
Set the system flag on 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 needed for some commands.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-start\-date=yyyy\-mm\-dd
The start date needed for some commands.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-end\-date=yyyy\-mm\-dd
The end date needed for some commands.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-shard\-id=<shard\-id>
Optional for mdlog list, data sync status. Required for \fBmdlog trim\fP,
\fBreplica mdlog get/delete\fP, \fBreplica datalog get/delete\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-entries=<entries>
Optional for listing operations to specify the max entires
.UNINDENT
.INDENT 0.0
.TP
.B \-\-auth\-uid=auid
The librados auid.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-purge\-data
Remove user data before user removal.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-purge\-keys
When specified, subuser removal will also purge all the subuser keys.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-purge\-objects
Remove all objects before bucket removal.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-metadata\-key=<key>
Key to retrieve metadata from with \fBmetadata get\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-rgw\-region=<region>
Region in which radosgw is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-rgw\-zone=<zone>
Zone in which radosgw is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-fix
Besides checking bucket index, will also fix it.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-check\-objects
bucket check: Rebuilds bucket index according to actual objects state.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-format=<format>
Specify output format for certain operations: xml, json.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sync\-stats
Option to \(aquser stats\(aq, update user stats with current stats reported by
user\(aqs buckets indexes.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-show\-log\-entries=<flag>
Enable/disable dump of log entries on log show.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-show\-log\-sum=<flag>
Enable/disable dump of log summation on log show.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-skip\-zero\-entries
Log show only dumps entries that don\(aqt have zero value in one of the numeric
field.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-infile
Specify a file to read in when setting data.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-state=<state string>
Specify a state for the opstate set command.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-replica\-log\-type
Replica log type (metadata, data, bucket), required for replica log
operations.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-categories=<list>
Comma separated list of categories, used in usage show.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-caps=<caps>
List of caps (e.g., "usage=read, write; user=read".
.UNINDENT
.INDENT 0.0
.TP
.B \-\-compression=<compression\-algorithm>
Placement target compression algorithm (lz4|snappy|zlib|zstd)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-yes\-i\-really\-mean\-it
Required for certain operations.
.UNINDENT
.SH QUOTA OPTIONS
.INDENT 0.0
.TP
.B \-\-max\-objects
Specify max objects (negative value to disable).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-size
Specify max size (in bytes, negative value to disable).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-quota\-scope
Scope of quota (bucket, user).
.UNINDENT
.SH ORPHANS SEARCH OPTIONS
.INDENT 0.0
.TP
.B \-\-pool
Data pool to scan for leaked rados objects
.UNINDENT
.INDENT 0.0
.TP
.B \-\-num\-shards
Number of shards to use for keeping the temporary scan info
.UNINDENT
.INDENT 0.0
.TP
.B \-\-orphan\-stale\-secs
Number of seconds to wait before declaring an object to be an orphan.
Default is 86400 (24 hours).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-job\-id
Set the job id (for orphans find)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-concurrent\-ios
Maximum concurrent ios for orphans find.
Default is 32.
.UNINDENT
.SH EXAMPLES
.sp
Generate a new user:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ radosgw\-admin user create \-\-display\-name="johnny rotten" \-\-uid=johnny
{ "user_id": "johnny",
  "rados_uid": 0,
  "display_name": "johnny rotten",
  "email": "",
  "suspended": 0,
  "subusers": [],
  "keys": [
        { "user": "johnny",
          "access_key": "TCICW53D9BQ2VGC46I44",
          "secret_key": "tfm9aHMI8X76L3UdgE+ZQaJag1vJQmE6HDb5Lbrz"}],
  "swift_keys": []}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Remove a user:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ radosgw\-admin user rm \-\-uid=johnny
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Remove a user and all associated buckets with their contents:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ radosgw\-admin user rm \-\-uid=johnny \-\-purge\-data
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Remove a bucket:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ radosgw\-admin bucket rm \-\-bucket=foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Link bucket to specified user:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ radosgw\-admin bucket link \-\-bucket=foo \-\-bucket_id=<bucket id> \-\-uid=johnny
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Unlink bucket from specified user:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ radosgw\-admin bucket unlink \-\-bucket=foo \-\-uid=johnny
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Show the logs of a bucket from April 1st, 2012:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ radosgw\-admin log show \-\-bucket=foo \-\-date=2012\-04\-01\-01 \-\-bucket\-id=default.14193.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Show usage information for user from March 1st to (but not including) April 1st, 2012:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ radosgw\-admin usage show \-\-uid=johnny \e
                \-\-start\-date=2012\-03\-01 \-\-end\-date=2012\-04\-01
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Show only summary of usage information for all users:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ radosgw\-admin usage show \-\-show\-log\-entries=false
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Trim usage information for user until March 1st, 2012:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ radosgw\-admin usage trim \-\-uid=johnny \-\-end\-date=2012\-04\-01
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AVAILABILITY
.sp
\fBradosgw\-admin\fP is part of Ceph, a massively scalable, open\-source,
distributed storage system.  Please refer to the Ceph documentation at
\fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
ceph(8)
radosgw(8)
.SH COPYRIGHT
2010-2019, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
.\" Generated by docutils manpage writer.
.