Upgrading the CLI
The new Command Line Interface, which was introduced in release 12.3, provides a simpler syntax and is cloud-friendly (based on the REST Manager API).
The legacy CLI is still supported, but has been deprecated as of GigaSpaces Platform and GigaSpaces release 14.0 and will be removed in a future version. Customers upgrading from older product versions are encouraged to upgrade to the new CLI.
To get started with the new CLI, simply runxap --help
bin
folder.
Commonly Used Options
The following table lists common tasks and the commands that are used to execute them using both the old and new Command Line Interfaces. This is not an exhaustive list, but it should help you get started with migration quickly and estimate the required effort.
Task | Old Command | New Command |
---|---|---|
Get help | gs help
|
xap help or xap --help |
Get version | gs version
|
xap version
|
Get information | gs stats
|
xap info
|
Start agent components | `gs gsa start-gsm | start-gsc |
Stop agent components | gs gsa shutdown [options]
|
xap host kill-agent [options]
|
List agent components | gs list [options]
|
xap host list [options] and xap container list [options] |
Deploy a Space | gs deploy-space [options] <space-name>
|
xap space deploy [options] <space-name>
|
List Spaces | gs space list [options]
|
xap space list [options] and xap space info [options] <space-name> |
Query a Space | gs space sql [options]
|
xap space query [options] <space-name> <type>
|
Deploy a Processing Unit | gs deploy [options] <pu-name-or-file>
|
xap pu deploy [options] <pu-name> <pu-file>
|
Undeploy a Processing Unit | gs undeploy [options] <pu-name>
|
xap pu undeploy [options] <pu-name>
|
Quiesce a Processing Unit | gs quiesce [options] <pu-name>
|
xap pu quiesce [options] <pu-name>
|
Unquiesce a Processing Unit | gs unquiesce [options] <pu-name>
|
xap pu unquiesce [options] <pu-name>
|
Interactive Shell Commands
The old Command Line Interface supports an interactive shell mode, and as such includes a set of shell-related commands, which are currently not supported in the new CLI as it is not interactive.
cd
dir
pwd
ls
set
login
Miscellaneous
pudeploy
- alias for thedeploy
command.deploy-memcached
- Can be done via thedeploy
command.deploy-rest
- Can be done via thedeploy
command.deploy-application
andundeploy-application
- Low usage rate, can be done via thedeploy
/undeploy
commands and scripting.jconsole
- The new CLI is based on the REST protocol, so this command is misleading. Users may access the standard JConsole directly.admin multicastTest
- The new CLI is based on the GigaSpaces Manager, which uses unicast.