start

Start servers, locators, gateway senders and gateway receivers, and monitoring tools.

start data-browser

Launch the DataBrowser tool. See DataBrowser for more information.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:
start data-browser
Example Commands:
start data-browser
Sample Output:
gfsh>start data-browser
Running GemFire DataBrowser
The DataBrowser interface appears with connection information in the status bar:

start gateway-receiver

Start the gateway receiver on a given member or group of members. Note that you can only have one gateway receiver on each member, and unlike a gateway sender, you do not need to specify an identifier for the gateway receiver.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:
start gateway-receiver [--group=value(,value)*] [--member=value]
member Name or ID of the member on which to start the Gateway Receiver.
group Group(s) of members on which to start the Gateway Receiver.
Example Commands:
start gateway-receiver
start gateway-receiver --member=member1
Sample Output:
gfsh>start gateway-receiver
      Member                | Result | Message
--------------------------- | -------| -----------------------------------------------------------------------
pc13(2266)<v6>:56852        | OK     | GatewayReceiver is started on member pc13(2266)<v6>:56852
pc13(Manager:2242)<v5>:57631| Error  | GatewayReceiver is not available on member pc13(Manager:2242)<v5>:57631
pc13(2275)<v7>:47480        | OK     | GatewayReceiver is started on member pc13(2275)<v7>:47480
pc13(2293)<v8>:55472        | OK     | GatewayReceiver is started on member pc13(2293)<v8>:55472

gfsh>start gateway-receiver --member=pc13(2266)<v14>:36579
GatewayReceiver is started on member pc13(2266)<v14>:36579

gfsh>start gateway-receiver --group=RG1
         Member      | Result | Message
-------------------- | -------| ----------------------------------------------------------
pc13(2275)<v23>:27484| OK     | GatewayReceiver is started on member pc13(2275)<v23>:27484
pc13(2293)<v24>:55810| OK     | GatewayReceiver is started on member pc13(2293)<v24>:55810
pc13(2266)<v22>:4522 | OK     | GatewayReceiver is started on member pc13(2266)<v22>:4522

start gateway-sender

Start the gateway sender on a member or members. For information on how to configure a gateway sender, see Configure Gateway Senders.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:
start gateway-sender --id=value [--group=value(,value)*] [--member=value]
id ID of the GatewaySender.
group Group(s) of members on which to start the Gateway Sender.
member Member used to start the Gateway Sender
Example Commands:
start gateway-sender --id=sender1-NY
start gateway-sender --id=sender1-NY --member=server1
start gateway-sender --id=sender1-NY --group=MemberGroup1,MemberGroup2
Sample Output:
gfsh>start gateway-sender --id=ln
 Member                       |  Result |                   Message
------------------------------| ------- | -------------------------------------------------------------------------
pc13(30614)<v6>:63670         | OK      | GatewaySender ln is started on member pc13(30614)<v6>:63670
pc13(30621)<v7>:36015         | OK      | GatewaySender ln is started on member pc13(30621)<v7>:36015
pc13(30633)<v8>:13633         | OK      | GatewaySender ln is started on member pc13(30633)<v8>:13633
pc13(Manager:30588)<v5>:42792 | Error   | GatewaySender ln is not available on member pc13(Manager:30588)<v5>:42792

gfsh>start gateway-sender --id=ln --member=pc13(30614)<v14>:44519
GatewaySender ln is started on member pc13(30614)<v14>:44519
gfsh>start gateway-sender --id=ln --group=SenderGroup1
Member                 | Result| Message
---------------------- | ------| ------------------------------------------------------------
pc13(30614)<v18>:15201 | OK    | GatewaySender ln is started on member pc13(30614)<v18>:15201
pc13(30621)<v19>:61437 | OK    | GatewaySender ln is started on member pc13(30621)<v19>:61437
pc13(30633)<v20>:22567 | OK    | GatewaySender ln is started on member pc13(30633)<v20>:22567

start jconsole

