[ceph.git] / ceph / src / test / cli / radosgw-admin / help.t

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