In This Section
Overview
Command Reference
Tool Properties
| 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
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]
reset
Reset a configuration or environment property to its default value
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.
set
Sets a configuration or environment property
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]
stacktraces
Sets whether or not command exception stacktraces should be shown
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
history
Displays command history
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']
help
Displays help message
Usage:
help [-h] [<command>]
[<-h|--help> Displays this help message (default='false')]
[command: When specifies displays help for that command only]
ansi
Enables or disables ansi output
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]
echo
Displays a message or turns echo on or off
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='']
script
Runs a command script
Usage:
script [-h] [<script>]
[<-h|--help> Displays this help message (default='false')]
[script: The script file to execute]
bye | exit | quit
Exit the tool.
Usage:
bye [-h]
[<-h|--help> Displays this help message (default='false')]
listXvms | xvms
Shows available xvms
Usage:
listXvms [-h]
[<-h|--help> Displays this help message (default='false')]
disconnect
Closes currently open admin connections
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) ]
connect
Connects to an xvm
Usage:
connect [-h] <xvm>
[<-h|--help> Displays this help message (default='false')]
xvm: The XVM to connect to.
listAppCommands
List commands for an XVM or an app hosted by a XVM
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='*']
invoke
Sends a command to a XVM or an app hosted by a XVM
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]
admin
Sends a command to a XVM or an app hosted by a XVM
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]