Command Line Interface


GigaSpaces provides an interactive command line tool as part of the product. This can be started using gs.sh/bat command (referred to as GigaSpaces CLI).

This tool provides many commands that can be used to manage and gather information about the various GigaSpaces runtime components. This section describes the commands supported by GigaSpaces CLI.

help

Syntax

gs> help [command-name]

Description

The help command displays the syntax of a specified CLI command, or a list of all available commands.

Options

Option Description
command-name The name of any one of the GigaSpaces CLI commands. Default: List all commands, without their arguments.

cd

Syntax

gs> cd directory

Description

The cd command moves to a different working directory, like the Unix cd command.

directory accepts an absolute or relative file-system path.

Options

Option Description
None

gsa

Syntax

gs> gsa <command> [-host<host name/ip address>]

Description

The following gsa CLI commands are available:

Command Description
shutdown shutdown gsa
start-gsc starts gsc agent within specific gsa service
start-gsm starts gsm agent within specific gsa service
start-lookup starts lus agent within specific gsa service

Options

Option Description Value Format
help / h Prints help – the command’s usage and options.
host / h Host name, optional parameter, allows to locate gsa that is running on specific machine.

The following prints a numbered list of GSA services, and you can choose a GSA service to create gsc within it:

gs> gsa start-gsc
total 5
[1]  10278  Grid Service Agent  gigaspaces-8.0.0-XAPPremium...  pc-lab43@192.xxx.x.xx
[2]  20157  Grid Service Agent  gigaspaces-8.0.0-XAPPremium...  pc-lab37@192.xxx.x.xx
[3]  26850  Grid Service Agent  gigaspaces-8.0.0-XAPPremium...  pc-lab38@192.xxx.x.xx
[4]  11752  Grid Service Agent  gigaspaces-8.0.0-XAPPremium...  Evgeny@192.xxx.xx.xxx
[5]  1608   Grid Service Agent  gigaspaces-8.0.0-XAPPremium...  pc-lab42@192.xxx.x.xx

Enter a number of service to gsa start-gsc or "c" to cancel :

Example for gsa shutdown when specific host name provided:

gs> gsa shutdown -host pc-lab43
total 1
[1]  10278  Grid Service Agent  gigaspaces-8.0.0-XAPPremium...  pc-lab43@192.xxx.x.xx
[2]  all

Enter a comma-separated list to gsa shutdown or "c" to cancel :

jconsole

Syntax

gs> jconsole [jmx-connection-string]

Description

The jconsole command launches the Service Grid Admin UI, allowing you to browse the JMX instance associated with a specific Grid Service Container (GSC).

JMX provides remote management capabilities for monitoring memory utilization, VM system configuration, performance and garbage collection characteristics etc. By default, each GSC is set to run a JMX enabled VM. For more details on monitoring and management using JMX, refer to the JMX Management section.

Options

Option Description
jmx-connection-string The JMX connection string to be used for starting the Java Management Console. If not provided, a selection list of all GSCs is displayed. You can select the appropriate instance from the list.
h / help Prints help
gs> jconsole
total services 2
[1]   Grid Service Container   gs-grid   69.203.99.5
[2]   Grid Service Manager     gs-grid   69.203.99.5

Choose a service for jconsole support or "c" to cancel : 1
Launching jconsole, command successful

gs> jconsole service:jmx:rmi:///jndi/rmi://192.10.10.10:10098/jmxrmi
Launching jconsole, command successful

list

Syntax

gs> list [type] [options]

Description

The list command lists information about active Service Grid services.

The following values are allowed for type. Only one type can be specified.

Type Description
gsm Grid Service Monitor
gsc Grid Service Container
lus Lists all active Jini Lookup Service instances and their attributes.
Default (none) List all types of services, but in less detail than when the types are specified individually: only service name, group, and machine.

Options

Each option adds to (or subtracts from) the default information listed. You can specify one option, more than one, or none.

The following options are available for types gsm, gsc, and default:

Option Description
cpu Lists the CPU utilization of each machine.
jmx Lists the jmx connection entry, if any.
codeserver Lists the IP addresses to which the service has been exported.
timeout Available for type lus only (new in GigaSpaces 6.0.2 and onwards) – the discovery timeout (in milliseconds). Usage example: timeout=20000. Default value is 30000 msec.

List All Services in the Network