Start the JDK JConsole monitoring application in a separate process. JConsole automatically connects to a running JMX Manager node if one is available.

Note that you must have a JDK installed (not just a JRE) and the correct PATH and JAVA_HOME environment variables set.

See Browsing GemFire MBeans through JConsole for an example of using JConsole with the GemFire management and monitoring system.

Availability: Online or offline.

Syntax:
start jconsole [--interval=<seconds>] [--notile] [--version] 
[-J<jconsole JVM options>]
interval Set the update interval to n seconds (default is 4 seconds). (Equivalent to JConsole's -interval=n)
notile Whether to initially tile windows for two or more connections. This parameter is passed as -notile to JConsole.
pluginpath "Directories or JAR files which are searched for JConsole plugins. The path should contain a provider-configuration file named:\n" + " META-INF/services/com.sun.tools.jconsole.JConsolePlugin\n" + "containing one line for each plugin specifying the fully qualified class name of the class implementing the com.sun.tools.jconsole.JConsolePlugin class."
version Display the JConsole version information. This parameter is passed as -version to JConsole.
J Arguments passed to the JVM on which JConsole will run.
Example Commands:
gfsh./> start jconsole --interval=8 --notile;
Running JDK JConsole

gfsh./> start jconsole --version;
JConsole version "1.6.0_31-b04-415"
Java(TM) SE Runtime Environment (build 1.6.0_31-b04-415-11M3646)
Java HotSpot(TM) 64-Bit Server VM (build 20.6-b01-415, mixed mode)
Sample Output:
gfsh>start jconsole
Running JDK JConsole
The JConsole application appears and auto-connects to a JMX Manager node if one is available:



Error Messages:
An error occurred while launching JConsole = %1$s

Connecting by the GemFire member's name or ID is not currently supported.
Please specify the member as '<hostname|IP>[PORT].

An IO error occurred while launching JConsole.
Please ensure that JAVA_HOME is set to the JDK installation 
or the JDK bin directory is in the system PATH.

JConsole could not be found.\nPlease ensure that JAVA_HOME is set to the 
JDK installation or the JDK bin directory is in the system PATH.

start jvisualvm

Start the JDK's Java VisualVM monitoring application in a separate process.

Availability: Online or offline.

Syntax:
start jvisualvm [--J=value(,value)*]
J VM-option passed to the spawned CacheServer VM, example -J-Dfoo.bar=true for setting foo.bar to 'true'.
Example Commands:
start jvisualvm

Sample Output:

start locator

Start a locator. The command creates a subdirectory and log file named after the locator. If the locator detects that no other JMX Manager exists, then the locator will automatically start an embedded JMX Manager and connect the current gfsh session to the JMX Manager.

Note: You must have JAVA_HOME set before starting gfsh to use this command.

In addition, if gfsh is not already connected to a JMX Manager, the gfsh console will automatically connect to the new embedded JMX Manager started by the new locator.

Note: When both --max-heap and --initial-heap are specified during locator startup, additional GC parameters are specified internally by GemFire's Resource Manager. If you do not want the additional default GC properties set by the Resource Manager, then use the-Xms and -Xmx JVM options. See Control Heap Use with the Resource Manager for more information.

Availability: Online or offline.

Syntax:
start locator --name=value [--bind-address=value] [--force(=value)?] 
[--group=value] [--hostname-for-clients=value] [--locators=value] 
[--log-level=value] [--mcast-address=value] [--mcast-port=value] [--port=value] [--dir=value] 
[--properties-file=value] [--security-properties-file=value]
[--initial-heap=value] [--max-heap=value] 
[--connect(=value)?] [--J=value(,value)*]
name Required. Name to be used for this GemFire locator service.
bind-address IP address on which the locator will be bound. (Default: bound to all local addresses)
force Whether to allow the PID file from a previous locator run to be overwritten.
group Group(s) the locator will be a part of.
hostname-for-clients Hostname or IP address that will be sent to clients so they can connect to this locator. (Default: uses the bind-address to which the locator is bound).
locators List of locators used by this locator to join the appropriate GemFire cluster.
log-level Level of output logged to the locator log file. Possible values for log-level include: finest, finer, fine, config, info, warning, severe, none.
mcast-address IP address or hostname used to bind the UPD socket for multi-cast networking so the locator can locate other members in the GemFire cluster. If mcast-port is zero, then mcast-address is ignored.
mcast-port Port used for multi-cast networking so the locator can locate other members of the GemFire cluster. A zero value disables mcast.
port Port the locator will listen on. If not specified, the default port is 10334.
dir Directory in which the Locator will be started and run. The default is ./<locator-member-name>
properties-file Specify the gemfire.properties file for configuring the locator's distributed system. The file's path should be absolute or relative to gfsh's working directory.
security-properties-file The gfsecurity.properties file for configuring the Locator's security configuration in the distributed system. The file's path can be absolute or relative to gfsh's working directory.
initial-heap Size has the same format as the -Xmx/-Xms JVM options.
Note: If you use the -J-Xms and -J-Xmx JVM properties instead of -initial-heap and -max-heap, then GemFire does not use default JVM resource management properties. If you use the JVM properties, you must then specify all properties manually for eviction, garbage collection, heap percentage, and so forth.
max-heap Size has the same format as the -Xmx/-Xms JVM options
Note: If you use the -J-Xms and -J-Xmx JVM properties instead of -initial-heap and -max-heap, then GemFire does not use default JVM resource management properties. If you use the JVM properties, you must then specify all properties manually for eviction, garbage collection, heap percentage, and so forth.
connect When connect is set to false, gfsh does not automatically connect to the locator which is started using this command.
J Argument passed to the JVM on which the Locator will run. For example, specifying --J=-Dfoo.bar=true sets property "foo.bar" to "true".
Example Commands:
start locator --name=locator1
Sample Output:
gfsh>start locator --name=locator1
Starting a locator in C:\PivotalGemFire70\Latest\locator1 on GemFireStymon[10334] 
as locator1...
.............................
locator in C:\PivotalGemFire70\Latest\locator1 on GemFireStymon[10334] as locator1 
is currently online.
Process ID: 3336
Uptime: 17 seconds
GemFire Version: 7.0
Java Version: 1.6.0_26
Log File: C:\PivotalGemFire70\Latest\locator1\locator1.log
JVM Arguments: -Dgemfire.launcher.registerSignalHandlers=true 
-Dsun.rmi.dgc.server.gcInterval=9223372036854775806
Class-Path: ;C:\PivotalGemFire70\Latest\lib\gfsh-dependencies.jar;
C:\PivotalGemFire70\Latest\lib\gemfire.jar;C:\PivotalGemFire70\Latest\lib\antlr.jar;
C:\PivotalGemFire70\Latest\lib\mail.jar;
C:\PivotalGemFire70\Latest\lib\tomcat-embed-core.jar;
C:\PivotalGemFire70\Latest\lib\tomcat-embed-logging-juli.jar;
C:\PivotalGemFire70\Latest\lib\tomcat-embed-jasper.jar;
C:\PivotalGemFire70\Latest\lib\ecj-3.7.2.jar;
C:\PivotalGemFire70\Latest\lib\spring-asm-3.1.1.RELEASE.jar;
C:\PivotalGemFire70\Latest\lib\gemfire.jar;C:\PivotalGemFire70\Latest\lib\antlr.jar;
C:\PivotalGemFire70\Latest\lib\gfsh-dependencies.jar;
C:\PivotalGemFire70\Latest\lib\gfSecurityImpl.jar;
C:\PivotalGemFire70\Latest\SampleCode\tutorial\classes;
C:\PivotalGemFire70\Latest\SampleCode\quickstart\classes;
C:\Program Files\Java\jdk1.6.0_26\lib\tools.jar

Successfully connected to: [host=GemFireStymon, port=1099]

start pulse

Launch the GemFire Pulse monitoring dashboard tool in the user's default system browser and navigates the user to the landing page (login page). For more information on GemFire Pulse, see GemFire Pulse.

Availability: Online or offline.

Syntax:
start pulse [--url=value]
Example Commands:
start pulse
start pulse --url=http://gemfire.mycompany.com:8080/pulse

Sample Output: See GemFire Pulse for examples of Pulse.

start server

Start a GemFire cache server process.
Note: When both --max-heap and --initial-heap are specified during locator startup, additional GC parameters are specified internally by GemFire's Resource Manager. If you do not want the additional default GC properties set by the Resource Manager, then use the -Xmsand -Xmx JVM options. See Control Heap Use with the Resource Manager for more information.

Availability: Online or offline.

Syntax:
start server --name=value [--assign-buckets(=value)?] 
[--cache-xml-file=value] [--classpath=value] [--disable-default-server(=value)?] 
[--enable-time-statistics(=value)?] [--force(=value)?] 
[--properties-file=value] [--security-properties-file=value]
[--group=value][--license-application-cache=value] [--license-data-management=value] 
[--locators=value] [--log-level=value] [--mcast-address=value] [--mcast-port=value] 
[--memcached-port=value] [--memcached-protocol=BINARY|ASCII] [--rebalance(=value)?] 
[--server-bind-address=value] [--server-port=value] [--statistic-archive-file=value] 
[--dir=value] [--initial-heap=value] [--max-heap=value] [--J=value(,value)*]
name Required. Member name for this GemFire Cache Server service.
assign-buckets Whether to assign buckets to the partitioned regions of the cache on server start.
cache-xml-file Specifies the name of the XML file or resource to initialize the cache with when it is created.
classpath Location of user classes required by the Cache Server. This path is appended to the current CLASSPATH.
disable-default-server Whether the Cache Server will be started by default. If the parameter is specified, the value is set to true. If the parameter is not specified, the value (default) is false.
enable-time-statistics Causes additional time-based statistics to be gathered for GemFire operations.
properties-file The gemfire.properties file for configuring the Cache Server's distributed system. The file's path can be absolute or relative to the gfsh working directory.
security-properties-file The gfsecurity.properties file for configuring the Server's security configuration in the distributed system. The file's path can be absolute or relative to gfsh directory.
group Group(s) the Cache Server will be a part of.
force Whether to allow the PID file from a previous Cache Server run to be overwritten.
license-application-cache Specifies the serial number this distributed system member will use unless a license-data-management serial number is also specified. This distributed member will attempt to activate a GemFire Application Cache Node license which allows it to be a peer-to-peer application cache node. If a license-data-management serial number is provided, then the license-application-cache serial number may be specified as the license for cache clients connecting to this node.
license-data-management Specifies the serial number(s) this distributed system member will use. This distributed member will attempt to activate a GemFire Data Management Node license which allows it to provide advanced data management services which includes hosting a cache server to which cache clients may connect.
locators Sets the list of locators used by the Cache Server to join the appropriate GemFire cluster.
log-level Sets the level of output logged to the Cache Server log file. Possible values for log-level include: finest, finer, fine, config, info, warning, severe, none.
mcast-address The IP address or hostname used to bind the UDP socket for multi-cast networking so the Cache Server can locate other members in the GemFire cluster. If mcast-port is zero, then mcast-address is ignored.
mcast-port Sets the port used for multi-cast networking so the Cache Server can locate other members of the GemFire cluster. A zero value disables mcast.
memcached-port If specified and is non-zero, sets the port number for an embedded Gemcached server and starts the Gemcached server.
memcached-protocol Sets the protocol used by an embedded Gemcached server. Valid values are BINARY and ASCII. If you omit this property, the ASCII protocol is used.
server-bind-address IP address on which the Server will be bound. If not specified, the default is to bind to all local addresses.
server-port Port the Server will listen on for client connections. If the option is not specified, the default is port 40404.
rebalance Whether to initiate rebalancing across the GemFire cluster. If the parameter is specified without a value, the value is set to true. If the parameter is not specified, the value (default) is false.
dir Specify the directory in which the server will run in. The default (if not specified) is a directory named after the server. This directory is written to the location where you started gfsh.
statistic-archive-file The file that statistic samples are written to. An empty string (default) disables statistic archival.
initial-heap Initial size of the heap in the same format as the JVM -Xms parameter.
Note: If you use the -J-Xms and -J-Xmx JVM properties instead of -initial-heap and -max-heap, then GemFire does not use default JVM resource management properties. If you use the JVM properties, you must then specify all properties manually for eviction, garbage collection, heap percentage, and so forth.
max-heap Maximum size of the heap in the same format as the JVM -Xmx parameter.
Note: If you use the -J-Xms and -J-Xmx JVM properties instead of -initial-heap and -max-heap, then GemFire does not use default JVM resource management properties. If you use the JVM properties, you must then specify all properties manually for eviction, garbage collection, heap percentage, and so forth.
J Argument passed to the JVM on which the Cache Server will run. For example, --J=-Dfoo.bar=true will set the property "foo.bar" to "true".

Examples

gfsh>start server --name=server1
gfsh>start server --name=server2 --server-port=40405
Sample Output:
gfsh>start server --name=server1
Starting a Cache server in C:\PivotalGemFire70\Latest\server1 on GemFireStymon[40404] 
as server1...
............
Server in C:\PivotalGemFire70\Latest\server1 on GemFireStymon[40404] as server1
is currently online.
Process ID: 3828
Uptime: 8 seconds
GemFire Version: 7.0
Java Version: 1.6.0_26
Log File: C:\PivotalGemFire70\Latest\server1\server1.log
JVM Arguments: -Dgemfire.launcher.registerSignalHandlers=true 
-Dsun.rmi.dgc.server.gcInterval=9223372036854775806
Class-Path: ;C:\PivotalGemFire70\Latest\lib\gfsh-dependencies.jar;
C:\PivotalGemFire70\Latest\lib\gemfire.jar;C:\PivotalGemFire70\Latest\lib\antlr.jar;
C:\PivotalGemFire70\Latest\lib\mail.jar;
C:\PivotalGemFire70\Latest\lib\tomcat-embed-core.jar;
C:\PivotalGemFire70\Latest\lib\tomcat-embed-logging-juli.jar;
C:\PivotalGemFire70\Latest\lib\tomcat-embed-jasper.jar;
C:\PivotalGemFire70\Latest\lib\ecj-3.7.2.jar;
C:\PivotalGemFire70\Latest\lib\spring-asm-3.1.1.RELEASE.jar;
C:\PivotalGemFire70\Latest\lib\gemfire.jar;C:\PivotalGemFire70\Latest\lib\antlr.jar;
C:\PivotalGemFire70\Latest\lib\gfsh-dependencies.jar;
C:\PivotalGemFire70\Latest\lib\gfSecurityImpl.jar;
C:\PivotalGemFire70\Latest\SampleCode\tutorial\classes;
C:\PivotalGemFire70\Latest\SampleCode\quickstart\classes;
C:\Program Files\Java\jdk1.6.0_26\lib\tools.jar

start vsd

Launch GemFire Visual Statistics Display (VSD) in a separate process. You can specify a comma delimited list of directories and specific GemFire statistics archive files (.gfs) to load into VSD upon start. A directory locations will be searched recursively for statistics archive (.gfs) files.

Availability: Online or offline.

Syntax:
start vsd [/path/to/dir/containing/gfs/files|/path/to/statisticsArchive.gfs] 
[,/path/to/dir/containing/gfs/files|/path/to/statisticsArchive.gfs]*
Example Commands:
gfsh> start vsd /export/gemfire/node1,/export/gemfire/node2/statArchive.gfs,../../gemfire/nodeN;
Running GemFire Visual Statistics Display (VSD)

gfsh> start vsd;
Running GemFire Visual Statistics Display (VSD)

Sample Output: