Apache Hadoop 3.2.1 – YARN Commands https://hadoop.apache.org/docs/stable/hadoop-yarn/hadoop-yarn-site/Ya...

Overview
User Commands
application or app
applicationattempt
classpath
container
jar
logs
node
queue
version
envvars
Administration Commands
daemonlog
nodemanager
proxyserver
resourcemanager
rmadmin
schedulerconf
scmadmin
sharedcachemanager
timelineserver
registrydns
Files

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

Usage: 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.

COMMAND_OPTIONS Description
SHELL_OPTIONS The common set of shell options. These are documented on the Commands Manual page.
GENERIC_OPTIONS The common set of options supported by multiple commands. See the Hadoop Commands
Manual for more information.
COMMAND Various commands with their options are described in the following sections. The commands
COMMAND_OPTIONS have been grouped into User Commands and Administration Commands.

User Commands
Commands useful for users of a Hadoop cluster.

application or app

Usage: yarn application [options] Usage: yarn app [options]

COMMAND_OPTIONS Description
-appId <ApplicationId> Specify Application Id to be operated
-appStates <States> Works with -list to filter applications based on input comma-separated list of application
states. The valid application state can be one of the following: ALL, NEW, NEW_SAVING,
SUBMITTED, ACCEPTED, RUNNING, FINISHED, FAILED, KILLED

1 of 8 10/23/2019, 10:28 PM
Apache Hadoop 3.2.1 – YARN Commands https://hadoop.apache.org/docs/stable/hadoop-yarn/hadoop-yarn-site/Ya...

COMMAND_OPTIONS Description
-appTags <Tags> Works with -list to filter applications based on input comma-separated list of application tags.
-appTypes <Types> Works with -list to filter applications based on input comma-separated list of application types.
-changeQueue <Queue Moves application to a new queue. ApplicationId can be passed using ‘appId’ option.
Name> ‘movetoqueue’ command is deprecated, this new command ‘changeQueue’ performs same
functionality.
-component <Component Works with -flex option to change the number of components/containers running for an
Name> <Count> application / long-running service. Supports absolute or relative changes, such as +1, 2, or
-3.
-components Works with -upgrade option to trigger the upgrade of specified components of the application.
<Components> Multiple components should be separated by commas.
-decommission Decommissions component instances for an application / long-running service. Requires
<Application Name> -instances option. Supports -appTypes option to specify which client implementation to use.
-destroy <Application Destroys a saved application specification and removes all application data permanently.
Name> Supports -appTypes option to specify which client implementation to use.
-enableFastLaunch Uploads AM dependencies to HDFS to make future launches faster. Supports -appTypes option
to specify which client implementation to use.
-flex <Application Name or Changes number of running containers for a component of an application / long-running
ID> service. Requires -component option. If name is provided, appType must be provided unless it
is the default yarn-service. If ID is provided, the appType will be looked up. Supports
-appTypes option to specify which client implementation to use.
-help Displays help for all commands.
-instances <Component Works with -upgrade option to trigger the upgrade of specified component instances of the
Instances> application. Also works with -decommission option to decommission specified component
instances. Multiple instances should be separated by commas.
-kill <Application ID> Kills the application. Set of applications can be provided separated with space
-launch <Application Launches application from specification file (saves specification and starts application).
Name> <File Name> Options -updateLifetime and -changeQueue can be specified to alter the values provided in
the file. Supports -appTypes option to specify which client implementation to use.
-list List applications. Supports optional use of -appTypes to filter applications based on application
type, -appStates to filter applications based on application state and -appTags to filter
applications based on application tag.
-movetoqueue <Application Moves the application to a different queue. Deprecated command. Use ‘changeQueue’ instead.
ID>
-queue <Queue Name> Works with the movetoqueue command to specify which queue to move an application to.
-save <Application Name> Saves specification file for an application. Options -updateLifetime and -changeQueue can be
<File Name> specified to alter the values provided in the file. Supports -appTypes option to specify which
client implementation to use.
-start <Application Name> Starts a previously saved application. Supports -appTypes option to specify which client
implementation to use.
-status <ApplicationId or Prints the status of the application. If app ID is provided, it prints the generic YARN
ApplicationName> application status. If name is provided, it prints the application specific status based on app’s
own implementation, and -appTypes option must be specified unless it is the default yarn-
service type.
-stop <Application Name or Stops application gracefully (may be started again later). If name is provided, appType must
ID> be provided unless it is the default yarn-service. If ID is provided, the appType will be looked
up. Supports -appTypes option to specify which client implementation to use.
-updateLifetime <Timeout> Update timeout of an application from NOW. ApplicationId can be passed using ‘appId’ option.
Timeout value is in seconds.
-updatePriority <Priority> Update priority of an application. ApplicationId can be passed using ‘appId’ option.

