docs/0.4.1-alpha/shell/format.html - ozone-site - Git at Google



 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">

     <meta name="description" content="Hadoop Ozone Documentation">

     <title>Documentation for Apache Hadoop Ozone</title>


     <link href="../css/bootstrap.min.css" rel="stylesheet">


     <link href="../css/ozonedoc.css" rel="stylesheet">

   </head>


 <body>


 <nav class="navbar navbar-inverse navbar-fixed-top">
   <div class="container-fluid">
     <div class="navbar-header">
       <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#sidebar" aria-expanded="false" aria-controls="navbar">
         <span class="sr-only">Toggle navigation</span>
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
       </button>
       <a href="#" class="navbar-left" style="height: 50px; padding: 5px 5px 5px 0;">
         <img src="../ozone-logo-small.png" width="40"/>
       </a>
       <a class="navbar-brand hidden-xs" href="#">
         Apache Hadoop Ozone/HDDS documentation
       </a>
       <a class="navbar-brand visible-xs-inline" href="#">Hadoop Ozone</a>
     </div>
     <div id="navbar" class="navbar-collapse collapse">
       <ul class="nav navbar-nav navbar-right">
         <li><a href="https://github.com/apache/hadoop">Source</a></li>
         <li><a href="https://hadoop.apache.org">Apache Hadoop</a></li>
         <li><a href="https://apache.org">ASF</a></li>
       </ul>
     </div>
   </div>
 </nav>


   <div class="container-fluid">
     <div class="row">

 <div class="col-sm-2 col-md-2 sidebar" id="sidebar">
   <ul class="nav nav-sidebar">


             <li class="">

                    <a href="../index.html">


                     <span>Overview</span>
                 </a>
             </li>


             <li class="">

                    <a href="../start.html">


                     <span>Getting Started</span>
                 </a>
             </li>


             <li class="">

                    <a href="../shell.html">


                     <span>Command Line Interface</span>
                 </a>
             </li>


             <li class="">

                    <a href="../interface.html">


                     <span>Programming Interfaces</span>
                 </a>
             </li>


             <li class="">

                    <a href="../security.html">


                     <span>Security</span>
                 </a>
             </li>


             <li class="">

                    <a href="../concept.html">


                     <span>Concepts</span>
                 </a>
             </li>


             <li class="">

                    <a href="../beyond.html">


                     <span>Beyond Basics</span>
                 </a>
             </li>


             <li class="">

                    <a href="../tools.html">


                     <span>Tools</span>
                 </a>
             </li>


             <li class="">

                    <a href="../recipe.html">


                     <span>Recipes</span>
                 </a>
             </li>


     <li class="visible-xs"><a href="#">References</a>
     <ul class="nav">
         <li><a href="https://github.com/apache/hadoop"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Source</a></li>
         <li><a href="https://hadoop.apache.org"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Apache Hadoop</a></li>
         <li><a href="https://apache.org"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> ASF</a></li>
     </ul></li>
   </ul>

 </div>

       <div class="col-sm-10 col-sm-offset-2 col-md-10 col-md-offset-2 main">


         <div class="col-md-9">
             <nav aria-label="breadcrumb">
                 <ol class="breadcrumb">
                   <li class="breadcrumb-item"><a href="../">Home</a></li>
                   <li class="breadcrumb-item" aria-current="page"><a href="../shell.html">Command Line Interface</a></li>
                   <li class="breadcrumb-item active" aria-current="page">Shell Overview</li>
                 </ol>
               </nav>

           <div class="col-md-9">
             <h1>Shell Overview</h1>
           </div>


 <!---
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 -->

 <p>Ozone shell help can be invoked at <em>object</em> level or at <em>action</em> level.
 For example:</p>

 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh volume --help</code></pre></div>

 <p>This will show all possible actions for volumes.</p>

 <p>or it can be invoked to explain a specific action like
 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh volume create --help</code></pre></div>
 This command will give you command line options of the create command.</p>

 <p></p></p>

 <h3 id="general-command-format">General Command Format</h3>

 <p>The Ozone shell commands take the following format.</p>

 <blockquote>
 <p><em>ozone sh object action url</em></p>
 </blockquote>

 <p><strong>ozone</strong> script is used to invoke all Ozone sub-commands. The ozone shell is
 invoked via <code>sh</code> command.</p>

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

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

 <p><em>[scheme][server:port]/volume/bucket/key</em></p>

 <p>Where,</p>

 <ol>
 <li><p><strong>Scheme</strong> - This should be <code>o3</code> which is the native RPC protocol to access
 Ozone API. The usage of the schema is optional.</p></li>

 <li><p><strong>Server:Port</strong> - This is the address of the Ozone Manager. If the port is
 omitted the default port from ozone-site.xml will be used.</p></li>
 </ol>

 <p>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.</p>


           <a class="btn  btn-success btn-lg" href="../shell/volumecommands.html">Next >></a>

         </div>
       </div>
     </div>
   </div>


 <script src="../js/jquery-3.4.1.min.js"></script>
 <script src="../js/ozonedoc.js"></script>
 <script src="../js/bootstrap.min.js"></script>


 </body>

 </html>


	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<meta name="viewport" content="width=device-width, initial-scale=1">

	<meta name="description" content="Hadoop Ozone Documentation">

	<title>Documentation for Apache Hadoop Ozone</title>


	<link href="../css/bootstrap.min.css" rel="stylesheet">


	<link href="../css/ozonedoc.css" rel="stylesheet">

	</head>


	<body>


	<nav class="navbar navbar-inverse navbar-fixed-top">
	<div class="container-fluid">
	<div class="navbar-header">
	<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#sidebar" aria-expanded="false" aria-controls="navbar">
	<span class="sr-only">Toggle navigation</span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	</button>
	<a href="#" class="navbar-left" style="height: 50px; padding: 5px 5px 5px 0;">
	<img src="../ozone-logo-small.png" width="40"/>
	</a>
	<a class="navbar-brand hidden-xs" href="#">
	Apache Hadoop Ozone/HDDS documentation
	</a>
	<a class="navbar-brand visible-xs-inline" href="#">Hadoop Ozone</a>
	</div>
	<div id="navbar" class="navbar-collapse collapse">
	<ul class="nav navbar-nav navbar-right">
	<li><a href="https://github.com/apache/hadoop">Source</a></li>
	<li><a href="https://hadoop.apache.org">Apache Hadoop</a></li>
	<li><a href="https://apache.org">ASF</a></li>
	</ul>
	</div>
	</div>
	</nav>


	<div class="container-fluid">
	<div class="row">

	<div class="col-sm-2 col-md-2 sidebar" id="sidebar">
	<ul class="nav nav-sidebar">



	<li class="">

	<a href="../index.html">



	<span>Overview</span>
	</a>
	</li>



	<li class="">

	<a href="../start.html">



	<span>Getting Started</span>
	</a>
	</li>



	<li class="">

	<a href="../shell.html">



	<span>Command Line Interface</span>
	</a>
	</li>



	<li class="">

	<a href="../interface.html">



	<span>Programming Interfaces</span>
	</a>
	</li>



	<li class="">

	<a href="../security.html">



	<span>Security</span>
	</a>
	</li>



	<li class="">

	<a href="../concept.html">



	<span>Concepts</span>
	</a>
	</li>



	<li class="">

	<a href="../beyond.html">



	<span>Beyond Basics</span>
	</a>
	</li>



	<li class="">

	<a href="../tools.html">



	<span>Tools</span>
	</a>
	</li>



	<li class="">

	<a href="../recipe.html">



	<span>Recipes</span>
	</a>
	</li>


	<li class="visible-xs"><a href="#">References</a>
	<ul class="nav">
	<li><a href="https://github.com/apache/hadoop"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Source</a></li>
	<li><a href="https://hadoop.apache.org"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Apache Hadoop</a></li>
	<li><a href="https://apache.org"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> ASF</a></li>
	</ul></li>
	</ul>

	</div>

	<div class="col-sm-10 col-sm-offset-2 col-md-10 col-md-offset-2 main">



	<div class="col-md-9">
	<nav aria-label="breadcrumb">
	<ol class="breadcrumb">
	<li class="breadcrumb-item"><a href="../">Home</a></li>
	<li class="breadcrumb-item" aria-current="page"><a href="../shell.html">Command Line Interface</a></li>
	<li class="breadcrumb-item active" aria-current="page">Shell Overview</li>
	</ol>
	</nav>

	<div class="col-md-9">
	<h1>Shell Overview</h1>
	</div>



	<!---
	Licensed to the Apache Software Foundation (ASF) under one or more
	contributor license agreements. See the NOTICE file distributed with
	this work for additional information regarding copyright ownership.
	The ASF licenses this file to You under the Apache License, Version 2.0
	(the "License"); you may not use this file except in compliance with
	the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
	-->

	<p>Ozone shell help can be invoked at <em>object</em> level or at <em>action</em> level.
	For example:</p>

	<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh volume --help</code></pre></div>

	<p>This will show all possible actions for volumes.</p>

	<p>or it can be invoked to explain a specific action like
	<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh volume create --help</code></pre></div>
	This command will give you command line options of the create command.</p>

	<p></p></p>

	<h3 id="general-command-format">General Command Format</h3>

	<p>The Ozone shell commands take the following format.</p>

	<blockquote>
	<p><em>ozone sh object action url</em></p>
	</blockquote>

	<p><strong>ozone</strong> script is used to invoke all Ozone sub-commands. The ozone shell is
	invoked via <code>sh</code> command.</p>

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

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

	<p><em>[scheme][server:port]/volume/bucket/key</em></p>

	<p>Where,</p>

	<ol>
	<li><p><strong>Scheme</strong> - This should be <code>o3</code> which is the native RPC protocol to access
	Ozone API. The usage of the schema is optional.</p></li>

	<li><p><strong>Server:Port</strong> - This is the address of the Ozone Manager. If the port is
	omitted the default port from ozone-site.xml will be used.</p></li>
	</ol>

	<p>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.</p>



	<a class="btn btn-success btn-lg" href="../shell/volumecommands.html">Next >></a>

	</div>
	</div>
	</div>
	</div>




	<script src="../js/jquery-3.4.1.min.js"></script>
	<script src="../js/ozonedoc.js"></script>
	<script src="../js/bootstrap.min.js"></script>


	</body>

	</html>