2 usage: radosgw-admin <cmd> [options...]
4 user create create a new user
5 user modify modify user
6 user info get user info
7 user rename rename user
9 user suspend suspend a user
10 user enable re-enable user after suspension
11 user check check user info
12 user stats show user stats as accounted by quota subsystem
14 caps add add user capabilities
15 caps rm remove user capabilities
16 subuser create create a new subuser
17 subuser modify modify subuser
18 subuser rm remove subuser
19 key create create access key
20 key rm remove access key
21 bucket list list buckets (specify --allow-unordered for
22 faster, unsorted listing)
23 bucket limit check show bucket sharding stats
24 bucket link link bucket to specified user
25 bucket unlink unlink bucket from specified user
26 bucket stats returns bucket statistics
27 bucket rm remove bucket
28 bucket check check bucket index by verifying size and object count stats
29 bucket check olh check for olh index entries and objects that are pending removal
30 bucket check unlinked check for object versions that are not visible in a bucket listing
31 bucket chown link bucket to specified user and update its object ACLs
32 bucket reshard reshard bucket
33 bucket rewrite rewrite all objects in the specified bucket
34 bucket sync checkpoint poll a bucket's sync status until it catches up to its remote
35 bucket sync disable disable bucket sync
36 bucket sync enable enable bucket sync
37 bucket radoslist list rados objects backing bucket's objects
38 bi get retrieve bucket index object entries
39 bi put store bucket index object entries
40 bi list list raw bucket index entries
41 bi purge purge bucket index entries
42 object rm remove object
44 object stat stat an object for its metadata
45 object unlink unlink object from bucket index
46 object rewrite rewrite the specified object
47 object reindex reindex the object(s) indicated by --bucket and either --object or --objects-file
48 objects expire run expired objects cleanup
49 objects expire-stale list list stale expired objects (caused by reshard)
50 objects expire-stale rm remove stale expired objects
51 period rm remove a period
52 period get get period info
53 period get-current get current period info
54 period pull pull a period
55 period push push a period
56 period list list all periods
57 period update update the staging period
58 period commit commit the staging period
59 quota set set quota params
60 quota enable enable quota
61 quota disable disable quota
62 ratelimit get get ratelimit params
63 ratelimit set set ratelimit params
64 ratelimit enable enable ratelimit
65 ratelimit disable disable ratelimit
66 global quota get view global quota params
67 global quota set set global quota params
68 global quota enable enable a global quota
69 global quota disable disable a global quota
70 global ratelimit get view global ratelimit params
71 global ratelimit set set global ratelimit params
72 global ratelimit enable enable a ratelimit quota
73 global ratelimit disable disable a ratelimit quota
74 realm create create a new realm
75 realm rm remove a realm
76 realm get show realm info
77 realm get-default get default realm name
78 realm list list realms
79 realm list-periods list all realm periods
80 realm rename rename a realm
81 realm set set realm info (requires infile)
82 realm default set realm as default
83 realm pull pull a realm and its current period
84 zonegroup add add a zone to a zonegroup
85 zonegroup create create a new zone group info
86 zonegroup default set default zone group
87 zonegroup delete delete a zone group info
88 zonegroup get show zone group info
89 zonegroup modify modify an existing zonegroup
90 zonegroup set set zone group info (requires infile)
91 zonegroup rm remove a zone from a zonegroup
92 zonegroup rename rename a zone group
93 zonegroup list list all zone groups set on this cluster
94 zonegroup placement list list zonegroup's placement targets
95 zonegroup placement get get a placement target of a specific zonegroup
96 zonegroup placement add add a placement target id to a zonegroup
97 zonegroup placement modify modify a placement target of a specific zonegroup
98 zonegroup placement rm remove a placement target from a zonegroup
99 zonegroup placement default set a zonegroup's default placement target
100 zone create create a new zone
101 zone rm remove a zone
102 zone get show zone cluster params
103 zone modify modify an existing zone
104 zone set set zone cluster params (requires infile)
105 zone list list all zones set on this cluster
106 zone rename rename a zone
107 zone placement list list zone's placement targets
108 zone placement get get a zone placement target
109 zone placement add add a zone placement target
110 zone placement modify modify a zone placement target
111 zone placement rm remove a zone placement target
112 metadata sync status get metadata sync status
113 metadata sync init init metadata sync
114 metadata sync run run metadata sync
115 data sync status get data sync status of the specified source zone
116 data sync init init data sync for the specified source zone
117 data sync run run data sync for the specified source zone
118 pool add add an existing pool for data placement
119 pool rm remove an existing pool from data placement set
120 pools list list placement active set
121 policy read bucket/object policy
122 log list list log objects
123 log show dump a log from specific object or (bucket + date
125 (NOTE: required to specify formatting of date
127 log rm remove log object
128 usage show show usage (by user, by bucket, date range)
129 usage trim trim usage (by user, by bucket, date range)
130 usage clear reset all the usage stats for the cluster
131 gc list dump expired garbage collection objects (specify
132 --include-all to list all entries, including unexpired)
133 gc process manually process garbage (specify
134 --include-all to process all entries, including unexpired)
135 lc list list all bucket lifecycle progress
136 lc get get a lifecycle bucket configuration
137 lc process manually process lifecycle
138 lc reshard fix fix LC for a resharded bucket
139 metadata get get metadata info
140 metadata put put metadata info
141 metadata rm remove metadata info
142 metadata list list metadata info
143 mdlog list list metadata log
144 mdlog autotrim auto trim metadata log
145 mdlog trim trim metadata log (use marker)
146 mdlog status read metadata log status
147 bilog list list bucket index log
148 bilog trim trim bucket index log (use start-marker, end-marker)
149 bilog status read bucket index log status
150 bilog autotrim auto trim bucket index log
151 datalog list list data log
152 datalog trim trim data log
153 datalog status read data log status
154 datalog type change datalog type to --log_type={fifo,omap}
155 orphans find deprecated -- init and run search for leaked rados objects (use job-id, pool)
156 orphans finish deprecated -- clean up search for leaked rados objects
157 orphans list-jobs deprecated -- list the current job-ids for orphans search
158 * the three 'orphans' sub-commands are now deprecated; consider using the `rgw-orphan-list` tool
159 role create create a AWS role for use with STS
160 role delete remove a role
162 role list list roles with specified path prefix
163 role-trust-policy modify modify the assume role policy of an existing role
164 role-policy put add/update permission policy to role
165 role-policy list list policies attached to a role
166 role-policy get get the specified inline policy document embedded with the given role
167 role-policy delete remove policy attached to a role
168 role update update max_session_duration of a role
169 reshard add schedule a resharding of a bucket
170 reshard list list all bucket resharding or scheduled to be resharded
171 reshard status read bucket resharding status
172 reshard process process of scheduled reshard jobs
173 reshard cancel cancel resharding a bucket
174 reshard stale-instances list list stale-instances from bucket resharding
175 reshard stale-instances delete cleanup stale-instances from bucket resharding
176 sync error list list sync error
177 sync error trim trim sync error
178 mfa create create a new MFA TOTP token
179 mfa list list MFA TOTP tokens
180 mfa get show MFA TOTP token
181 mfa remove delete MFA TOTP token
182 mfa check check MFA TOTP token
183 mfa resync re-sync MFA TOTP token
184 topic list list bucket notifications topics
185 topic get get a bucket notifications topic
186 topic rm remove a bucket notifications topic
187 script put upload a lua script to a context
188 script get get the lua script of a context
189 script rm remove the lua scripts of a context
190 script-package add add a lua package to the scripts allowlist
191 script-package rm remove a lua package from the scripts allowlist
192 script-package list get the lua packages allowlist
193 notification list list bucket notifications configuration
194 notification get get a bucket notifications configuration
195 notification rm remove a bucket notifications configuration
197 --tenant=<tenant> tenant name
198 --user_ns=<namespace> namespace of user (oidc in case of users authenticated with oidc provider)
200 --new-uid=<id> new user id
201 --subuser=<name> subuser name
202 --access-key=<key> S3 access key
203 --email=<email> user's email address
204 --secret/--secret-key=<key>
206 --gen-access-key generate random access key (for S3)
207 --gen-secret generate random secret key
208 --key-type=<type> key type, options are: swift, s3
209 --temp-url-key[-2]=<key> temp url key
210 --access=<access> Set access permissions for sub-user, should be one
211 of read, write, readwrite, full
212 --display-name=<name> user's display name
213 --max-buckets max number of buckets for a user
214 --admin set the admin flag on the user
215 --system set the system flag on the user
216 --op-mask set the op mask on the user
217 --bucket=<bucket> Specify the bucket name. Also used by the quota command.
218 --pool=<pool> Specify the pool name. Also used to scan for leaked rados objects.
219 --object=<object> object name
220 --objects-file=<file> file containing a list of object names to process
221 --object-version=<version> object version
222 --date=<date> date in the format yyyy-mm-dd
223 --start-date=<date> start date in the format yyyy-mm-dd
224 --end-date=<date> end date in the format yyyy-mm-dd
225 --bucket-id=<bucket-id> bucket id
226 --bucket-new-name=<bucket>
227 for bucket link: optional new name
228 --shard-id=<shard-id> optional for:
233 --gen=<gen-id> optional for:
237 --max-entries=<entries> max entries for listing operations
238 --metadata-key=<key> key to retrieve metadata from with metadata get
239 --remote=<remote> zone or zonegroup id of remote gateway
240 --period=<id> period id
241 --url=<url> url for pushing/pulling period/realm
242 --epoch=<number> period epoch
243 --commit commit the period during 'period update'
244 --staging get staging period info
245 --master set as master
246 --master-zone=<id> master zone id
247 --rgw-realm=<name> realm name
248 --realm-id=<id> realm id
249 --realm-new-name=<name> realm new name
250 --rgw-zonegroup=<name> zonegroup name
251 --zonegroup-id=<id> zonegroup id
252 --zonegroup-new-name=<name>
254 --rgw-zone=<name> name of zone in which radosgw is running
255 --zone-id=<id> zone id
256 --zone-new-name=<name> zone new name
257 --source-zone specify the source zone (for data sync)
258 --default set entity (realm, zonegroup, zone) as default
259 --read-only set zone as read-only (when adding to zonegroup)
260 --redirect-zone specify zone id to redirect when response is 404 (not found)
261 --placement-id placement id for zonegroup placement commands
262 --storage-class storage class for zonegroup placement commands
263 --tags=<list> list of tags for zonegroup placement add and modify commands
264 --tags-add=<list> list of tags to add for zonegroup placement modify command
265 --tags-rm=<list> list of tags to remove for zonegroup placement modify command
266 --endpoints=<list> zone endpoints
267 --index-pool=<pool> placement target index pool
268 --data-pool=<pool> placement target data pool
269 --data-extra-pool=<pool> placement target data extra (non-ec) pool
270 --placement-index-type=<type>
271 placement target index type (normal, indexless, or #id)
272 --placement-inline-data=<true>
273 set whether the placement target is configured to store a data
274 chunk inline in head objects
275 --compression=<type> placement target compression type (plugin name or empty/none)
276 --tier-type=<type> zone tier type
277 --tier-config=<k>=<v>[,...]
278 set zone tier config keys, values
279 --tier-config-rm=<k>[,...]
280 unset zone tier config keys
281 --sync-from-all[=false] set/reset whether zone syncs from all zonegroup peers
282 --sync-from=[zone-name][,...]
283 set list of zones to sync from
284 --sync-from-rm=[zone-name][,...]
285 remove zones from list of zones to sync from
286 --bucket-index-max-shards override a zone/zonegroup's default bucket index shard count
287 --fix besides checking bucket index, will also fix it
288 --check-objects bucket check: rebuilds bucket index according to
290 --format=<format> specify output format for certain operations: xml,
292 --purge-data when specified, user removal will also purge all the
294 --purge-keys when specified, subuser removal will also purge all the
296 --purge-objects remove a bucket's objects before deleting it
297 (NOTE: required to delete a non-empty bucket)
298 --sync-stats option to 'user stats', update user stats with current
299 stats reported by user's buckets indexes
300 --reset-stats option to 'user stats', reset stats in accordance with user buckets
301 --show-config show configuration
302 --show-log-entries=<flag> enable/disable dump of log entries on log show
303 --show-log-sum=<flag> enable/disable dump of log summation on log show
304 --skip-zero-entries log show only dumps entries that don't have zero value
305 in one of the numeric field
306 --infile=<file> file to read in when setting data
307 --categories=<list> comma separated list of categories, used in usage show
308 --caps=<caps> list of caps (e.g., "usage=read, write; user=read")
309 --op-mask=<op-mask> permission of user's operations (e.g., "read, write, delete, *")
310 --yes-i-really-mean-it required for certain operations
311 --warnings-only when specified with bucket limit check, list
312 only buckets nearing or over the current max
313 objects per shard value
314 --bypass-gc when specified with bucket deletion, triggers
315 object deletions by not involving GC
316 --inconsistent-index when specified with bucket deletion and bypass-gc set to true,
317 ignores bucket index consistency
318 --min-rewrite-size min object size for bucket rewrite (default 4M)
319 --max-rewrite-size max object size for bucket rewrite (default ULLONG_MAX)
320 --min-rewrite-stripe-size min stripe size for object rewrite (default 0)
321 --trim-delay-ms time interval in msec to limit the frequency of sync error log entries trimming operations,
322 the trimming process will sleep the specified msec for every 1000 entries trimmed
323 --max-concurrent-ios maximum concurrent ios for bucket operations (default: 32)
324 --enable-feature enable a zone/zonegroup feature
325 --disable-feature disable a zone/zonegroup feature
327 <date> := "YYYY-MM-DD[ hh:mm:ss]"
330 --max-objects specify max objects (negative value to disable)
331 --max-size specify max size (in B/K/M/G/T, negative value to disable)
332 --quota-scope scope of quota (bucket, user)
334 Rate limiting options:
335 --max-read-ops specify max requests per minute for READ ops per RGW (GET and HEAD request methods), 0 means unlimited
336 --max-read-bytes specify max bytes per minute for READ ops per RGW (GET and HEAD request methods), 0 means unlimited
337 --max-write-ops specify max requests per minute for WRITE ops per RGW (Not GET or HEAD request methods), 0 means unlimited
338 --max-write-bytes specify max bytes per minute for WRITE ops per RGW (Not GET or HEAD request methods), 0 means unlimited
339 --ratelimit-scope scope of rate limiting: bucket, user, anonymous
340 anonymous can be configured only with global rate limit
342 Orphans search options:
343 --num-shards num of shards to use for keeping the temporary scan info
344 --orphan-stale-secs num of seconds to wait before declaring an object to be an orphan (default: 86400)
345 --job-id set the job id (for orphans find)
346 --detail detailed mode, log and stat head objects as well
348 Orphans list-jobs options:
349 --extra-info provide extra info in job list
352 --role-name name of the role to create
353 --path path to the role
354 --assume-role-policy-doc the trust relationship policy document that grants an entity permission to assume the role
355 --policy-name name of the policy document
356 --policy-doc permission policy document
357 --path-prefix path prefix for filtering roles
360 --totp-serial a string that represents the ID of a TOTP token
361 --totp-seed the secret seed that is used to calculate the TOTP
362 --totp-seconds the time resolution that is being used for TOTP generation
363 --totp-window the number of TOTP tokens that are checked before and after the current token when validating token
364 --totp-pin the valid value of a TOTP token at a certain time
366 Bucket notifications options:
367 --topic bucket notifications topic name
368 --notification-id bucket notifications id
371 --context context in which the script runs. one of: prerequest, postrequest, background, getdata, putdata
372 --package name of the lua package that should be added/removed to/from the allowlist
373 --allow-compilation package is allowed to compile C code as part of its installation
375 Bucket check olh/unlinked options:
376 --min-age-hours minimum age of unlinked objects to consider for bucket check unlinked (default: 1)
377 --dump-keys when specified, all keys identified as problematic are printed to stdout
378 --hide-progress when specified, per-shard progress details are not printed to stderr
381 --rgw-obj-fs the field separator that will separate the rados
382 object name from the rgw object name;
383 additionally rados objects for incomplete
384 multipart uploads will not be output
386 --conf/-c FILE read configuration from the given configuration file
387 --id ID set ID portion of my name
388 --name/-n TYPE.ID set name
389 --cluster NAME set cluster name (default: ceph)
390 --setuser USER set uid to user or uid (and gid to user's gid)
391 --setgroup GROUP set gid to group or gid
392 --version show version and quit
projects / ceph.git / blob