Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-project-dist / hadoop-hdfs / build / source / hadoop-hdfs-project / hadoop-hdfs / target / api / org / apache / hadoop / hdfs / tools / DiskBalancerCLI.html
blob: dc3c338ca0131eb2462d5ce8c85367b48dbf6285 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:06:39 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DiskBalancerCLI (Apache Hadoop HDFS 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DiskBalancerCLI (Apache Hadoop HDFS 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DiskBalancerCLI.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hdfs/tools/DFSHAAdmin.html" title="class in org.apache.hadoop.hdfs.tools"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hdfs/tools/GetConf.html" title="class in org.apache.hadoop.hdfs.tools"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html" target="_top">Frames</a></li>
<li><a href="DiskBalancerCLI.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hdfs.tools</div>
<h2 title="Class DiskBalancerCLI" class="title">Class DiskBalancerCLI</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.conf.Configured</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hdfs.tools.DiskBalancerCLI</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DiskBalancerCLI</span>
extends org.apache.hadoop.conf.Configured
implements org.apache.hadoop.util.Tool</pre>
<div class="block">DiskBalancer is a tool that can be used to ensure that data is spread evenly
across volumes of same storage type.
<p>
For example, if you have 3 disks, with 100 GB , 600 GB and 200 GB on each
disk, this tool will ensure that each disk will have 300 GB.
<p>
This tool can be run while data nodes are fully functional.
<p>
At very high level diskbalancer computes a set of moves that will make disk
utilization equal and then those moves are executed by the datanode.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#BANDWIDTH">BANDWIDTH</a></span></code>
<div class="block">Specifies the maximum disk bandwidth to use per second.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#BEFORE_TEMPLATE">BEFORE_TEMPLATE</a></span></code>
<div class="block">Template for the Before File.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#CANCEL">CANCEL</a></span></code>
<div class="block">Cancels a running plan.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#DEFAULT_TOP">DEFAULT_TOP</a></span></code>
<div class="block">specify default top number of nodes to be processed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#EXECUTE">EXECUTE</a></span></code>
<div class="block">Executes a given plan file on the target datanode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#HELP">HELP</a></span></code>
<div class="block">Help for the program.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#MAXERROR">MAXERROR</a></span></code>
<div class="block">Specifies the maximum errors to tolerate.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#NODE">NODE</a></span></code>
<div class="block">Name or address of the node to execute against.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#OUTFILE">OUTFILE</a></span></code>
<div class="block">Output file name, for commands like report, plan etc.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#PLAN">PLAN</a></span></code>
<div class="block">Computes a plan for a given set of nodes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#PLAN_TEMPLATE">PLAN_TEMPLATE</a></span></code>
<div class="block">Template for the plan file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#PLAN_VERSION">PLAN_VERSION</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#QUERY">QUERY</a></span></code>
<div class="block">Reports the status of disk balancer operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#REPORT">REPORT</a></span></code>
<div class="block">The report command prints out a disk fragmentation report about the data
cluster.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#SKIPDATECHECK">SKIPDATECHECK</a></span></code>
<div class="block">Skips date check(now by default the plan is valid for 24 hours), and force
execute the plan.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#THRESHOLD">THRESHOLD</a></span></code>
<div class="block">Percentage of data unevenness that we are willing to live with.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#TOP">TOP</a></span></code>
<div class="block">specify top number of nodes to be processed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#VERBOSE">VERBOSE</a></span></code>
<div class="block">Runs the command in verbose mode.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#DiskBalancerCLI-org.apache.hadoop.conf.Configuration-">DiskBalancerCLI</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Construct a DiskBalancer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#DiskBalancerCLI-org.apache.hadoop.conf.Configuration-java.io.PrintStream-">DiskBalancerCLI</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;printStream)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static org.apache.commons.cli.Options</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#getCancelOptions--">getCancelOptions</a></span>()</code>
<div class="block">Returns Cancel Options.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hdfs/server/diskbalancer/command/Command.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.command">Command</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#getCurrentCommand--">getCurrentCommand</a></span>()</code>
<div class="block">Gets current command associated with this instance of DiskBalancer.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static org.apache.commons.cli.Options</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#getExecuteOptions--">getExecuteOptions</a></span>()</code>
<div class="block">Retuns execute options.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static org.apache.commons.cli.Options</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#getHelpOptions--">getHelpOptions</a></span>()</code>
<div class="block">Returns help options.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static org.apache.commons.cli.Options</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#getPlanOptions--">getPlanOptions</a></span>()</code>
<div class="block">Returns Plan options.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static org.apache.commons.cli.Options</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#getQueryOptions--">getQueryOptions</a></span>()</code>
<div class="block">Returns Query Options.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static org.apache.commons.cli.Options</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#getReportOptions--">getReportOptions</a></span>()</code>
<div class="block">Returns Report Options.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#main-java.lang.String:A-">main</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;argv)</code>
<div class="block">Main for the DiskBalancer Command handling.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html#run-java.lang.String:A-">run</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>
<div class="block">Execute the command with the given arguments.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.conf.Configured">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.conf.Configured</h3>
<code>getConf, setConf</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.conf.Configurable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.conf.Configurable</h3>
<code>getConf, setConf</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="PLAN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PLAN</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PLAN</pre>
<div class="block">Computes a plan for a given set of nodes.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.PLAN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OUTFILE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OUTFILE</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OUTFILE</pre>
<div class="block">Output file name, for commands like report, plan etc. This is an optional
argument, by default diskbalancer will write all its output to
/system/reports/diskbalancer of the current cluster it is operating
against.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.OUTFILE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HELP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HELP</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> HELP</pre>
<div class="block">Help for the program.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.HELP">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="THRESHOLD">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>THRESHOLD</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> THRESHOLD</pre>
<div class="block">Percentage of data unevenness that we are willing to live with. For example
- a value like 10 indicates that we are okay with 10 % +/- from
idealStorage Target.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.THRESHOLD">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BANDWIDTH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BANDWIDTH</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> BANDWIDTH</pre>
<div class="block">Specifies the maximum disk bandwidth to use per second.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.BANDWIDTH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MAXERROR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAXERROR</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAXERROR</pre>
<div class="block">Specifies the maximum errors to tolerate.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.MAXERROR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="EXECUTE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EXECUTE</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> EXECUTE</pre>
<div class="block">Executes a given plan file on the target datanode.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.EXECUTE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SKIPDATECHECK">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SKIPDATECHECK</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SKIPDATECHECK</pre>
<div class="block">Skips date check(now by default the plan is valid for 24 hours), and force
execute the plan.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.SKIPDATECHECK">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="REPORT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REPORT</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> REPORT</pre>
<div class="block">The report command prints out a disk fragmentation report about the data
cluster. By default it prints the DEFAULT_TOP machines names with high
nodeDataDensity {DiskBalancerDataNode#getNodeDataDensity} values. This
means that these are the nodes that deviates from the ideal data
distribution.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.REPORT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TOP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TOP</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TOP</pre>
<div class="block">specify top number of nodes to be processed.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.TOP">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_TOP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TOP</h4>
<pre>public static final&nbsp;int DEFAULT_TOP</pre>
<div class="block">specify default top number of nodes to be processed.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.DEFAULT_TOP">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NODE</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NODE</pre>
<div class="block">Name or address of the node to execute against.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.NODE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VERBOSE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VERBOSE</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> VERBOSE</pre>
<div class="block">Runs the command in verbose mode.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.VERBOSE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PLAN_VERSION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PLAN_VERSION</h4>
<pre>public static final&nbsp;int PLAN_VERSION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.PLAN_VERSION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="QUERY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>QUERY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> QUERY</pre>
<div class="block">Reports the status of disk balancer operation.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.QUERY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CANCEL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CANCEL</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CANCEL</pre>
<div class="block">Cancels a running plan.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.CANCEL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BEFORE_TEMPLATE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BEFORE_TEMPLATE</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> BEFORE_TEMPLATE</pre>
<div class="block">Template for the Before File. It is node.before.json.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.BEFORE_TEMPLATE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PLAN_TEMPLATE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PLAN_TEMPLATE</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PLAN_TEMPLATE</pre>
<div class="block">Template for the plan file. it is node.plan.json.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hdfs.tools.DiskBalancerCLI.PLAN_TEMPLATE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DiskBalancerCLI-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DiskBalancerCLI</h4>
<pre>public&nbsp;DiskBalancerCLI(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Construct a DiskBalancer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - </dd>
</dl>
</li>
</ul>
<a name="DiskBalancerCLI-org.apache.hadoop.conf.Configuration-java.io.PrintStream-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DiskBalancerCLI</h4>
<pre>public&nbsp;DiskBalancerCLI(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;printStream)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;argv)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Main for the DiskBalancer Command handling.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>argv</code> - - System Args Strings[]</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="run-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;int&nbsp;run(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Execute the command with the given arguments.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>run</code>&nbsp;in interface&nbsp;<code>org.apache.hadoop.util.Tool</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - command specific arguments.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>exit code.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="getPlanOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlanOptions</h4>
<pre>public static&nbsp;org.apache.commons.cli.Options&nbsp;getPlanOptions()</pre>
<div class="block">Returns Plan options.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Options.</dd>
</dl>
</li>
</ul>
<a name="getHelpOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHelpOptions</h4>
<pre>public static&nbsp;org.apache.commons.cli.Options&nbsp;getHelpOptions()</pre>
<div class="block">Returns help options.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>- help options.</dd>
</dl>
</li>
</ul>
<a name="getExecuteOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecuteOptions</h4>
<pre>public static&nbsp;org.apache.commons.cli.Options&nbsp;getExecuteOptions()</pre>
<div class="block">Retuns execute options.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>- execute options.</dd>
</dl>
</li>
</ul>
<a name="getQueryOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryOptions</h4>
<pre>public static&nbsp;org.apache.commons.cli.Options&nbsp;getQueryOptions()</pre>
<div class="block">Returns Query Options.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>query Options</dd>
</dl>
</li>
</ul>
<a name="getCancelOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCancelOptions</h4>
<pre>public static&nbsp;org.apache.commons.cli.Options&nbsp;getCancelOptions()</pre>
<div class="block">Returns Cancel Options.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Options</dd>
</dl>
</li>
</ul>
<a name="getReportOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReportOptions</h4>
<pre>public static&nbsp;org.apache.commons.cli.Options&nbsp;getReportOptions()</pre>
<div class="block">Returns Report Options.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Options</dd>
</dl>
</li>
</ul>
<a name="getCurrentCommand--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCurrentCommand</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hdfs/server/diskbalancer/command/Command.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.command">Command</a>&nbsp;getCurrentCommand()</pre>
<div class="block">Gets current command associated with this instance of DiskBalancer.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DiskBalancerCLI.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hdfs/tools/DFSHAAdmin.html" title="class in org.apache.hadoop.hdfs.tools"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hdfs/tools/GetConf.html" title="class in org.apache.hadoop.hdfs.tools"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hdfs/tools/DiskBalancerCLI.html" target="_top">Frames</a></li>
<li><a href="DiskBalancerCLI.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>