Description
===========
-:program:`radosgw-admin` is a RADOS gateway user administration utility. It
-allows creating and modifying users.
+:program:`radosgw-admin` is a Ceph Object Gateway user administration utility. It
+is used to create and modify users.
Commands
========
-:program:`radosgw-admin` utility uses many commands for administration purpose
-which are as follows:
+:program:`radosgw-admin` utility provides commands for administration purposes
+as follows:
:command:`user create`
Create a new user.
Modify a user.
:command:`user info`
- Display information of a user, and any potentially available
- subusers and keys.
+ Display information for a user including any subusers and keys.
:command:`user rename`
Renames a user.
Check user info.
:command:`user stats`
- Show user stats as accounted by quota subsystem.
+ Show user stats as accounted by the quota subsystem.
:command:`user list`
List all users.
Remove access key.
:command:`bucket list`
- List buckets, or, if bucket specified with --bucket=<bucket>,
- list its objects. If bucket specified adding --allow-unordered
- removes ordering requirement, possibly generating results more
- quickly in buckets with large number of objects.
+ List buckets, or, if a bucket is specified with --bucket=<bucket>,
+ list its objects. Adding --allow-unordered
+ removes the ordering requirement, possibly generating results more
+ quickly for buckets with large number of objects.
:command:`bucket limit check`
Show bucket sharding stats.
Unlink bucket from specified user.
:command:`bucket chown`
- Link bucket to specified user and update object ACLs.
- Use --marker to resume if command gets interrupted.
+ Change bucket ownership to the specified user and update object ACLs.
+ Invoke with --marker to resume if the command is interrupted.
:command:`bucket stats`
Returns bucket statistics.
Rewrite all objects in the specified bucket.
:command:`bucket radoslist`
- List the rados objects that contain the data for all objects is
- the designated bucket, if --bucket=<bucket> is specified, or
- otherwise all buckets.
+ List the RADOS objects that contain the data for all objects in
+ the designated bucket, if --bucket=<bucket> is specified.
+ Otherwise, list the RADOS objects that contain data for all
+ buckets.
:command:`bucket reshard`
- Reshard a bucket.
+ Reshard a bucket's index.
:command:`bucket sync disable`
Disable bucket sync.
Run data sync for the specified source zone.
:command:`sync error list`
- list sync error.
+ List sync errors.
:command:`sync error trim`
- trim sync error.
+ Trim sync errors.
:command:`zone rename`
Rename a zone.
:command:`zone placement list`
- List zone's placement targets.
+ List a zone's placement targets.
:command:`zone placement add`
Add a zone placement target.
List all bucket lifecycle progress.
:command:`lc process`
- Manually process lifecycle. If a bucket is specified (e.g., via
+ Manually process lifecycle transitions. If a bucket is specified (e.g., via
--bucket_id or via --bucket and optional --tenant), only that bucket
is processed.
List metadata log which is needed for multi-site deployments.
:command:`mdlog trim`
- Trim metadata log manually instead of relying on RGWs integrated log sync.
+ Trim metadata log manually instead of relying on the gateway's integrated log sync.
Before trimming, compare the listings and make sure the last sync was
complete, otherwise it can reinitiate a sync.
:command:`bilog trim`
Trim bucket index log (use start-marker, end-marker) manually instead
- of relying on RGWs integrated log sync.
+ of relying on the gateway's integrated log sync.
Before trimming, compare the listings and make sure the last sync was
complete, otherwise it can reinitiate a sync.
List data log which is needed for multi-site deployments.
:command:`datalog trim`
- Trim data log manually instead of relying on RGWs integrated log sync.
+ Trim data log manually instead of relying on the gateway's integrated log sync.
Before trimming, compare the listings and make sure the last sync was
complete, otherwise it can reinitiate a sync.
Read data log status.
:command:`orphans find`
- Init and run search for leaked rados objects.
+ Init and run search for leaked RADOS objects.
DEPRECATED. See the "rgw-orphan-list" tool.
:command:`orphans finish`
- Clean up search for leaked rados objects.
+ Clean up search for leaked RADOS objects.
DEPRECATED. See the "rgw-orphan-list" tool.
:command:`orphans list-jobs`
- List the current job-ids for the orphans search.
+ List the current orphans search job IDs.
DEPRECATED. See the "rgw-orphan-list" tool.
:command:`role create`
- create a new AWS role for use with STS.
+ Create a new role for use with STS (Security Token Service).
:command:`role rm`
Remove a role.
Show events in a pubsub subscription
:command:`subscription ack`
- Ack (remove) an events in a pubsub subscription
+ Acknowledge (remove) events in a pubsub subscription
Options
.. option:: -m monaddress[:port]
- Connect to specified monitor (instead of looking through ceph.conf).
+ Connect to specified monitor (instead of selecting one
+ from ceph.conf).
.. option:: --tenant=<tenant>
.. option:: --uid=uid
- The radosgw user ID.
+ The user on which to operate.
.. option:: --new-uid=uid
- ID of the new user. Used with 'user rename' command.
+ The new ID of the user. Used with 'user rename' command.
.. option:: --subuser=<name>
- Name of the subuser.
+ Name of the subuser.
.. option:: --access-key=<key>
- S3 access key.
+ S3 access key.
.. option:: --email=email
.. option:: --gen-access-key
- Generate random access key (for S3).
+ Generate random access key (for S3).
+
.. option:: --gen-secret
- Generate random secret key.
+ Generate random secret key.
.. option:: --key-type=<type>
- key type, options are: swift, s3.
+ Key type, options are: swift, s3.
.. option:: --temp-url-key[-2]=<key>
- Temporary url key.
+ Temporary URL key.
.. option:: --max-buckets
- max number of buckets for a user (0 for no limit, negative value to disable bucket creation).
- Default is 1000.
+ Maximum number of buckets for a user (0 for no limit, negative value to disable bucket creation).
+ Default is 1000.
.. option:: --access=<access>
- Set the access permissions for the sub-user.
+ Set the access permissions for the subuser.
Available access permissions are read, write, readwrite and full.
.. option:: --display-name=<name>
.. option:: --bucket-new-name=[tenant-id/]<bucket>
Optional for `bucket link`; use to rename a bucket.
- While tenant-id/ can be specified, this is never
- necessary for normal operation.
+ While the tenant-id can be specified, this is not
+ necessary in normal operation.
.. option:: --shard-id=<shard-id>
- Optional for mdlog list, bi list, data sync status. Required for ``mdlog trim``.
+ Optional for mdlog list, bi list, data sync status. Required for ``mdlog trim``.
.. option:: --max-entries=<entries>
- Optional for listing operations to specify the max entries.
+ Optional for listing operations to specify the max entries.
.. option:: --purge-data
- When specified, user removal will also purge all the user data.
+ When specified, user removal will also purge the user's data.
.. option:: --purge-keys
- When specified, subuser removal will also purge all the subuser keys.
+ When specified, subuser removal will also purge the subuser' keys.
.. option:: --purge-objects
.. option:: --metadata-key=<key>
- Key to retrieve metadata from with ``metadata get``.
+ Key from which to retrieve metadata, used with ``metadata get``.
.. option:: --remote=<remote>
.. option:: --period=<id>
- Period id.
+ Period ID.
.. option:: --url=<url>
- url for pushing/pulling period or realm.
+ URL for pushing/pulling period or realm.
.. option:: --epoch=<number>
.. option:: --master-zone=<id>
- Master zone id.
+ Master zone ID.
.. option:: --rgw-realm=<name>
.. option:: --realm-id=<id>
- The realm id.
+ The realm ID.
.. option:: --realm-new-name=<name>
- New name of realm.
+ New name for the realm.
.. option:: --rgw-zonegroup=<name>
.. option:: --zonegroup-id=<id>
- The zonegroup id.
+ The zonegroup ID.
.. option:: --zonegroup-new-name=<name>
.. option:: --rgw-zone=<zone>
- Zone in which radosgw is running.
+ Zone in which the gateway is running.
.. option:: --zone-id=<id>
- The zone id.
+ The zone ID.
.. option:: --zone-new-name=<name>
.. option:: --placement-id
- Placement id for the zonegroup placement commands.
+ Placement ID for the zonegroup placement commands.
.. option:: --tags=<list>
.. option:: --data-extra-pool=<pool>
- The placement target data extra (non-ec) pool.
+ The placement target data extra (non-EC) pool.
.. option:: --placement-index-type=<type>
.. option:: --sync-from=[zone-name][,...]
- Set the list of zones to sync from.
+ Set the list of zones from which to sync.
.. option:: --sync-from-rm=[zone-name][,...]
- Remove the zones from list of zones to sync from.
+ Remove zone(s) from list of zones from which to sync.
.. option:: --bucket-index-max-shards
.. option:: --fix
- Besides checking bucket index, will also fix it.
+ Fix the bucket index in addition to checking it.
.. option:: --check-objects
- bucket check: Rebuilds bucket index according to actual objects state.
+ Bucket check: Rebuilds the bucket index according to actual object state.
.. option:: --format=<format>
- Specify output format for certain operations. Supported formats: xml, json.
+ Specify output format for certain operations. Supported formats: xml, json.
.. option:: --sync-stats
- Option for 'user stats' command. When specified, it will update user stats with
- the current stats reported by user's buckets indexes.
+ Option for the 'user stats' command. When specified, it will update user stats with
+ the current stats reported by the user's buckets indexes.
.. option:: --show-config
- Show configuration.
+ Show configuration.
.. option:: --show-log-entries=<flag>
- Enable/disable dump of log entries on log show.
+ Enable/disable dumping of log entries on log show.
.. option:: --show-log-sum=<flag>
- Enable/disable dump of log summation on log show.
+ Enable/disable dump of log summation on log show.
.. option:: --skip-zero-entries
- Log show only dumps entries that don't have zero value in one of the numeric
- field.
+ Log show only dumps entries that don't have zero value in one of the numeric
+ field.
.. option:: --infile
- Specify a file to read in when setting data.
+ Specify a file to read when setting data.
.. option:: --categories=<list>
- Comma separated list of categories, used in usage show.
+ Comma separated list of categories, used in usage show.
.. option:: --caps=<caps>
- List of caps (e.g., "usage=read, write; user=read").
+ List of capabilities (e.g., "usage=read, write; user=read").
.. option:: --compression=<compression-algorithm>
- Placement target compression algorithm (lz4|snappy|zlib|zstd)
+ Placement target compression algorithm (lz4|snappy|zlib|zstd).
.. option:: --yes-i-really-mean-it
- Required for certain operations.
+ Required as a guardrail for certain destructive operations.
.. option:: --min-rewrite-size
- Specify the min object size for bucket rewrite (default 4M).
+ Specify the minimum object size for bucket rewrite (default 4M).
.. option:: --max-rewrite-size
- Specify the max object size for bucket rewrite (default ULLONG_MAX).
+ Specify the maximum object size for bucket rewrite (default ULLONG_MAX).
.. option:: --min-rewrite-stripe-size
- Specify the min stripe size for object rewrite (default 0). If the value
+ Specify the minimum stripe size for object rewrite (default 0). If the value
is set to 0, then the specified object will always be
- rewritten for restriping.
+ rewritten when restriping.
.. option:: --warnings-only
.. option:: --bypass-gc
When specified with bucket deletion,
- triggers object deletions by not involving GC.
+ triggers object deletion without involving GC.
.. option:: --inconsistent-index
.. option:: --max-concurrent-ios
- Maximum concurrent ios for bucket operations. Affects operations that
- scan the bucket index, e.g., listing, deletion, and all scan/search
- operations such as finding orphans or checking the bucket index.
- Default is 32.
+ Maximum concurrent bucket operations. Affects operations that
+ scan the bucket index, e.g., listing, deletion, and all scan/search
+ operations such as finding orphans or checking the bucket index.
+ The default is 32.
Quota Options
=============
.. option:: --max-objects
- Specify max objects (negative value to disable).
+ Specify the maximum number of objects (negative value to disable).
.. option:: --max-size
- Specify max size (in B/K/M/G/T, negative value to disable).
+ Specify the maximum object size (in B/K/M/G/T, negative value to disable).
.. option:: --quota-scope
- The scope of quota (bucket, user).
+ The scope of quota (bucket, user).
Orphans Search Options
.. option:: --num-shards
- Number of shards to use for keeping the temporary scan info
+ Number of shards to use for temporary scan info
.. option:: --orphan-stale-secs
- Number of seconds to wait before declaring an object to be an orphan.
- Default is 86400 (24 hours).
+ Number of seconds to wait before declaring an object to be an orphan.
+ The efault is 86400 (24 hours).
.. option:: --job-id
- Set the job id (for orphans find)
+ Set the job id (for orphans find)
Orphans list-jobs options
projects / ceph.git / blobdiff