Ozone CLI
Overview
The general way to invoke an Ozone shell command is as follows:
$ ozone sh <object> <action> [<params>]where:
-
<object>is an Ozone object such as bucket, key, prefix, snapshot, user, token, or volume. -
<action>is an action to perform with an object. For example, to create a volume, the action would becreate. -
[params]are additional parameters that some actions require.
For examples of how to use the CLI tool, refer to the Connect to Ozone via CLI article.
Bucket commands
These commands allow you to administer buckets within a volume.
| Command | Description |
|---|---|
Adds ACLs to a bucket |
|
Clears bucket quota |
|
Creates a new bucket |
|
Deletes a bucket |
|
Returns all ACLs from a bucket |
|
Prints information about a bucket |
|
Creates a symlink between buckets |
|
Prints information about all buckets in a volume |
|
Removes ACLs from a bucket |
|
Sets replication configuration for a bucket |
|
Overwrites bucket’s ACLs |
|
Sets quotas for an existing bucket |
|
Updates the owner of a bucket |
Key commands
These commands allow you to administer keys within a bucket.
| Command | Description |
|---|---|
Adds ACLs to a key |
|
Prints contents of a specific Ozone key to standard output |
|
Returns checksum information of a key |
|
Copies an existing key to another one within the same bucket |
|
Deletes a key |
|
Downloads contents of a key from a server |
|
Lists all ACLs for a given key |
|
Prints information about a key |
|
Lists information about all keys in a given volume, bucket, or snapshot |
|
Adds a key with file contents to a bucket |
|
Removes an access control list from a key |
|
Renames an existing key |
|
Sets one or more ACLs, replacing the existing ones |
User commands
These commands allow you to administer users.
| Command | Description |
|---|---|
Assigns an admin role to an access ID |
|
Assigns a user to a tenant (organization) |
|
Returns a secret given to an access ID |
|
Prints information about a user |
|
Lists all users in a tenant |
|
Revokes admin privileges from a user |
|
Removes a user from an organization (tenant) |
|
Sets a secret for an access ID |
Volume commands
These commands allow you to administer volumes.
| Command | Description |
|---|---|
Adds ACLs to a volume |
|
Clears volume quota |
|
Creates a new volume |
|
Deletes a volume |
|
Returns all ACLs from a volume |
|
Prints information about a volume |
|
Prints information about all volumes |
|
Removes ACLs from a volume |
|
Overwrites volume’s ACLs |
|
Sets quotas for an existing volume |
|
Updates the owner of a volume |