1RADOSGW-ADMIN(8) Ceph RADOSGW-ADMIN(8)
2
6 radosgw-admin - rados REST gateway user administration utility
7
9 radosgw-admin command [ options ... ]
10
13 radosgw-admin is a RADOS gateway user administration utility. It allows
14 creating and modifying users.
15
17 radosgw-admin utility uses many commands for administration purpose
18 which are as follows:
19 user create
21 Create a new user.
22 user modify
24 Modify a user.
25 user info
27 Display information of a user, and any potentially available
28 subusers and keys.
29 user rm
31 Remove a user.
32 user suspend
34 Suspend a user.
35 user enable
37 Re-enable user after suspension.
38 user check
40 Check user info.
41 user stats
43 Show user stats as accounted by quota subsystem.
44 caps add
46 Add user capabilities.
47 caps rm
49 Remove user capabilities.
50 subuser create
52 Create a new subuser (primarily useful for clients using the
53 Swift API).
54 subuser modify
56 Modify a subuser.
57 subuser rm
59 Remove a subuser.
60 key create
62 Create access key.
63 key rm Remove access key.
65 bucket list
67 List all buckets.
68 bucket link
70 Link bucket to specified user.
71 bucket unlink
73 Unlink bucket from specified user.
74 bucket stats
76 Returns bucket statistics.
77 bucket rm
79 Remove a bucket.
80 bucket check
82 Check bucket index.
83 object rm
85 Remove an object.
86 object unlink
88 Unlink object from bucket index.
89 quota set
91 Set quota params.
92 quota enable
94 Enable quota.
95 quota disable
97 Disable quota.
98 region get
100 Show region info.
101 region list
103 List all regions set on this cluster.
104 region set
106 Set region info (requires infile).
107 region default
109 Set default region.
110 region-map get
112 Show region-map.
113 region-map set
115 Set region-map (requires infile).
116 zone get
118 Show zone cluster params.
119 zone set
121 Set zone cluster params (requires infile).
122 zone list
124 List all zones set on this cluster.
125 sync error list
127 list sync error.
128 sync error trim
130 trim sync error.
131 pool add
133 Add an existing pool for data placement.
134 pool rm
136 Remove an existing pool from data placement set.
137 pools list
139 List placement active set.
140 policy Display bucket/object policy.
142 log list
144 List log objects.
145 log show
147 Dump a log from specific object or (bucket + date + bucket-id).
148 (NOTE: required to specify formatting of date to
149 "YYYY-MM-DD-hh")
150 log rm Remove log object.
152 usage show
154 Show the usage information (with optional user and date range).
155 usage trim
157 Trim usage information (with optional user and date range).
158 gc list
160 Dump expired garbage collection objects (specify --include-all
161 to list all entries, including unexpired).
162 gc process
164 Manually process garbage.
165 metadata get
167 Get metadata info.
168 metadata put
170 Put metadata info.
171 metadata rm
173 Remove metadata info.
174 metadata list
176 List metadata info.
177 mdlog list
179 List metadata log.
180 mdlog trim
182 Trim metadata log.
183 bilog list
185 List bucket index log.
186 bilog trim
188 Trim bucket index log (use start-marker, end-marker).
189 datalog list
191 List data log.
192 datalog trim
194 Trim data log.
195 opstate list
197 List stateful operations entries (use client_id, op_id, object).
198 opstate set
200 Set state on an entry (use client_id, op_id, object, state).
201 opstate renew
203 Renew state on an entry (use client_id, op_id, object).
204 opstate rm
206 Remove entry (use client_id, op_id, object).
207 replicalog get
209 Get replica metadata log entry.
210 replicalog delete
212 Delete replica metadata log entry.
213 orphans find
215 Init and run search for leaked rados objects
216 orphans finish
218 Clean up search for leaked rados objects
219
221 -c ceph.conf, --conf=ceph.conf
222 Use ceph.conf configuration file instead of the default
223 /etc/ceph/ceph.conf to determine monitor addresses during
224 startup.
225 -m monaddress[:port]
227 Connect to specified monitor (instead of looking through
228 ceph.conf).
229 --uid=uid
231 The radosgw user ID.
232 --subuser=<name>
234 Name of the subuser.
235 --email=email
237 The e-mail address of the user.
238 --display-name=name
240 Configure the display name of the user.
241 --access-key=<key>
243 S3 access key.
244 --gen-access-key
246 Generate random access key (for S3).
247 --secret=secret
249 The secret associated with a given key.
250 --gen-secret
252 Generate random secret key.
253 --key-type=<type>
255 key type, options are: swift, s3.
256 --temp-url-key[-2]=<key>
258 Temporary url key.
259 --system
261 Set the system flag on the user.
262 --bucket=bucket
264 Specify the bucket name.
265 --object=object
267 Specify the object name.
268 --date=yyyy-mm-dd
270 The date needed for some commands.
271 --start-date=yyyy-mm-dd
273 The start date needed for some commands.
274 --end-date=yyyy-mm-dd
276 The end date needed for some commands.
277 --shard-id=<shard-id>
279 Optional for mdlog list, data sync status. Required for mdlog
280 trim, replica mdlog get/delete, replica datalog get/delete.
281 --max-entries=<entries>
283 Optional for listing operations to specify the max entires
284 --auth-uid=auid
286 The librados auid.
287 --purge-data
289 Remove user data before user removal.
290 --purge-keys
292 When specified, subuser removal will also purge all the subuser
293 keys.
294 --purge-objects
296 Remove all objects before bucket removal.
297 --metadata-key=<key>
299 Key to retrieve metadata from with metadata get.
300 --rgw-region=<region>
302 Region in which radosgw is running.
303 --rgw-zone=<zone>
305 Zone in which radosgw is running.
306 --fix Besides checking bucket index, will also fix it.
308 --check-objects
310 bucket check: Rebuilds bucket index according to actual objects
311 state.
312 --format=<format>
314 Specify output format for certain operations: xml, json.
315 --sync-stats
317 Option to 'user stats', update user stats with current stats
318 reported by user's buckets indexes.
319 --show-log-entries=<flag>
321 Enable/disable dump of log entries on log show.
322 --show-log-sum=<flag>
324 Enable/disable dump of log summation on log show.
325 --skip-zero-entries
327 Log show only dumps entries that don't have zero value in one of
328 the numeric field.
329 --infile
331 Specify a file to read in when setting data.
332 --state=<state string>
334 Specify a state for the opstate set command.
335 --replica-log-type
337 Replica log type (metadata, data, bucket), required for replica
338 log operations.
339 --categories=<list>
341 Comma separated list of categories, used in usage show.
342 --caps=<caps>
344 List of caps (e.g., "usage=read, write; user=read".
345 --compression=<compression-algorithm>
347 Placement target compression algorithm (lz4|snappy|zlib|zstd)
348 --yes-i-really-mean-it
350 Required for certain operations.
351
353 --max-objects
354 Specify max objects (negative value to disable).
355 --max-size
357 Specify max size (in bytes, negative value to disable).
358 --quota-scope
360 Scope of quota (bucket, user).
361
363 --pool Data pool to scan for leaked rados objects
364 --num-shards
366 Number of shards to use for keeping the temporary scan info
367 --orphan-stale-secs
369 Number of seconds to wait before declaring an object to be an
370 orphan. Default is 86400 (24 hours).
371 --job-id
373 Set the job id (for orphans find)
374 --max-concurrent-ios
376 Maximum concurrent ios for orphans find. Default is 32.
377
379 Generate a new user:
380 $ radosgw-admin user create --display-name="johnny rotten" --uid=johnny
382 { "user_id": "johnny",
383 "rados_uid": 0,
384 "display_name": "johnny rotten",
385 "email": "",
386 "suspended": 0,
387 "subusers": [],
388 "keys": [
389 { "user": "johnny",
390 "access_key": "TCICW53D9BQ2VGC46I44",
391 "secret_key": "tfm9aHMI8X76L3UdgE+ZQaJag1vJQmE6HDb5Lbrz"}],
392 "swift_keys": []}
393 Remove a user:
395 $ radosgw-admin user rm --uid=johnny
397 Remove a user and all associated buckets with their contents:
399 $ radosgw-admin user rm --uid=johnny --purge-data
401 Remove a bucket:
403 $ radosgw-admin bucket rm --bucket=foo
405 Link bucket to specified user:
407 $ radosgw-admin bucket link --bucket=foo --bucket_id=<bucket id> --uid=johnny
409 Unlink bucket from specified user:
411 $ radosgw-admin bucket unlink --bucket=foo --uid=johnny
413 Show the logs of a bucket from April 1st, 2012:
415 $ radosgw-admin log show --bucket=foo --date=2012-04-01-01 --bucket-id=default.14193.1
417 Show usage information for user from March 1st to (but not including)
419 April 1st, 2012:
420 $ radosgw-admin usage show --uid=johnny \
422 --start-date=2012-03-01 --end-date=2012-04-01
423 Show only summary of usage information for all users:
425 $ radosgw-admin usage show --show-log-entries=false
427 Trim usage information for user until March 1st, 2012:
429 $ radosgw-admin usage trim --uid=johnny --end-date=2012-04-01
431
433 radosgw-admin is part of Ceph, a massively scalable, open-source, dis‐
434 tributed storage system. Please refer to the Ceph documentation at
435 http://ceph.com/docs for more information.
436
438 ceph(8) radosgw(8)
439
441 2010-2014, Inktank Storage, Inc. and contributors. Licensed under Cre‐
442 ative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
443dev Apr 14, 2019 RADOSGW-ADMIN(8)