Prints application(s) report/kill application/manage long running application

applicationattempt

Usage: yarn applicationattempt [options]

COMMAND_OPTIONS Description

2 of 8 10/23/2019, 10:28 PM
Apache Hadoop 3.2.1 – YARN Commands https://hadoop.apache.org/docs/stable/hadoop-yarn/hadoop-yarn-site/Ya...

COMMAND_OPTIONS Description
-help Help
-list <ApplicationId> Lists applications attempts for the given application.
-status <Application Attempt Id> Prints the status of the application attempt.

prints applicationattempt(s) report

classpath

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

COMMAND_OPTION Description
--glob expand wildcards
--jar path write classpath as manifest in jar named path
-h, --help print help

Prints the class path needed to get the Hadoop jar and the required libraries. If called without arguments, then
prints the classpath set up by the command scripts, which is likely to contain wildcards in the classpath entries.
Additional options print the classpath after wildcard expansion or write the classpath into the manifest of a jar file.
The latter is useful in environments where wildcards cannot be used and the expanded classpath exceeds the
maximum supported command line length.

container

Usage: yarn container [options]

COMMAND_OPTIONS Description
-help Help
-list <Application Attempt Id> Lists containers for the application attempt.
-status <ContainerId> Prints the status of the container.

prints container(s) report

jar

Usage: yarn jar <jar> [mainClass] args...

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

3 of 8 10/23/2019, 10:28 PM
Apache Hadoop 3.2.1 – YARN Commands https://hadoop.apache.org/docs/stable/hadoop-yarn/hadoop-yarn-site/Ya...

logs

Usage: yarn logs -applicationId <application ID> [options]

COMMAND_OPTIONS
-applicationId <application ID>
-appOwner <AppOwner>
-containerId <ContainerId>
-help
-nodeAddress <NodeAddress>
Description
Specifies an application id
AppOwner (assumed to be current user if not specified)
ContainerId (must be specified if node address is specified)
Help
NodeAddress in the format nodename:port (must be specified if container id is specified)

Dump the container logs

node

Usage: yarn node [options]

COMMAND_OPTIONS Description
-all Works with -list to list all nodes.
-list Lists all running nodes. Supports optional use of -states to filter nodes based on node state, and
-all to list all nodes.
-states <States> Works with -list to filter nodes based on input comma-separated list of node states.
-status <NodeId> Prints the status report of the node.

Prints node report(s)

queue

Usage: yarn queue [options]

COMMAND_OPTIONS Description
-help Help
-status <QueueName> Prints the status of the queue.

Prints queue information

version

Usage: yarn version

Prints the Hadoop version.

envvars

Usage: yarn envvars

Display computed Hadoop environment variables.

Administration Commands

4 of 8 10/23/2019, 10:28 PM
Apache Hadoop 3.2.1 – YARN Commands https://hadoop.apache.org/docs/stable/hadoop-yarn/hadoop-yarn-site/Ya...

Commands useful for administrators of a Hadoop cluster.

daemonlog

Get/Set the log level for a Log identified by a qualified class name in the daemon dynamically. See the Hadoop
Commands Manual for more information.

nodemanager

Usage: yarn nodemanager

Start the NodeManager

proxyserver

Usage: yarn proxyserver

Start the web proxy server

