nodetool help

Returns a synopsis and brief description for each nodetool command.

Synopsis

nodetool [<connection_options>] help
[<command_name>]

Definition

If a parameter has multiple forms, the following reference provides both the short form and long form, separated by a comma.

Connection options

-h, --host hostname: The hostname or IP address of a remote node or nodes. When omitted, the default is the local machine.
-p, --port jmx_port: The JMX port number.
-pw, --password jmxpassword: The JMX password for authenticating with secure JMX. If a password is not provided, you are prompted to enter one.
-pwf, --password-file jmx_password_filepath: The file path to the file that stores JMX authentication credentials.
-u, --username jmx_username: The username for authenticating with secure JMX.

Command arguments

command_name: Name of nodetool command.

Example

Get help for nodetool netstats:

nodetool help netstats

NAME
        nodetool netstats - Print network information on provided host
        (connecting node by default)

SYNOPSIS
        nodetool [(-h <host> | --host <host>)] [(-p <port> | --port <port>)]
                [(-pw <password> | --password <password>)]
                [(-pwf <passwordFilePath> | --password-file <passwordFilePath>)]
                [(-u <username> | --username <username>)] netstats
                [(-H | --human-readable)]

OPTIONS
        -h <host>, --host <host>
            Node hostname or ip address

        -H, --human-readable
            Display bytes in human readable form, i.e. KiB, MiB, GiB, TiB

        -p <port>, --port <port>
            Remote jmx agent port number

        -pw <password>, --password <password>
            Remote jmx agent password

        -pwf <passwordFilePath>, --password-file <passwordFilePath>
            Path to the JMX password file

        -u <username>, --username <username>
            Remote jmx agent username