2 usage: radosgw-admin <cmd> [options...]
4 user create create a new user
5 user modify modify user
6 user info get user info
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
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
20 bucket list list buckets
21 bucket limit check show bucket sharding stats
22 bucket link link bucket to specified user
23 bucket unlink unlink bucket from specified user
24 bucket stats returns bucket statistics
25 bucket rm remove bucket
26 bucket check check bucket index
27 bucket reshard reshard bucket
28 bi get retrieve bucket index object entries
29 bi put store bucket index object entries
30 bi list list raw bucket index entries
31 object rm remove object
32 object stat stat an object for its metadata
33 object unlink unlink object from bucket index
34 objects expire run expired objects cleanup
35 period delete delete a period
36 period get get period info
37 period get-current get current period info
38 period pull pull a period
39 period push push a period
40 period list list all periods
41 period update update the staging period
42 period commit commit the staging period
43 quota set set quota params
44 quota enable enable quota
45 quota disable disable quota
46 global quota get view global quota params
47 global quota set set global quota params
48 global quota enable enable a global quota
49 global quota disable disable a global quota
50 realm create create a new realm
51 realm delete delete a realm
52 realm get show realm info
53 realm get-default get default realm name
54 realm list list realms
55 realm list-periods list all realm periods
56 realm remove remove a zonegroup from the realm
57 realm rename rename a realm
58 realm set set realm info (requires infile)
59 realm default set realm as default
60 realm pull pull a realm and its current period
61 zonegroup add add a zone to a zonegroup
62 zonegroup create create a new zone group info
63 zonegroup default set default zone group
64 zonegroup delete delete a zone group info
65 zonegroup get show zone group info
66 zonegroup modify modify an existing zonegroup
67 zonegroup set set zone group info (requires infile)
68 zonegroup remove remove a zone from a zonegroup
69 zonegroup rename rename a zone group
70 zonegroup list list all zone groups set on this cluster
71 zonegroup placement list list zonegroup's placement targets
72 zonegroup placement add add a placement target id to a zonegroup
73 zonegroup placement modify modify a placement target of a specific zonegroup
74 zonegroup placement rm remove a placement target from a zonegroup
75 zonegroup placement default set a zonegroup's default placement target
76 zone create create a new zone
77 zone delete delete a zone
78 zone get show zone cluster params
79 zone modify modify an existing zone
80 zone set set zone cluster params (requires infile)
81 zone list list all zones set on this cluster
82 zone rename rename a zone
83 zone placement list list zone's placement targets
84 zone placement add add a zone placement target
85 zone placement modify modify a zone placement target
86 zone placement rm remove a zone placement target
87 pool add add an existing pool for data placement
88 pool rm remove an existing pool from data placement set
89 pools list list placement active set
90 policy read bucket/object policy
91 log list list log objects
92 log show dump a log from specific object or (bucket + date
94 (NOTE: required to specify formatting of date
96 log rm remove log object
97 usage show show usage (by user, date range)
98 usage trim trim usage (by user, date range)
99 gc list dump expired garbage collection objects (specify
100 --include-all to list all entries, including unexpired)
101 gc process manually process garbage
102 lc list list all bucket lifecycle progress
103 lc process manually process lifecycle
104 metadata get get metadata info
105 metadata put put metadata info
106 metadata rm remove metadata info
107 metadata list list metadata info
108 mdlog list list metadata log
109 mdlog trim trim metadata log (use start-date, end-date or
110 start-marker, end-marker)
111 mdlog status read metadata log status
112 bilog list list bucket index log
113 bilog trim trim bucket index log (use start-marker, end-marker)
114 datalog list list data log
115 datalog trim trim data log
116 datalog status read data log status
117 opstate list list stateful operations entries (use client_id,
119 opstate set set state on an entry (use client_id, op_id, object, state)
120 opstate renew renew state on an entry (use client_id, op_id, object)
121 opstate rm remove entry (use client_id, op_id, object)
122 replicalog get get replica metadata log entry
123 replicalog update update replica metadata log entry
124 replicalog delete delete replica metadata log entry
125 orphans find init and run search for leaked rados objects (use job-id, pool)
126 orphans finish clean up search for leaked rados objects
127 orphans list-jobs list the current job-ids for orphans search
128 role create create a AWS role for use with STS
129 role delete delete a role
131 role list list roles with specified path prefix
132 role modify modify the assume role policy of an existing role
133 role-policy put add/update permission policy to role
134 role-policy list list policies attached to a role
135 role-policy get get the specified inline policy document embedded with the given role
136 role-policy delete delete policy attached to a role
137 reshard add schedule a resharding of a bucket
138 reshard list list all bucket resharding or scheduled to be reshared
139 reshard process process of scheduled reshard jobs
140 reshard cancel cancel resharding a bucket
142 --tenant=<tenant> tenant name
144 --subuser=<name> subuser name
145 --access-key=<key> S3 access key
147 --secret/--secret-key=<key>
149 --gen-access-key generate random access key (for S3)
150 --gen-secret generate random secret key
151 --key-type=<type> key type, options are: swift, s3
152 --temp-url-key[-2]=<key> temp url key
153 --access=<access> Set access permissions for sub-user, should be one
154 of read, write, readwrite, full
155 --display-name=<name>
156 --max_buckets max number of buckets for a user
157 --admin set the admin flag on the user
158 --system set the system flag on the user
165 --bucket-id=<bucket-id>
166 --shard-id=<shard-id> optional for mdlog list
169 replica mdlog get/delete
170 replica datalog get/delete
171 --metadata-key=<key> key to retrieve metadata from with metadata get
172 --remote=<remote> zone or zonegroup id of remote gateway
173 --period=<id> period id
174 --epoch=<number> period epoch
175 --commit commit the period during 'period update'
176 --staging get staging period info
177 --master set as master
178 --master-url master url
179 --master-zonegroup=<id> master zonegroup id
180 --master-zone=<id> master zone id
181 --rgw-realm=<name> realm name
182 --realm-id=<id> realm id
183 --realm-new-name=<name> realm new name
184 --rgw-zonegroup=<name> zonegroup name
185 --zonegroup-id=<id> zonegroup id
186 --zonegroup-new-name=<name>
188 --rgw-zone=<name> name of zone in which radosgw is running
189 --zone-id=<id> zone id
190 --zone-new-name=<name> zone new name
191 --source-zone specify the source zone (for data sync)
192 --default set entity (realm, zonegroup, zone) as default
193 --read-only set zone as read-only (when adding to zonegroup)
194 --placement-id placement id for zonegroup placement commands
195 --tags=<list> list of tags for zonegroup placement add and modify commands
196 --tags-add=<list> list of tags to add for zonegroup placement modify command
197 --tags-rm=<list> list of tags to remove for zonegroup placement modify command
198 --endpoints=<list> zone endpoints
199 --index_pool=<pool> placement target index pool
200 --data_pool=<pool> placement target data pool
201 --data_extra_pool=<pool> placement target data extra (non-ec) pool
202 --placement-index-type=<type>
203 placement target index type (normal, indexless, or #id)
204 --compression=<type> placement target compression type (plugin name or empty/none)
205 --tier-type=<type> zone tier type
206 --tier-config=<k>=<v>[,...]
207 set zone tier config keys, values
208 --tier-config-rm=<k>[,...]
209 unset zone tier config keys
210 --sync-from-all[=false] set/reset whether zone syncs from all zonegroup peers
211 --sync-from=[zone-name][,...]
212 set list of zones to sync from
213 --sync-from-rm=[zone-name][,...]
214 remove zones from list of zones to sync from
215 --fix besides checking bucket index, will also fix it
216 --check-objects bucket check: rebuilds bucket index according to
218 --format=<format> specify output format for certain operations: xml,
220 --purge-data when specified, user removal will also purge all the
222 --purge-keys when specified, subuser removal will also purge all the
224 --purge-objects remove a bucket's objects before deleting it
225 (NOTE: required to delete a non-empty bucket)
226 --sync-stats option to 'user stats', update user stats with current
227 stats reported by user's buckets indexes
228 --show-log-entries=<flag> enable/disable dump of log entries on log show
229 --show-log-sum=<flag> enable/disable dump of log summation on log show
230 --skip-zero-entries log show only dumps entries that don't have zero value
231 in one of the numeric field
232 --infile=<file> specify a file to read in when setting data
233 --state=<state string> specify a state for the opstate set command
234 --replica-log-type replica log type (metadata, data, bucket), required for
235 replica log operations
236 --categories=<list> comma separated list of categories, used in usage show
237 --caps=<caps> list of caps (e.g., "usage=read, write; user=read")
238 --yes-i-really-mean-it required for certain operations
239 --warnings-only when specified with bucket limit check, list
240 only buckets nearing or over the current max
241 objects per shard value
242 --bypass-gc when specified with bucket deletion, triggers
243 object deletions by not involving GC
244 --inconsistent-index when specified with bucket deletion and bypass-gc set to true,
245 ignores bucket index consistency
247 <date> := "YYYY-MM-DD[ hh:mm:ss]"
250 --bucket specified bucket for quota command
251 --max-objects specify max objects (negative value to disable)
252 --max-size specify max size (in B/K/M/G/T, negative value to disable)
253 --quota-scope scope of quota (bucket, user)
255 Orphans search options:
256 --pool data pool to scan for leaked rados objects in
257 --num-shards num of shards to use for keeping the temporary scan info
258 --orphan-stale-secs num of seconds to wait before declaring an object to be an orphan (default: 86400)
259 --job-id set the job id (for orphans find)
260 --max-concurrent-ios maximum concurrent ios for orphans find (default: 32)
262 Orphans list-jobs options:
263 --extra-info provide extra info in job list
266 --role-name name of the role to create
267 --path path to the role
268 --assume-role-policy-doc the trust relationship policy document that grants an entity permission to assume the role
269 --policy-name name of the policy document
270 --policy-doc permission policy document
271 --path-prefix path prefix for filtering roles
273 --conf/-c FILE read configuration from the given configuration file
274 --id/-i ID set ID portion of my name
275 --name/-n TYPE.ID set name
276 --cluster NAME set cluster name (default: ceph)
277 --setuser USER set uid to user or uid (and gid to user's gid)
278 --setgroup GROUP set gid to group or gid
279 --version show version and quit
projects / ceph.git / blob