.\" Man page generated from reStructuredText.
.
.
.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
..
.TH "RADOSGW-ADMIN" "8" "Mar 10, 2024" "dev" "Ceph"
.SH NAME
radosgw-admin \- rados REST gateway user administration utility
.SH SYNOPSIS
.nf
\fBradosgw\-admin\fP \fIcommand\fP [ \fIoptions\fP \fI\&...\fP ]
.fi
.sp
.SH DESCRIPTION
.sp
\fBradosgw\-admin\fP is a Ceph Object Gateway user administration utility. It
is used to create and modify users.
.SH COMMANDS
.sp
\fBradosgw\-admin\fP utility provides commands for administration purposes
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 for a user including any subusers and keys.
.TP
\fBuser rename\fP
Renames a user.
.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 the quota subsystem.
.TP
\fBuser list\fP
List all users.
.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 buckets, or, if a bucket is specified with \-\-bucket=<bucket>,
list its objects. Adding \-\-allow\-unordered
removes the ordering requirement, possibly generating results more
quickly for buckets with large number of objects.
.TP
\fBbucket limit check\fP
Show bucket sharding stats.
.TP
\fBbucket link\fP
Link bucket to specified user.
.TP
\fBbucket unlink\fP
Unlink bucket from specified user.
.TP
\fBbucket chown\fP
Change bucket ownership to the specified user and update object ACLs.
Invoke with \-\-marker to resume if the command is interrupted.
.TP
\fBbucket stats\fP
Returns bucket statistics.
.TP
\fBbucket rm\fP
Remove a bucket.
.TP
\fBbucket check\fP
Check bucket index.
.TP
\fBbucket rewrite\fP
Rewrite all objects in the specified bucket.
.TP
\fBbucket radoslist\fP
List the RADOS objects that contain the data for all objects in
the designated bucket, if \-\-bucket=<bucket> is specified.
Otherwise, list the RADOS objects that contain data for all
buckets.
.TP
\fBbucket reshard\fP
Reshard a bucket\(aqs index.
.TP
\fBbucket sync disable\fP
Disable bucket sync.
.TP
\fBbucket sync enable\fP
Enable bucket sync.
.TP
\fBbi get\fP
Retrieve bucket index object entries.
.TP
\fBbi put\fP
Store bucket index object entries.
.TP
\fBbi list\fP
List raw bucket index entries.
.TP
\fBbi purge\fP
Purge bucket index entries.
.TP
\fBobject rm\fP
Remove an object.
.TP
\fBobject stat\fP
Stat an object for its metadata.
.TP
\fBobject unlink\fP
Unlink object from bucket index.
.TP
\fBobject rewrite\fP
Rewrite the specified object.
.TP
\fBobjects expire\fP
Run expired objects cleanup.
.TP
\fBperiod rm\fP
Remove a period.
.TP
\fBperiod get\fP
Get the period info.
.TP
\fBperiod get\-current\fP
Get the current period info.
.TP
\fBperiod pull\fP
Pull a period.
.TP
\fBperiod push\fP
Push a period.
.TP
\fBperiod list\fP
List all periods.
.TP
\fBperiod update\fP
Update the staging period.
.TP
\fBperiod commit\fP
Commit the staging period.
.TP
\fBquota set\fP
Set quota params.
.TP
\fBquota enable\fP
Enable quota.
.TP
\fBquota disable\fP
Disable quota.
.TP
\fBglobal quota get\fP
View global quota parameters.
.TP
\fBglobal quota set\fP
Set global quota parameters.
.TP
\fBglobal quota enable\fP
Enable a global quota.
.TP
\fBglobal quota disable\fP
Disable a global quota.
.TP
\fBrealm create\fP
Create a new realm.
.TP
\fBrealm rm\fP
Remove a realm.
.TP
\fBrealm get\fP
Show the realm info.
.TP
\fBrealm get\-default\fP
Get the default realm name.
.TP
\fBrealm list\fP
List all realms.
.TP
\fBrealm list\-periods\fP
List all realm periods.
.TP
\fBrealm rename\fP
Rename a realm.
.TP
\fBrealm set\fP
Set the realm info (requires infile).
.TP
\fBrealm default\fP
Set the realm as default.
.TP
\fBrealm pull\fP
Pull a realm and its current period.
.TP
\fBzonegroup add\fP
Add a zone to a zonegroup.
.TP
\fBzonegroup create\fP
Create a new zone group info.
.TP
\fBzonegroup default\fP
Set the default zone group.
.TP
\fBzonegroup rm\fP
Remove a zone group info.
.TP
\fBzonegroup get\fP
Show the zone group info.
.TP
\fBzonegroup modify\fP
Modify an existing zonegroup.
.TP
\fBzonegroup set\fP
Set the zone group info (requires infile).
.TP
\fBzonegroup remove\fP
Remove a zone from a zonegroup.
.TP
\fBzonegroup rename\fP
Rename a zone group.
.TP
\fBzonegroup list\fP
List all zone groups set on this cluster.
.TP
\fBzonegroup placement list\fP
List zonegroup\(aqs placement targets.
.TP
\fBzonegroup placement add\fP
Add a placement target id to a zonegroup.
.TP
\fBzonegroup placement modify\fP
Modify a placement target of a specific zonegroup.
.TP
\fBzonegroup placement rm\fP
Remove a placement target from a zonegroup.
.TP
\fBzonegroup placement default\fP
Set a zonegroup\(aqs default placement target.
.TP
\fBzone create\fP
Create a new zone.
.TP
\fBzone rm\fP
Remove a zone.
.TP
\fBzone get\fP
Show zone cluster params.
.TP
\fBzone set\fP
Set zone cluster params (requires infile).
.TP
\fBzone modify\fP
Modify an existing zone.
.TP
\fBzone list\fP
List all zones set on this cluster.
.TP
\fBmetadata sync status\fP
Get metadata sync status.
.TP
\fBmetadata sync init\fP
Init metadata sync.
.TP
\fBmetadata sync run\fP
Run metadata sync.
.TP
\fBdata sync status\fP
Get data sync status of the specified source zone.
.TP
\fBdata sync init\fP
Init data sync for the specified source zone.
.TP
\fBdata sync run\fP
Run data sync for the specified source zone.
.TP
\fBsync error list\fP
List sync errors.
.TP
\fBsync error trim\fP
Trim sync errors.
.TP
\fBzone rename\fP
Rename a zone.
.TP
\fBzone placement list\fP
List a zone\(aqs placement targets.
.TP
\fBzone placement add\fP
Add a zone placement target.
.TP
\fBzone placement modify\fP
Modify a zone placement target.
.TP
\fBzone placement rm\fP
Remove a zone placement target.
.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 \(dqYYYY\-MM\-DD\-hh\(dq)
.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
\fBlc list\fP
List all bucket lifecycle progress.
.TP
\fBlc process\fP
Manually process lifecycle transitions.  If a bucket is specified (e.g., via
\-\-bucket_id or via \-\-bucket and optional \-\-tenant), only that bucket
is processed.
.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 which is needed for multi\-site deployments.
.TP
\fBmdlog trim\fP
Trim metadata log manually instead of relying on the gateway\(aqs integrated log sync.
Before trimming, compare the listings and make sure the last sync was
complete, otherwise it can reinitiate a sync.
.TP
\fBmdlog status\fP
Read metadata log status.
.TP
\fBbilog list\fP
List bucket index log which is needed for multi\-site deployments.
.TP
\fBbilog trim\fP
Trim bucket index log (use start\-marker, end\-marker) manually instead
of relying on the gateway\(aqs integrated log sync.
Before trimming, compare the listings and make sure the last sync was
complete, otherwise it can reinitiate a sync.
.TP
\fBdatalog list\fP
List data log which is needed for multi\-site deployments.
.TP
\fBdatalog trim\fP
Trim data log manually instead of relying on the gateway\(aqs integrated log sync.
Before trimming, compare the listings and make sure the last sync was
complete, otherwise it can reinitiate a sync.
.TP
\fBdatalog status\fP
Read data log status.
.TP
\fBorphans find\fP
Init and run search for leaked RADOS objects.
DEPRECATED. See the \(dqrgw\-orphan\-list\(dq tool.
.TP
\fBorphans finish\fP
Clean up search for leaked RADOS objects.
DEPRECATED. See the \(dqrgw\-orphan\-list\(dq tool.
.TP
\fBorphans list\-jobs\fP
List the current orphans search job IDs.
DEPRECATED. See the \(dqrgw\-orphan\-list\(dq tool.
.TP
\fBrole create\fP
Create a new role for use with STS (Security Token Service).
.TP
\fBrole rm\fP
Remove a role.
.TP
\fBrole get\fP
Get a role.
.TP
\fBrole list\fP
List the roles with specified path prefix.
.TP
\fBrole modify\fP
Modify the assume role policy of an existing role.
.TP
\fBrole\-policy put\fP
Add/update permission policy to role.
.TP
\fBrole\-policy list\fP
List the policies attached to a role.
.TP
\fBrole\-policy get\fP
Get the specified inline policy document embedded with the given role.
.TP
\fBrole\-policy rm\fP
Remove the policy attached to a role
.TP
\fBreshard add\fP
Schedule a resharding of a bucket
.TP
\fBreshard list\fP
List all bucket resharding or scheduled to be resharded
.TP
\fBreshard process\fP
Process of scheduled reshard jobs
.TP
\fBreshard status\fP
Resharding status of a bucket
.TP
\fBreshard cancel\fP
Cancel resharding a bucket
.TP
\fBtopic list\fP
List bucket notifications/pubsub topics
.TP
\fBtopic get\fP
Get a bucket notifications/pubsub topic
.TP
\fBtopic rm\fP
Remove a bucket notifications/pubsub topic
.TP
\fBsubscription get\fP
Get a pubsub subscription definition
.TP
\fBsubscription rm\fP
Remove a pubsub subscription
.TP
\fBsubscription pull\fP
Show events in a pubsub subscription
.TP
\fBsubscription ack\fP
Acknowledge (remove) events in a pubsub subscription
.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 selecting one
from ceph.conf).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-tenant=<tenant>
Name of the tenant.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-uid=uid
The user on which to operate.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-new\-uid=uid
The new ID of the user. Used with \(aquser rename\(aq command.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-subuser=<name>
Name of the subuser.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-access\-key=<key>
S3 access key.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-email=email
The e\-mail address of the user.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-secret/\-\-secret\-key=<key>
The secret key.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-gen\-access\-key
Generate random access key (for S3).
.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 \-\-max\-buckets
Maximum number of buckets for a user (0 for no limit, negative value to disable bucket creation).
Default is 1000.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-access=<access>
Set the access permissions for the subuser.
Available access permissions are read, write, readwrite and full.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-display\-name=<name>
The display name of the user.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-admin
Set the admin flag on the user.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-system
Set the system flag on the user.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-bucket=[tenant\-id/]bucket
Specify the bucket name.  If tenant\-id is not specified, the tenant\-id
of the user (\-\-uid) is used.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pool=<pool>
Specify the pool name.
Also used with \fIorphans find\fP as data pool to scan for leaked rados objects.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-object=object
Specify the object name.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-date=yyyy\-mm\-dd
The date in the format yyyy\-mm\-dd.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-start\-date=yyyy\-mm\-dd
The start date in the format yyyy\-mm\-dd.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-end\-date=yyyy\-mm\-dd
The end date in the format yyyy\-mm\-dd.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-bucket\-id=<bucket\-id>
Specify the bucket id.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-bucket\-new\-name=[tenant\-id/]<bucket>
Optional for \fIbucket link\fP; use to rename a bucket.
While the tenant\-id can be specified, this is not
necessary in normal operation.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-shard\-id=<shard\-id>
Optional for mdlog list, bi list, data sync status. Required for \fBmdlog trim\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-entries=<entries>
Optional for listing operations to specify the max entries.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-purge\-data
When specified, user removal will also purge the user\(aqs data.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-purge\-keys
When specified, subuser removal will also purge the subuser\(aq keys.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-purge\-objects
When specified, the bucket removal will also purge all objects in it.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-metadata\-key=<key>
Key from which to retrieve metadata, used with \fBmetadata get\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-remote=<remote>
Zone or zonegroup id of remote gateway.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-period=<id>
Period ID.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-url=<url>
URL for pushing/pulling period or realm.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-epoch=<number>
Period epoch.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-commit
Commit the period during \(aqperiod update\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-staging
Get the staging period info.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-master
Set as master.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-master\-zone=<id>
Master zone ID.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-rgw\-realm=<name>
The realm name.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-realm\-id=<id>
The realm ID.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-realm\-new\-name=<name>
New name for the realm.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-rgw\-zonegroup=<name>
The zonegroup name.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-zonegroup\-id=<id>
The zonegroup ID.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-zonegroup\-new\-name=<name>
The new name of the zonegroup.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-rgw\-zone=<zone>
Zone in which the gateway is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-zone\-id=<id>
The zone ID.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-zone\-new\-name=<name>
The new name of the zone.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-source\-zone
The source zone for data sync.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-default
Set the entity (realm, zonegroup, zone) as default.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-read\-only
Set the zone as read\-only when adding to the zonegroup.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-placement\-id
Placement ID for the zonegroup placement commands.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-tags=<list>
The list of tags for zonegroup placement add and modify commands.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-tags\-add=<list>
The list of tags to add for zonegroup placement modify command.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-tags\-rm=<list>
The list of tags to remove for zonegroup placement modify command.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-endpoints=<list>
The zone endpoints.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-index\-pool=<pool>
The placement target index pool.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-data\-pool=<pool>
The placement target data pool.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-data\-extra\-pool=<pool>
The placement target data extra (non\-EC) pool.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-placement\-index\-type=<type>
The placement target index type (normal, indexless, or #id).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-placement\-inline\-data=<true>
Whether the placement target is configured to store a data chunk inline in head objects.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-tier\-type=<type>
The zone tier type.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-tier\-config=<k>=<v>[,...]
Set zone tier config keys, values.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-tier\-config\-rm=<k>[,...]
Unset zone tier config keys.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sync\-from\-all[=false]
Set/reset whether zone syncs from all zonegroup peers.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sync\-from=[zone\-name][,...]
Set the list of zones from which to sync.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sync\-from\-rm=[zone\-name][,...]
Remove zone(s) from list of zones from which to sync.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-bucket\-index\-max\-shards
Override a zone\(aqs or zonegroup\(aqs default number of bucket index shards. This
option is accepted by the \(aqzone create\(aq, \(aqzone modify\(aq, \(aqzonegroup add\(aq,
and \(aqzonegroup modify\(aq commands, and applies to buckets that are created
after the zone/zonegroup changes take effect.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-fix
Fix the bucket index in addition to checking it.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-check\-objects
Bucket check: Rebuilds the bucket index according to actual object state.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-format=<format>
Specify output format for certain operations. Supported formats: xml, json.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sync\-stats
Option for the \(aquser stats\(aq command. When specified, it will update user stats with
the current stats reported by the user\(aqs buckets indexes.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-show\-config
Show configuration.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-show\-log\-entries=<flag>
Enable/disable dumping 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 when setting data.
.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 capabilities (e.g., \(dqusage=read, write; user=read\(dq).
.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 as a guardrail for certain destructive operations.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-min\-rewrite\-size
Specify the minimum object size for bucket rewrite (default 4M).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-rewrite\-size
Specify the maximum object size for bucket rewrite (default ULLONG_MAX).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-min\-rewrite\-stripe\-size
Specify the minimum stripe size for object rewrite (default 0). If the value
is set to 0, then the specified object will always be
rewritten when restriping.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-warnings\-only
When specified with bucket limit check,
list only buckets nearing or over the current max objects per shard value.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-bypass\-gc
When specified with bucket deletion,
triggers object deletion without involving GC.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-inconsistent\-index
When specified with bucket deletion and bypass\-gc set to true,
ignores bucket index consistency.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-concurrent\-ios
Maximum concurrent bucket operations. Affects operations that
scan the bucket index, e.g., listing, deletion, and all scan/search
operations such as finding orphans or checking the bucket index.
The default is 32.
.UNINDENT
.SH QUOTA OPTIONS
.INDENT 0.0
.TP
.B \-\-max\-objects
Specify the maximum number of objects (negative value to disable).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-size
Specify the maximum object size (in B/K/M/G/T, negative value to disable).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-quota\-scope
The scope of quota (bucket, user).
.UNINDENT
.SH ORPHANS SEARCH OPTIONS
.INDENT 0.0
.TP
.B \-\-num\-shards
Number of shards to use for 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.
The efault is 86400 (24 hours).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-job\-id
Set the job id (for orphans find)
.UNINDENT
.SH ORPHANS LIST-JOBS OPTIONS
.INDENT 0.0
.TP
.B \-\-extra\-info
Provide extra info in the job list.
.UNINDENT
.SH ROLE OPTIONS
.INDENT 0.0
.TP
.B \-\-role\-name
The name of the role to create.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-path
The path to the role.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-assume\-role\-policy\-doc
The trust relationship policy document that grants an entity permission to
assume the role.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-policy\-name
The name of the policy document.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-policy\-doc
The permission policy document.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-path\-prefix
The path prefix for filtering the roles.
.UNINDENT
.SH BUCKET NOTIFICATIONS/PUBSUB OPTIONS
.INDENT 0.0
.TP
.B \-\-topic
The bucket notifications/pubsub topic name.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-subscription
The pubsub subscription name.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-event\-id
The event id in a pubsub subscription.
.UNINDENT
.SH EXAMPLES
.sp
Generate a new user:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin user create \-\-display\-name=\(dqjohnny rotten\(dq \-\-uid=johnny
{ \(dquser_id\(dq: \(dqjohnny\(dq,
  \(dqrados_uid\(dq: 0,
  \(dqdisplay_name\(dq: \(dqjohnny rotten\(dq,
  \(dqemail\(dq: \(dq\(dq,
  \(dqsuspended\(dq: 0,
  \(dqsubusers\(dq: [],
  \(dqkeys\(dq: [
        { \(dquser\(dq: \(dqjohnny\(dq,
          \(dqaccess_key\(dq: \(dqTCICW53D9BQ2VGC46I44\(dq,
          \(dqsecret_key\(dq: \(dqtfm9aHMI8X76L3UdgE+ZQaJag1vJQmE6HDb5Lbrz\(dq}],
  \(dqswift_keys\(dq: []}
.EE
.UNINDENT
.UNINDENT
.sp
Remove a user:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin user rm \-\-uid=johnny
.EE
.UNINDENT
.UNINDENT
.sp
Rename a user:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin user rename \-\-uid=johnny \-\-new\-uid=joe
.EE
.UNINDENT
.UNINDENT
.sp
Remove a user and all associated buckets with their contents:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin user rm \-\-uid=johnny \-\-purge\-data
.EE
.UNINDENT
.UNINDENT
.sp
Remove a bucket:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin bucket rm \-\-bucket=foo
.EE
.UNINDENT
.UNINDENT
.sp
Link bucket to specified user:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin bucket link \-\-bucket=foo \-\-bucket_id=<bucket id> \-\-uid=johnny
.EE
.UNINDENT
.UNINDENT
.sp
Unlink bucket from specified user:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin bucket unlink \-\-bucket=foo \-\-uid=johnny
.EE
.UNINDENT
.UNINDENT
.sp
Rename a bucket:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin bucket link \-\-bucket=foo \-\-bucket\-new\-name=bar \-\-uid=johnny
.EE
.UNINDENT
.UNINDENT
.sp
Move a bucket from the old global tenant space to a specified tenant:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin bucket link \-\-bucket=foo \-\-uid=\(aq12345678$12345678\(aq
.EE
.UNINDENT
.UNINDENT
.sp
Link bucket to specified user and change object ACLs:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin bucket chown \-\-bucket=foo \-\-uid=\(aq12345678$12345678\(aq
.EE
.UNINDENT
.UNINDENT
.sp
Show the logs of a bucket from April 1st, 2012:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin log show \-\-bucket=foo \-\-date=2012\-04\-01\-01 \-\-bucket\-id=default.14193.1
.EE
.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
.EX
$ radosgw\-admin usage show \-\-uid=johnny \e
                \-\-start\-date=2012\-03\-01 \-\-end\-date=2012\-04\-01
.EE
.UNINDENT
.UNINDENT
.sp
Show only summary of usage information for all users:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin usage show \-\-show\-log\-entries=false
.EE
.UNINDENT
.UNINDENT
.sp
Trim usage information for user until March 1st, 2012:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ radosgw\-admin usage trim \-\-uid=johnny \-\-end\-date=2012\-04\-01
.EE
.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\%https://docs.ceph.com\fP for more information.
.SH SEE ALSO
.sp
\fI\%ceph\fP(8)
\fI\%radosgw\fP(8)
.SH COPYRIGHT
2010-2024, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
.\" Generated by docutils manpage writer.
.