Overview

The AdminTool is a lightweight tool that provides the ability for invoking commands on a running XVM or Application. It is intended primarily for use by developers; usage of Robin or Lumino is recommended for production usecases. The AdminTool discovers running XVMs and connects to them via their advertised store connections. 

Running The Tool 

The AdminTool can be found in the nvx-talon or nvx-core-all jar. And can be invoked as follows: 

... where the libs folder contains the talon jar and its dependencies. The same discovery descriptor used by the XVM must be specified when launching the tool as the AdminTool discovers running XVMs and connects to them via the acceptor that each XVM has broadcast. 

Listing Running XVMs 

The 'xvms' command can be used to see which xvms have been discovered

List Apps in an XVM 

The list of apps loaded in an XVM can be determined as follows: 

List App Commands 

The list of apps loaded in an XVM can be determined using the listAppCommand command as follows. 

Invoking an App Command

A command on an application can be invoked using the invoke command: 

Command Reference

Tool Properties

The following properties can be set using set <Property Name> <Property Value>

Commands

Usage:
  listXvms [-h] 

       [<-h|--help> Displays this help message (default='false')]

            

Usage:
  disconnect [-h] [<xvm>] 

       [<-h|--help> Displays this help message (default='false')]
       [xvm: The XVM in whose connection should be closed (if omitted
           closes all connections) ]

            

Usage:
  connect [-h] <xvm> 

       [<-h|--help> Displays this help message (default='false')]
       xvm: The XVM to connect to. 

            

Usage:
  listAppCommands [-h] -x [-a] [-u] [<filter>] 

       [<-h|--help> Displays this help message (default='false')]
       <-x|--xvm> The XVM in which to list commands
       [<-a|--app> The app whose command to list. If 'admin' or omitted
           then XVM administration commands are listed. (default='admin')]
       [<-u|--usage> Flag that can be specified to additionally show usage
           for the commands. (default='false')]
       [filter: Optionally can be specified to list only commands that
           contain this filter in their name. '*' indicates that all commands
           should be displayed default='*']

            

Usage:
  invoke [-h] [<app>] <xvm> <command> 

       [<-h|--help> Displays this help message (default='false')]
       [app: The app whose command to list. If 'server' or omitted then XVM
           commands are listed. default='admin']
       xvm: The XVM in which to list commands
       command: The name of the command to execute
       [args: The command arguments]

            

Usage:
  admin [-h] <dest> <command> 

       [<-h|--help> Displays this help message (default='false')]
       dest: The app and XVM against which to invoke the command specfied
           as <appName>@<xvmName>.
 The appName can be omitted if the command
           is an XVM command.
       command: The name of the command to execute
       [args: The command arguments]

General Commands

Usage:
  get [-h] [-a] [<propName>] 

       [<-h|--help> Displays this help message (default='false')]
       [<-a|--all> flag indicating that all properties should be listed
           (default='false')]
       [propName: The name of property to get, or with -a, a filter on
           properties to list]

            

Usage:
  reset [-h] <propName> 

       [<-h|--help> Displays this help message (default='false')]
       propName: The name of property to reset. '*' resets all properties
           to their default value.

            

Usage:
  set [-h] [<propName>] [<propValue>] 

       [<-h|--help> Displays this help message (default='false')]
       [propName: The name of property to set, if no name is set config
           properties are listed]
       [propValue: The value of the property to set. If omitted clears the
           property]

            

Usage:
  stacktraces [-h] <enabled> 

       [<-h|--help> Displays this help message (default='false')]
       enabled: <true|false|off|on> Indicates whether or not command
           exceptions should be displayed

            

Usage:
  history [-h] [-c] [<n>] 

       [<-h|--help> Displays this help message (default='false')]
       [<-c|--clear> Clears command history]
       [n: lists only the last 'n' lines default='1000']

            

Usage:
  help [-h] [<command>] 

       [<-h|--help> Displays this help message (default='false')]
       [command: When specifies displays help for that command only]

            

Usage:
  ansi [-h] [<value>] 

       [<-h|--help> Displays this help message (default='false')]
       [value: <off|on> Turns ansi on or off. With no argument display the
           current ansi setting]

            

Usage:
  echo [-h] [<value>] 

       [<-h|--help> Displays this help message (default='false')]
       [value: Displays a message or turns echo on or off. With no argument
           list the current echo setting]
       [message: A message to display default='']

            

Usage:
  script [-h] [<script>] 

       [<-h|--help> Displays this help message (default='false')]
       [script: The script file to execute]

            

Usage:
  bye [-h] 

       [<-h|--help> Displays this help message (default='false')]