ceph/doc/man/8/radosgw-admin.rst

   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 Ceph Object Gateway user administration utility. It
  19 is used to create and modify users.
  20
  21
  22 Commands
  23 ========
  24
  25 :program:`radosgw-admin` utility provides commands for administration purposes
  26 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 for a user including any subusers and keys.
  36
  37 :command:`user rename`
  38   Renames a user.
  39
  40 :command:`user rm`
  41   Remove a user.
  42
  43 :command:`user suspend`
  44   Suspend a user.
  45
  46 :command:`user enable`
  47   Re-enable user after suspension.
  48
  49 :command:`user check`
  50   Check user info.
  51
  52 :command:`user stats`
  53   Show user stats as accounted by the quota subsystem.
  54
  55 :command:`user list`
  56   List all users.
  57
  58 :command:`caps add`
  59   Add user capabilities.
  60
  61 :command:`caps rm`
  62   Remove user capabilities.
  63
  64 :command:`subuser create`
  65   Create a new subuser (primarily useful for clients using the Swift API).
  66
  67 :command:`subuser modify`
  68   Modify a subuser.
  69
  70 :command:`subuser rm`
  71   Remove a subuser.
  72
  73 :command:`key create`
  74   Create access key.
  75
  76 :command:`key rm`
  77   Remove access key.
  78
  79 :command:`bucket list`
  80   List buckets, or, if a bucket is specified with --bucket=<bucket>,
  81   list its objects. Adding --allow-unordered
  82   removes the ordering requirement, possibly generating results more
  83   quickly for buckets with large number of objects.
  84
  85 :command:`bucket limit check`
  86   Show bucket sharding stats.
  87
  88 :command:`bucket link`
  89   Link bucket to specified user.
  90
  91 :command:`bucket unlink`
  92   Unlink bucket from specified user.
  93
  94 :command:`bucket chown`
  95   Change bucket ownership to the specified user and update object ACLs.
  96   Invoke with --marker to resume if the command is interrupted.
  97
  98 :command:`bucket stats`
  99   Returns bucket statistics.
 100
 101 :command:`bucket rm`
 102   Remove a bucket.
 103
 104 :command:`bucket check`
 105   Check bucket index.
 106
 107 :command:`bucket rewrite`
 108   Rewrite all objects in the specified bucket.
 109
 110 :command:`bucket radoslist`
 111   List the RADOS objects that contain the data for all objects in
 112   the designated bucket, if --bucket=<bucket> is specified.
 113   Otherwise, list the RADOS objects that contain data for all
 114   buckets.
 115
 116 :command:`bucket reshard`
 117   Reshard a bucket's index.
 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
 137 :command:`object rm`
 138   Remove an object.
 139
 140 :command:`object stat`
 141   Stat an object for its metadata.
 142
 143 :command:`object unlink`
 144   Unlink object from bucket index.
 145
 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
 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
 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.
 202
 203 :command:`realm get`
 204   Show the realm info.
 205
 206 :command:`realm get-default`
 207   Get the default realm name.
 208
 209 :command:`realm list`
 210   List all realms.
 211
 212 :command:`realm list-periods`
 213   List all realm periods.
 214
 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.
 277
 278 :command:`zone get`
 279   Show zone cluster params.
 280
 281 :command:`zone set`
 282   Set zone cluster params (requires infile).
 283
 284 :command:`zone modify`
 285   Modify an existing zone.
 286
 287 :command:`zone list`
 288   List all zones set on this cluster.
 289
 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
 308 :command:`sync error list`
 309   List sync errors.
 310
 311 :command:`sync error trim`
 312   Trim sync errors.
 313
 314 :command:`zone rename`
 315   Rename a zone.
 316
 317 :command:`zone placement list`
 318   List a 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
 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
 364 :command:`lc list`
 365   List all bucket lifecycle progress.
 366
 367 :command:`lc process`
 368   Manually process lifecycle transitions.  If a bucket is specified (e.g., via
 369   --bucket_id or via --bucket and optional --tenant), only that bucket
 370   is processed.
 371
 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`
 385   List metadata log which is needed for multi-site deployments.
 386
 387 :command:`mdlog trim`
 388   Trim metadata log manually instead of relying on the gateway's integrated log sync.
 389   Before trimming, compare the listings and make sure the last sync was
 390   complete, otherwise it can reinitiate a sync.
 391
 392 :command:`mdlog status`
 393   Read metadata log status.
 394
 395 :command:`bilog list`
 396   List bucket index log which is needed for multi-site deployments.
 397
 398 :command:`bilog trim`
 399   Trim bucket index log (use start-marker, end-marker) manually instead
 400   of relying on the gateway's integrated log sync.
 401   Before trimming, compare the listings and make sure the last sync was
 402   complete, otherwise it can reinitiate a sync.
 403
 404 :command:`datalog list`
 405   List data log which is needed for multi-site deployments.
 406
 407 :command:`datalog trim`
 408   Trim data log manually instead of relying on the gateway's integrated log sync.
 409   Before trimming, compare the listings and make sure the last sync was
 410   complete, otherwise it can reinitiate a sync.
 411
 412 :command:`datalog status`
 413   Read data log status.
 414
 415 :command:`orphans find`
 416   Init and run search for leaked RADOS objects.
 417   DEPRECATED. See the "rgw-orphan-list" tool.
 418
 419 :command:`orphans finish`
 420   Clean up search for leaked RADOS objects.
 421   DEPRECATED. See the "rgw-orphan-list" tool.
 422
 423 :command:`orphans list-jobs`
 424   List the current orphans search job IDs.
 425   DEPRECATED. See the "rgw-orphan-list" tool.
 426
 427 :command:`role create`
 428   Create a new role for use with STS (Security Token Service).
 429
 430 :command:`role rm`
 431   Remove a role.
 432
 433 :command:`role get`
 434   Get a role.
 435
 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
 462
 463 :command:`reshard status`
 464   Resharding status of a bucket
 465
 466 :command:`reshard cancel`
 467   Cancel resharding a bucket
 468
 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   Acknowledge (remove) events in a pubsub subscription
 489
 490
 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 selecting one
 503    from ceph.conf).
 504
 505 .. option:: --tenant=<tenant>
 506
 507    Name of the tenant.
 508
 509 .. option:: --uid=uid
 510
 511    The user on which to operate.
 512
 513 .. option:: --new-uid=uid
 514
 515    The new ID of the user. Used with 'user rename' command.
 516
 517 .. option:: --subuser=<name>
 518
 519     Name of the subuser.
 520
 521 .. option:: --access-key=<key>
 522
 523    S3 access key.
 524
 525 .. option:: --email=email
 526
 527    The e-mail address of the user.
 528
 529 .. option:: --secret/--secret-key=<key>
 530
 531    The secret key.
 532
 533 .. option:: --gen-access-key
 534
 535     Generate random access key (for S3).
 536
 537
 538 .. option:: --gen-secret
 539
 540     Generate random secret key.
 541
 542 .. option:: --key-type=<type>
 543
 544     Key type, options are: swift, s3.
 545
 546 .. option:: --temp-url-key[-2]=<key>
 547
 548     Temporary URL key.
 549
 550 .. option:: --max-buckets
 551
 552     Maximum number of buckets for a user (0 for no limit, negative value to disable bucket creation).
 553     Default is 1000.
 554
 555 .. option:: --access=<access>
 556
 557    Set the access permissions for the subuser.
 558    Available access permissions are read, write, readwrite and full.
 559
 560 .. option:: --display-name=<name>
 561
 562    The display name of the user.
 563
 564 .. option:: --admin
 565
 566    Set the admin flag on the user.
 567
 568 .. option:: --system
 569
 570    Set the system flag on the user.
 571
 572 .. option:: --bucket=[tenant-id/]bucket
 573
 574    Specify the bucket name.  If tenant-id is not specified, the tenant-id
 575    of the user (--uid) is used.
 576
 577 .. option:: --pool=<pool>
 578
 579    Specify the pool name.
 580    Also used with `orphans find` as data pool to scan for leaked rados objects.
 581
 582 .. option:: --object=object
 583
 584    Specify the object name.
 585
 586 .. option:: --date=yyyy-mm-dd
 587
 588    The date in the format yyyy-mm-dd.
 589
 590 .. option:: --start-date=yyyy-mm-dd
 591
 592    The start date in the format yyyy-mm-dd.
 593
 594 .. option:: --end-date=yyyy-mm-dd
 595
 596    The end date in the format yyyy-mm-dd.
 597
 598 .. option:: --bucket-id=<bucket-id>
 599
 600    Specify the bucket id.
 601
 602 .. option:: --bucket-new-name=[tenant-id/]<bucket>
 603
 604    Optional for `bucket link`; use to rename a bucket.
 605    While the tenant-id can be specified, this is not
 606    necessary in normal operation.
 607
 608 .. option:: --shard-id=<shard-id>
 609
 610    Optional for mdlog list, bi list, data sync status. Required for ``mdlog trim``.
 611
 612 .. option:: --max-entries=<entries>
 613
 614    Optional for listing operations to specify the max entries.
 615
 616 .. option:: --purge-data
 617
 618    When specified, user removal will also purge the user's data.
 619
 620 .. option:: --purge-keys
 621
 622    When specified, subuser removal will also purge the subuser' keys.
 623
 624 .. option:: --purge-objects
 625
 626    When specified, the bucket removal will also purge all objects in it.
 627
 628 .. option:: --metadata-key=<key>
 629
 630    Key from which to retrieve metadata, used with ``metadata get``.
 631
 632 .. option:: --remote=<remote>
 633
 634    Zone or zonegroup id of remote gateway.
 635
 636 .. option:: --period=<id>
 637
 638    Period ID.
 639
 640 .. option:: --url=<url>
 641
 642    URL for pushing/pulling period or realm.
 643
 644 .. option:: --epoch=<number>
 645
 646    Period epoch.
 647
 648 .. option:: --commit
 649
 650    Commit the period during 'period update'.
 651
 652 .. option:: --staging
 653
 654    Get the staging period info.
 655
 656 .. option:: --master
 657
 658    Set as master.
 659
 660 .. option:: --master-zone=<id>
 661
 662    Master zone ID.
 663
 664 .. option:: --rgw-realm=<name>
 665
 666    The realm name.
 667
 668 .. option:: --realm-id=<id>
 669
 670    The realm ID.
 671
 672 .. option:: --realm-new-name=<name>
 673
 674    New name for the realm.
 675
 676 .. option:: --rgw-zonegroup=<name>
 677
 678    The zonegroup name.
 679
 680 .. option:: --zonegroup-id=<id>
 681
 682    The zonegroup ID.
 683
 684 .. option:: --zonegroup-new-name=<name>
 685
 686    The new name of the zonegroup.
 687
 688 .. option:: --rgw-zone=<zone>
 689
 690    Zone in which the gateway is running.
 691
 692 .. option:: --zone-id=<id>
 693
 694    The zone ID.
 695
 696 .. option:: --zone-new-name=<name>
 697
 698    The new name of the zone.
 699
 700 .. option:: --source-zone
 701
 702    The source zone for data sync.
 703
 704 .. option:: --default
 705
 706    Set the entity (realm, zonegroup, zone) as default.
 707
 708 .. option:: --read-only
 709
 710    Set the zone as read-only when adding to the zonegroup.
 711
 712 .. option:: --placement-id
 713
 714    Placement ID for the zonegroup placement commands.
 715
 716 .. option:: --tags=<list>
 717
 718    The list of tags for zonegroup placement add and modify commands.
 719
 720 .. option:: --tags-add=<list>
 721
 722    The list of tags to add for zonegroup placement modify command.
 723
 724 .. option:: --tags-rm=<list>
 725
 726    The list of tags to remove for zonegroup placement modify command.
 727
 728 .. option:: --endpoints=<list>
 729
 730    The zone endpoints.
 731
 732 .. option:: --index-pool=<pool>
 733
 734    The placement target index pool.
 735
 736 .. option:: --data-pool=<pool>
 737
 738    The placement target data pool.
 739
 740 .. option:: --data-extra-pool=<pool>
 741
 742    The placement target data extra (non-EC) pool.
 743
 744 .. option:: --placement-index-type=<type>
 745
 746    The placement target index type (normal, indexless, or #id).
 747
 748 .. option:: --placement-inline-data=<true>
 749
 750    Whether the placement target is configured to store a data chunk inline in head objects.
 751
 752 .. option:: --tier-type=<type>
 753
 754    The zone tier type.
 755
 756 .. option:: --tier-config=<k>=<v>[,...]
 757
 758    Set zone tier config keys, values.
 759
 760 .. option:: --tier-config-rm=<k>[,...]
 761
 762    Unset zone tier config keys.
 763
 764 .. option:: --sync-from-all[=false]
 765
 766    Set/reset whether zone syncs from all zonegroup peers.
 767
 768 .. option:: --sync-from=[zone-name][,...]
 769
 770    Set the list of zones from which to sync.
 771
 772 .. option:: --sync-from-rm=[zone-name][,...]
 773
 774    Remove zone(s) from list of zones from which to sync.
 775
 776 .. option:: --bucket-index-max-shards
 777
 778    Override a zone's or zonegroup's default number of bucket index shards. This
 779    option is accepted by the 'zone create', 'zone modify', 'zonegroup add',
 780    and 'zonegroup modify' commands, and applies to buckets that are created
 781    after the zone/zonegroup changes take effect.
 782
 783 .. option:: --fix
 784
 785     Fix the bucket index in addition to checking it.
 786
 787 .. option:: --check-objects
 788
 789     Bucket check: Rebuilds the bucket index according to actual object state.
 790
 791 .. option:: --format=<format>
 792
 793     Specify output format for certain operations. Supported formats: xml, json.
 794
 795 .. option:: --sync-stats
 796
 797     Option for the 'user stats' command. When specified, it will update user stats with
 798     the current stats reported by the user's buckets indexes.
 799
 800 .. option:: --show-config
 801
 802     Show configuration.
 803
 804 .. option:: --show-log-entries=<flag>
 805
 806     Enable/disable dumping of log entries on log show.
 807
 808 .. option:: --show-log-sum=<flag>
 809
 810     Enable/disable dump of log summation on log show.
 811
 812 .. option:: --skip-zero-entries
 813
 814     Log show only dumps entries that don't have zero value in one of the numeric
 815     field.
 816
 817 .. option:: --infile
 818
 819     Specify a file to read when setting data.
 820
 821 .. option:: --categories=<list>
 822
 823     Comma separated list of categories, used in usage show.
 824
 825 .. option:: --caps=<caps>
 826
 827     List of capabilities (e.g., "usage=read, write; user=read").
 828
 829 .. option:: --compression=<compression-algorithm>
 830
 831     Placement target compression algorithm (lz4|snappy|zlib|zstd).
 832
 833 .. option:: --yes-i-really-mean-it
 834
 835     Required as a guardrail for certain destructive operations.
 836
 837 .. option:: --min-rewrite-size
 838
 839     Specify the minimum object size for bucket rewrite (default 4M).
 840
 841 .. option:: --max-rewrite-size
 842
 843     Specify the maximum object size for bucket rewrite (default ULLONG_MAX).
 844
 845 .. option:: --min-rewrite-stripe-size
 846
 847     Specify the minimum stripe size for object rewrite (default 0). If the value
 848     is set to 0, then the specified object will always be
 849     rewritten when restriping.
 850
 851 .. option:: --warnings-only
 852
 853    When specified with bucket limit check,
 854    list only buckets nearing or over the current max objects per shard value.
 855
 856 .. option:: --bypass-gc
 857
 858    When specified with bucket deletion,
 859    triggers object deletion without involving GC.
 860
 861 .. option:: --inconsistent-index
 862
 863    When specified with bucket deletion and bypass-gc set to true,
 864    ignores bucket index consistency.
 865
 866 .. option:: --max-concurrent-ios
 867
 868    Maximum concurrent bucket operations. Affects operations that
 869    scan the bucket index, e.g., listing, deletion, and all scan/search
 870    operations such as finding orphans or checking the bucket index.
 871    The default is 32.
 872
 873 Quota Options
 874 =============
 875
 876 .. option:: --max-objects
 877
 878    Specify the maximum number of objects (negative value to disable).
 879
 880 .. option:: --max-size
 881
 882     Specify the maximum object size (in B/K/M/G/T, negative value to disable).
 883
 884 .. option:: --quota-scope
 885
 886     The scope of quota (bucket, user).
 887
 888
 889 Orphans Search Options
 890 ======================
 891
 892 .. option:: --num-shards
 893
 894     Number of shards to use for temporary scan info
 895
 896 .. option:: --orphan-stale-secs
 897
 898    Number of seconds to wait before declaring an object to be an orphan.
 899    The efault is 86400 (24 hours).
 900
 901 .. option:: --job-id
 902
 903    Set the job id (for orphans find)
 904
 905
 906 Orphans list-jobs options
 907 =========================
 908
 909 .. option:: --extra-info
 910
 911    Provide extra info in the job list.
 912
 913
 914 Role Options
 915 ============
 916
 917 .. option:: --role-name
 918
 919    The name of the role to create.
 920
 921 .. option:: --path
 922
 923    The path to the role.
 924
 925 .. option:: --assume-role-policy-doc
 926
 927    The trust relationship policy document that grants an entity permission to
 928    assume the role.
 929
 930 .. option:: --policy-name
 931
 932    The name of the policy document.
 933
 934 .. option:: --policy-doc
 935
 936    The permission policy document.
 937
 938 .. option:: --path-prefix
 939
 940    The path prefix for filtering the roles.
 941
 942
 943 Bucket Notifications/PubSub Options
 944 ===================================
 945 .. option:: --topic
 946
 947    The bucket notifications/pubsub topic name.
 948
 949 .. option:: --subscription
 950
 951    The pubsub subscription name.
 952
 953 .. option:: --event-id
 954
 955    The event id in a pubsub subscription.
 956
 957
 958 Examples
 959 ========
 960
 961 Generate a new user::
 962
 963         $ radosgw-admin user create --display-name="johnny rotten" --uid=johnny
 964         { "user_id": "johnny",
 965           "rados_uid": 0,
 966           "display_name": "johnny rotten",
 967           "email": "",
 968           "suspended": 0,
 969           "subusers": [],
 970           "keys": [
 971                 { "user": "johnny",
 972                   "access_key": "TCICW53D9BQ2VGC46I44",
 973                   "secret_key": "tfm9aHMI8X76L3UdgE+ZQaJag1vJQmE6HDb5Lbrz"}],
 974           "swift_keys": []}
 975
 976 Remove a user::
 977
 978         $ radosgw-admin user rm --uid=johnny
 979
 980 Rename a user::
 981
 982         $ radosgw-admin user rename --uid=johnny --new-uid=joe
 983
 984 Remove a user and all associated buckets with their contents::
 985
 986         $ radosgw-admin user rm --uid=johnny --purge-data
 987
 988 Remove a bucket::
 989
 990         $ radosgw-admin bucket rm --bucket=foo
 991
 992 Link bucket to specified user::
 993
 994         $ radosgw-admin bucket link --bucket=foo --bucket_id=<bucket id> --uid=johnny
 995
 996 Unlink bucket from specified user::
 997
 998         $ radosgw-admin bucket unlink --bucket=foo --uid=johnny
 999
1000 Rename a bucket::
1001
1002         $ radosgw-admin bucket link --bucket=foo --bucket-new-name=bar --uid=johnny
1003
1004 Move a bucket from the old global tenant space to a specified tenant::
1005
1006         $ radosgw-admin bucket link --bucket=foo --uid='12345678$12345678'
1007
1008 Link bucket to specified user and change object ACLs::
1009
1010         $ radosgw-admin bucket chown --bucket=foo --uid='12345678$12345678'
1011
1012 Show the logs of a bucket from April 1st, 2012::
1013
1014         $ radosgw-admin log show --bucket=foo --date=2012-04-01-01 --bucket-id=default.14193.1
1015
1016 Show usage information for user from March 1st to (but not including) April 1st, 2012::
1017
1018         $ radosgw-admin usage show --uid=johnny \
1019                         --start-date=2012-03-01 --end-date=2012-04-01
1020
1021 Show only summary of usage information for all users::
1022
1023         $ radosgw-admin usage show --show-log-entries=false
1024
1025 Trim usage information for user until March 1st, 2012::
1026
1027         $ radosgw-admin usage trim --uid=johnny --end-date=2012-04-01
1028
1029
1030 Availability
1031 ============
1032
1033 :program:`radosgw-admin` is part of Ceph, a massively scalable, open-source,
1034 distributed storage system.  Please refer to the Ceph documentation at
1035 https://docs.ceph.com for more information.
1036
1037
1038 See also
1039 ========
1040
1041 :doc:`ceph <ceph>`\(8)
1042 :doc:`radosgw <radosgw>`\(8)