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