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 disable disable bucket sync
33 bucket sync enable enable bucket sync
34 bucket radoslist list rados objects backing bucket's objects
35 bi get retrieve bucket index object entries
36 bi put store bucket index object entries
37 bi list list raw bucket index entries
38 bi purge purge bucket index entries
39 object rm remove object
41 object stat stat an object for its metadata
42 object unlink unlink object from bucket index
43 object rewrite rewrite the specified object
44 objects expire run expired objects cleanup
45 objects expire-stale list list stale expired objects (caused by reshard)
46 objects expire-stale rm remove stale expired objects
47 period rm remove a period
48 period get get period info
49 period get-current get current period info
50 period pull pull a period
51 period push push a period
52 period list list all periods
53 period update update the staging period
54 period commit commit the staging period
55 quota set set quota params
56 quota enable enable quota
57 quota disable disable quota
58 global quota get view global quota params
59 global quota set set global quota params
60 global quota enable enable a global quota
61 global quota disable disable a global quota
62 realm create create a new realm
63 realm rm remove a realm
64 realm get show realm info
65 realm get-default get default realm name
66 realm list list realms
67 realm list-periods list all realm periods
68 realm rename rename a realm
69 realm set set realm info (requires infile)
70 realm default set realm as default
71 realm pull pull a realm and its current period
72 zonegroup add add a zone to a zonegroup
73 zonegroup create create a new zone group info
74 zonegroup default set default zone group
75 zonegroup delete delete a zone group info
76 zonegroup get show zone group info
77 zonegroup modify modify an existing zonegroup
78 zonegroup set set zone group info (requires infile)
79 zonegroup rm remove a zone from a zonegroup
80 zonegroup rename rename a zone group
81 zonegroup list list all zone groups set on this cluster
82 zonegroup placement list list zonegroup's placement targets
83 zonegroup placement get get a placement target of a specific zonegroup
84 zonegroup placement add add a placement target id to a zonegroup
85 zonegroup placement modify modify a placement target of a specific zonegroup
86 zonegroup placement rm remove a placement target from a zonegroup
87 zonegroup placement default set a zonegroup's default placement target
88 zone create create a new zone
90 zone get show zone cluster params
91 zone modify modify an existing zone
92 zone set set zone cluster params (requires infile)
93 zone list list all zones set on this cluster
94 zone rename rename a zone
95 zone placement list list zone's placement targets
96 zone placement get get a zone placement target
97 zone placement add add a zone placement target
98 zone placement modify modify a zone placement target
99 zone placement rm remove a zone placement target
100 metadata sync status get metadata sync status
101 metadata sync init init metadata sync
102 metadata sync run run metadata sync
103 data sync status get data sync status of the specified source zone
104 data sync init init data sync for the specified source zone
105 data sync run run data sync for the specified source zone
106 pool add add an existing pool for data placement
107 pool rm remove an existing pool from data placement set
108 pools list list placement active set
109 policy read bucket/object policy
110 log list list log objects
111 log show dump a log from specific object or (bucket + date
113 (NOTE: required to specify formatting of date
115 log rm remove log object
116 usage show show usage (by user, by bucket, date range)
117 usage trim trim usage (by user, by bucket, date range)
118 usage clear reset all the usage stats for the cluster
119 gc list dump expired garbage collection objects (specify
120 --include-all to list all entries, including unexpired)
121 gc process manually process garbage (specify
122 --include-all to process all entries, including unexpired)
123 lc list list all bucket lifecycle progress
124 lc get get a lifecycle bucket configuration
125 lc process manually process lifecycle
126 lc reshard fix fix LC for a resharded bucket
127 metadata get get metadata info
128 metadata put put metadata info
129 metadata rm remove metadata info
130 metadata list list metadata info
131 mdlog list list metadata log
132 mdlog trim trim metadata log (use start-date, end-date or
133 start-marker, end-marker)
134 mdlog status read metadata log status
135 bilog list list bucket index log
136 bilog trim trim bucket index log (use start-marker, end-marker)
137 bilog status read bucket index log status
138 datalog list list data log
139 datalog trim trim data log
140 datalog status read data log status
141 orphans find deprecated -- init and run search for leaked rados objects (use job-id, pool)
142 orphans finish deprecated -- clean up search for leaked rados objects
143 orphans list-jobs deprecated -- list the current job-ids for orphans search
144 * the three 'orphans' sub-commands are now deprecated; consider using the `rgw-orphan-list` tool
145 role create create a AWS role for use with STS
146 role rm remove a role
148 role list list roles with specified path prefix
149 role modify modify the assume role policy of an existing role
150 role-policy put add/update permission policy to role
151 role-policy list list policies attached to a role
152 role-policy get get the specified inline policy document embedded with the given role
153 role-policy rm remove policy attached to a role
154 reshard add schedule a resharding of a bucket
155 reshard list list all bucket resharding or scheduled to be resharded
156 reshard status read bucket resharding status
157 reshard process process of scheduled reshard jobs
158 reshard cancel cancel resharding a bucket
159 reshard stale-instances list list stale-instances from bucket resharding
160 reshard stale-instances rm cleanup stale-instances from bucket resharding
161 sync error list list sync error
162 sync error trim trim sync error
163 mfa create create a new MFA TOTP token
164 mfa list list MFA TOTP tokens
165 mfa get show MFA TOTP token
166 mfa remove delete MFA TOTP token
167 mfa check check MFA TOTP token
168 mfa resync re-sync MFA TOTP token
170 --tenant=<tenant> tenant name
172 --new-uid=<id> new user id
173 --subuser=<name> subuser name
174 --access-key=<key> S3 access key
175 --email=<email> user's email address
176 --secret/--secret-key=<key>
178 --gen-access-key generate random access key (for S3)
179 --gen-secret generate random secret key
180 --key-type=<type> key type, options are: swift, s3
181 --temp-url-key[-2]=<key> temp url key
182 --access=<access> Set access permissions for sub-user, should be one
183 of read, write, readwrite, full
184 --display-name=<name> user's display name
185 --max-buckets max number of buckets for a user
186 --admin set the admin flag on the user
187 --system set the system flag on the user
188 --op-mask set the op mask on the user
189 --bucket=<bucket> Specify the bucket name. Also used by the quota command.
190 --pool=<pool> Specify the pool name. Also used to scan for leaked rados objects.
191 --object=<object> object name
192 --object-version=<version> object version
193 --date=<date> date in the format yyyy-mm-dd
194 --start-date=<date> start date in the format yyyy-mm-dd
195 --end-date=<date> end date in the format yyyy-mm-dd
196 --bucket-id=<bucket-id> bucket id
197 --bucket-new-name=<bucket>
198 for bucket link: optional new name
199 --shard-id=<shard-id> optional for:
204 --max-entries=<entries> max entries for listing operations
205 --metadata-key=<key> key to retrieve metadata from with metadata get
206 --remote=<remote> zone or zonegroup id of remote gateway
207 --period=<id> period id
208 --url=<url> url for pushing/pulling period/realm
209 --epoch=<number> period epoch
210 --commit commit the period during 'period update'
211 --staging get staging period info
212 --master set as master
213 --master-zone=<id> master zone id
214 --rgw-realm=<name> realm name
215 --realm-id=<id> realm id
216 --realm-new-name=<name> realm new name
217 --rgw-zonegroup=<name> zonegroup name
218 --zonegroup-id=<id> zonegroup id
219 --zonegroup-new-name=<name>
221 --rgw-zone=<name> name of zone in which radosgw is running
222 --zone-id=<id> zone id
223 --zone-new-name=<name> zone new name
224 --source-zone specify the source zone (for data sync)
225 --default set entity (realm, zonegroup, zone) as default
226 --read-only set zone as read-only (when adding to zonegroup)
227 --redirect-zone specify zone id to redirect when response is 404 (not found)
228 --placement-id placement id for zonegroup placement commands
229 --storage-class storage class for zonegroup placement commands
230 --tags=<list> list of tags for zonegroup placement add and modify commands
231 --tags-add=<list> list of tags to add for zonegroup placement modify command
232 --tags-rm=<list> list of tags to remove for zonegroup placement modify command
233 --endpoints=<list> zone endpoints
234 --index-pool=<pool> placement target index pool
235 --data-pool=<pool> placement target data pool
236 --data-extra-pool=<pool> placement target data extra (non-ec) pool
237 --placement-index-type=<type>
238 placement target index type (normal, indexless, or #id)
239 --compression=<type> placement target compression type (plugin name or empty/none)
240 --tier-type=<type> zone tier type
241 --tier-config=<k>=<v>[,...]
242 set zone tier config keys, values
243 --tier-config-rm=<k>[,...]
244 unset zone tier config keys
245 --sync-from-all[=false] set/reset whether zone syncs from all zonegroup peers
246 --sync-from=[zone-name][,...]
247 set list of zones to sync from
248 --sync-from-rm=[zone-name][,...]
249 remove zones from list of zones to sync from
250 --bucket-index-max-shards override a zone/zonegroup's default bucket index shard count
251 --fix besides checking bucket index, will also fix it
252 --check-objects bucket check: rebuilds bucket index according to
254 --format=<format> specify output format for certain operations: xml,
256 --purge-data when specified, user removal will also purge all the
258 --purge-keys when specified, subuser removal will also purge all the
260 --purge-objects remove a bucket's objects before deleting it
261 (NOTE: required to delete a non-empty bucket)
262 --sync-stats option to 'user stats', update user stats with current
263 stats reported by user's buckets indexes
264 --reset-stats option to 'user stats', reset stats in accordance with user buckets
265 --show-log-entries=<flag> enable/disable dump of log entries on log show
266 --show-log-sum=<flag> enable/disable dump of log summation on log show
267 --skip-zero-entries log show only dumps entries that don't have zero value
268 in one of the numeric field
269 --infile=<file> specify a file to read in when setting data
270 --categories=<list> comma separated list of categories, used in usage show
271 --caps=<caps> list of caps (e.g., "usage=read, write; user=read")
272 --op-mask=<op-mask> permission of user's operations (e.g., "read, write, delete, *")
273 --yes-i-really-mean-it required for certain operations
274 --warnings-only when specified with bucket limit check, list
275 only buckets nearing or over the current max
276 objects per shard value
277 --bypass-gc when specified with bucket deletion, triggers
278 object deletions by not involving GC
279 --inconsistent-index when specified with bucket deletion and bypass-gc set to true,
280 ignores bucket index consistency
281 --min-rewrite-size min object size for bucket rewrite (default 4M)
282 --max-rewrite-size max object size for bucket rewrite (default ULLONG_MAX)
283 --min-rewrite-stripe-size min stripe size for object rewrite (default 0)
284 --trim-delay-ms time interval in msec to limit the frequency of sync error log entries trimming operations,
285 the trimming process will sleep the specified msec for every 1000 entries trimmed
286 --max-concurrent-ios maximum concurrent ios for bucket operations (default: 32)
288 <date> := "YYYY-MM-DD[ hh:mm:ss]"
291 --max-objects specify max objects (negative value to disable)
292 --max-size specify max size (in B/K/M/G/T, negative value to disable)
293 --quota-scope scope of quota (bucket, user)
295 Orphans search options:
296 --num-shards num of shards to use for keeping the temporary scan info
297 --orphan-stale-secs num of seconds to wait before declaring an object to be an orphan (default: 86400)
298 --job-id set the job id (for orphans find)
299 --detail detailed mode, log and stat head objects as well
301 Orphans list-jobs options:
302 --extra-info provide extra info in job list
305 --role-name name of the role to create
306 --path path to the role
307 --assume-role-policy-doc the trust relationship policy document that grants an entity permission to assume the role
308 --policy-name name of the policy document
309 --policy-doc permission policy document
310 --path-prefix path prefix for filtering roles
313 --totp-serial a string that represents the ID of a TOTP token
314 --totp-seed the secret seed that is used to calculate the TOTP
315 --totp-seconds the time resolution that is being used for TOTP generation
316 --totp-window the number of TOTP tokens that are checked before and after the current token when validating token
317 --totp-pin the valid value of a TOTP token at a certain time
319 --conf/-c FILE read configuration from the given configuration file
320 --id ID set ID portion of my name
321 --name/-n TYPE.ID set name
322 --cluster NAME set cluster name (default: ceph)
323 --setuser USER set uid to user or uid (and gid to user's gid)
324 --setgroup GROUP set gid to group or gid
325 --version show version and quit
projects / ceph.git / blob