Apache Ignite Tools Documentation

The Apache Ignite Tools Developer Hub

Welcome to the Apache Ignite Tools developer hub. You'll find comprehensive guides and documentation to help you start working with Apache Ignite Tools as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Command Line Interface

Overview

Visor Command Line Interface provides scriptable monitoring capabilities for Ignite. It can be used to get statistics about nodes, caches and tasks in the grid. General details about the topology showing various metrics and node configuration properties can also be viewed here. Visor Command Line Interface also allows you to start and stop remote nodes.

Usage

Ignite ships with IGNITE_HOME/bin/ignitevisorcmd.{sh|bat} script that starts command line management interface.
To get help and get started, type help or ? commands. To connect visor to the grid, type open command.

Commands

The following commands are available in Visor. To get full information on a command, type help "cmd" or ? "cmd".

Command
Alias
Description

ack

Acks arguments on all remote nodes.

alert

Alerts for user-defined events.

cache

Prints cache statistics, clears cache, prints list of all entries from cache.

close

Disconnects Visor console from the grid.

config

Prints node configuration.

deploy

Copies file or folder to remote host.

disco

Prints topology change log.

events

Print events from a node.

gc

Runs GC on remote nodes.

help

?

Prints Visor console help.

kill

Kills or restarts node.

log

Starts or stops grid-wide events logging.

mclear

Clears Visor console memory variables.

mget

Gets Visor console memory variable.

mlist

Prints Visor console memory variables.

node

Prints node statistics.

open

Connects Visor console to the grid.

ping

Pings node.

quit

Quit from Visor console.

start

Starts or restarts nodes on remote hosts.

status

!

Prints Visor console status.

tasks

Prints tasks execution statistics.

top

Prints current topology.

vvm

Opens VisualVM for nodes in topology.