div

id	toc
class	toc

div

class	tocTitle

In This Section

div

class	tocContents

Table of Contents

maxLevel	2
indent	8px
style	none

Overview

Excerpt
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:

Code Block

language	bash

java -Dnv.discovery.descriptor=<xvm-discovery-descriptor> -cp “libs\*” com.neeve.tools.AdminTool
 
__   __      _____  _            _______ ______ ____  _____  __  __
\ \ / /     |  __ \| |        /\|__   __|  ____/ __ \|  __ \|  \/  |
 \ V /      | |__) | |       /  \  | |  | |__ | |  | | |__) | \  / |
  > <       |  ___/| |      / /\ \ | |  |  __|| |  | |  _  /| |\/| |
 / . \      | |    | |____ / ____ \| |  | |   | |__| | | \ \| |  | |
/_/ \_\     |_|    |______/_/    \_\_|  |_|    \____/|_|  \_\_|  |_|
XVM Admin Tool                             nvx-talon v3.12 (build 7)
                               Copyright(c) 2019 Neeve Research, LLC
                                                 All Rights Reserved
Type 'help' for the list of commands
admin> listXvms

... 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 XV

Code Block

language	bash

java -Dnv.discovery.descriptor=<xvm-discovery-descriptor> -cp “libs\*” com.neeve.tools.AdminTool

Command Reference

Table of Content Zone

location	top

Tool Properties

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

Property Name	Default Value	Description
commandTimeout	30.0s	Sets the timeout to wait for a command response. If no unit suffix is specified the value is interpreted as SECONDS
connectHandshakeTimeout	1.5s	The connect timeout. If no unit suffix is specified the value is interpreted as SECONDS
longCommandDisplayThreshold	5.0s	Commands that take longer than the given time will result in the tool outputting their execution time. If no unit suffix is specified the value is interpreted as SECONDS
stacktraces	false	Whether or not command exception stacktraces should be dumped

Commands

get

Gets a configuration or environment property

listXvms | xvms

Shows available xvms

Usage:
  getlistXvms [-h] [-a]
[<propName>]
         [<-h|--help> Displays this help message (default='false')]

      [<-a|--all> flag indicating that all properties should be listed

disconnect

Closes currently open admin connections

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

       [<-h|--help> Displays this help message (default='false')]
       [propNamexvm: The nameXVM ofin propertywhose toconnection get,should orbe with -a, a filter onclosed (if omitted
           closes all propertiesconnections) to list]

reset

Reset a configuration or environment property to its default value

connect

Connects to an xvm

Usage:
  resetconnect [-h] <propName><xvm> 

       [<-h|--help> Displays this help message (default='false')]
       propNamexvm: The nameXVM ofto propertyconnect to reset. '*'
resets
all properties            to their default value.

set

Sets a configuration or environment property

listAppCommands

List commands for an XVM or an app hosted by a XVM

Usage:
  setlistAppCommands [-h] -x [<propName>-a] [<propValue>-u] [<filter>] 

       [<-h|--help> Displays this help message (default='false')]
       [propName:<-x|--xvm> The nameXVM ofin propertywhich to set,list ifcommands
no name is set config   [<-a|--app> The app whose command to list. If 'admin' propertiesor areomitted
listed]        [propValue: The value ofthen theXVM propertyadministration tocommands setare listed. If omitted clears the(default='admin')]
       [<-u|--usage> Flag that can be specified to property]additionally show usage

stacktraces

Sets whether or not command exception stacktraces should be shown

Usage:
  stacktraces [-h] <enabled> 

       [<-h|--help> Displays this help message (default='false')]for the commands. (default='false')]
       [filter: Optionally can be specified to list only commands that
           contain this filter enabled: <true|false|off|on> Indicates whether or not command
in their name. '*' indicates that all commands
          exceptions should be displayed default='*']

history

invoke

Displays command historySends a command to a XVM or an app hosted by a XVM

Usage:
  historyinvoke [-h] [-c<app>] [<n>]<xvm> <command> 

       [<-h|--help> Displays this help message (default='false')]
       [<-c|--clear> Clears command history]
       [n: lists only the last 'n' lines default='1000']app: The app whose command to list. If 'server' or omitted then XVM
           commands are listed. default='admin']

help

