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