resourcemanager

Usage: yarn resourcemanager [-format-state-store]

COMMAND_OPTIONS
-format-state-store
-remove-application-from-state-
store <appId>
Description
Formats the RMStateStore. This will clear the RMStateStore and is useful if past
applications are no longer needed. This should be run only when the ResourceManager is
not running.
Remove the application from RMStateStore. This should be run only when the
ResourceManager is not running.

Start the ResourceManager

rmadmin

Usage:

Usage: yarn rmadmin

-refreshQueues
-refreshNodes [-g|graceful [timeout in seconds] -client|server]
-refreshNodesResources
-refreshSuperUserGroupsConfiguration
-refreshUserToGroupsMappings
-refreshAdminAcls
-refreshServiceAcl
-getGroups [username]
-addToClusterNodeLabels <"label1(exclusive=true),label2(exclusive=false),label3">
-removeFromClusterNodeLabels <label1,label2,label3> (label splitted by ",")
-replaceLabelsOnNode <"node1[:port]=label1,label2 node2[:port]=label1,label2"> [-f
-directlyAccessNodeLabelStore
-refreshClusterMaxPriority
-updateNodeResource [NodeID] [MemSize] [vCores] ([OvercommitTimeout]) or -updateNo
-transitionToActive [--forceactive] <serviceId>
-transitionToStandby <serviceId>

5 of 8 10/23/2019, 10:28 PM
Apache Hadoop 3.2.1 – YARN Commands https://hadoop.apache.org/docs/stable/hadoop-yarn/hadoop-yarn-site/Ya...

-failover [--forcefence] [--forceactive] <serviceId> <serviceId>

-getServiceState <serviceId>
-getAllServiceState
-checkHealth <serviceId>
-help [cmd]

COMMAND_OPTIONS Description
-refreshQueues Reload the queues’ acls, states and scheduler specific
properties. ResourceManager will reload the mapred-queues
configuration file.
-refreshNodes [-g|graceful [timeout in seconds] Refresh the hosts information at the ResourceManager. Here
-client|server] [-g|graceful [timeout in seconds] -client|server] is optional, if
we specify the timeout then ResourceManager will wait for
timeout before marking the NodeManager as decommissioned.
The -client|server indicates if the timeout tracking should be
handled by the client or the ResourceManager. The client-side
tracking is blocking, while the server-side tracking is not.
Omitting the timeout, or a timeout of -1, indicates an infinite
timeout. Known Issue: the server-side tracking will
immediately decommission if an RM HA failover occurs.
-refreshNodesResources Refresh resources of NodeManagers at the ResourceManager.
-refreshSuperUserGroupsConfiguration Refresh superuser proxy groups mappings.
-refreshUserToGroupsMappings Refresh user-to-groups mappings.
-refreshAdminAcls Refresh acls for administration of ResourceManager
-refreshServiceAcl Reload the service-level authorization policy file
ResourceManager will reload the authorization policy file.
-getGroups [username] Get groups the specified user belongs to.
-addToClusterNodeLabels Add to cluster node labels. Default exclusivity is true.
<“label1(exclusive=true),label2(exclusive=false),label3”>
-removeFromClusterNodeLabels <label1,label2,label3> Remove from cluster node labels.
(label splitted by “,”)
-replaceLabelsOnNode <“node1[:port]=label1,label2 Replace labels on nodes (please note that we do not support
node2[:port]=label1,label2”> [-failOnUnknownNodes] specifying multiple labels on a single host for now.)
-failOnUnknownNodes is optional, when we set this option, it
will fail if specified nodes are unknown.
-directlyAccessNodeLabelStore This is DEPRECATED, will be removed in future releases.
Directly access node label store, with this option, all node label
related operations will not connect RM. Instead, they will
access/modify stored node labels directly. By default, it is false
(access via RM). AND PLEASE NOTE: if you configured
yarn.node-labels.fs-store.root-dir to a local directory (instead
of NFS or HDFS), this option will only work when the command
run on the machine where RM is running.
-refreshClusterMaxPriority Refresh cluster max priority
-updateNodeResource [NodeID] [MemSize] [vCores] Update resource on specific node.
([OvercommitTimeout])
-updateNodeResource [NodeID] [ResourceTypes] Update resource types on specific node. Resource Types is
([OvercommitTimeout]) comma-delimited key value pairs of any resources availale at
Resource Manager. For example, memory-
mb=1024Mi,vcores=1,resource1=2G,resource2=4m
-transitionToActive [–forceactive] [–forcemanual] Transitions the service into Active state. Try to make the target
<serviceId> active without checking that there is no active node if the
–forceactive option is used. This command can not be used if
automatic failover is enabled. Though you can override this by
–forcemanual option, you need caution. This command can not
be used if automatic failover is enabled.
-transitionToStandby [–forcemanual] <serviceId> Transitions the service into Standby state. This command can
not be used if automatic failover is enabled. Though you can
override this by –forcemanual option, you need caution.

6 of 8 10/23/2019, 10:28 PM
Apache Hadoop 3.2.1 – YARN Commands https://hadoop.apache.org/docs/stable/hadoop-yarn/hadoop-yarn-site/Ya...

COMMAND_OPTIONS Description
-failover [–forceactive] <serviceId1> <serviceId2> Initiate a failover from serviceId1 to serviceId2. Try to failover
to the target service even if it is not ready if the –forceactive
option is used. This command can not be used if automatic
failover is enabled.
-getServiceState <serviceId> Returns the state of the service.
-getAllServiceState Returns the state of all the services.
-checkHealth <serviceId> Requests that the service perform a health check. The
RMAdmin tool will exit with a non-zero exit code if the check
fails.
-help [cmd] Displays help for the given command or all commands if none
is specified.

Runs ResourceManager admin client

schedulerconf

Usage: yarn schedulerconf [options]

COMMAND_OPTIONS
-add <“queuePath1:key1=val1,key2=val2;
queuePath2:key3=val3”>
-remove <“queuePath1;queuePath2”>
-update
<“queuePath1:key1=val1,key2=val2;
queuePath2:key3=val3”>
-global <key1=val1,key2=val2>
Description
Semicolon separated values of queues to add and their queue
configurations. This example adds queue “queuePath1” (a full path name),
which has queue configurations key1=val1 and key2=val2. It also adds
queue “queuePath2”, which has queue configuration key3=val3.
Semicolon separated queues to remove. This example removes queuePath1
and queuePath2 queues (full path names). Note: Queues must be put into
STOPPED state before they are deleted.
Semicolon separated values of queues whose configurations should be
updated. This example sets key1=val1 and key2=val2 for queue
configuration of queuePath1 (full path name), and sets key3=val3 for queue
configuration of queuePath2.
Update scheduler global configurations. This example sets key1=val1 and
key2=val2 for scheduler’s global configuration.

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

scmadmin

Usage: yarn scmadmin [options]

COMMAND_OPTIONS Description
-help Help
-runCleanerTask Runs the cleaner task

Runs Shared Cache Manager admin client

sharedcachemanager

Usage: yarn sharedcachemanager

Start the Shared Cache Manager

timelineserver

7 of 8 10/23/2019, 10:28 PM
Apache Hadoop 3.2.1 – YARN Commands https://hadoop.apache.org/docs/stable/hadoop-yarn/hadoop-yarn-site/Ya...

Usage: yarn timelineserver

Start the TimeLineServer

registrydns

Usage: yarn registrydns

Start the RegistryDNS server

Files
File Description
etc/hadoop/hadoop- This file stores the global settings used by all Hadoop shell commands.
env.sh
etc/hadoop/yarn-env.sh This file stores overrides used by all YARN shell commands.
etc/hadoop/hadoop- This file allows for advanced users to override some shell functionality.
user-functions.sh
~/.hadooprc This stores the personal environment for an individual user. It is processed after the hadoop-
env.sh, hadoop-user-functions.sh, and yarn-env.sh files and can contain the same settings.

8 of 8 10/23/2019, 10:28 PM