YARN CLI

This section includes the reference documentation for the YARN shell.

All YARN commands are invoked by the bin/yarn script. Running the bin/yarn script without arguments prints the description for all commands.

The script usage is as follows:

$ yarn [SHELL_OPTIONS] COMMAND [GENERIC_OPTIONS] [SUB_COMMAND] [COMMAND_OPTIONS]

YARN has an option parsing framework that employs parsing generic options as well as running classes.

YARN shell basic structure
Field Description

SHELL_OPTIONS

The common set of shell options

GENERIC_OPTIONS

The common set of options supported by multiple commands

COMMAND_OPTIONS

Various commands with their options are described in the following sections

User commands

Used to print application reports, kill application, and manage long running application

Prints applicationattempt reports

Prints the classpath needed to get the Hadoop JAR and the required libraries

Prints container(s) report

Runs a JAR file. Users can bundle their YARN code in a JAR file and execute it using this command

Dumps the container logs

Prints node report(s)

Prints queue information

Displays YARN applications and the resources they consume

Prints the Hadoop version

Displays computed Hadoop environment variables

Administration commands

Gets/sets the log level for a log identified by a qualified class name in the daemon dynamically

Starts the NodeManager

Starts the web proxy server

Starts the ResourceManager

Runs ResourceManager admin client

Updates scheduler configuration. Note, this feature is in alpha phase and is subject to change

Runs Shared Cache Manager admin client

Starts the Shared Cache Manager

Starts the TimeLineServer

Starts the RegistryDNS server

Found a mistake? Seleсt text and press Ctrl+Enter to report it