Overview

The command-line utilities provide life-cycle management both for the container and the spaces it manages. You can start and shutdown containers, and create, ping, clean, stop, start, and destroy spaces. You may discover the spaces running over the network and perform some network diagnosis tasks.

The general format of most of the utilities is:

Utility <container name> <space name> | [ -l <lookup host> | -r <RMIregistry host> ] <utility specific options>

The default container name is the name of the host running the container. You can use also "." as the container name – this will count as:

<Space name>_container

The space name is the same name given when the space was created. All the utilities provide two basic methods of locating a space in the environment:

• Using the Jini Lookup Service – This option enables both a Unicast and Multicast lookup. Multicast is the default option. Use Unicast if you specify the lookup host with the -l option.
• Using the RMI Registry – Every container has an embedded RMI Registry. The default port for it is 10098. This mode allows the space to be located independently of the Jini services. It also enables more control of the space by providing direct access to the container, thus avoiding the possibility of conflict, if and when spaces with the same name and containers run across the network.

Commands Run from <GigaSpaces Root>\bin Directory

The following commands are run directly from the <GigaSpaces Root>\bin directory.

• generateGsXml - GigaSpaces CLI — Converts a Java class into a *gs.xml mapping file.
• gsInstance - GigaSpaces CLI — Loads a space container, one space, an embedded Reggie, and an embedded Webster, using the gsInstance script.
• PlatformInfo - GigaSpaces CLI — Provides full information on the system configuration.
• startJiniLUS - GigaSpaces CLI — Starts the Jini Lookup Service as a standalone process.
• startJiniTX_Mahalo - GigaSpaces CLI — Starts the Jini Transaction Manager as a stand alone process.

Benchmark

The benchmark utility is run from the <GigaSpaces Root>\examples\Advanced\Benchmark\bin directory.

• Benchmark Utility - GigaSpaces CLI — A tool for running performance benchmarks on the space in various scenarios.

Commands Run Using <GigaSpaces Root>\bin\gs.bat/sh

To run the following commands, run the <GigaSpaces Root>\bin\gs.bat/sh command.

gs > admin

The following commands are run as part of the <GigaSpaces Root>\bin\gs.bat/sh > admin command:

• admin multicastTest - GigaSpaces CLI — Used to determine whether multicast is available.
• admin userAdmin - GigaSpaces CLI — Modifies user name and password for the container administrator.

gs > space

The following commands are run as part of the <GigaSpaces Root>\bin\gs.bat/sh > space command:

• space clean - GigaSpaces CLI — Removes all Entries and templates from the space.
• space cluster-members - GigaSpaces CLI — Show the full list of cluster members, including members that aren't "alive".
• space config - GigaSpaces CLI — Displays the specified spaces's configuration details.
• space connections - GigaSpaces CLI — Displays all live connections to the specified space.
• space copy - GigaSpaces CLI — Copies all objects from the specified source space to the specified destination space.
• space create - GigaSpaces CLI — Makes a space active on one or more machines.
• space destroy - GigaSpaces CLI — Destroys the specified space and removes all references to it, including persistent ones.
• space list - GigaSpaces CLI — Lists spaces in the network.
• space ping - GigaSpaces CLI — Provides a convenient way to test a space.
• space restart - GigaSpaces CLI — Restarts the specified space.
• space shutdownContainer - GigaSpaces CLI — Stops the container and all the spaces in it, and unregisters all the associated proxies from the Lookup Services.
• space sql - GigaSpaces CLI — Queries specified space.
• space start - GigaSpaces CLI — Starts a pre-existing space after it was stopped.
• space stop - GigaSpaces CLI — Stops a preexisting space.

Other gs Commands

The following commands are run directly from <GigaSpaces Root>\bin\gs.bat/sh command:

• cd - GigaSpaces CLI — Moves to a different working directory, like the Unix cd command.
• deploy - GigaSpaces CLI — Makes one or more application deployment units active on a machine.
• destroy - GigaSpaces CLI — Destroys a specific set of services over the network.
• help - GigaSpaces CLI — Displays syntax of specified CLI command, or list of all commands.
• http - GigaSpaces CLI — Starts an HTTP server and displays IP address, port, roots.
• jconsole - GigaSpaces CLI — Launches Admin UI for browsing the JMX instance associated with a specific GSC.
• list - GigaSpaces CLI — Lists information about active Service Grid services.
• ls - GigaSpaces CLI — Lists the contents of the current working directory, like the Unix ls command.
• pudeploy - GigaSpaces CLI — Deploys a Processing Unit onto the Service Grid.
• pwd - GigaSpaces CLI — Displays path of current working directory, like the Unix pwd command.
• quit - GigaSpaces CLI — Ends the CLI session.
• redeploy - GigaSpaces CLI — Renews one or more application deployment units.
• set - GigaSpaces CLI — Sets the Service Grid system environment variables.
• stats - GigaSpaces CLI — Provides statistics from the GSC and GSM of the local machine.
• task - GigaSpaces CLI — Submits a task in the form of an Ant configuration file.
• undeploy - GigaSpaces CLI — Makes one or more application deployment units inactive.