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