gs> list
total services 9
[1]  27882  myDataGrid.1                 myLookupgroups  my-pc@192.168.10.199
[2]  27898  myDataGrid.1                 myLookupgroups  my-pc@192.168.10.199
[3]         Lookup                       myLookupgroups  192.168.10.199
[4]  27882  GSC                          myLookupgroups  my-pc@192.168.10.199
[5]  28307  GSM                          myLookupgroups  my-pc@192.168.10.199
[6]  27898  GSC                          myLookupgroups  my-pc@192.168.10.199
[7]  27898  myDataGrid          Backup   myLookupgroups  192.168.10.199
[8]  27780  Grid Service Agent           myLookupgroups  my-pc@192.168.10.199
[9]  27882  myDataGrid          Primary  myLookupgroups  192.168.10.199

List all Service Containers

gs> list gsc
total 2
[1]  27898  GSC    myLookupgroups  my-pc@192.168.10.199
    myDataGrid.1        myLookupgroups      26 seconds
[2]  27882  GSC    myLookupgroups  my-pc@192.168.10.199
    myDataGrid.1        myLookupgroups      30 seconds

List Grid Service Managers

gs> list gsm
Found 1 GSMs
[1]  28307  GSM    myLookupgroups  my-pc@192.168.10.199
    myDataGrid  role=primary
        myDataGrid.1    planned=2   actual=2    pending=0
            id=1        192.168.10.199
            id=2        192.168.10.199

List all Active Jini Lookup Service Instances and their Attributes

gs> list lus
Searching for available Jini Lookup Services...

-----------------------------------------------------------------------
-- Discovered Lookup Service at host [ 192.168.10.199:4174 ].
-- Lookup Service registered to the following jini groups:
         Group [ myLookupgroups ]
