Command Line Interface

OzoneShell

Ozone shell is the primary interface to interact with Ozone. It provides a command shell interface to work against Ozone.

Shell Overview

Ozone shell help can be invoked at object level or at action level. For example: ozone sh volume --help This will show all possible actions for volumes. or it can be invoked to explain a specific action like ozone sh volume create --help 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

Shell Overview

Volume Commands

Volume commands generally need administrator privileges. The ozone shell supports the following volume commands. create delete info list update Create The volume create command allows an administrator to create a volume and assign it to a user. Params: Arguments Comment -q, --quota Optional, This argument that specifies the maximum size this volume can use in the Ozone cluster. -u, --user Required, The name of the user who owns this volume.

Volume Commands

Bucket Commands

Ozone shell supports the following bucket commands. create delete info list Create The bucket create command allows users to create a bucket. Params: Arguments Comment Uri The name of the bucket in /volume/bucket format. ozone sh bucket create /hive/jan The above command will create a bucket called jan in the hive volume. Since no scheme was specified this command defaults to O3 (RPC) protocol.

Bucket Commands

Key Commands

Ozone shell supports the following key commands. get put delete info list rename Get The key get command downloads a key from Ozone cluster to local file system. Params: Arguments Comment Uri The name of the key in /volume/bucket/key format. FileName Local file to download the key to. ozone sh key get /hive/jan/sales.orc sales.orc Downloads the file sales.

Key Commands