]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | :orphan: |
2 | ||
3 | ================================================================= | |
4 | radosgw-admin -- rados REST gateway user administration utility | |
5 | ================================================================= | |
6 | ||
7 | .. program:: radosgw-admin | |
8 | ||
9 | Synopsis | |
10 | ======== | |
11 | ||
12 | | **radosgw-admin** *command* [ *options* *...* ] | |
13 | ||
14 | ||
15 | Description | |
16 | =========== | |
17 | ||
18 | :program:`radosgw-admin` is a RADOS gateway user administration utility. It | |
19 | allows creating and modifying users. | |
20 | ||
21 | ||
22 | Commands | |
23 | ======== | |
24 | ||
25 | :program:`radosgw-admin` utility uses many commands for administration purpose | |
26 | which are as follows: | |
27 | ||
28 | :command:`user create` | |
29 | Create a new user. | |
30 | ||
31 | :command:`user modify` | |
32 | Modify a user. | |
33 | ||
34 | :command:`user info` | |
35 | Display information of a user, and any potentially available | |
36 | subusers and keys. | |
37 | ||
9f95a23c TL |
38 | :command:`user rename` |
39 | Renames a user. | |
40 | ||
7c673cae FG |
41 | :command:`user rm` |
42 | Remove a user. | |
43 | ||
44 | :command:`user suspend` | |
45 | Suspend a user. | |
46 | ||
47 | :command:`user enable` | |
48 | Re-enable user after suspension. | |
49 | ||
50 | :command:`user check` | |
51 | Check user info. | |
52 | ||
53 | :command:`user stats` | |
54 | Show user stats as accounted by quota subsystem. | |
55 | ||
11fdf7f2 TL |
56 | :command:`user list` |
57 | List all users. | |
58 | ||
7c673cae FG |
59 | :command:`caps add` |
60 | Add user capabilities. | |
61 | ||
62 | :command:`caps rm` | |
63 | Remove user capabilities. | |
64 | ||
65 | :command:`subuser create` | |
66 | Create a new subuser (primarily useful for clients using the Swift API). | |
67 | ||
68 | :command:`subuser modify` | |
69 | Modify a subuser. | |
70 | ||
71 | :command:`subuser rm` | |
72 | Remove a subuser. | |
73 | ||
74 | :command:`key create` | |
75 | Create access key. | |
76 | ||
77 | :command:`key rm` | |
78 | Remove access key. | |
79 | ||
80 | :command:`bucket list` | |
494da23a TL |
81 | List buckets, or, if bucket specified with --bucket=<bucket>, |
82 | list its objects. If bucket specified adding --allow-unordered | |
83 | removes ordering requirement, possibly generating results more | |
84 | quickly in buckets with large number of objects. | |
7c673cae | 85 | |
11fdf7f2 TL |
86 | :command:`bucket limit check` |
87 | Show bucket sharding stats. | |
88 | ||
7c673cae FG |
89 | :command:`bucket link` |
90 | Link bucket to specified user. | |
91 | ||
92 | :command:`bucket unlink` | |
93 | Unlink bucket from specified user. | |
94 | ||
9f95a23c TL |
95 | :command:`bucket chown` |
96 | Link bucket to specified user and update object ACLs. | |
97 | Use --marker to resume if command gets interrupted. | |
98 | ||
7c673cae FG |
99 | :command:`bucket stats` |
100 | Returns bucket statistics. | |
101 | ||
102 | :command:`bucket rm` | |
103 | Remove a bucket. | |
104 | ||
105 | :command:`bucket check` | |
106 | Check bucket index. | |
107 | ||
11fdf7f2 TL |
108 | :command:`bucket rewrite` |
109 | Rewrite all objects in the specified bucket. | |
110 | ||
e306af50 TL |
111 | :command:`bucket radoslist` |
112 | List the rados objects that contain the data for all objects is | |
113 | the designated bucket, if --bucket=<bucket> is specified, or | |
114 | otherwise all buckets. | |
115 | ||
11fdf7f2 TL |
116 | :command:`bucket reshard` |
117 | Reshard a bucket. | |
118 | ||
119 | :command:`bucket sync disable` | |
120 | Disable bucket sync. | |
121 | ||
122 | :command:`bucket sync enable` | |
123 | Enable bucket sync. | |
124 | ||
125 | :command:`bi get` | |
126 | Retrieve bucket index object entries. | |
127 | ||
128 | :command:`bi put` | |
129 | Store bucket index object entries. | |
130 | ||
131 | :command:`bi list` | |
132 | List raw bucket index entries. | |
133 | ||
134 | :command:`bi purge` | |
135 | Purge bucket index entries. | |
136 | ||
7c673cae FG |
137 | :command:`object rm` |
138 | Remove an object. | |
139 | ||
11fdf7f2 TL |
140 | :command:`object stat` |
141 | Stat an object for its metadata. | |
142 | ||
7c673cae FG |
143 | :command:`object unlink` |
144 | Unlink object from bucket index. | |
145 | ||
11fdf7f2 TL |
146 | :command:`object rewrite` |
147 | Rewrite the specified object. | |
148 | ||
149 | :command:`objects expire` | |
150 | Run expired objects cleanup. | |
151 | ||
152 | :command:`period rm` | |
153 | Remove a period. | |
154 | ||
155 | :command:`period get` | |
156 | Get the period info. | |
157 | ||
158 | :command:`period get-current` | |
159 | Get the current period info. | |
160 | ||
161 | :command:`period pull` | |
162 | Pull a period. | |
163 | ||
164 | :command:`period push` | |
165 | Push a period. | |
166 | ||
167 | :command:`period list` | |
168 | List all periods. | |
169 | ||
170 | :command:`period update` | |
171 | Update the staging period. | |
172 | ||
173 | :command:`period commit` | |
174 | Commit the staging period. | |
175 | ||
7c673cae FG |
176 | :command:`quota set` |
177 | Set quota params. | |
178 | ||
179 | :command:`quota enable` | |
180 | Enable quota. | |
181 | ||
182 | :command:`quota disable` | |
183 | Disable quota. | |
184 | ||
11fdf7f2 TL |
185 | :command:`global quota get` |
186 | View global quota parameters. | |
187 | ||
188 | :command:`global quota set` | |
189 | Set global quota parameters. | |
190 | ||
191 | :command:`global quota enable` | |
192 | Enable a global quota. | |
193 | ||
194 | :command:`global quota disable` | |
195 | Disable a global quota. | |
196 | ||
197 | :command:`realm create` | |
198 | Create a new realm. | |
199 | ||
200 | :command:`realm rm` | |
201 | Remove a realm. | |
7c673cae | 202 | |
11fdf7f2 TL |
203 | :command:`realm get` |
204 | Show the realm info. | |
7c673cae | 205 | |
11fdf7f2 TL |
206 | :command:`realm get-default` |
207 | Get the default realm name. | |
7c673cae | 208 | |
11fdf7f2 TL |
209 | :command:`realm list` |
210 | List all realms. | |
7c673cae | 211 | |
11fdf7f2 TL |
212 | :command:`realm list-periods` |
213 | List all realm periods. | |
7c673cae | 214 | |
11fdf7f2 TL |
215 | :command:`realm rename` |
216 | Rename a realm. | |
217 | ||
218 | :command:`realm set` | |
219 | Set the realm info (requires infile). | |
220 | ||
221 | :command:`realm default` | |
222 | Set the realm as default. | |
223 | ||
224 | :command:`realm pull` | |
225 | Pull a realm and its current period. | |
226 | ||
227 | :command:`zonegroup add` | |
228 | Add a zone to a zonegroup. | |
229 | ||
230 | :command:`zonegroup create` | |
231 | Create a new zone group info. | |
232 | ||
233 | :command:`zonegroup default` | |
234 | Set the default zone group. | |
235 | ||
236 | :command:`zonegroup rm` | |
237 | Remove a zone group info. | |
238 | ||
239 | :command:`zonegroup get` | |
240 | Show the zone group info. | |
241 | ||
242 | :command:`zonegroup modify` | |
243 | Modify an existing zonegroup. | |
244 | ||
245 | :command:`zonegroup set` | |
246 | Set the zone group info (requires infile). | |
247 | ||
248 | :command:`zonegroup remove` | |
249 | Remove a zone from a zonegroup. | |
250 | ||
251 | :command:`zonegroup rename` | |
252 | Rename a zone group. | |
253 | ||
254 | :command:`zonegroup list` | |
255 | List all zone groups set on this cluster. | |
256 | ||
257 | :command:`zonegroup placement list` | |
258 | List zonegroup's placement targets. | |
259 | ||
260 | :command:`zonegroup placement add` | |
261 | Add a placement target id to a zonegroup. | |
262 | ||
263 | :command:`zonegroup placement modify` | |
264 | Modify a placement target of a specific zonegroup. | |
265 | ||
266 | :command:`zonegroup placement rm` | |
267 | Remove a placement target from a zonegroup. | |
268 | ||
269 | :command:`zonegroup placement default` | |
270 | Set a zonegroup's default placement target. | |
271 | ||
272 | :command:`zone create` | |
273 | Create a new zone. | |
274 | ||
275 | :command:`zone rm` | |
276 | Remove a zone. | |
7c673cae FG |
277 | |
278 | :command:`zone get` | |
279 | Show zone cluster params. | |
280 | ||
281 | :command:`zone set` | |
282 | Set zone cluster params (requires infile). | |
283 | ||
11fdf7f2 TL |
284 | :command:`zone modify` |
285 | Modify an existing zone. | |
286 | ||
7c673cae FG |
287 | :command:`zone list` |
288 | List all zones set on this cluster. | |
289 | ||
11fdf7f2 TL |
290 | :command:`metadata sync status` |
291 | Get metadata sync status. | |
292 | ||
293 | :command:`metadata sync init` | |
294 | Init metadata sync. | |
295 | ||
296 | :command:`metadata sync run` | |
297 | Run metadata sync. | |
298 | ||
299 | :command:`data sync status` | |
300 | Get data sync status of the specified source zone. | |
301 | ||
302 | :command:`data sync init` | |
303 | Init data sync for the specified source zone. | |
304 | ||
305 | :command:`data sync run` | |
306 | Run data sync for the specified source zone. | |
307 | ||
94b18763 FG |
308 | :command:`sync error list` |
309 | list sync error. | |
310 | ||
311 | :command:`sync error trim` | |
312 | trim sync error. | |
313 | ||
11fdf7f2 TL |
314 | :command:`zone rename` |
315 | Rename a zone. | |
316 | ||
317 | :command:`zone placement list` | |
318 | List zone's placement targets. | |
319 | ||
320 | :command:`zone placement add` | |
321 | Add a zone placement target. | |
322 | ||
323 | :command:`zone placement modify` | |
324 | Modify a zone placement target. | |
325 | ||
326 | :command:`zone placement rm` | |
327 | Remove a zone placement target. | |
328 | ||
7c673cae FG |
329 | :command:`pool add` |
330 | Add an existing pool for data placement. | |
331 | ||
332 | :command:`pool rm` | |
333 | Remove an existing pool from data placement set. | |
334 | ||
335 | :command:`pools list` | |
336 | List placement active set. | |
337 | ||
338 | :command:`policy` | |
339 | Display bucket/object policy. | |
340 | ||
341 | :command:`log list` | |
342 | List log objects. | |
343 | ||
344 | :command:`log show` | |
345 | Dump a log from specific object or (bucket + date + bucket-id). | |
346 | (NOTE: required to specify formatting of date to "YYYY-MM-DD-hh") | |
347 | ||
348 | :command:`log rm` | |
349 | Remove log object. | |
350 | ||
351 | :command:`usage show` | |
352 | Show the usage information (with optional user and date range). | |
353 | ||
354 | :command:`usage trim` | |
355 | Trim usage information (with optional user and date range). | |
356 | ||
357 | :command:`gc list` | |
358 | Dump expired garbage collection objects (specify --include-all to list all | |
359 | entries, including unexpired). | |
360 | ||
361 | :command:`gc process` | |
362 | Manually process garbage. | |
363 | ||
11fdf7f2 TL |
364 | :command:`lc list` |
365 | List all bucket lifecycle progress. | |
366 | ||
367 | :command:`lc process` | |
20effc67 TL |
368 | Manually process lifecycle. If a bucket is specified (e.g., via |
369 | --bucket_id or via --bucket and optional --tenant), only that bucket | |
370 | is processed. | |
11fdf7f2 | 371 | |
7c673cae FG |
372 | :command:`metadata get` |
373 | Get metadata info. | |
374 | ||
375 | :command:`metadata put` | |
376 | Put metadata info. | |
377 | ||
378 | :command:`metadata rm` | |
379 | Remove metadata info. | |
380 | ||
381 | :command:`metadata list` | |
382 | List metadata info. | |
383 | ||
384 | :command:`mdlog list` | |
20effc67 | 385 | List metadata log which is needed for multi-site deployments. |
7c673cae FG |
386 | |
387 | :command:`mdlog trim` | |
20effc67 TL |
388 | Trim metadata log manually instead of relying on RGWs integrated log sync. |
389 | Before trimming, compare the listings and make sure the last sync was | |
390 | complete, otherwise it can reinitiate a sync. | |
7c673cae | 391 | |
11fdf7f2 TL |
392 | :command:`mdlog status` |
393 | Read metadata log status. | |
394 | ||
7c673cae | 395 | :command:`bilog list` |
20effc67 | 396 | List bucket index log which is needed for multi-site deployments. |
7c673cae FG |
397 | |
398 | :command:`bilog trim` | |
20effc67 TL |
399 | Trim bucket index log (use start-marker, end-marker) manually instead |
400 | of relying on RGWs integrated log sync. | |
401 | Before trimming, compare the listings and make sure the last sync was | |
402 | complete, otherwise it can reinitiate a sync. | |
7c673cae FG |
403 | |
404 | :command:`datalog list` | |
20effc67 | 405 | List data log which is needed for multi-site deployments. |
7c673cae FG |
406 | |
407 | :command:`datalog trim` | |
20effc67 TL |
408 | Trim data log manually instead of relying on RGWs integrated log sync. |
409 | Before trimming, compare the listings and make sure the last sync was | |
410 | complete, otherwise it can reinitiate a sync. | |
7c673cae | 411 | |
11fdf7f2 TL |
412 | :command:`datalog status` |
413 | Read data log status. | |
7c673cae | 414 | |
11fdf7f2 | 415 | :command:`orphans find` |
e306af50 TL |
416 | Init and run search for leaked rados objects. |
417 | DEPRECATED. See the "rgw-orphan-list" tool. | |
7c673cae | 418 | |
11fdf7f2 | 419 | :command:`orphans finish` |
e306af50 TL |
420 | Clean up search for leaked rados objects. |
421 | DEPRECATED. See the "rgw-orphan-list" tool. | |
7c673cae | 422 | |
11fdf7f2 TL |
423 | :command:`orphans list-jobs` |
424 | List the current job-ids for the orphans search. | |
e306af50 | 425 | DEPRECATED. See the "rgw-orphan-list" tool. |
7c673cae | 426 | |
11fdf7f2 TL |
427 | :command:`role create` |
428 | create a new AWS role for use with STS. | |
7c673cae | 429 | |
11fdf7f2 TL |
430 | :command:`role rm` |
431 | Remove a role. | |
7c673cae | 432 | |
11fdf7f2 TL |
433 | :command:`role get` |
434 | Get a role. | |
7c673cae | 435 | |
11fdf7f2 TL |
436 | :command:`role list` |
437 | List the roles with specified path prefix. | |
438 | ||
439 | :command:`role modify` | |
440 | Modify the assume role policy of an existing role. | |
441 | ||
442 | :command:`role-policy put` | |
443 | Add/update permission policy to role. | |
444 | ||
445 | :command:`role-policy list` | |
446 | List the policies attached to a role. | |
447 | ||
448 | :command:`role-policy get` | |
449 | Get the specified inline policy document embedded with the given role. | |
450 | ||
451 | :command:`role-policy rm` | |
452 | Remove the policy attached to a role | |
453 | ||
454 | :command:`reshard add` | |
455 | Schedule a resharding of a bucket | |
456 | ||
457 | :command:`reshard list` | |
458 | List all bucket resharding or scheduled to be resharded | |
459 | ||
460 | :command:`reshard process` | |
461 | Process of scheduled reshard jobs | |
7c673cae | 462 | |
11fdf7f2 TL |
463 | :command:`reshard status` |
464 | Resharding status of a bucket | |
465 | ||
466 | :command:`reshard cancel` | |
467 | Cancel resharding a bucket | |
7c673cae | 468 | |
f67539c2 TL |
469 | :command:`topic list` |
470 | List bucket notifications/pubsub topics | |
471 | ||
472 | :command:`topic get` | |
473 | Get a bucket notifications/pubsub topic | |
474 | ||
475 | :command:`topic rm` | |
476 | Remove a bucket notifications/pubsub topic | |
477 | ||
478 | :command:`subscription get` | |
479 | Get a pubsub subscription definition | |
480 | ||
481 | :command:`subscription rm` | |
482 | Remove a pubsub subscription | |
483 | ||
484 | :command:`subscription pull` | |
485 | Show events in a pubsub subscription | |
486 | ||
487 | :command:`subscription ack` | |
488 | Ack (remove) an events in a pubsub subscription | |
489 | ||
490 | ||
7c673cae FG |
491 | Options |
492 | ======= | |
493 | ||
494 | .. option:: -c ceph.conf, --conf=ceph.conf | |
495 | ||
496 | Use ``ceph.conf`` configuration file instead of the default | |
497 | ``/etc/ceph/ceph.conf`` to determine monitor addresses during | |
498 | startup. | |
499 | ||
500 | .. option:: -m monaddress[:port] | |
501 | ||
502 | Connect to specified monitor (instead of looking through ceph.conf). | |
503 | ||
11fdf7f2 TL |
504 | .. option:: --tenant=<tenant> |
505 | ||
506 | Name of the tenant. | |
507 | ||
7c673cae FG |
508 | .. option:: --uid=uid |
509 | ||
510 | The radosgw user ID. | |
511 | ||
9f95a23c TL |
512 | .. option:: --new-uid=uid |
513 | ||
514 | ID of the new user. Used with 'user rename' command. | |
515 | ||
7c673cae FG |
516 | .. option:: --subuser=<name> |
517 | ||
518 | Name of the subuser. | |
519 | ||
11fdf7f2 | 520 | .. option:: --access-key=<key> |
7c673cae | 521 | |
11fdf7f2 | 522 | S3 access key. |
7c673cae | 523 | |
11fdf7f2 | 524 | .. option:: --email=email |
7c673cae | 525 | |
11fdf7f2 | 526 | The e-mail address of the user. |
7c673cae | 527 | |
11fdf7f2 | 528 | .. option:: --secret/--secret-key=<key> |
7c673cae | 529 | |
11fdf7f2 | 530 | The secret key. |
7c673cae FG |
531 | |
532 | .. option:: --gen-access-key | |
533 | ||
534 | Generate random access key (for S3). | |
535 | ||
7c673cae FG |
536 | .. option:: --gen-secret |
537 | ||
538 | Generate random secret key. | |
539 | ||
540 | .. option:: --key-type=<type> | |
541 | ||
542 | key type, options are: swift, s3. | |
543 | ||
544 | .. option:: --temp-url-key[-2]=<key> | |
545 | ||
546 | Temporary url key. | |
547 | ||
11fdf7f2 TL |
548 | .. option:: --max-buckets |
549 | ||
550 | max number of buckets for a user (0 for no limit, negative value to disable bucket creation). | |
551 | Default is 1000. | |
552 | ||
553 | .. option:: --access=<access> | |
554 | ||
555 | Set the access permissions for the sub-user. | |
556 | Available access permissions are read, write, readwrite and full. | |
557 | ||
558 | .. option:: --display-name=<name> | |
559 | ||
560 | The display name of the user. | |
561 | ||
562 | .. option:: --admin | |
563 | ||
564 | Set the admin flag on the user. | |
565 | ||
7c673cae FG |
566 | .. option:: --system |
567 | ||
11fdf7f2 | 568 | Set the system flag on the user. |
7c673cae | 569 | |
9f95a23c | 570 | .. option:: --bucket=[tenant-id/]bucket |
7c673cae | 571 | |
9f95a23c TL |
572 | Specify the bucket name. If tenant-id is not specified, the tenant-id |
573 | of the user (--uid) is used. | |
7c673cae | 574 | |
11fdf7f2 TL |
575 | .. option:: --pool=<pool> |
576 | ||
577 | Specify the pool name. | |
578 | Also used with `orphans find` as data pool to scan for leaked rados objects. | |
579 | ||
7c673cae FG |
580 | .. option:: --object=object |
581 | ||
582 | Specify the object name. | |
583 | ||
584 | .. option:: --date=yyyy-mm-dd | |
585 | ||
11fdf7f2 | 586 | The date in the format yyyy-mm-dd. |
7c673cae FG |
587 | |
588 | .. option:: --start-date=yyyy-mm-dd | |
589 | ||
11fdf7f2 | 590 | The start date in the format yyyy-mm-dd. |
7c673cae FG |
591 | |
592 | .. option:: --end-date=yyyy-mm-dd | |
593 | ||
11fdf7f2 TL |
594 | The end date in the format yyyy-mm-dd. |
595 | ||
596 | .. option:: --bucket-id=<bucket-id> | |
597 | ||
598 | Specify the bucket id. | |
7c673cae | 599 | |
9f95a23c TL |
600 | .. option:: --bucket-new-name=[tenant-id/]<bucket> |
601 | ||
602 | Optional for `bucket link`; use to rename a bucket. | |
603 | While tenant-id/ can be specified, this is never | |
604 | necessary for normal operation. | |
605 | ||
7c673cae FG |
606 | .. option:: --shard-id=<shard-id> |
607 | ||
9f95a23c | 608 | Optional for mdlog list, bi list, data sync status. Required for ``mdlog trim``. |
7c673cae | 609 | |
28e407b8 AA |
610 | .. option:: --max-entries=<entries> |
611 | ||
20effc67 | 612 | Optional for listing operations to specify the max entries. |
28e407b8 | 613 | |
7c673cae FG |
614 | .. option:: --purge-data |
615 | ||
11fdf7f2 | 616 | When specified, user removal will also purge all the user data. |
7c673cae FG |
617 | |
618 | .. option:: --purge-keys | |
619 | ||
620 | When specified, subuser removal will also purge all the subuser keys. | |
621 | ||
622 | .. option:: --purge-objects | |
623 | ||
11fdf7f2 | 624 | When specified, the bucket removal will also purge all objects in it. |
7c673cae FG |
625 | |
626 | .. option:: --metadata-key=<key> | |
627 | ||
628 | Key to retrieve metadata from with ``metadata get``. | |
629 | ||
11fdf7f2 | 630 | .. option:: --remote=<remote> |
7c673cae | 631 | |
11fdf7f2 TL |
632 | Zone or zonegroup id of remote gateway. |
633 | ||
634 | .. option:: --period=<id> | |
635 | ||
636 | Period id. | |
637 | ||
638 | .. option:: --url=<url> | |
639 | ||
640 | url for pushing/pulling period or realm. | |
641 | ||
642 | .. option:: --epoch=<number> | |
643 | ||
644 | Period epoch. | |
645 | ||
646 | .. option:: --commit | |
647 | ||
648 | Commit the period during 'period update'. | |
649 | ||
650 | .. option:: --staging | |
651 | ||
652 | Get the staging period info. | |
653 | ||
654 | .. option:: --master | |
655 | ||
656 | Set as master. | |
657 | ||
658 | .. option:: --master-zone=<id> | |
659 | ||
660 | Master zone id. | |
661 | ||
662 | .. option:: --rgw-realm=<name> | |
663 | ||
664 | The realm name. | |
665 | ||
666 | .. option:: --realm-id=<id> | |
667 | ||
668 | The realm id. | |
669 | ||
670 | .. option:: --realm-new-name=<name> | |
671 | ||
672 | New name of realm. | |
673 | ||
674 | .. option:: --rgw-zonegroup=<name> | |
675 | ||
676 | The zonegroup name. | |
677 | ||
678 | .. option:: --zonegroup-id=<id> | |
679 | ||
680 | The zonegroup id. | |
681 | ||
682 | .. option:: --zonegroup-new-name=<name> | |
683 | ||
684 | The new name of the zonegroup. | |
7c673cae FG |
685 | |
686 | .. option:: --rgw-zone=<zone> | |
687 | ||
688 | Zone in which radosgw is running. | |
689 | ||
11fdf7f2 TL |
690 | .. option:: --zone-id=<id> |
691 | ||
692 | The zone id. | |
693 | ||
694 | .. option:: --zone-new-name=<name> | |
695 | ||
696 | The new name of the zone. | |
697 | ||
698 | .. option:: --source-zone | |
699 | ||
700 | The source zone for data sync. | |
701 | ||
702 | .. option:: --default | |
703 | ||
704 | Set the entity (realm, zonegroup, zone) as default. | |
705 | ||
706 | .. option:: --read-only | |
707 | ||
708 | Set the zone as read-only when adding to the zonegroup. | |
709 | ||
710 | .. option:: --placement-id | |
711 | ||
712 | Placement id for the zonegroup placement commands. | |
713 | ||
714 | .. option:: --tags=<list> | |
715 | ||
716 | The list of tags for zonegroup placement add and modify commands. | |
717 | ||
718 | .. option:: --tags-add=<list> | |
719 | ||
720 | The list of tags to add for zonegroup placement modify command. | |
721 | ||
722 | .. option:: --tags-rm=<list> | |
723 | ||
724 | The list of tags to remove for zonegroup placement modify command. | |
725 | ||
726 | .. option:: --endpoints=<list> | |
727 | ||
728 | The zone endpoints. | |
729 | ||
730 | .. option:: --index-pool=<pool> | |
731 | ||
732 | The placement target index pool. | |
733 | ||
734 | .. option:: --data-pool=<pool> | |
735 | ||
736 | The placement target data pool. | |
737 | ||
738 | .. option:: --data-extra-pool=<pool> | |
739 | ||
740 | The placement target data extra (non-ec) pool. | |
741 | ||
742 | .. option:: --placement-index-type=<type> | |
743 | ||
744 | The placement target index type (normal, indexless, or #id). | |
745 | ||
39ae355f TL |
746 | .. option:: --placement-inline-data=<true> |
747 | ||
748 | Whether the placement target is configured to store a data chunk inline in head objects. | |
749 | ||
11fdf7f2 TL |
750 | .. option:: --tier-type=<type> |
751 | ||
752 | The zone tier type. | |
753 | ||
754 | .. option:: --tier-config=<k>=<v>[,...] | |
755 | ||
756 | Set zone tier config keys, values. | |
757 | ||
758 | .. option:: --tier-config-rm=<k>[,...] | |
759 | ||
760 | Unset zone tier config keys. | |
761 | ||
762 | .. option:: --sync-from-all[=false] | |
763 | ||
764 | Set/reset whether zone syncs from all zonegroup peers. | |
765 | ||
766 | .. option:: --sync-from=[zone-name][,...] | |
767 | ||
768 | Set the list of zones to sync from. | |
769 | ||
770 | .. option:: --sync-from-rm=[zone-name][,...] | |
771 | ||
772 | Remove the zones from list of zones to sync from. | |
773 | ||
9f95a23c TL |
774 | .. option:: --bucket-index-max-shards |
775 | ||
776 | Override a zone's or zonegroup's default number of bucket index shards. This | |
777 | option is accepted by the 'zone create', 'zone modify', 'zonegroup add', | |
778 | and 'zonegroup modify' commands, and applies to buckets that are created | |
779 | after the zone/zonegroup changes take effect. | |
780 | ||
7c673cae FG |
781 | .. option:: --fix |
782 | ||
783 | Besides checking bucket index, will also fix it. | |
784 | ||
785 | .. option:: --check-objects | |
786 | ||
787 | bucket check: Rebuilds bucket index according to actual objects state. | |
788 | ||
789 | .. option:: --format=<format> | |
790 | ||
11fdf7f2 | 791 | Specify output format for certain operations. Supported formats: xml, json. |
7c673cae FG |
792 | |
793 | .. option:: --sync-stats | |
794 | ||
11fdf7f2 TL |
795 | Option for 'user stats' command. When specified, it will update user stats with |
796 | the current stats reported by user's buckets indexes. | |
7c673cae | 797 | |
20effc67 TL |
798 | .. option:: --show-config |
799 | ||
800 | Show configuration. | |
801 | ||
7c673cae FG |
802 | .. option:: --show-log-entries=<flag> |
803 | ||
804 | Enable/disable dump of log entries on log show. | |
805 | ||
806 | .. option:: --show-log-sum=<flag> | |
807 | ||
808 | Enable/disable dump of log summation on log show. | |
809 | ||
810 | .. option:: --skip-zero-entries | |
811 | ||
812 | Log show only dumps entries that don't have zero value in one of the numeric | |
813 | field. | |
814 | ||
815 | .. option:: --infile | |
816 | ||
817 | Specify a file to read in when setting data. | |
818 | ||
7c673cae FG |
819 | .. option:: --categories=<list> |
820 | ||
821 | Comma separated list of categories, used in usage show. | |
822 | ||
823 | .. option:: --caps=<caps> | |
824 | ||
20effc67 | 825 | List of caps (e.g., "usage=read, write; user=read"). |
7c673cae | 826 | |
d2e6a577 FG |
827 | .. option:: --compression=<compression-algorithm> |
828 | ||
829 | Placement target compression algorithm (lz4|snappy|zlib|zstd) | |
830 | ||
7c673cae FG |
831 | .. option:: --yes-i-really-mean-it |
832 | ||
833 | Required for certain operations. | |
834 | ||
11fdf7f2 TL |
835 | .. option:: --min-rewrite-size |
836 | ||
837 | Specify the min object size for bucket rewrite (default 4M). | |
838 | ||
839 | .. option:: --max-rewrite-size | |
840 | ||
841 | Specify the max object size for bucket rewrite (default ULLONG_MAX). | |
842 | ||
843 | .. option:: --min-rewrite-stripe-size | |
844 | ||
845 | Specify the min stripe size for object rewrite (default 0). If the value | |
846 | is set to 0, then the specified object will always be | |
847 | rewritten for restriping. | |
848 | ||
849 | .. option:: --warnings-only | |
850 | ||
851 | When specified with bucket limit check, | |
852 | list only buckets nearing or over the current max objects per shard value. | |
853 | ||
854 | .. option:: --bypass-gc | |
855 | ||
856 | When specified with bucket deletion, | |
857 | triggers object deletions by not involving GC. | |
858 | ||
859 | .. option:: --inconsistent-index | |
860 | ||
861 | When specified with bucket deletion and bypass-gc set to true, | |
862 | ignores bucket index consistency. | |
7c673cae | 863 | |
9f95a23c TL |
864 | .. option:: --max-concurrent-ios |
865 | ||
866 | Maximum concurrent ios for bucket operations. Affects operations that | |
867 | scan the bucket index, e.g., listing, deletion, and all scan/search | |
868 | operations such as finding orphans or checking the bucket index. | |
869 | Default is 32. | |
870 | ||
7c673cae FG |
871 | Quota Options |
872 | ============= | |
873 | ||
874 | .. option:: --max-objects | |
875 | ||
876 | Specify max objects (negative value to disable). | |
877 | ||
878 | .. option:: --max-size | |
879 | ||
11fdf7f2 | 880 | Specify max size (in B/K/M/G/T, negative value to disable). |
7c673cae FG |
881 | |
882 | .. option:: --quota-scope | |
883 | ||
11fdf7f2 | 884 | The scope of quota (bucket, user). |
7c673cae FG |
885 | |
886 | ||
887 | Orphans Search Options | |
888 | ====================== | |
889 | ||
7c673cae FG |
890 | .. option:: --num-shards |
891 | ||
892 | Number of shards to use for keeping the temporary scan info | |
893 | ||
894 | .. option:: --orphan-stale-secs | |
895 | ||
896 | Number of seconds to wait before declaring an object to be an orphan. | |
897 | Default is 86400 (24 hours). | |
898 | ||
899 | .. option:: --job-id | |
900 | ||
901 | Set the job id (for orphans find) | |
902 | ||
7c673cae | 903 | |
11fdf7f2 TL |
904 | Orphans list-jobs options |
905 | ========================= | |
906 | ||
907 | .. option:: --extra-info | |
908 | ||
909 | Provide extra info in the job list. | |
910 | ||
911 | ||
912 | Role Options | |
913 | ============ | |
914 | ||
915 | .. option:: --role-name | |
916 | ||
917 | The name of the role to create. | |
918 | ||
919 | .. option:: --path | |
920 | ||
921 | The path to the role. | |
922 | ||
923 | .. option:: --assume-role-policy-doc | |
924 | ||
925 | The trust relationship policy document that grants an entity permission to | |
926 | assume the role. | |
927 | ||
928 | .. option:: --policy-name | |
929 | ||
930 | The name of the policy document. | |
931 | ||
932 | .. option:: --policy-doc | |
933 | ||
934 | The permission policy document. | |
935 | ||
936 | .. option:: --path-prefix | |
937 | ||
938 | The path prefix for filtering the roles. | |
939 | ||
f67539c2 TL |
940 | |
941 | Bucket Notifications/PubSub Options | |
942 | =================================== | |
943 | .. option:: --topic | |
944 | ||
945 | The bucket notifications/pubsub topic name. | |
946 | ||
947 | .. option:: --subscription | |
948 | ||
949 | The pubsub subscription name. | |
950 | ||
951 | .. option:: --event-id | |
952 | ||
953 | The event id in a pubsub subscription. | |
954 | ||
955 | ||
7c673cae FG |
956 | Examples |
957 | ======== | |
958 | ||
959 | Generate a new user:: | |
960 | ||
961 | $ radosgw-admin user create --display-name="johnny rotten" --uid=johnny | |
962 | { "user_id": "johnny", | |
963 | "rados_uid": 0, | |
964 | "display_name": "johnny rotten", | |
965 | "email": "", | |
966 | "suspended": 0, | |
967 | "subusers": [], | |
968 | "keys": [ | |
969 | { "user": "johnny", | |
970 | "access_key": "TCICW53D9BQ2VGC46I44", | |
971 | "secret_key": "tfm9aHMI8X76L3UdgE+ZQaJag1vJQmE6HDb5Lbrz"}], | |
972 | "swift_keys": []} | |
973 | ||
974 | Remove a user:: | |
975 | ||
976 | $ radosgw-admin user rm --uid=johnny | |
9f95a23c TL |
977 | |
978 | Rename a user:: | |
979 | ||
980 | $ radosgw-admin user rename --uid=johny --new-uid=joe | |
7c673cae FG |
981 | |
982 | Remove a user and all associated buckets with their contents:: | |
983 | ||
984 | $ radosgw-admin user rm --uid=johnny --purge-data | |
985 | ||
986 | Remove a bucket:: | |
987 | ||
988 | $ radosgw-admin bucket rm --bucket=foo | |
989 | ||
990 | Link bucket to specified user:: | |
991 | ||
992 | $ radosgw-admin bucket link --bucket=foo --bucket_id=<bucket id> --uid=johnny | |
993 | ||
994 | Unlink bucket from specified user:: | |
995 | ||
996 | $ radosgw-admin bucket unlink --bucket=foo --uid=johnny | |
997 | ||
9f95a23c TL |
998 | Rename a bucket:: |
999 | ||
1000 | $ radosgw-admin bucket link --bucket=foo --bucket-new-name=bar --uid=johnny | |
1001 | ||
1002 | Move a bucket from the old global tenant space to a specified tenant:: | |
1003 | ||
1004 | $ radosgw-admin bucket link --bucket=/foo --uid=12345678$12345678' | |
1005 | ||
1006 | Link bucket to specified user and change object ACLs:: | |
1007 | ||
1008 | $ radosgw-admin bucket chown --bucket=/foo --uid=12345678$12345678' | |
1009 | ||
7c673cae FG |
1010 | Show the logs of a bucket from April 1st, 2012:: |
1011 | ||
1012 | $ radosgw-admin log show --bucket=foo --date=2012-04-01-01 --bucket-id=default.14193.1 | |
1013 | ||
1014 | Show usage information for user from March 1st to (but not including) April 1st, 2012:: | |
1015 | ||
1016 | $ radosgw-admin usage show --uid=johnny \ | |
1017 | --start-date=2012-03-01 --end-date=2012-04-01 | |
1018 | ||
1019 | Show only summary of usage information for all users:: | |
1020 | ||
1021 | $ radosgw-admin usage show --show-log-entries=false | |
1022 | ||
1023 | Trim usage information for user until March 1st, 2012:: | |
1024 | ||
1025 | $ radosgw-admin usage trim --uid=johnny --end-date=2012-04-01 | |
1026 | ||
1027 | ||
1028 | Availability | |
1029 | ============ | |
1030 | ||
1031 | :program:`radosgw-admin` is part of Ceph, a massively scalable, open-source, | |
1032 | distributed storage system. Please refer to the Ceph documentation at | |
20effc67 | 1033 | https://docs.ceph.com for more information. |
7c673cae FG |
1034 | |
1035 | ||
1036 | See also | |
1037 | ======== | |
1038 | ||
1039 | :doc:`ceph <ceph>`\(8) | |
1040 | :doc:`radosgw <radosgw>`\(8) |