HDFS 客户端的 Shell 命令

迷南。 2023-02-15 01:18 59阅读 0赞

## HDFS 命令 ##

所有的 HDFS 命令都是由 bin/hdfs 脚本调用的。不带任何参数运行 hdfs 脚本将打印所有命令的描述。

> Usage: hdfs \[SHELL\_OPTIONS\] COMMAND \[GENERIC\_OPTIONS\] \[COMMAND\_OPTIONS\]

Hadoop有一个选项解析框架，它使用解析通用选项和运行类。

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTIONS</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>SHELL_OPTIONS</td> 
   <td>一组常见的shell选项。这些都记录在命令手册页上。</td> 
  </tr> 
  <tr> 
   <td>GENERIC_OPTIONS</td> 
   <td>多个命令支持的常见选项集。有关更多信息，请参阅Hadoop命令手册。</td> 
  </tr> 
  <tr> 
   <td>COMMAND COMMAND_OPTIONS</td> 
   <td>下面几节将介绍各种命令及其选项。命令被分组为用户命令和管理命令。</td> 
  </tr> 
 </tbody> 
</table>

## 用户命令 ##

对hadoop集群的用户有用的命令。

### classpath ###

> Usage: hdfs classpath \[--glob |--jar <path> |-h |--help\]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>--glob</td> 
   <td>expand wildcards</td> 
  </tr> 
  <tr> 
   <td>--jar&nbsp;<em>path</em></td> 
   <td>在jar命名路径中编写类路径作为清单</td> 
  </tr> 
  <tr> 
   <td>-h,&nbsp;--help</td> 
   <td>print help</td> 
  </tr> 
 </tbody> 
</table>

打印获取 Hadoop jar 和所需库所需的类路径。如果在不带参数的情况下调用，则输出命令脚本设置的类路径，它可能在类路径条目中包含通配符。其他选项在通配符展开后打印类路径，或者将类路径写入 jar 文件的清单中。后者在不能使用通配符并且展开的类路径超过了所支持的最大命令行长度的环境中非常有用。

### dfs ###

> Usage: hdfs dfs \[COMMAND \[COMMAND\_OPTIONS\]\]

在 Hadoop 支持的文件系统上运行 filesystem 命令。可以在[文件系统指南][Link 1]中找到各种COMMAND\_OPTIONS。

### envvars ###

> Usage: hdfs envvars

显示计算的Hadoop环境变量。

### fetchdt ###

> Usage: hdfs fetchdt <opts> <token\_file\_path>

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>--webservice&nbsp;<em>NN_Url</em></td> 
   <td>连接NN的Url(从http或https开始)</td> 
  </tr> 
  <tr> 
   <td>--renewer&nbsp;<em>name</em></td> 
   <td>授权令牌续订者的名称</td> 
  </tr> 
  <tr> 
   <td>--cancel</td> 
   <td>取消授权令牌</td> 
  </tr> 
  <tr> 
   <td>--renew</td> 
   <td>更新授权令牌。必须使用-renewer name选项获取委托令牌。</td> 
  </tr> 
  <tr> 
   <td>--print</td> 
   <td>打印委托令牌</td> 
  </tr> 
  <tr> 
   <td><em>token_file_path</em></td> 
   <td>用于存储令牌的文件路径。</td> 
  </tr> 
 </tbody> 
</table>

从 NameNode 获取委托令牌。更多信息见 fetchdt。

### fsck ###

