ceph/src/test/cli/radosgw-admin/help.t

   1   $ radosgw-admin --help
   2   usage: radosgw-admin <cmd> [options...]
   3   commands:
   4     user create                create a new user
   5     user modify                modify user
   6     user info                  get user info
   7     user rm                    remove user
   8     user suspend               suspend a user
   9     user enable                re-enable user after suspension
  10     user check                 check user info
  11     user stats                 show user stats as accounted by quota subsystem
  12     user list                  list users
  13     caps add                   add user capabilities
  14     caps rm                    remove user capabilities
  15     subuser create             create a new subuser
  16     subuser modify             modify subuser
  17     subuser rm                 remove subuser
  18     key create                 create access key
  19     key rm                     remove access key
  20     bucket list                list buckets
  21     bucket limit check         show bucket sharding stats
  22     bucket link                link bucket to specified user
  23     bucket unlink              unlink bucket from specified user
  24     bucket stats               returns bucket statistics
  25     bucket rm                  remove bucket
  26     bucket check               check bucket index
  27     bucket reshard             reshard bucket
  28     bucket sync disable        disable bucket sync
  29     bucket sync enable         enable bucket sync
  30     bi get                     retrieve bucket index object entries
  31     bi put                     store bucket index object entries
  32     bi list                    list raw bucket index entries
  33     object rm                  remove object
  34     object stat                stat an object for its metadata
  35     object unlink              unlink object from bucket index
  36     objects expire             run expired objects cleanup
  37     period delete              delete a period
  38     period get                 get period info
  39     period get-current         get current period info
  40     period pull                pull a period
  41     period push                push a period
  42     period list                list all periods
  43     period update              update the staging period
  44     period commit              commit the staging period
  45     quota set                  set quota params
  46     quota enable               enable quota
  47     quota disable              disable quota
  48     global quota get           view global quota params
  49     global quota set           set global quota params
  50     global quota enable        enable a global quota
  51     global quota disable       disable a global quota
  52     realm create               create a new realm
  53     realm delete               delete a realm
  54     realm get                  show realm info
  55     realm get-default          get default realm name
  56     realm list                 list realms
  57     realm list-periods         list all realm periods
  58     realm remove               remove a zonegroup from the realm
  59     realm rename               rename a realm
  60     realm set                  set realm info (requires infile)
  61     realm default              set realm as default
  62     realm pull                 pull a realm and its current period
  63     zonegroup add              add a zone to a zonegroup
  64     zonegroup create           create a new zone group info
  65     zonegroup default          set default zone group
  66     zonegroup delete           delete a zone group info
  67     zonegroup get              show zone group info
  68     zonegroup modify           modify an existing zonegroup
  69     zonegroup set              set zone group info (requires infile)
  70     zonegroup remove           remove a zone from a zonegroup
  71     zonegroup rename           rename a zone group
  72     zonegroup list             list all zone groups set on this cluster
  73     zonegroup placement list   list zonegroup's placement targets
  74     zonegroup placement add    add a placement target id to a zonegroup
  75     zonegroup placement modify modify a placement target of a specific zonegroup
  76     zonegroup placement rm     remove a placement target from a zonegroup
  77     zonegroup placement default  set a zonegroup's default placement target
  78     zone create                create a new zone
  79     zone delete                delete a zone
  80     zone get                   show zone cluster params
  81     zone modify                modify an existing zone
  82     zone set                   set zone cluster params (requires infile)
  83     zone list                  list all zones set on this cluster
  84     zone rename                rename a zone
  85     zone placement list        list zone's placement targets
  86     zone placement add         add a zone placement target
  87     zone placement modify      modify a zone placement target
  88     zone placement rm          remove a zone placement target
  89     pool add                   add an existing pool for data placement
  90     pool rm                    remove an existing pool from data placement set
  91     pools list                 list placement active set
  92     policy                     read bucket/object policy
  93     log list                   list log objects
  94     log show                   dump a log from specific object or (bucket + date
  95                                + bucket-id)
  96                                (NOTE: required to specify formatting of date
  97                                to "YYYY-MM-DD-hh")
  98     log rm                     remove log object
  99     usage show                 show usage (by user, date range)
 100     usage trim                 trim usage (by user, date range)
 101     gc list                    dump expired garbage collection objects (specify
 102                                --include-all to list all entries, including unexpired)
 103     gc process                 manually process garbage
 104     lc list                    list all bucket lifecycle progress
 105     lc process                 manually process lifecycle
 106     metadata get               get metadata info
 107     metadata put               put metadata info
 108     metadata rm                remove metadata info
 109     metadata list              list metadata info
 110     mdlog list                 list metadata log
 111     mdlog trim                 trim metadata log (use start-date, end-date or
 112                                start-marker, end-marker)
 113     mdlog status               read metadata log status
 114     bilog list                 list bucket index log
 115     bilog trim                 trim bucket index log (use start-marker, end-marker)
 116     datalog list               list data log
 117     datalog trim               trim data log
 118     datalog status             read data log status
 119     opstate list               list stateful operations entries (use client_id,
 120                                op_id, object)
 121     opstate set                set state on an entry (use client_id, op_id, object, state)
 122     opstate renew              renew state on an entry (use client_id, op_id, object)
 123     opstate rm                 remove entry (use client_id, op_id, object)
 124     replicalog get             get replica metadata log entry
 125     replicalog update          update replica metadata log entry
 126     replicalog delete          delete replica metadata log entry
 127     orphans find               init and run search for leaked rados objects (use job-id, pool)
 128     orphans finish             clean up search for leaked rados objects
 129     orphans list-jobs          list the current job-ids for orphans search
 130     role create                create a AWS role for use with STS
 131     role delete                delete a role
 132     role get                   get a role
 133     role list                  list roles with specified path prefix
 134     role modify                modify the assume role policy of an existing role
 135     role-policy put            add/update permission policy to role
 136     role-policy list           list policies attached to a role
 137     role-policy get            get the specified inline policy document embedded with the given role
 138     role-policy delete         delete policy attached to a role
 139     reshard add                schedule a resharding of a bucket
 140     reshard list               list all bucket resharding or scheduled to be reshared
 141     reshard process            process of scheduled reshard jobs
 142     reshard cancel             cancel resharding a bucket
 143     reshard stale-instances list list stale-instances from bucket resharding
 144     reshard stale-instances rm   cleanup stale-instances from bucket resharding
 145     sync error list            list sync error
 146     sync error trim            trim sync error
 147   options:
 148      --tenant=<tenant>         tenant name
 149      --uid=<id>                user id
 150      --subuser=<name>          subuser name
 151      --access-key=<key>        S3 access key
 152      --email=<email>
 153      --secret/--secret-key=<key>
 154                                specify secret key
 155      --gen-access-key          generate random access key (for S3)
 156      --gen-secret              generate random secret key
 157      --key-type=<type>         key type, options are: swift, s3
 158      --temp-url-key[-2]=<key>  temp url key
 159      --access=<access>         Set access permissions for sub-user, should be one
 160                                of read, write, readwrite, full
 161      --display-name=<name>
 162      --max-buckets             max number of buckets for a user
 163      --admin                   set the admin flag on the user
 164      --system                  set the system flag on the user
 165      --bucket=<bucket>         Specify the bucket name. Also used by the quota command.
 166      --pool=<pool>             Specify the pool name. Also used to scan for leaked rados objects.
 167      --object=<object>         object name
 168      --date=<date>             date in the format yyyy-mm-dd
 169      --start-date=<date>       start date in the format yyyy-mm-dd
 170      --end-date=<date>         end date in the format yyyy-mm-dd
 171      --bucket-id=<bucket-id>   bucket id
 172      --shard-id=<shard-id>     optional for:
 173                                  mdlog list
 174                                  data sync status
 175                                required for:
 176                                  mdlog trim
 177                                  replica mdlog get/delete
 178                                  replica datalog get/delete
 179      --max-entries=<entries>   max entries for listing operations
 180      --metadata-key=<key>      key to retrieve metadata from with metadata get
 181      --remote=<remote>         zone or zonegroup id of remote gateway
 182      --period=<id>             period id
 183      --epoch=<number>          period epoch
 184      --commit                  commit the period during 'period update'
 185      --staging                 get staging period info
 186      --master                  set as master
 187      --master-url              master url
 188      --master-zonegroup=<id>   master zonegroup id
 189      --master-zone=<id>        master zone id
 190      --rgw-realm=<name>        realm name
 191      --realm-id=<id>           realm id
 192      --realm-new-name=<name>   realm new name
 193      --rgw-zonegroup=<name>    zonegroup name
 194      --zonegroup-id=<id>       zonegroup id
 195      --zonegroup-new-name=<name>
 196                                zonegroup new name
 197      --rgw-zone=<name>         name of zone in which radosgw is running
 198      --zone-id=<id>            zone id
 199      --zone-new-name=<name>    zone new name
 200      --source-zone             specify the source zone (for data sync)
 201      --default                 set entity (realm, zonegroup, zone) as default
 202      --read-only               set zone as read-only (when adding to zonegroup)
 203      --placement-id            placement id for zonegroup placement commands
 204      --tags=<list>             list of tags for zonegroup placement add and modify commands
 205      --tags-add=<list>         list of tags to add for zonegroup placement modify command
 206      --tags-rm=<list>          list of tags to remove for zonegroup placement modify command
 207      --endpoints=<list>        zone endpoints
 208      --index-pool=<pool>       placement target index pool
 209      --data-pool=<pool>        placement target data pool
 210      --data-extra-pool=<pool>  placement target data extra (non-ec) pool
 211      --placement-index-type=<type>
 212                                placement target index type (normal, indexless, or #id)
 213      --compression=<type>      placement target compression type (plugin name or empty/none)
 214      --tier-type=<type>        zone tier type
 215      --tier-config=<k>=<v>[,...]
 216                                set zone tier config keys, values
 217      --tier-config-rm=<k>[,...]
 218                                unset zone tier config keys
 219      --sync-from-all[=false]   set/reset whether zone syncs from all zonegroup peers
 220      --sync-from=[zone-name][,...]
 221                                set list of zones to sync from
 222      --sync-from-rm=[zone-name][,...]
 223                                remove zones from list of zones to sync from
 224      --fix                     besides checking bucket index, will also fix it
 225      --check-objects           bucket check: rebuilds bucket index according to
 226                                actual objects state
 227      --format=<format>         specify output format for certain operations: xml,
 228                                json
 229      --purge-data              when specified, user removal will also purge all the
 230                                user data
 231      --purge-keys              when specified, subuser removal will also purge all the
 232                                subuser keys
 233      --purge-objects           remove a bucket's objects before deleting it
 234                                (NOTE: required to delete a non-empty bucket)
 235      --sync-stats              option to 'user stats', update user stats with current
 236                                stats reported by user's buckets indexes
 237      --reset-stats             option to 'user stats', reset stats in accordance with user buckets
 238      --show-log-entries=<flag> enable/disable dump of log entries on log show
 239      --show-log-sum=<flag>     enable/disable dump of log summation on log show
 240      --skip-zero-entries       log show only dumps entries that don't have zero value
 241                                in one of the numeric field
 242      --infile=<file>           specify a file to read in when setting data
 243      --state=<state string>    specify a state for the opstate set command
 244      --replica-log-type        replica log type (metadata, data, bucket), required for
 245                                replica log operations
 246      --categories=<list>       comma separated list of categories, used in usage show
 247      --caps=<caps>             list of caps (e.g., "usage=read, write; user=read")
 248      --yes-i-really-mean-it    required for certain operations
 249      --warnings-only           when specified with bucket limit check, list
 250                                only buckets nearing or over the current max
 251                                objects per shard value
 252      --bypass-gc               when specified with bucket deletion, triggers
 253                                object deletions by not involving GC
 254      --inconsistent-index      when specified with bucket deletion and bypass-gc set to true,
 255                                ignores bucket index consistency
 256
 257   <date> := "YYYY-MM-DD[ hh:mm:ss]"
 258
 259   Quota options:
 260      --bucket                  specified bucket for quota command
 261      --max-objects             specify max objects (negative value to disable)
 262      --max-size                specify max size (in B/K/M/G/T, negative value to disable)
 263      --quota-scope             scope of quota (bucket, user)
 264
 265   Orphans search options:
 266      --pool                    data pool to scan for leaked rados objects in
 267      --num-shards              num of shards to use for keeping the temporary scan info
 268      --orphan-stale-secs       num of seconds to wait before declaring an object to be an orphan (default: 86400)
 269      --job-id                  set the job id (for orphans find)
 270      --max-concurrent-ios      maximum concurrent ios for orphans find (default: 32)
 271
 272   Orphans list-jobs options:
 273      --extra-info              provide extra info in job list
 274
 275   Role options:
 276      --role-name               name of the role to create
 277      --path                    path to the role
 278      --assume-role-policy-doc  the trust relationship policy document that grants an entity permission to assume the role
 279      --policy-name             name of the policy document
 280      --policy-doc              permission policy document
 281      --path-prefix             path prefix for filtering roles
 282
 283     --conf/-c FILE    read configuration from the given configuration file
 284     --id ID           set ID portion of my name
 285     --name/-n TYPE.ID set name
 286     --cluster NAME    set cluster name (default: ceph)
 287     --setuser USER    set uid to user or uid (and gid to user's gid)
 288     --setgroup GROUP  set gid to group or gid
 289     --version         show version and quit
 290
 291   [1]
 292
 293