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