> Usage:
> 
>     hdfs fsck <path>
>               [-list-corruptfileblocks |
>               [-move | -delete | -openforwrite]
>               [-files [-blocks [-locations | -racks | -replicaDetails | -upgradedomains]]]
>               [-includeSnapshots] [-showprogress]
>               [-storagepolicies] [-maintenance]
>               [-blockId <blk_Id>]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><em>path</em></td> 
   <td>从这个路径开始检查。</td> 
  </tr> 
  <tr> 
   <td>-delete</td> 
   <td>删除损坏的文件。</td> 
  </tr> 
  <tr> 
   <td>-files</td> 
   <td>打印被检查的文件。</td> 
  </tr> 
  <tr> 
   <td>-files&nbsp;-blocks</td> 
   <td>打印出块报告</td> 
  </tr> 
  <tr> 
   <td>-files&nbsp;-blocks&nbsp;-locations</td> 
   <td>打印出每个块的位置。</td> 
  </tr> 
  <tr> 
   <td>-files&nbsp;-blocks&nbsp;-racks</td> 
   <td>打印出数据节点位置的网络拓扑。</td> 
  </tr> 
  <tr> 
   <td>-files&nbsp;-blocks&nbsp;-replicaDetails</td> 
   <td>打印出每个副本细节。</td> 
  </tr> 
  <tr> 
   <td>-files&nbsp;-blocks&nbsp;-upgradedomains</td> 
   <td>打印出每个块的升级域。</td> 
  </tr> 
  <tr> 
   <td>-includeSnapshots</td> 
   <td>如果给定路径指示一个可快照目录，或者该目录下有可快照目录，则包含快照数据。</td> 
  </tr> 
  <tr> 
   <td>-list-corruptfileblocks</td> 
   <td>打印出丢失的块和他们所属的文件的列表。</td> 
  </tr> 
  <tr> 
   <td>-move</td> 
   <td>移动损坏的文件到 /lost+found.</td> 
  </tr> 
  <tr> 
   <td>-openforwrite</td> 
   <td>打印文件打开写。</td> 
  </tr> 
  <tr> 
   <td>-showprogress</td> 
   <td>在输出过程中打印出点。默认是关闭的(没有进展)。</td> 
  </tr> 
  <tr> 
   <td>-storagepolicies</td> 
   <td>打印出这些块的存储策略摘要。</td> 
  </tr> 
  <tr> 
   <td>-maintenance</td> 
   <td>打印维护状态节点的详细信息。</td> 
  </tr> 
  <tr> 
   <td>-blockId</td> 
   <td>打印出有关块的信息。</td> 
  </tr> 
 </tbody> 
</table>

运行 HDFS 文件系统检查实用程序。更多信息见 fsck。

### getconf ###

> Usage:
> 
>     hdfs getconf -namenodes
>        hdfs getconf -secondaryNameNodes
>        hdfs getconf -backupNodes
>        hdfs getconf -journalNodes
>        hdfs getconf -includeFile
>        hdfs getconf -excludeFile
>        hdfs getconf -nnRpcAddresses
>        hdfs getconf -confKey [key]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-namenodes</td> 
   <td>获取集群中的namenode列表。</td> 
  </tr> 
  <tr> 
   <td>-secondaryNameNodes</td> 
   <td>获取集群中的辅助名称节点列表。</td> 
  </tr> 
  <tr> 
   <td>-backupNodes</td> 
   <td>获取集群中备份节点的列表。</td> 
  </tr> 
  <tr> 
   <td>-journalNodes</td> 
   <td>获取群集中的日志节点列表。</td> 
  </tr> 
  <tr> 
   <td>-includeFile</td> 
   <td>获取定义可以加入集群的 DataNode 的包含文件路径。</td> 
  </tr> 
  <tr> 
   <td>-excludeFile</td> 
   <td>获取定义需要退役的 DataNode 的排除文件路径。</td> 
  </tr> 
  <tr> 
   <td>-nnRpcAddresses</td> 
   <td>获取namenode rpc地址</td> 
  </tr> 
  <tr> 
   <td>-confKey&nbsp;[key]</td> 
   <td>从配置中获取特定密钥</td> 
  </tr> 
 </tbody> 
</table>

从配置目录获取配置信息，进行后处理。

### groups ###

> Usage: hdfs groups \[username ...\]

返回给定一个或多个用户名的组信息。

### httpfs ###

> Usage: hdfs httpfs

运行HttpFS服务器，HDFS HTTP网关。

### lsSnapshottableDir ###

> Usage: hdfs lsSnapshottableDir \[-help\]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-help</td> 
   <td>print help</td> 
  </tr> 
 </tbody> 
</table>

获取可快照目录列表。当它作为超级用户运行时，它返回所有可快照目录。否则，它将返回当前用户所拥有的目录。

### jmxget ###

> Usage: hdfs jmxget \[-localVM ConnectorURL | -port port | -server mbeanserver | -service service\]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-help</td> 
   <td>print help</td> 
  </tr> 
  <tr> 
   <td>-localVM&nbsp;ConnectorURL</td> 
   <td>连接到同一台机器上的VM</td> 
  </tr> 
  <tr> 
   <td>-port&nbsp;<em>mbean server port</em></td> 
   <td>指定mbean服务器端口，如果缺少，它将尝试连接到同一VM中的mbean服务器</td> 
  </tr> 
  <tr> 
   <td>-server</td> 
   <td>specify mbean server (localhost by default)</td> 
  </tr> 
  <tr> 
   <td>-service&nbsp;NameNode|DataNode</td> 
   <td>specify jmx service. NameNode by default.</td> 
  </tr> 
 </tbody> 
</table>

从服务转储JMX信息。

### oev ###

> Usage: hdfs oev \[OPTIONS\] -i INPUT\_FILE -o OUTPUT\_FILE

所需命令行参数:

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-i,--inputFile&nbsp;<em>arg</em></td> 
   <td>编辑文件处理，xml(不区分大小写)扩展意味着xml格式，任何其他文件名意味着二进制格式</td> 
  </tr> 
  <tr> 
   <td>-o,--outputFile&nbsp;<em>arg</em></td> 
   <td>输出文件的名称。如果指定的文件存在，它将被覆盖，文件的格式由-p选项决定</td> 
  </tr> 
 </tbody> 
</table>

可选命令行参数:

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-f,--fix-txids</td> 
   <td>在输入中重新编号事务id，以便不存在空白或无效的事务id。</td> 
  </tr> 
  <tr> 
   <td>-h,--help</td> 
   <td>显示使用信息并退出</td> 
  </tr> 
  <tr> 
   <td>-r,--recover</td> 
   <td>当读取二进制编辑日志时，使用恢复模式。这将使您有机会跳过编辑日志中损坏的部分。</td> 
  </tr> 
  <tr> 
   <td>-p,--processor&nbsp;<em>arg</em></td> 
   <td>选择对图像文件应用的处理器类型，当前支持的处理器有:二进制(Hadoop使用的原生二进制格式)、xml(默认为xml格式)、stats(打印关于编辑文件的统计信息)</td> 
  </tr> 
  <tr> 
   <td>-v,--verbose</td> 
   <td>更详细的输出，打印输入和输出文件名，对于写文件的处理器，也输出到屏幕。对于大型图像文件，这将极大地增加处理时间(默认为false)。</td> 
  </tr> 
 </tbody> 
</table>

Hadoop offline edits viewer. See [Offline Edits Viewer Guide][] for more info.Hadoop离线编辑查看器。更多信息请参见离线编辑查看器指南。

### oiv ###

> Usage: hdfs oiv \[OPTIONS\] -i INPUT\_FILE

Required command line arguments:

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-i|--inputFile&nbsp;<em>input file</em></td> 
   <td>指定要处理的输入fsimage文件(如果使用reverse exml处理器，则为XML文件)。</td> 
  </tr> 
 </tbody> 
</table>

Optional command line arguments:

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-o,--outputFile&nbsp;<em>output file</em></td> 
   <td>如果指定的输出处理程序生成输出文件名，则指定输出文件名。如果指定的文件已经存在，则会以静默方式覆盖它。(默认情况下输出到stdout)如果输入文件是XML文件，它还创建一个&lt;outputFile&gt;.md5。</td> 
  </tr> 
  <tr> 
   <td>-p,--processor&nbsp;<em>processor</em></td> 
   <td>指定要应用于映像文件的映像处理器。当前有效的选项是Web(默认)、XML、Delimited、FileDistribution和ReverseXML。</td> 
  </tr> 
  <tr> 
   <td>-addr&nbsp;<em>address</em></td> 
   <td>指定要监听的地址(主机:端口)。在默认情况下(localhost: 5978)。此选项用于Web处理器。</td> 
  </tr> 
  <tr> 
   <td>-maxSize&nbsp;<em>size</em></td> 
   <td>指定要分析的文件大小的范围[0,maxSize]，以字节为单位(默认为128GB)。此选项用于文件分发处理器。</td> 
  </tr> 
  <tr> 
   <td>-step&nbsp;<em>size</em></td> 
   <td>以字节为单位指定分布的粒度(默认为2MB)。此选项用于文件分发处理器。</td> 
  </tr> 
  <tr> 
   <td>-format</td> 
   <td>以人类可读的方式(而不是字节数)格式化输出结果。(默认错误)。此选项用于文件分发处理器。</td> 
  </tr> 
  <tr> 
   <td>-delimiter&nbsp;<em>arg</em></td> 
   <td>在带分隔符的处理程序中使用的分隔字符串。</td> 
  </tr> 
  <tr> 
   <td>-t,--temp&nbsp;<em>temporary dir</em></td> 
   <td>使用临时dir缓存中间结果以生成带分隔符的输出。如果没有设置，分隔符处理器将在输出文本之前在内存中构造名称空间。</td> 
  </tr> 
  <tr> 
   <td>-h,--help</td> 
   <td>显示工具使用情况和帮助信息并退出。</td> 
  </tr> 
 </tbody> 
</table>

Hadoop Offline Image Viewer for image files in Hadoop 2.4 or up. See [Offline Image Viewer Guide][] for more info.

### oiv\_legacy ###

> Usage: hdfs oiv\_legacy \[OPTIONS\] -i INPUT\_FILE -o OUTPUT\_FILE

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-i,--inputFile&nbsp;<em>input file</em></td> 
   <td>指定要处理的输入fsimage文件。</td> 
  </tr> 
  <tr> 
   <td>-o,--outputFile&nbsp;<em>output file</em></td> 
   <td>如果指定的输出处理程序生成输出文件名，则指定输出文件名。如果指定的文件已经存在，则会以静默方式覆盖它。</td> 
  </tr> 
 </tbody> 
</table>

Optional command line arguments:

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-p|--processor&nbsp;<em>processor</em></td> 
   <td>指定要应用于映像文件的映像处理器。有效的选项是Ls(默认)、XML、分隔符、缩进、文件分发和名称分发。</td> 
  </tr> 
  <tr> 
   <td>-maxSize&nbsp;<em>size</em></td> 
   <td>指定要分析的文件大小的范围[0,maxSize]，以字节为单位(默认为128GB)。此选项用于文件分发处理器。</td> 
  </tr> 
  <tr> 
   <td>-step&nbsp;<em>size</em></td> 
   <td>以字节为单位指定分布的粒度(默认为2MB)。此选项用于文件分发处理器。</td> 
  </tr> 
  <tr> 
   <td>-format</td> 
   <td>以人类可读的方式(而不是字节数)格式化输出结果。(默认错误)。此选项用于文件分发处理器。</td> 
  </tr> 
  <tr> 
   <td>-skipBlocks</td> 
   <td>不要枚举文件中的单个块。对于非常大的文件，这可以节省名称空间上的处理时间和外文件空间。Ls处理器读取块以正确确定文件大小并忽略此选项。</td> 
  </tr> 
  <tr> 
   <td>-printToScreen</td> 
   <td>处理程序的管道输出到控制台以及指定的文件。在非常大的名称空间上，这可能会使处理时间增加一个数量级。</td> 
  </tr> 
  <tr> 
   <td>-delimiter&nbsp;<em>arg</em></td> 
   <td>与带分隔符的处理器一起使用时，将默认制表符分隔符替换为由arg指定的字符串。</td> 
  </tr> 
  <tr> 
   <td>-h|--help</td> 
   <td>Display the tool usage and help information and exit.</td> 
  </tr> 
 </tbody> 
</table>

旧版本的Hadoop离线图像查看器。See [oiv\_legacy Command][oiv_legacy Command] for more info.旧版本的Hadoop离线图像查看器。更多信息请参见oiv\_legacy命令。

### snapshotDiff ###

> Usage: hdfs snapshotDiff <path> <fromSnapshot> <toSnapshot>

确定HDFS快照之间的区别。See the [HDFS Snapshot Documentation][] for more information.有关更多信息，请参阅HDFS快照文档。

### version ###

> Usage: hdfs version

Prints the version.

## Administration Commands ##

对hadoop集群的管理员有用的命令。

### balancer ###

> Usage:
> 
>     hdfs balancer
>               [-policy <policy>]
>               [-threshold <threshold>]
>               [-exclude [-f <hosts-file> | <comma-separated list of hosts>]]
>               [-include [-f <hosts-file> | <comma-separated list of hosts>]]
>               [-source [-f <hosts-file> | <comma-separated list of hosts>]]
>               [-blockpools <comma-separated list of blockpool ids>]
>               [-idleiterations <idleiterations>]
>               [-runDuringUpgrade]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-policy&nbsp;&lt;policy&gt;</td> 
   <td>datanode(默认):如果每个datanode都是平衡的，那么集群就是平衡的。<br> 块池:如果每个datanode中的块池都是平衡的，那么集群就是平衡的。</td> 
  </tr> 
  <tr> 
   <td>-threshold&nbsp;&lt;threshold&gt;</td> 
   <td>磁盘容量百分比。这将覆盖默认阈值。</td> 
  </tr> 
  <tr> 
   <td>-exclude -f&nbsp;&lt;hosts-file&gt; | &lt;comma-separated list of hosts&gt;</td> 
   <td>Excludes the specified datanodes from being balanced by the balancer.</td> 
  </tr> 
  <tr> 
   <td>-include -f&nbsp;&lt;hosts-file&gt; | &lt;comma-separated list of hosts&gt;</td> 
   <td>Includes only the specified datanodes to be balanced by the balancer.</td> 
  </tr> 
  <tr> 
   <td>-source -f&nbsp;&lt;hosts-file&gt; | &lt;comma-separated list of hosts&gt;</td> 
   <td>Pick only the specified datanodes as source nodes.</td> 
  </tr> 
  <tr> 
   <td>-blockpools&nbsp;&lt;comma-separated list of blockpool ids&gt;</td> 
   <td>The balancer will only run on blockpools included in this list.</td> 
  </tr> 
  <tr> 
   <td>-idleiterations&nbsp;&lt;iterations&gt;</td> 
   <td>Maximum number of idle iterations before exit. This overwrites the default idleiterations(5).</td> 
  </tr> 
  <tr> 
   <td>-runDuringUpgrade</td> 
   <td>Whether to run the balancer during an ongoing HDFS upgrade. This is usually not desired since it will not affect used space on over-utilized machines.</td> 
  </tr> 
  <tr> 
   <td>-h|--help</td> 
   <td>Display the tool usage and help information and exit.</td> 
  </tr> 
 </tbody> 
</table>

运行一个集群平衡实用程序。管理员只需按下Ctrl-C就可以停止重新平衡过程。See [Balancer][] for more details.

注意块池策略比datanode策略更严格。

除了上面的命令选项之外，从2.7.0开始还引入了一个固定特性，以防止某些副本被均衡器/移动器移动。默认情况下该固定功能是禁用的，可以通过配置属性" dfs.datanode.block-pinning.enabled "启用。当启用时，该特性只影响写入create()调用中指定的优先节点的块。**当我们希望为 HBase regionserver 等应用程序维护数据局部性时，该特性非常有用。**

### cacheadmin ###

> Usage:
> 
>     hdfs cacheadmin [-addDirective -path <path> -pool <pool-name> [-force] [-replication <replication>] [-ttl <time-to-live>]]
>     hdfs cacheadmin [-modifyDirective -id <id> [-path <path>] [-force] [-replication <replication>] [-pool <pool-name>] [-ttl <time-to-live>]]
>     hdfs cacheadmin [-listDirectives [-stats] [-path <path>] [-pool <pool>] [-id <id>]]
>     hdfs cacheadmin [-removeDirective <id>]
>     hdfs cacheadmin [-removeDirectives -path <path>]
>     hdfs cacheadmin [-addPool <name> [-owner <owner>] [-group <group>] [-mode <mode>] [-limit <limit>] [-maxTtl <maxTtl>]]
>     hdfs cacheadmin [-modifyPool <name> [-owner <owner>] [-group <group>] [-mode <mode>] [-limit <limit>] [-maxTtl <maxTtl>]]
>     hdfs cacheadmin [-removePool <name>]
>     hdfs cacheadmin [-listPools [-stats] [<name>]]
>     hdfs cacheadmin [-help <command-name>]

See the [HDFS Cache Administration Documentation][] for more information.

### crypto ###

> Usage:
> 
>     hdfs crypto -createZone -keyName <keyName> -path <path>
>       hdfs crypto -listZones
>       hdfs crypto -provisionTrash -path <path>
>       hdfs crypto -help <command-name>

See the [HDFS Transparent Encryption Documentation][] for more information.

### datanode ###

> Usage: hdfs datanode \[-regular | -rollback | -rollingupgrade rollback\]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-regular</td> 
   <td>Normal datanode startup (default).</td> 
  </tr> 
  <tr> 
   <td>-rollback</td> 
   <td>Rollback the datanode to the previous version. This should be used after stopping the datanode and distributing the old hadoop version.</td> 
  </tr> 
  <tr> 
   <td>-rollingupgrade&nbsp;rollback</td> 
   <td>Rollback a rolling upgrade operation.</td> 
  </tr> 
 </tbody> 
</table>

Runs a HDFS datanode.

### dfsadmin ###

> Usage:
> 
>     hdfs dfsadmin [-report [-live] [-dead] [-decommissioning] [-enteringmaintenance] [-inmaintenance]]
>         hdfs dfsadmin [-safemode enter | leave | get | wait | forceExit]
>         hdfs dfsadmin [-saveNamespace [-beforeShutdown]]
>         hdfs dfsadmin [-rollEdits]
>         hdfs dfsadmin [-restoreFailedStorage true |false |check]
>         hdfs dfsadmin [-refreshNodes]
>         hdfs dfsadmin [-setQuota <quota> <dirname>...<dirname>]
>         hdfs dfsadmin [-clrQuota <dirname>...<dirname>]
>         hdfs dfsadmin [-setSpaceQuota <quota> [-storageType <storagetype>] <dirname>...<dirname>]
>         hdfs dfsadmin [-clrSpaceQuota [-storageType <storagetype>] <dirname>...<dirname>]
>         hdfs dfsadmin [-finalizeUpgrade]
>         hdfs dfsadmin [-rollingUpgrade [<query> |<prepare> |<finalize>]]
>         hdfs dfsadmin [-upgrade [query | finalize]
>         hdfs dfsadmin [-refreshServiceAcl]
>         hdfs dfsadmin [-refreshUserToGroupsMappings]
>         hdfs dfsadmin [-refreshSuperUserGroupsConfiguration]
>         hdfs dfsadmin [-refreshCallQueue]
>         hdfs dfsadmin [-refresh <host:ipc_port> <key> [arg1..argn]]
>         hdfs dfsadmin [-reconfig <namenode|datanode> <host:ipc_port> <start |status |properties>]
>         hdfs dfsadmin [-printTopology]
>         hdfs dfsadmin [-refreshNamenodes datanodehost:port]
>         hdfs dfsadmin [-getVolumeReport datanodehost:port]
>         hdfs dfsadmin [-deleteBlockPool datanode-host:port blockpoolId [force]]
>         hdfs dfsadmin [-setBalancerBandwidth <bandwidth in bytes per second>]
>         hdfs dfsadmin [-getBalancerBandwidth <datanode_host:ipc_port>]
>         hdfs dfsadmin [-fetchImage <local directory>]
>         hdfs dfsadmin [-allowSnapshot <snapshotDir>]
>         hdfs dfsadmin [-disallowSnapshot <snapshotDir>]
>         hdfs dfsadmin [-shutdownDatanode <datanode_host:ipc_port> [upgrade]]
>         hdfs dfsadmin [-evictWriters <datanode_host:ipc_port>]
>         hdfs dfsadmin [-getDatanodeInfo <datanode_host:ipc_port>]
>         hdfs dfsadmin [-metasave filename]
>         hdfs dfsadmin [-triggerBlockReport [-incremental] <datanode_host:ipc_port>]
>         hdfs dfsadmin [-listOpenFiles [-blockingDecommission] [-path <path>]]
>         hdfs dfsadmin [-help [cmd]]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-report&nbsp;[-live]&nbsp;[-dead]&nbsp;[-decommissioning]&nbsp;[-enteringmaintenance]&nbsp;[-inmaintenance]</td> 
   <td>报告基本的文件系统信息和统计信息，dfs的使用可能不同于“du”的使用，因为它测量所有DNs上的复制、校验和、快照等所使用的原始空间。可选标志可用于筛选显示的 DataNode 列表。</td> 
  </tr> 
  <tr> 
   <td>-safemode&nbsp;enter|leave|get|wait|forceExit</td> 
   <td>安全模式维护命令。安全模式是一种Namenode状态<br> 1. 不接受对名称空间的更改(只读)<br> 2. 不复制或删除块。<br> 安全模式在 Namenode 启动时自动输入，当配置的最小块百分比满足最小复制条件时自动离开安全模式。如果 Namenode 检测到任何异常，那么它将停留在安全模式中，直到问题得到解决。如果异常是故意操作的结果，那么管理员可以使用 -safemode forceExit 退出安全模式。 可能需要强制出口的情况是<br> 1. Namenode 元数据不一致。如果 Namenode 检测到元数据在带外被修改，并且可能导致数据丢失，那么 Namenode 将进入 forceExit 状态。此时，用户可以使用正确的元数据文件或forceExit(如果可以接受数据丢失的话)重新启动 Namenode。<br> 2. 回滚会导致元数据被替换，而且它很少会触发 Namenode 中的安全模式 forceExit 状态。在这种情况下，您可以继续通过发行 -safemode forceExit。<br> 安全模式也可以手动输入，但也只能手动关闭。</td> 
  </tr> 
  <tr> 
   <td>-saveNamespace&nbsp;[-beforeShutdown]</td> 
   <td>将当前名称空间保存到存储目录中并重置编辑日志。需要安全模式。如果提供了“beforeShutdown”选项，则 NameNode 只有在一个时间窗口(可配置的检查点周期数量)内没有执行检查点时才执行检查点。这通常在关闭 NameNode 之前使用，以防止潜在的 fsimage/editlog 损坏。</td> 
  </tr> 
  <tr> 
   <td>-rollEdits</td> 
   <td>滚动活动 NameNode 上的编辑日志。</td> 
  </tr> 
  <tr> 
   <td>-restoreFailedStorage&nbsp;true|false|check</td> 
   <td>此选项将打开/关闭自动尝试恢复失败的存储副本。如果失败的存储重新可用，系统将尝试在检查点期间恢复 edit和/或 fsimage。“检查”选项将返回当前设置。</td> 
  </tr> 
  <tr> 
   <td>-refreshNodes</td> 
   <td>重新读取主机并排除文件，以更新允许连接到 Namenode 的 DataNode，以及应该退役或重新启用的 DataNode 集。</td> 
  </tr> 
  <tr> 
   <td>-setQuota&nbsp;&lt;quota&gt; &lt;dirname&gt;…&lt;dirname&gt;</td> 
   <td>See&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsQuotaAdminGuide.html#Administrative_Commands" rel="nofollow">HDFS Quotas Guide</a>&nbsp;for the detail.</td> 
  </tr> 
  <tr> 
   <td>-clrQuota&nbsp;&lt;dirname&gt;…&lt;dirname&gt;</td> 
   <td>See&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsQuotaAdminGuide.html#Administrative_Commands" rel="nofollow">HDFS Quotas Guide</a>&nbsp;for the detail.</td> 
  </tr> 
  <tr> 
   <td>-setSpaceQuota&nbsp;&lt;quota&gt;&nbsp;[-storageType &lt;storagetype&gt;]&nbsp;&lt;dirname&gt;…&lt;dirname&gt;</td> 
   <td>See&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsQuotaAdminGuide.html#Administrative_Commands" rel="nofollow">HDFS Quotas Guide</a>&nbsp;for the detail.</td> 
  </tr> 
  <tr> 
   <td>-clrSpaceQuota&nbsp;[-storageType &lt;storagetype&gt;]&nbsp;&lt;dirname&gt;…&lt;dirname&gt;</td> 
   <td>See&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsQuotaAdminGuide.html#Administrative_Commands" rel="nofollow">HDFS Quotas Guide</a>&nbsp;for the detail.</td> 
  </tr> 
  <tr> 
   <td>-finalizeUpgrade</td> 
   <td>完成 HDFS 的升级。datanode 删除它们以前版本的工作目录，Namenode 也这样做。这样升级过程就完成了。</td> 
  </tr> 
  <tr> 
   <td>-rollingUpgrade&nbsp;[&lt;query&gt;|&lt;prepare&gt;|&lt;finalize&gt;]</td> 
   <td>See&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsRollingUpgrade.html#dfsadmin_-rollingUpgrade" rel="nofollow">Rolling Upgrade document</a>&nbsp;for the detail.</td> 
  </tr> 
  <tr> 
   <td>-upgrade&nbsp;query|finalize</td> 
   <td>查询当前升级状态。<br> HDFS的Finalize升级(相当于-finalizeUpgrade)。</td> 
  </tr> 
  <tr> 
   <td>-refreshServiceAcl</td> 
   <td>重新加载服务级别授权策略文件。</td> 
  </tr> 
  <tr> 
   <td>-refreshUserToGroupsMappings</td> 
   <td>Refresh user-to-groups mappings.</td> 
  </tr> 
  <tr> 
   <td>-refreshSuperUserGroupsConfiguration</td> 
   <td>Refresh superuser proxy groups mappings</td> 
  </tr> 
  <tr> 
   <td>-refreshCallQueue</td> 
   <td>Reload the call queue from config.</td> 
  </tr> 
  <tr> 
   <td>-refresh&nbsp;&lt;host:ipc_port&gt; &lt;key&gt; [arg1..argn]</td> 
   <td>在&lt;host:ipc_port&gt;上，触发&lt;key&gt;指定的资源的运行时刷新。之后所有其他参数被发送到主机。</td> 
  </tr> 
  <tr> 
   <td>-reconfig&nbsp;&lt;datanode |namenode&gt; &lt;host:ipc_port&gt; &lt;start|status|properties&gt;</td> 
   <td>启动“重新配置”或获取正在进行的重新配置的状态，或获取可重新配置属性的列表。第二个参数指定节点类型。</td> 
  </tr> 
  <tr> 
   <td>-printTopology</td> 
   <td>打印Namenode报告的机架及其节点的树</td> 
  </tr> 
  <tr> 
   <td>-refreshNamenodes&nbsp;datanodehost:port</td> 
   <td>对于给定的datanode，重新加载配置文件，停止为已删除的块池提供服务，并开始为新的块池提供服务。</td> 
  </tr> 
  <tr> 
   <td>-getVolumeReport&nbsp;datanodehost:port</td> 
   <td>For the given datanode, get the volume report.</td> 
  </tr> 
  <tr> 
   <td>-deleteBlockPool&nbsp;datanode-host:port blockpoolId [force]</td> 
   <td>如果传递了 force，则删除给定 datanode 上给定块池id的块池目录及其内容，否则仅在目录为空时才删除该目录。如果 datanode 仍在为块池服务，则命令将失败。请参考 refreshnamenode 来关闭 datanode 上的块池服务。</td> 
  </tr> 
  <tr> 
   <td>-setBalancerBandwidth&nbsp;&lt;bandwidth in bytes per second&gt;</td> 
   <td>更改每个 datanode 在 HDFS 块平衡期间使用的网络带宽。&lt;bandwidth&gt;是每个 datanode 每秒使用的最大字节数。此值将覆盖dfs.datanode.balance。bandwidthPerSec参数。注意:新值在DataNode上不是持久的。</td> 
  </tr> 
  <tr> 
   <td>-getBalancerBandwidth&nbsp;&lt;datanode_host:ipc_port&gt;</td> 
   <td>获取给定datanode的网络带宽(单位为字节/秒)。这是 datanode 在 HDFS 块平衡期间使用的最大网络带宽。</td> 
  </tr> 
  <tr> 
   <td>-fetchImage&nbsp;&lt;local directory&gt;</td> 
   <td>从NameNode下载最新的fsimage，并将其保存在指定的本地目录中。</td> 
  </tr> 
  <tr> 
   <td>-allowSnapshot&nbsp;&lt;snapshotDir&gt;</td> 
   <td>允许创建目录的快照。如果操作成功完成，则该目录将变为 snapshottable。See the&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsSnapshots.html" rel="nofollow">HDFS Snapshot Documentation</a>&nbsp;for more information.</td> 
  </tr> 
  <tr> 
   <td>-disallowSnapshot&nbsp;&lt;snapshotDir&gt;</td> 
   <td>不允许创建目录的快照。在禁止快照之前，必须删除目录的所有快照。See the&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsSnapshots.html" rel="nofollow">HDFS Snapshot Documentation</a>&nbsp;for more information.</td> 
  </tr> 
  <tr> 
   <td>-shutdownDatanode&nbsp;&lt;datanode_host:ipc_port&gt; [upgrade]</td> 
   <td>为给定的datanode提交关闭请求。See&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsRollingUpgrade.html#dfsadmin_-shutdownDatanode" rel="nofollow">Rolling Upgrade document</a>&nbsp;for the detail.</td> 
  </tr> 
  <tr> 
   <td>-evictWriters&nbsp;&lt;datanode_host:ipc_port&gt;</td> 
   <td>使datanode 驱逐所有正在写块的客户端。如果由于写入速度慢而挂起退役操作，这是有用的。</td> 
  </tr> 
  <tr> 
   <td>-getDatanodeInfo&nbsp;&lt;datanode_host:ipc_port&gt;</td> 
   <td>获取关于给定datanode的信息。See&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsRollingUpgrade.html#dfsadmin_-getDatanodeInfo" rel="nofollow">Rolling Upgrade document</a>&nbsp;for the detail.</td> 
  </tr> 
  <tr> 
   <td>-metasave&nbsp;filename</td> 
   <td>在hadoop.log指定的目录中将Namenode的主要数据结构保存为filename。dir属性。如果文件名存在，它将被覆盖。文件名将为以下每个文件包含一行<br> 1. Datanodes heart beating with Namenode<br> 2. Blocks waiting to be replicated<br> 3. Blocks currently being replicated<br> 4. Blocks waiting to be deleted</td> 
  </tr> 
  <tr> 
   <td>-triggerBlockReport&nbsp;[-incremental]&nbsp;&lt;datanode_host:ipc_port&gt;</td> 
   <td>为给定的 datanode 触发一个块报告。如果“incremental”被指定，否则它将是一个完整的块报告。</td> 
  </tr> 
  <tr> 
   <td>-listOpenFiles&nbsp;[-blockingDecommission]&nbsp;[-path &lt;path&gt;]</td> 
   <td>列出 NameNode 当前管理的所有打开的文件，以及访问这些文件的客户机名称和客户机机器。打开的文件列表将根据给定的类型和路径进行过滤。<strong>添加 -blockingDecommission 选项，如果您只想列出正在阻止DataNode退役的打开的文件。</strong></td> 
  </tr> 
  <tr> 
   <td>-help&nbsp;[cmd]</td> 
   <td>Displays help for the given command or all commands if none is specified.</td> 
  </tr> 
 </tbody> 
</table>

Runs a HDFS dfsadmin client.

### dfsrouter ###

> Usage: hdfs dfsrouter

Runs the DFS router. See [Router][] for more info.

### dfsrouteradmin ###

> Usage:
> 
>     hdfs dfsrouteradmin
>           [-add <source> <nameservice1, nameservice2, ...> <destination> [-readonly] [-order HASH|LOCAL|RANDOM|HASH_ALL] -owner <owner> -group <group> -mode <mode>]
>           [-update <source> <nameservice1, nameservice2, ...> <destination> [-readonly] [-order HASH|LOCAL|RANDOM|HASH_ALL] -owner <owner> -group <group> -mode <mode>]
>           [-rm <source>]
>           [-ls <path>]
>           [-setQuota <path> -nsQuota <nsQuota> -ssQuota <quota in bytes or quota size string>]
>           [-clrQuota <path>]
>           [-safemode enter | leave | get]
>           [-nameservice disable | enable <nameservice>]
>           [-getDisabledNameservices]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-add&nbsp;<em>source</em>&nbsp;<em>nameservices</em>&nbsp;<em>destination</em></td> 
   <td>添加挂载表条目，如果存在，则进行更新。</td> 
  </tr> 
  <tr> 
   <td>-update&nbsp;<em>source</em>&nbsp;<em>nameservices</em>&nbsp;<em>destination</em></td> 
   <td>更新挂载表条目，如果不存在则创建一个挂载表条目。</td> 
  </tr> 
  <tr> 
   <td>-rm&nbsp;<em>source</em></td> 
   <td>Remove mount point of specified path.</td> 
  </tr> 
  <tr> 
   <td>-ls&nbsp;<em>path</em></td> 
   <td>列出指定路径下的挂载点。</td> 
  </tr> 
  <tr> 
   <td>-setQuota&nbsp;<em>path</em>&nbsp;-nsQuota&nbsp;<em>nsQuota</em>&nbsp;-ssQuota&nbsp;<em>ssQuota</em></td> 
   <td>设置指定路径的配额。See&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsQuotaAdminGuide.html" rel="nofollow">HDFS Quotas Guide</a>&nbsp;for the quota detail.</td> 
  </tr> 
  <tr> 
   <td>-clrQuota&nbsp;<em>path</em></td> 
   <td>清除给定挂载点的配额。See&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsQuotaAdminGuide.html" rel="nofollow">HDFS Quotas Guide</a>&nbsp;for the quota detail.</td> 
  </tr> 
  <tr> 
   <td>-safemode&nbsp;enter&nbsp;leave&nbsp;get</td> 
   <td>手动设置路由器进入或离开安全模式。选项get将用于验证路由器是否处于安全模式状态。</td> 
  </tr> 
  <tr> 
   <td>-nameservice&nbsp;disable&nbsp;enable&nbsp;<em>nameservice</em></td> 
   <td>禁用/启用来自联合的名称服务。如果禁用，请求将不会转到该名称服务。</td> 
  </tr> 
  <tr> 
   <td>-getDisabledNameservices</td> 
   <td>获取联合中禁用的名称服务。</td> 
  </tr> 
 </tbody> 
</table>

用于管理基于路由器的联合的命令。See [Mount table management][] for more info.

### diskbalancer ###

> Usage:
> 
>     hdfs diskbalancer
>          [-plan <datanode> -fs <namenodeURI>]
>          [-execute <planfile>]
>          [-query <datanode>]
>          [-cancel <planfile>]
>          [-cancel <planID> -node <datanode>]
>          [-report -node <file://> | [<DataNodeID|IP|Hostname>,...]]
>          [-report -node -top <topnum>]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-plan</td> 
   <td>Creates a disbalancer plan</td> 
  </tr> 
  <tr> 
   <td>-execute</td> 
   <td>Executes a given plan on a datanode</td> 
  </tr> 
  <tr> 
   <td>-query</td> 
   <td>Gets the current diskbalancer status from a datanode</td> 
  </tr> 
  <tr> 
   <td>-cancel</td> 
   <td>Cancels a running plan</td> 
  </tr> 
  <tr> 
   <td>-report</td> 
   <td>Reports the volume information from datanode(s)</td> 
  </tr> 
 </tbody> 
</table>

Runs the diskbalancer CLI. See [HDFS Diskbalancer][] for more information on this command.

### ec ###

> Usage:
> 
>     hdfs ec [generic options]
>          [-setPolicy -policy <policyName> -path <path>]
>          [-getPolicy -path <path>]
>          [-unsetPolicy -path <path>]
>          [-listPolicies]
>          [-addPolicies -policyFile <file>]
>          [-listCodecs]
>          [-enablePolicy -policy <policyName>]
>          [-disablePolicy -policy <policyName>]
>          [-help [cmd ...]]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-setPolicy</td> 
   <td>Set a specified ErasureCoding policy to a directory</td> 
  </tr> 
  <tr> 
   <td>-getPolicy</td> 
   <td>Get ErasureCoding policy information about a specified path</td> 
  </tr> 
  <tr> 
   <td>-unsetPolicy</td> 
   <td>Unset an ErasureCoding policy set by a previous call to “setPolicy” on a directory</td> 
  </tr> 
  <tr> 
   <td>-listPolicies</td> 
   <td>列出所有支持的擦除编码策略</td> 
  </tr> 
  <tr> 
   <td>-addPolicies</td> 
   <td>Add a list of erasure coding policies</td> 
  </tr> 
  <tr> 
   <td>-listCodecs</td> 
   <td>获取系统中支持的擦除编码编解码器和编码器的列表</td> 
  </tr> 
  <tr> 
   <td>-enablePolicy</td> 
   <td>Enable an ErasureCoding policy in system</td> 
  </tr> 
  <tr> 
   <td>-disablePolicy</td> 
   <td>Disable an ErasureCoding policy in system</td> 
  </tr> 
 </tbody> 
</table>

Runs the ErasureCoding CLI. See [HDFS ErasureCoding][] for more information on this command.

### haadmin ###

> Usage:
> 
>     hdfs haadmin -transitionToActive <serviceId> [--forceactive]
>         hdfs haadmin -transitionToStandby <serviceId>
>         hdfs haadmin -transitionToObserver <serviceId>
>         hdfs haadmin -failover [--forcefence] [--forceactive] <serviceId> <serviceId>
>         hdfs haadmin -getServiceState <serviceId>
>         hdfs haadmin -getAllServiceState
>         hdfs haadmin -checkHealth <serviceId>
>         hdfs haadmin -help <command>

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-checkHealth</td> 
   <td>检查给定NameNode的运行状况</td> 
  </tr> 
  <tr> 
   <td>-failover</td> 
   <td>在两个 namenode 之间启动故障转移</td> 
  </tr> 
  <tr> 
   <td>-getServiceState</td> 
   <td>确定给定的NameNode是活动的还是备用的</td> 
  </tr> 
  <tr> 
   <td>-getAllServiceState</td> 
   <td>returns the state of all the NameNodes</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>-transitionToActive</td> 
   <td>transition the state of the given NameNode to Active (Warning: No fencing is done)</td> 
  </tr> 
  <tr> 
   <td>-transitionToStandby</td> 
   <td>transition the state of the given NameNode to Standby (Warning: No fencing is done)</td> 
  </tr> 
  <tr> 
   <td>-transitionToObserver</td> 
   <td>将给定NameNode的状态转换为Observer (Warning: No fencing is done)</td> 
  </tr> 
  <tr> 
   <td>-help&nbsp;[cmd]</td> 
   <td>Displays help for the given command or all commands if none is specified.</td> 
  </tr> 
 </tbody> 
</table>

See [HDFS HA with NFS][] or [HDFS HA with QJM][] for more information on this command.

### journalnode ###

> Usage: hdfs journalnode

This comamnd starts a journalnode for use with [HDFS HA with QJM][].

### mover ###

> Usage: hdfs mover \[-p <files/dirs> | -f <local file name>\]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-f&nbsp;&lt;local file&gt;</td> 
   <td>Specify a local file containing a list of HDFS files/dirs to migrate.</td> 
  </tr> 
  <tr> 
   <td>-p&nbsp;&lt;files/dirs&gt;</td> 
   <td>Specify a space separated list of HDFS files/dirs to migrate.</td> 
  </tr> 
 </tbody> 
</table>

Runs the data migration utility. See [Mover][] for more details.

**注意，当省略-p和-f选项时，默认路径是根目录。**

此外，从2.7.0开始引入了一个固定特性，以防止某些副本被均衡器/移动器移动。默认情况下该固定功能是禁用的，可以通过配置属性" dfs.datanode.block-pinning.enabled "启用。当启用时，该特性只影响写入create()调用中指定的优先节点的块。**当我们希望为HBase regionserver等应用程序维护数据局部性时，该特性非常有用。**

### namenode ###

> Usage:
> 
>     hdfs namenode [-backup] |
>               [-checkpoint] |
>               [-format [-clusterid cid ] [-force] [-nonInteractive] ] |
>               [-upgrade [-clusterid cid] [-renameReserved<k-v pairs>] ] |
>               [-upgradeOnly [-clusterid cid] [-renameReserved<k-v pairs>] ] |
>               [-rollback] |
>               [-rollingUpgrade <rollback |started> ] |
>               [-importCheckpoint] |
>               [-initializeSharedEdits] |
>               [-bootstrapStandby [-force] [-nonInteractive] [-skipSharedEditsCheck] ] |
>               [-recover [-force] ] |
>               [-metadataVersion ]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-backup</td> 
   <td>Start backup node.</td> 
  </tr> 
  <tr> 
   <td>-checkpoint</td> 
   <td>Start checkpoint node.</td> 
  </tr> 
  <tr> 
   <td>-format&nbsp;[-clusterid cid]</td> 
   <td>格式化指定的NameNode。它启动NameNode，格式化它，然后关闭它。将抛出NameNodeFormatException，如果名称目录已经存在，并且在集群中禁用了重新格式化。</td> 
  </tr> 
  <tr> 
   <td>-upgrade&nbsp;[-clusterid cid]&nbsp;[-renameReserved&nbsp;&lt;k-v pairs&gt;]</td> 
   <td>在新的Hadoop版本发布后，Namenode应该以upgrade选项启动。</td> 
  </tr> 
  <tr> 
   <td>-upgradeOnly&nbsp;[-clusterid cid]&nbsp;[-renameReserved&nbsp;&lt;k-v pairs&gt;]</td> 
   <td>升级指定的NameNode，然后关闭它。</td> 
  </tr> 
  <tr> 
   <td>-rollback</td> 
   <td>将NameNode回滚到以前的版本。在停止集群并分发旧的Hadoop版本之后，应该使用这个方法。</td> 
  </tr> 
  <tr> 
   <td>-rollingUpgrade&nbsp;&lt;rollback|started&gt;</td> 
   <td>See&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsRollingUpgrade.html#NameNode_Startup_Options" rel="nofollow">Rolling Upgrade document</a>&nbsp;for the detail.</td> 
  </tr> 
  <tr> 
   <td>-importCheckpoint</td> 
   <td>从检查点目录加载映像并将其保存到当前目录中。检查点目录从属性dfs.namenode.checkpoint.dir中读取</td> 
  </tr> 
  <tr> 
   <td>-initializeSharedEdits</td> 
   <td>格式化一个新的共享编辑目录并复制足够的编辑日志段，以便备用的NameNode可以启动。</td> 
  </tr> 
  <tr> 
   <td>-bootstrapStandby&nbsp;[-force]&nbsp;[-nonInteractive]&nbsp;[-skipSharedEditsCheck]</td> 
   <td>允许通过从活动的 NameNode 复制最新的名称空间快照来引导备用的 NameNode 存储目录。在第一次配置HA集群时使用。选项-force或-nonInteractive的含义与namenode -format命令中描述的含义相同。-skipSharedEditsCheck 选项跳过编辑检查，确保我们在共享目录中已经有足够的编辑，可以从活动目录上的最后一个检查点启动。</td> 
  </tr> 
  <tr> 
   <td>-recover&nbsp;[-force]</td> 
   <td>恢复损坏文件系统上丢失的元数据。See&nbsp;<a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html#Recovery_Mode" rel="nofollow">HDFS User Guide</a>&nbsp;for the detail.</td> 
  </tr> 
  <tr> 
   <td>-metadataVersion</td> 
   <td>验证配置的目录是否存在，然后打印软件和映像的元数据版本。</td> 
  </tr> 
 </tbody> 
</table>

Runs the namenode. More info about the upgrade and rollback is at [Upgrade Rollback][].

### nfs3 ###

> Usage: hdfs nfs3

这个comamnd启动NFS3网关，以便与HDFS NFS3服务一起使用。

### portmap ###

> Usage: hdfs portmap

这个comamnd启动RPC端口映射，以便与HDFS NFS3服务一起使用。

### secondarynamenode ###

> Usage: hdfs secondarynamenode \[-checkpoint \[force\]\] | \[-format\] | \[-geteditsize\]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-checkpoint&nbsp;[force]</td> 
   <td>Checkpoints the SecondaryNameNode if EditLog size &gt;= fs.checkpoint.size. If&nbsp;force&nbsp;is used, checkpoint irrespective of EditLog size.</td> 
  </tr> 
  <tr> 
   <td>-format</td> 
   <td>在启动期间格式化本地存储。</td> 
  </tr> 
  <tr> 
   <td>-geteditsize</td> 
   <td>打印 NameNode 上未检查点事务的数量。</td> 
  </tr> 
 </tbody> 
</table>

运行 HDFS secondary namenode

### storagepolicies ###

> Usage:
> 
>     hdfs storagepolicies
>           [-listPolicies]
>           [-setStoragePolicy -path <path> -policy <policy>]
>           [-getStoragePolicy -path <path>]
>           [-unsetStoragePolicy -path <path>]
>           [-satisfyStoragePolicy -path <path>]
>           [-isSatisfierRunning]
>           [-help <command-name>]

列出所有/获取/设置/取消设置存储策略。

### zkfc ###

> Usage: hdfs zkfc \[-formatZK \[-force\] \[-nonInteractive\]\]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-formatZK</td> 
   <td>格式化 Zookeeper 实例。-force：格式化 znode 如果 znode 存在。-nonInteractive：格式 znode 中止如果 znode 存在，除非 -force 选项被指定。</td> 
  </tr> 
  <tr> 
   <td>-h</td> 
   <td>Display help</td> 
  </tr> 
 </tbody> 
</table>

这个 comamnd 启动一个 Zookeeper 故障转移控制器进程，用于与 HDFS HA 和 QJM 一起使用。

## 调试命令 ##

帮助管理员调试 HDFS 问题的有用命令。这些命令仅供高级用户使用。

### verifyMeta ###

> Usage: hdfs debug verifyMeta -meta <metadata-file> \[-block <block-file>\]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-block&nbsp;<em>block-file</em></td> 
   <td>可选参数，用于指定数据节点的本地文件系统上的块文件的绝对路径。</td> 
  </tr> 
  <tr> 
   <td>-meta&nbsp;<em>metadata-file</em></td> 
   <td>数据节点的本地文件系统上的元数据文件的绝对路径。</td> 
  </tr> 
 </tbody> 
</table>

验证 HDFS 元数据和块文件。如果指定了块文件，我们将验证元数据文件中的校验和是否与块文件匹配。

### computeMeta ###

> Usage: hdfs debug computeMeta -block <block-file> -out <output-metadata-file>

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-block&nbsp;<em>block-file</em></td> 
   <td>数据节点的本地文件系统上的块文件的绝对路径。</td> 
  </tr> 
  <tr> 
   <td>-out&nbsp;<em>output-metadata-file</em></td> 
   <td>用于存储块文件的校验和计算结果的输出元数据文件的绝对路径</td> 
  </tr> 
 </tbody> 
</table>

从块文件计算 HDFS 元数据。如果指定了块文件，我们将从块文件中计算校验和，并将其保存到指定的输出元数据文件中。

注意：使用风险自负!如果块文件损坏，你改写了它的元文件，它将在HDFS中显示为‘好’，但你无法读取数据。只有当你100%确定块文件是好的时候才使用。

### recoverLease ###

> Usage: hdfs debug recoverLease -path <path> \[-retries <num-retries>\]

<table> 
 <thead> 
  <tr> 
   <th>COMMAND_OPTION</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>[-path&nbsp;<em>path</em>]</td> 
   <td>恢复租约的HDFS路径</td> 
  </tr> 
  <tr> 
   <td>[-retries&nbsp;<em>num-retries</em>]</td> 
   <td>客户端重试调用recoverLease的次数。默认的重试次数为1。</td> 
  </tr> 
 </tbody> 
</table>

恢复指定路径上的租约。路径必须驻留在HDFS文件系统上。默认的重试次数为1。

[Link 1]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/FileSystemShell.html
[Offline Edits Viewer Guide]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsEditsViewer.html
[Offline Image Viewer Guide]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsImageViewer.html
[oiv_legacy Command]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsImageViewer.html#oiv_legacy_Command
[HDFS Snapshot Documentation]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsSnapshots.html#Get_Snapshots_Difference_Report
[Balancer]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html#Balancer
[HDFS Cache Administration Documentation]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/CentralizedCacheManagement.html#cacheadmin_command-line_interface
[HDFS Transparent Encryption Documentation]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/TransparentEncryption.html#crypto_command-line_interface
[Router]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs-rbf/HDFSRouterFederation.html#Router
[Mount table management]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs-rbf/HDFSRouterFederation.html#Mount_table_management
[HDFS Diskbalancer]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HDFSDiskbalancer.html
[HDFS ErasureCoding]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HDFSErasureCoding.html#Administrative_commands
[HDFS HA with NFS]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithNFS.html#Administrative_commands
[HDFS HA with QJM]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithQJM.html#Administrative_commands
[Mover]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html#Mover_-_A_New_Data_Migration_Tool
[Upgrade Rollback]: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html#Upgrade_and_Rollback