hadoop/hadoop-hdds/docs/content/shell/Format.md

title	summary	weight
Shell Overview	Explains the command syntax used by shell command.	1

Ozone shell help can be invoked at object level or at action level. For example:

{{< highlight bash >}} ozone sh volume --help {{< /highlight >}}

This will show all possible actions for volumes.

or it can be invoked to explain a specific action like {{< highlight bash >}} ozone sh volume create --help {{< /highlight >}} This command will give you command line options of the create command.

General Command Format

The Ozone shell commands take the following format.

ozone sh object action url

ozone script is used to invoke all Ozone sub-commands. The ozone shell is invoked via sh command.

The object can be a volume, bucket or a key. The action is various verbs like create, list, delete etc.

Ozone URL can point to a volume, bucket or keys in the following format:

[scheme][server:port]/volume/bucket/key

Where,

1. Scheme - This should be o3 which is the native RPC protocol to access Ozone API. The usage of the schema is optional.

2. Server:Port - This is the address of the Ozone Manager. If the port is omitted the default port from ozone-site.xml will be used.

Depending on the call, the volume/bucket/key names will be part of the URL. Please see volume commands, bucket commands, and key commands section for more detail.