GridGain Developers Hub

Visor CMD

Visor Command Line Interface (CLI) provides scriptable monitoring capabilities for GridGain. You can use it to get statistics about nodes, caches, tasks, and information about the topology including various metrics and node configuration properties. CLI also allows you to start and stop remote nodes.

visor cmd

Usage

GridGain ships with the GRIDGAIN_HOME/bin/ignitevisorcmd.{sh|bat} script that starts command line management interface. To get help and get started, type the help or ? commands. To connect Visor to a running cluster, type the 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

Emails alerts for user-defined events.

cache

Prints cache statistics.

close

Disconnects Visor from the cluster.

dash

Opens Visor UI dashboard.

deploy

Copies file or directory to remote host.

disco

Prints topology change log.

events

Prints events from a node.

gc

Runs GC on remote nodes.

help

?

Prints Visor help.

kill

Kills or restarts the node.

license

Shows information about licenses and updates them.

log

Starts or stops cluster-wide events logging.

mclear

Clears Visor memory variables.

mget

Gets Visor memory variable.

mlist

Prints Visor memory variables.

node

Prints node statistics.

open

Connects Visor to the cluster.

ping

Pings the node.

start

Starts or restarts nodes on remote hosts.

status

!

Prints Visor status.

tasks

Prints tasks execution statistics.

top

Prints current topology.

vvm

Opens VisualVM for nodes in topology.

quit

Quits from Visor console.