-- Lookup Service has [9] services, lookup took [39] millis, [0] seconds:
         Service Class: com.gigaspaces.grid.gsm.GSMProxy | ac759574-48a8-4c3c-aed1-6ed04abec326
         Service Attributes Set: [org.jini.rio.entry.OperationalStringEntry(name=Service Grid Infrastructure), org.jini.rio.entry.ApplianceInfo(osName=Linux,osVersion=3.16.0-28-generic,arch=amd64,jvmVendor=Sun Microsystems Inc.,jvmVersion=1.6.0_45,hostName=my-pc,hostAddress=192.168.10.199), net.jini.lookup.entry.Name(name=GSM), org.jini.rio.entry.StandardServiceType(name=GSM,description=,iconURL=null), org.jini.rio.entry.ComputeResourceUtilization(description=my-pc Linux, amd64, 3.16.0-28-generic,hostName=my-pc,address=192.168.10.199,utilization=NaN,utilizationMap={}), Class: org.jini.rio.qos.SLAThresholdEvent, eventID: 1000000001, Class: org.jini.rio.monitor.ProvisionMonitorEvent, eventID: 2764185076071141340, Class: org.jini.rio.monitor.ProvisionFailureEvent, eventID: -7832310585750966248, net.jini.lookup.entry.ServiceInfo(name=GSM,manufacturer=GigaSpaces Technologies, Inc.,vendor=,version=v10.1.0-XAPPremium-m6 Build 12586-1806,model=,serialNumber=), com.gigaspaces.management.entry.JMXConnection(jmxServiceURL=service:jmx:rmi:///jndi/rmi://192.168.10.199:10101/jmxrmi,name=GSM_192.168.10.199_10101)]

         Service Class: com.gigaspaces.internal.client.spaceproxy.SpaceProxyImpl | 4de7900f-aa02-44ba-81b4-098317c23a14
         Service Attributes Set: [net.jini.lookup.entry.Name(name=myDataGrid), com.j_spaces.lookup.entry.ClusterName(name=myDataGrid), com.j_spaces.lookup.entry.ClusterGroup(electionGroup=myDataGrid_container1:myDataGrid,replicationGroup=replGroupmyDataGrid_0,loadBalancingGroup=LB_FO_Backup), com.j_spaces.lookup.entry.ContainerName(name=myDataGrid_container1), net.jini.lookup.entry.ServiceInfo(name=JavaSpace,manufacturer=GigaSpaces Technologies Ltd.,vendor=GigaSpaces,version=GigaSpaces XAP Premium 10.1.0 M6 (build 12586-1806),model=,serialNumber=), com.j_spaces.lookup.entry.HostName(name=192.168.10.199), com.j_spaces.lookup.entry.State(state=started,electable=true,replicable=true), com.gigaspaces.cluster.activeelection.core.ActiveElectionState(state=ACTIVE)]

         Service Class: com.gigaspaces.grid.gsa.GSAProxy | ae38ef3b-35a2-4c2a-9ad6-0a19755034b2
         Service Attributes Set: [org.jini.rio.entry.OperationalStringEntry(name=Service Grid Infrastructure), org.jini.rio.entry.ApplianceInfo(osName=Linux,osVersion=3.16.0-28-generic,arch=amd64,jvmVendor=Sun Microsystems Inc.,jvmVersion=1.6.0_45,hostName=my-pc,hostAddress=192.168.10.199), net.jini.lookup.entry.Name(name=Grid Service Agent), org.jini.rio.entry.StandardServiceType(name=Grid Service Agent,description=,iconURL=null), org.jini.rio.entry.ComputeResourceUtilization(description=my-pc Linux, amd64, 3.16.0-28-generic,hostName=my-pc,address=192.168.10.199,utilization=NaN,utilizationMap={}), Class: org.jini.rio.qos.SLAThresholdEvent, eventID: 1000000001, com.gigaspaces.management.entry.JMXConnection(jmxServiceURL=service:jmx:rmi:///jndi/rmi://192.168.10.199:10098/jmxrmi,name=Grid Service Agent_192.168.10.199_10098)]

         Service Class: com.gigaspaces.grid.gsc.GSCProxy | f267cf24-984f-4373-95c6-11b906601b11
         Service Attributes Set: [org.jini.rio.entry.OperationalStringEntry(name=Service Grid Infrastructure), org.jini.rio.entry.ApplianceInfo(osName=Linux,osVersion=3.16.0-28-generic,arch=amd64,jvmVendor=Sun Microsystems Inc.,jvmVersion=1.6.0_45,hostName=my-pc,hostAddress=192.168.10.199), net.jini.lookup.entry.Name(name=GSC), org.jini.rio.entry.StandardServiceType(name=GSC,description=,iconURL=null), org.jini.rio.entry.ComputeResourceUtilization(description=my-pc Linux, amd64, 3.16.0-28-generic,hostName=my-pc,address=192.168.10.199,utilization=0.11943122836384142,utilizationMap={Memory=0.04842780075764728, CPU=0.19043465597003556}), Class: org.jini.rio.qos.SLAThresholdEvent, eventID: 1000000001, net.jini.lookup.entry.ServiceInfo(name=GSC,manufacturer=GigaSpaces Technologies, Inc.,vendor=,version=v10.1.0-XAPPremium-m6 Build 12586-1806,model=,serialNumber=), org.jini.rio.entry.BasicStatus(severity=StatusType.NORMAL), com.gigaspaces.management.entry.JMXConnection(jmxServiceURL=service:jmx:rmi:///jndi/rmi://192.168.10.199:10100/jmxrmi,name=GSC_192.168.10.199_10100)]

         Service Class: com.sun.jini.reggie.RegistrarProxy | 806c30e8-a8e1-48b3-91dd-4cccd1cf084b
         Service Attributes Set: [net.jini.lookup.entry.ServiceInfo(name=Lookup,manufacturer=Sun Microsystems, Inc.,vendor=Sun Microsystems, Inc.,version=2.1,model=,serialNumber=), com.sun.jini.lookup.entry.BasicServiceType(type=Lookup), net.jini.lookup.entry.Name(name=Lookup), org.jini.rio.entry.OperationalStringEntry(name=Service Grid Infrastructure), com.gigaspaces.management.entry.JMXConnection(jmxServiceURL=service:jmx:rmi:///jndi/rmi://192.168.10.199:10102/jmxrmi,name=LUS_192.168.10.199_10102)]

         Service Class: org.openspaces.pu.container.servicegrid.PUServiceBeanProxy | ab0b9572-b51c-46ff-9ce2-31d92e9d8435
         Service Attributes Set: [org.jini.rio.entry.OperationalStringEntry(name=myDataGrid), org.jini.rio.entry.ApplianceInfo(osName=Linux,osVersion=3.16.0-28-generic,arch=amd64,jvmVendor=Sun Microsystems Inc.,jvmVersion=1.6.0_45,hostName=my-pc,hostAddress=192.168.10.199), net.jini.lookup.entry.Name(name=myDataGrid.1), org.jini.rio.entry.StandardServiceType(name=myDataGrid.1,description=,iconURL=null), org.jini.rio.entry.ComputeResourceUtilization(description=my-pc Linux, amd64, 3.16.0-28-generic,hostName=my-pc,address=192.168.10.199,utilization=0.11943122836384142,utilizationMap={Memory=0.04842780075764728, CPU=0.19043465597003556}), Class: org.jini.rio.qos.SLAThresholdEvent, eventID: 1000000001, com.gigaspaces.management.entry.JMXConnection(jmxServiceURL=service:jmx:rmi:///jndi/rmi://192.168.10.199:10100/jmxrmi,name=myDataGrid.1_192.168.10.199_10100)]

         Service Class: com.gigaspaces.grid.gsc.GSCProxy | 055212a0-0d63-4255-b03c-0105ea645259
         Service Attributes Set: [org.jini.rio.entry.OperationalStringEntry(name=Service Grid Infrastructure), org.jini.rio.entry.ApplianceInfo(osName=Linux,osVersion=3.16.0-28-generic,arch=amd64,jvmVendor=Sun Microsystems Inc.,jvmVersion=1.6.0_45,hostName=my-pc,hostAddress=192.168.10.199), net.jini.lookup.entry.Name(name=GSC), org.jini.rio.entry.StandardServiceType(name=GSC,description=,iconURL=null), org.jini.rio.entry.ComputeResourceUtilization(description=my-pc Linux, amd64, 3.16.0-28-generic,hostName=my-pc,address=192.168.10.199,utilization=0.12554125717516085,utilizationMap={Memory=0.06121865565617705, CPU=0.18986385869414463}), Class: org.jini.rio.qos.SLAThresholdEvent, eventID: 1000000001, net.jini.lookup.entry.ServiceInfo(name=GSC,manufacturer=GigaSpaces Technologies, Inc.,vendor=,version=v10.1.0-XAPPremium-m6 Build 12586-1806,model=,serialNumber=), org.jini.rio.entry.BasicStatus(severity=StatusType.NORMAL), com.gigaspaces.management.entry.JMXConnection(jmxServiceURL=service:jmx:rmi:///jndi/rmi://192.168.10.199:10099/jmxrmi,name=GSC_192.168.10.199_10099)]

         Service Class: com.gigaspaces.internal.client.spaceproxy.SpaceProxyImpl | 0a579e41-6114-43b0-817f-7b201a354b38
         Service Attributes Set: [net.jini.lookup.entry.Name(name=myDataGrid), com.j_spaces.lookup.entry.ClusterName(name=myDataGrid), com.j_spaces.lookup.entry.ClusterGroup(electionGroup=myDataGrid_container1:myDataGrid,replicationGroup=replGroupmyDataGrid_0,loadBalancingGroup=LB_FO_Backup), com.j_spaces.lookup.entry.ContainerName(name=myDataGrid_container1_1), net.jini.lookup.entry.ServiceInfo(name=JavaSpace,manufacturer=GigaSpaces Technologies Ltd.,vendor=GigaSpaces,version=GigaSpaces XAP Premium 10.1.0 M6 (build 12586-1806),model=,serialNumber=), com.j_spaces.lookup.entry.HostName(name=192.168.10.199), com.j_spaces.lookup.entry.State(state=started,electable=true,replicable=true), com.gigaspaces.cluster.activeelection.core.ActiveElectionState(state=PENDING)]

         Service Class: org.openspaces.pu.container.servicegrid.PUServiceBeanProxy | 02379c7e-8779-41c3-b409-451222c04d1b
         Service Attributes Set: [org.jini.rio.entry.OperationalStringEntry(name=myDataGrid), org.jini.rio.entry.ApplianceInfo(osName=Linux,osVersion=3.16.0-28-generic,arch=amd64,jvmVendor=Sun Microsystems Inc.,jvmVersion=1.6.0_45,hostName=my-pc,hostAddress=192.168.10.199), net.jini.lookup.entry.Name(name=myDataGrid.1), org.jini.rio.entry.StandardServiceType(name=myDataGrid.1,description=,iconURL=null), org.jini.rio.entry.ComputeResourceUtilization(description=my-pc Linux, amd64, 3.16.0-28-generic,hostName=my-pc,address=192.168.10.199,utilization=0.12554125717516085,utilizationMap={Memory=0.06121865565617705, CPU=0.18986385869414463}), Class: org.jini.rio.qos.SLAThresholdEvent, eventID: 1000000001, com.gigaspaces.management.entry.JMXConnection(jmxServiceURL=service:jmx:rmi:///jndi/rmi://192.168.10.199:10099/jmxrmi,name=myDataGrid.1_192.168.10.199_10099)]

Troubleshooting: terminated services are still listed

The list command uses the lookup service to extract the information regarding the services.

A service’s entry in the lookup is leased and kept until the next renewal attempt fails. If the service is not properly shutdown, i.e. abruptly terminated, it doesn’t un register itself from the lookup service. Thus, attempts to call list will still display the service until its lease expires.

For defaults and configuration options, refer to Jini Lookup Service configuration settings for minMaxServiceLease property.

login

Syntax

gs> login
gs> login -user xxx -password yyy

Description

This CLI command allows you to login to secured services: GSM, GSC and spaces. Each time you invoke this command, you are required afterwards to type in the user name and password (if not supplied in the command). The user name and password are used in order to attempt to authenticate secured services before invoking any operation for them ( e.g. pudeploy, undeploy, space clear, space connections … ).

gs> login
Please enter user name:
my_name
Please enter user password:

gs>

ls

Syntax

gs> ls [-l]

Description

The ls command lists the contents of the current working directory, like the Unix ls command.

Options

Option Description
-l List the contents in more detail.

pwd

Syntax

gs> pwd

Description

The pwd command displays the full path of the current working directory, like the Unix pwd command.

Options

None.

quit

Syntax

gs> quit

Description

The quit command ends the CLI session.

A shortcut for this command is q.

Options

None.

set

Syntax

gs> set [variable [value]]

Description

The set command sets the Service Grid system environment variables.

Options

Option Description Value Format
groups The Jini lookup groups value. The group filters the specific group of services that should be managed by the current shell context. * List of comma-delimited names: group1,group2,...
- all_groups assigns the current context to all available GridService elements in the network.
locators A list of Jini locators hosts. The locators provide an alternate discovery mechanism, if multicast is not working. The locator points to the location of Jini lookup hosts. Normally a lookup service is running as an embedded instance with the Grid Service Monitor (GSM). jini://<hostname1>
To set several locators you have to execute:
set locators jini://<hostname1>
set locators jini://<hostname2>

To empty the locators variable you have to execute:
set locators null
system-props Should be one of the properties used by the system. Omit this parameter to view a list of the available properties. <system property name>=<property value>
disco-timeout Jini discovery timeout [in ms]. Defines the time for waiting for service discovery announcements. Relevant for multicast discovery only.
wait-on-deploy Timeout [in ms] for finding deployable servers.
deploy-timeout Timeout [in ms] for blocking for deployment status.
See also:

Make sure your network and machines running GigaSpaces are configured to have multicast enabled. See the How to Configure Multicast section for details on how to enable multicast.

Displaying Current System Variables

gs> set
groups ALL_GROUPS
locators null
system-props com.gigaspaces.grid.lib=C:demosGS-Cache1362GigaSpacesXAP6.0ServiceGridlib
com.gigaspaces.grid.home=C:demosGS-Cache1362GigaSpacesXAP6.0ServiceGrid
com.gs.jini_lus.groups=gigaspaces-1346
com.gigaspaces.jini.lib=C:demosGS-Cache1362GigaSpacesXAP6.0ServiceGrid..libjini
com.gigaspaces.lib=C:demosGS-Cache1362GigaSpacesXAP6.0ServiceGrid..lib
com.gs.home= C:demosGS
disco-timeout 5000
wait-on-deploy true
deploy-timeout 5000

Setting New Location for Two Properties with Timeout

This example sets new locations for the properties com.gigaspaces.lib and com.gs.home, with a timeout of five and a half seconds for discovery.

gs> set system-props com.gigaspaces.lib=c:gslib,com.gs.home=c:gs
gs> set discovery-timeout 5500
gs> set groups all_groups
gs> set groups gs-grid,test

stats

Syntax

gs> stats

Description

The stats command provides statistics from the Grid Service Container (GSC) and Grid Service Monitor (GSM) of the local machine. The following statistics are reported:

Statistic Decription
User name Current user name in local operating system.
Home directory Service Grid installation directory.
Time of login Time the Service Grid CLI was started.
Elapsed time since login Elapsed time since the Service Grid CLI was started.
Pathname of log file Where advertised, the group advertised, and the time when the service was found to be discarded.
HTTP Address (plus roots) if any HTTP server has been started under this session .
Lookup service discovery statistics Statistics on discovered lookup instances, including IP address and port, group, and time elapsed. At the end, statistics are shown for discarded lookup services, if any.

Options

None.

gs> stats

User : nuser
Home directory :  GigaSpacesXAP6.0ServiceGridbin
Login time : Mon Jan 30 12:02:59 GMT+02:00 2006
Time logged in : 14 minutes, 14 seconds
Log file :  GigaSpacesXAP6.0ServiceGridbings.log
http : No HTTP server started
Lookup Service Discovery Statistics
        No lookup services discovered
Lookup Service Discarded Statistics
        127.0.0.1:4160     gs-grid, gigaspaces-13 Mon Jan 30 12:04:16 GMT+02:00 2006

version

Syntax

gs> version [-verbose]

Description

The version command displays the product’s version information.

Options

Option Description
-verbose Displays additional environment information (OS, JVM, network, system properties, etc).