Displays help message

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

  xvm: The XVM in which to list commands
    [<-h|--help> Displays this helpcommand: message (default='false')]
    The name of the command to execute
  [command: When specifies displays help for[args: thatThe command onlyarguments]

ansi

Enables or disables ansi output

admin

Sends a command to a XVM or an app hosted by a XVM

Usage:
  ansiadmin [-h] [<value>]<dest> <command> 

       [<-h|--help> Displays this help message (default='false')]
       [valuedest: <off|on>The Turnsapp ansiand onXVM or off. With no argument display the
against which to invoke the command specfied
           as <appName>@<xvmName>.
 The appName can be omitted if the command
          current ansiis setting]an XVM command.
       command: The name of

echo

Displays a message or turns echo on or off

the command to execute
       [args: The command arguments]

General Commands

get

Gets a configuration or environment property

Usage:
  echoget [-h] [<value>-a] [<propName>] 

       [<-h|--help> Displays this help message (default='false')]
       [value: Displays a message or turns echo on or off. With no argument<-a|--all> flag indicating that all properties should be listed
           (default='false')]
   list the current echo setting][propName: The name of property to get, or [message: A message to display default=''with -a, a filter on
           properties to list]

script

reset

Runs a command scriptReset a configuration or environment property to its default value

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

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

bye | exit | quit

Exit the tool.

Usage:
  bye [-h]property to reset. '*' resets all properties
         [<-h|--help> Displays thisto helptheir message (default='false')]
 value.

listXvms | xvms

Shows available xvms

set

Sets a configuration or environment property

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

       [<-h|--help> Displays this help message (default='false')]
       [propName: The name of property

disconnect

Closes currently open admin connections

Usage:
  disconnect [-h] [<xvm>] to set, if no name is set config
        [<-h|--help> Displays this helpproperties message (default='false')are listed]
       [xvmpropValue: The XVMvalue inof whosethe connectionproperty shouldto beset. closedIf (if omitted clears the
         closes all connections) property]

connect

Connects to an xvm

stacktraces

Sets whether or not command exception stacktraces should be shown

Usage:
  connectstacktraces [-h] <xvm><enabled> 

       [<-h|--help> Displays this help message (default='false')]
       xvmenabled: The XVM to connect to. <true|false|off|on> Indicates whether or not command
           exceptions should

listAppCommands

List commands for an XVM or an app hosted by a XVM

be displayed

history

Displays command history

Usage:
  listAppCommandshistory [-h] -x [-ac] [-u<n>] [<filter>]

        [<-h|--help> Displays this help message (default='false')]
       [<-xc|--xvm>clear> TheClears XVMcommand inhistory]
which to list commands    [n: lists only  [<-a|--app> The app whose command to list. If 'admin' or omittedthe last 'n' lines default='1000']

help

Displays help message

Usage:
  help  then XVM administration commands are listed. [-h] [<command>] 

       [<-h|--help> Displays this help message (default='adminfalse')]
       [<-u|--usage> Flag that can be specified to additionally show usagecommand: When specifies displays help for that command only]

           for the commands. (default='false')]

ansi

Enables or disables ansi output

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

  [filter: Optionally can be specified to list only commands that
 [<-h|--help> Displays this help message (default='false')]
       [value: <off|on> Turns containansi thison filter in their nameor off. '*'With indicatesno thatargument alldisplay commandsthe
           shouldcurrent be displayed default='*'ansi setting]

invoke

echo

Sends a command to a XVM or an app hosted by a XVMDisplays a message or turns echo on or off

Usage:
  invokeecho [-h] [<app><value>] <xvm>
<command>
         [<-h|--help> Displays this help message (default='false')]
       [appvalue: TheDisplays appa whosemessage commandor toturns list.echo Ifon 'server' or omitted then XVM
           commands are listed. default='admin']
 or off. With no argument
     xvm: The XVM in which to list commandsthe current echo setting]
    command: The name of[message: theA commandmessage to execute
       [args: The command argumentsdisplay default='']

admin

script

Sends Runs a command to a XVM or an app hosted by a XVMscript

Usage:
  adminscript [-h] <dest>[<script>] <command>

        [<-h|--help> Displays this help message (default='false')]
       dest[script: The appscript and XVM against which file to invokeexecute]
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

bye | exit | quit

Exit the tool.

Usage:
  bye [-h] 

        [args: The command arguments]

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

The Talon Manual

Additional Links

Page History

Versions Compared

Old Version 1

New Version 2

Key

Overview

Running The Tool

Listing Running XV

Command Reference

Tool Properties

Commands

get

listXvms | xvms

disconnect

reset

connect

set

listAppCommands

stacktraces

invoke

help

ansi

admin

echo

General Commands

get

reset

bye | exit | quit

listXvms | xvms

set

disconnect

connect

stacktraces

listAppCommands

history

help

ansi

echo

script

bye | exit | quit