http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb deleted file mode 100644 index 9864fb2..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb +++ /dev/null @@ -1,937 +0,0 @@ ---- -title: create ---- -<a id="topic_9663C9448D2745B387FC08F84818DDEC"></a> - - -Create async-event-queues, disk-stores, gateway receivers, gateway senders, indexes, and regions. - -- **[create async-event-queue](../../../tools_modules/gfsh/command-pages/create.html#topic_ryz_pb1_dk)** - - Creates an asynchronous event queue for batching events before they are delivered by a gateway sender. - -- **[create defined indexes](../../../tools_modules/gfsh/command-pages/create.html#topic_w2t_l3m_qq)** - - Creates all the defined indexes. - -- **[create disk-store](../../../tools_modules/gfsh/command-pages/create.html#topic_bkn_zty_ck)** - - Defines a pool of one or more disk stores, which can be used by regions and client subscription queues, and gateway sender queues for WAN distribution. - -- **[create gateway-receiver](../../../tools_modules/gfsh/command-pages/create.html#topic_a4x_pb1_dk)** - - Creates a gateway receiver. 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 . - -- **[create gateway-sender](../../../tools_modules/gfsh/command-pages/create.html#topic_hg2_bjz_ck)** - - Creates a gateway sender on one or more members of a distributed system. - -- **[create index](../../../tools_modules/gfsh/command-pages/create.html#topic_960A5B6FD3D84E1881EE118E299DD12D)** - - Create an index that can be used when executing queries. - -- **[create region](../../../tools_modules/gfsh/command-pages/create.html#topic_54B0985FEC5241CA9D26B0CE0A5EA863)** - - Create a region with given path and configuration. - -## <a id="topic_ryz_pb1_dk" class="no-quick-link"></a>create async-event-queue - -Creates an asynchronous event queue for batching events before they are delivered by a gateway sender. - -See [Configuring Multi-Site (WAN) Event Queues](../../../developing/events/configure_multisite_event_messaging.html#configure_multisite_event_messaging). - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -create async-event-queue --id=value --listener=value [--group=value(nullvalue)*] - [--parallel(=value)?] [--enable-batch-conflation(=value)?] [--batch-size=value] - [--batch-time-interval=value] [--persistent(=value)?] [--disk-store=value] - [--disk-synchronous(=value)?] [--max-queue-memory=value] - [--dispatcher-threads=value] [--order-policy=value] - [--gateway-event-filter=value(,value)*] - [--gateway-event-substitution-filter=value] - [--listener-param=value(,value)*] -``` - -<a id="topic_ryz_pb1_dk__table_jzz_pb1_dk"></a> - -<table> -<caption><span class="tablecap">Table 1. Create Async-Event-Queue Parameters</span></caption> -<colgroup> -<col width="33%" /> -<col width="34%" /> -<col width="33%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Name</th> -<th>Description</th> -<th>Default Value</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td><span class="keyword parmname">\-\-id</span></td> -<td><em>Required</em>. ID of the asynchronous event queue</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-group</span></td> -<td>The queue is created on all members of this group. If you do not specify a group the queue is created on all members.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-parallel</span></td> -<td>Specifies whether the queue is parallel.</td> -<td>false</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-enable-batch-conflation</span></td> -<td>Enables batch conflation.</td> -<td>false</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-batch-size</span></td> -<td>Maximum number of messages that a batch can contain.</td> -<td>100</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-batch-time-interval</span></td> -<td>Maximum amount of time, in ms, that can elapse before a batch is delivered.</td> -<td>5</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-persistent</span></td> -<td>Boolean value that determines whether Geode persists this queue.</td> -<td>false -<p>If specified with out a value, default is true.</p></td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-disk-store</span></td> -<td>Named disk store to use for storing queue overflow, or for persisting the queue. If you specify a value, the named disk store must exist. If you specify a null value, Geode uses the default disk store for overflow and queue persistence.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-disk-synchronous</span></td> -<td>Specifies whether disk writes are synchronous.</td> -<td>true</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-max-queue-memory</span></td> -<td>Maximum amount of memory in megabytes that the queue can consume before overflowing to disk.</td> -<td>100</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-dispatcher-threads</span></td> -<td>Number of threads used for sending events.</td> -<td>5</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-order-policy</span></td> -<td>Policy for dispatching events when \-\-dispatcher-threads is > 1. Possible values are <code class="ph codeph">THREAD</code>, <code class="ph codeph">KEY</code>, <code class="ph codeph">PARTITION</code>.</td> -<td>KEY</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-gateway-event-filter</span></td> -<td>List of fully qualified class names of GatewayEventFilters for this queue. These classes filter events before dispatching to remote servers.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-gateway-event-substitution-filter</span></td> -<td>Fully-qualified class name of the <code class="ph codeph">GatewayEventSubstitutionFilter</code> for this queue.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-listener</span></td> -<td><em>Required.</em> Fully-qualified class name of Async Event Listener for this queue</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-listener-param</span></td> -<td>Parameter name and value to be passed to the Async Event Listener class. Optionally, you can specify a value by following the parameter name with the # character and the value. For example: -<pre class="pre codeblock"><code>--listener-param=myParam#24</code></pre></td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-forward-expiration-destroy</span></td> -<td>Enables forwarding of expiration destroy operations to AsyncEventListener instances. If specified without a value, this parameter is set to âfalseâ.</td> -<td>false</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 1. Create Async-Event-Queue Parameters</span> - -**Example Commands:** - -``` pre -create async-event-queue --id=myAEQ --listener=myApp.myListener -``` - -## <a id="topic_w2t_l3m_qq" class="no-quick-link"></a>create defined indexes - -Creates all the defined indexes. - -See also [define index](define.html) and [clear defined indexes](clear.html). - -**Availability:** Online. You must be connected in <span class="keyword parmname">gfsh</span> to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -create defined indexes [--member=value] [--group=value] -``` - -<a id="topic_w2t_l3m_qq__table_cgy_3jm_qq"></a> - -| Name | Description | Default | -|------------------------------------------------|--------------------------------------------------------------------|---------| -| <span class="keyword parmname">\\-\\-member</span> | Name/Id of the member on which index will be created. | Â | -| <span class="keyword parmname">\\-\\-group</span> | The index will be created on all the members in this member group. | Â | - -<span class="tablecap">Table 2. Create Defined Indexes Parameters</span> - -**Example Commands:** - -``` pre -create defined indexes -``` - -**Sample Output:** - -``` pre -gfsh>create defined indexes -Indexes successfully created. Use list indexes to get details. -1. ubuntu(server1:17682)<v1>:27574 -``` - -If index creation fails, you may receive an error message in gfsh similar to the following: - -``` pre -gfsh>create defined indexes -Exception : org.apache.geode.cache.query.RegionNotFoundException , -Message : Region ' /r3' not found: from /r3Occurred on following members -1. india(s1:17866)<v1>:27809 -``` - -## <a id="topic_bkn_zty_ck" class="no-quick-link"></a>create disk-store - -Defines a pool of one or more disk stores, which can be used by regions and client subscription queues, and gateway sender queues for WAN distribution. - -See [Disk Storage](../../../managing/disk_storage/chapter_overview.html) - -**Availability:** Online. You must be connected in <span class="keyword parmname">gfsh</span> to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -create disk-store --name=value --dir=value(,value)* [--allow-force-compaction(=value)?] -[--auto-compact(=value)?] [--compaction-threshold=value] [--max-oplog-size=value] -[--queue-size=value] [--time-interval=value] [--write-buffer-size=value] [--group=value(,value)*] -[--disk-usage-warning-percentage=value] [--disk-usage-critical-percentage=value] -``` - -<a id="topic_bkn_zty_ck__table_lkn_zty_ck"></a> - -<table> -<caption><span class="tablecap">Table 3. Create Disk-Store Parameters</span></caption> -<colgroup> -<col width="25%" /> -<col width="50%" /> -<col width="25%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Name</th> -<th>Description</th> -<th>Default Value</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td><span class="keyword parmname">\-\-name</span></td> -<td><em>Required.</em> The name of this disk store.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-dir</span></td> -<td><em>Required.</em> One or more directory names where the disk store files are written. Optionally, directory names may be followed by <code class="ph codeph">#</code> and the maximum number of megabytes that the disk store can use in the directory. For example: -<pre class="pre codeblock"><code>--dir=/data/ds1 ---dir=/data/ds2#5000</code></pre> -If the specified directory does not exist, the command will create the directory for you.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-allow-force-compaction</span></td> -<td>Set to true to allow disk compaction to be forced on this disk store.</td> -<td>false</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-auto-compact</span></td> -<td>Set to true to automatically compact the disk files.</td> -<td>true</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-compaction-threshold</span></td> -<td>Percentage of garbage allowed before the disk store is eligible for compaction.</td> -<td>50</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-max-oplog-size</span></td> -<td>Maximum size, in megabytes, for an oplog file. When the oplog file reaches this size, the file is rolled over to a new file.</td> -<td>1024</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-queue-size</span></td> -<td>Maximum number of operations that can be asynchronously queued to be written to disk.</td> -<td>0</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-time-interval</span></td> -<td>The number of milliseconds that can elapse before unwritten data is written to disk.</td> -<td>1000</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname"> --group</span></td> -<td>The name of a group of distributed system members. The disk store is created on all members of this group. If no group is specified, the disk store is created on all members.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-write-buffer-size</span></td> -<td>The size of the write buffer that this disk store uses when writing data to disk. Larger values may increase performance but use more memory. The disk store allocates one direct memory buffer of this size.</td> -<td>32768</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-disk-usage-warning-percentage</span></td> -<td>Disk usage above this threshold generates a warning message. For example, if the threshold is set to 90%, then on a 1 TB drive falling under 100 GB of free disk space generates the warning. -<p>Set to "0" (zero) to disable.</p></td> -<td>90</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-disk-usage-critical-percentage</span></td> -<td>Disk usage above this threshold generates an error message and shuts down the member's cache. For example, if the threshold is set to 99%, then falling under 10 GB of free disk space on a 1 TB drive generates the error and shuts down the cache. -<p>Set to "0" (zero) to disable.</p></td> -<td>99</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 3. Create Disk-Store Parameters</span> - -**Example Commands:** - -``` pre -create disk-store --name-store1 --dir=/data/ds1 -``` - -**Sample Output:** - -``` pre -gfsh>create disk-store --name-store1 --dir=/data/ds1 -Member | Result -------- | ------- -server1 | Success -``` - -## <a id="topic_a4x_pb1_dk" class="no-quick-link"></a>create gateway-receiver - -Creates a gateway receiver. 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. - -See [Gateway Receivers](../../../topologies_and_comm/topology_concepts/multisite_overview.html#topic_4DB3D9CF01AD4F4899457D1250468D00). - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -create gateway-receiver [--group=value(,value)*] [--member=value(,value)*] - [--manual-start=value] [--start-port=value] [--end-port=value] [--bind-address=value] - [--maximum-time-between-pings=value] [--socket-buffer-size=value] - [--gateway-transport-filter=value(,value)*] -``` - -<a id="topic_a4x_pb1_dk__table_v4x_pb1_dk"></a> - -<table> -<caption><span class="tablecap">Table 4. Create Gateway-Receiver Parameters</span></caption> -<colgroup> -<col width="33%" /> -<col width="33%" /> -<col width="33%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Name</th> -<th>Description</th> -<th>Default Value</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td><span class="keyword parmname">\-\-group</span></td> -<td>Gateway receivers are created on the members of this group.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-member</span></td> -<td>Name of the distributed system member on which to create the gateway receiver.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-manual-start</span></td> -<td>Boolean value that specifies whether you need to manually start the gateway receiver. If you supply a null value, the default is "true" and you will need to start the gateway receiver manually.</td> -<td>true</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-start-port</span></td> -<td><p>Starting port number to use when specifying the range of possible port numbers this gateway receiver will use to connects to gateway senders in other sites. Geode chooses an unused port number in the specified port number range to start the receiver. If no port numbers in the range are available, an exception is thrown.</p> -<p>The <code class="ph codeph">STARTPORT</code> value is inclusive while the <code class="ph codeph">ENDPORT</code> value is exclusive. For example, if you specify <code class="ph codeph">STARTPORT="50510"</code> and <code class="ph codeph">ENDPOINT="50520"</code>, Geode chooses a port value from 50510 to 50519.</p></td> -<td>5000</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-end-port</span></td> -<td><p>Defines the upper bound port number to use when specifying the range of possible port numbers this gateway receiver will use to for connections from gateway senders in other sites. Geode chooses an unused port number in the specified port number range to start the receiver. If no port numbers in the range are available, an exception is thrown.</p> -<p>The <code class="ph codeph">ENDPORT</code> value is exclusive while the <code class="ph codeph">STARTPORT</code> value is inclusive. For example, if you specify <code class="ph codeph">STARTPORT="50510"</code> and <code class="ph codeph">ENDPOINT="50520"</code>, Geode chooses a port value from 50510 to 50519.</p></td> -<td>5500</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-bind-address</span></td> -<td>Network address for connections from gateway senders in other sites. Specify the address as a literal string value.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-socket-buffer-size</span></td> -<td>An integer value that sets the buffer size (in bytes) of the socket connection for this gateway receiver. This value should match the <code class="ph codeph">socket-buffer-size</code> setting of gateway senders that connect to this receiver.</td> -<td>32768</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-gateway-transport-filter</span></td> -<td>The fully qualified class name of the GatewayTransportFilter to be added to the Gateway receiver.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-maximum-time-between-pings</span></td> -<td>Integer value that specifies the time interval (in milliseconds) to use between pings to connected WAN sites. This value determines the maximum amount of time that can elapse before a remote WAN site is considered offline.</td> -<td>60000</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 4. Create Gateway-Receiver Parameters</span> - -**Example Commands:** - -``` pre -gfsh>create gatweway-receiver --member=server1 -``` - -**Sample Output:** - -``` pre -gfsh>create gateway-receiver --member=server1 -Member | Status -------- | --------------------------------------------------------------------------- -server1 | GatewayReceiver created on member "server1" and will listen on the port "0" -``` - -## <a id="topic_hg2_bjz_ck" class="no-quick-link"></a>create gateway-sender - -Creates a gateway sender on one or more members of a distributed system. - -See [Gateway Senders](../../../topologies_and_comm/topology_concepts/multisite_overview.html#topic_9AA37B43642D4DE19072CA3367C849BA). - -**Note:** -The gateway sender configuration for a specific sender `id` must be identical on each Geode member that hosts the gateway sender. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -create gateway-sender --id=value --remote-distributed-system-id=value - [--group=value(,value)*] [--member=value(,value)*] [--parallel=value] - [--manual-start=value] [--socket-buffer-size=value] [--socket-read-timeout=value] - [--enable-batch-conflation=value] [--batch-size=value] [--batch-time-interval=value] - [--enable-persistence=value] [--disk-store-name=value] [--disk-synchronous=value] - [--maximum-queue-memory=value] [--alert-threshold=value] [--dispatcher-threads=value] - [--order-policy=value][--gateway-event-filter=value(,value)*] - [--gateway-transport-filter=value(,value)*] -``` - -<a id="topic_hg2_bjz_ck__table_ah2_bjz_ck"></a> - -<table> -<caption><span class="tablecap">Table 5. Create Gateway-Sender Parameters</span></caption> -<colgroup> -<col width="30%" /> -<col width="50%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Name</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td><span class="keyword parmname">\-\-id</span></td> -<td><em>Required.</em> Unique identifier for the gateway sender, usually an identifier associated with a physical location.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-remote-distributed-system-id</span></td> -<td><em>Required.</em> ID of the remote distributed system where this gateway sender sends events.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-group</span></td> -<td>Gateway senders are created on the members of this group.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-member</span></td> -<td>Name of the distributed system member on which to create the gateway sender.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-parallel</span></td> -<td>When set to true, specifies a parallel Gateway Sender.</td> -<td>false</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-enable-batch-conflation</span></td> -<td>Boolean value that determines whether Geode should conflate messages.</td> -<td>false</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-manual-start</span></td> -<td>Boolean value that specifies whether you need to manually start the gateway sender. If you supply a null value, the default is "false" and the gateway sender attempts to start automatically.</td> -<td>false</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-socket-buffer-size</span></td> -<td>Size of the socket buffer that sends messages to remote sites. This size should match the size of the <code class="ph codeph">socket-buffer-size</code> attribute of remote gateway receivers that process region events.</td> -<td>32768</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-socket-read-timeout</span></td> -<td>Amount of time in milliseconds that the gateway sender will wait to receive an acknowledgment from a remote site. By default this is set to 0, which means there is no timeout. If you do set this timeout, you must set it to a minimum of 30000 (milliseconds). Setting it to a lower number will generate an error message and reset the value to the default of 0.</td> -<td>0</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-batch-size</span></td> -<td>Maximum number of messages that a batch can contain.</td> -<td>100</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-batch-time-interval</span></td> -<td>Maximum number of milliseconds that can elapse between sending batches.</td> -<td>1000</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-enable-persistence</span></td> -<td>Boolean value that determines whether Geode persists the gateway queue.</td> -<td>false</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-disk-store-name</span></td> -<td>Named disk store to use for storing the queue overflow, or for persisting the queue. If you specify a value, the named disk store must exist. If you specify a null value, Geode uses the default disk store for overflow and queue persistence.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-disk-synchronous</span></td> -<td>For regions that write to disk, boolean that specifies whether disk writes are done synchronously for the region.</td> -<td>true</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-maximum-queue-memory</span></td> -<td>Maximum amount of memory in megabytes that the queue can consume before overflowing to disk.</td> -<td>100 MB</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-alert-threshold</span></td> -<td>Maximum number of milliseconds that a region event can remain in the gateway sender queue before Geode logs an alert.</td> -<td>0</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-dispatcher-threads</span></td> -<td>Number of dispatcher threads that are used to process region events from a gateway sender queue or asynchronous event queue.</td> -<td>5</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-order-policy</span></td> -<td>When the <code class="ph codeph">dispatcher-threads</code> attribute is greater than 1, <code class="ph codeph">order-policy</code> configures the way in which multiple dispatcher threads process region events from a serial gateway queue or serial asynchronous event queue. This attribute can have one of the following values: -<dt><b>key</b></dt> -<dd>When distributing region events from the local queue, multiple dispatcher threads preserve the order of key updates.</dd> -<dt><b>thread</b></dt> -<dd>When distributing region events from the local queue, multiple dispatcher threads preserve the order in which a given thread added region events to the queue.</dd> -<dt><b>partition</b></dt> -<dd>When distributing region events from the local queue, multiple dispatcher threads preserve the order in which region events were added to the local queue. For a partitioned region, this means that all region events delivered to a specific partition are delivered in the same order to the remote Geode site. For a distributed region, this means that all key updates delivered to the local gateway sender queue are distributed to the remote site in the same order.</dd> - -<p>You cannot configure the <code class="ph codeph">order-policy</code> for a parallel event queue, because parallel queues cannot preserve event ordering for regions. Only the ordering of events for a given partition (or in a given queue of a distributed region) can be preserved.</p></td> -<td>key</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-gateway-event-filter</span></td> -<td>A list of fully-qualified class names of GatewayEventFilters (separated by comma) to be associated with the GatewaySender. This serves as a callback for users to filter out events before dispatching to remote distributed system. For example: -<pre class="pre codeblock"><code>gateway-event-filter=com.user.filters.MyFilter1,com.user.filters.MyFilters2</code></pre></td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-gateway-transport-filter</span></td> -<td>The fully-qualified class name of the GatewayTransportFilter to be added to the GatewaySender.</td> -<td>Â </td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 5. Create Gateway-Sender Parameters</span> - -**Example Commands:** - -``` pre -gfsh>create gateway-sender --remote-distributed-system-id="2" --id="sender2" -``` - -**Sample Output:** - -``` pre -gfsh>create gateway-sender --remote-distributed-system-id="2" --id="sender2" -Member | Status -------- | -------------------------------------------- -server1 | GatewaySender "sender2" created on "server1" -``` - -## <a id="topic_960A5B6FD3D84E1881EE118E299DD12D" class="no-quick-link"></a>create index - -Create an index that can be used when executing queries. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -See [Working with Indexes](../../../developing/query_index/query_index.html). - -**Syntax:** - -``` pre -create index --name=value --expression=value --region=value -[--member=value] [--type=value] [--group=value] -``` - -<a id="topic_960A5B6FD3D84E1881EE118E299DD12D__table_9E1C010276AC45A59446A767A517D39F"></a> - -| Name | Description | Default | -|----------------------------------------------------|----------------------------------------------------------------------------------------|---------| -| <span class="keyword parmname">\\-\\-name</span> | *Required.* Name of the index to create. | Â | -| <span class="keyword parmname">\\-\\-expression</span> | *Required.* Field of the region values that are referenced by the index. | Â | -| <span class="keyword parmname">\\-\\-region</span> | *Required.* Name/Path of the region which corresponds to the "from" clause in a query. | Â | -| <span class="keyword parmname">\\-\\-member</span> | Name/Id of the member on which index will be created. | Â | -| <span class="keyword parmname">\\-\\-type</span> | Type of the index. Valid values are: `range`, `key` and `hash`. | `range` | -| <span class="keyword parmname">\\-\\-group</span> | The index will be created on all the members in this member group. | Â | - -<span class="tablecap">Table 6. Create Index Parameters</span> - -**Example Commands:** - -``` pre -create index --name=myKeyIndex --expression=region1.Id --region=region1 --type=key -``` - -**Sample Output:** - -``` pre -gfsh>create index --name=myKeyIdex --expression=region1.Id --region=region1 --type=key -Index successfully created with following details -Name : myKeyIdex -Expression : region1.Id -RegionPath : /region1 -Members which contain the index -1. ubuntu(server1:17682)<v1>:27574 - -gfsh>create index --name=myIndex2 --expression=exp2 --region=/exampleRegion -Failed to create index "myIndex2" due to following reasons -Index "myIndex2" already exists. Create failed due to duplicate name. -Occurred on following members -1. ubuntu(server1:17682)<v1>:27574 -``` - -## <a id="topic_54B0985FEC5241CA9D26B0CE0A5EA863" class="no-quick-link"></a>create region - -Create a region with given path and configuration. - -You must specify either a `--type` or a `--template-region` for initial configuration when creating a region. Specifying a `--key-constraint` and `--value-constraint` makes object type information available during querying and indexing. - -See [Region Data Storage and Distribution](../../../developing/region_options/chapter_overview.html). - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre - create region --name=value [--type=value] [--template-region=value] - [--group=value(,value)*] [--skip-if-exists(=value)?] - [--key-constraint=value] [--value-constraint=value] - [--enable-statistics=value] [--entry-idle-time-expiration=value] - [--entry-idle-time-expiration-action=value] - [--entry-time-to-live-expiration=value] - [--entry-time-to-live-expiriation-action=value] - [--region-idle-time-expiration=value] - [--region-idle-time-expiration-action=value] - [--region-time-to-live-expiration=value] - [--region-time-to-live-expiration-action=value] [--disk-store=value] - [--enable-synchronous-disk=value] [--enable-async-conflation=value] - [--enable-subscription-conflation=value] [--cache-listener=value(,value)*] - [--cache-loader=value] [--cache-writer=value] - [--async-event-queue-id=value(,value)*] - [--gateway-sender-id=value(,value)*] [--enable-concurrency-checks=value] - [--enable-cloning=value] [--concurrency-level=value] - [--colocated-with=value] [--local-max-memory=value] - [--recovery-delay=value] [--redundant-copies=value] - [--startup-recovery-delay=value] [--total-max-memory=value] - [--total-num-buckets=value] [--compressor=value] [--off-heap(=value)] -``` - -<a id="topic_54B0985FEC5241CA9D26B0CE0A5EA863__table_4CDCDC115DD043D5B8ACAA8D4CCFB145"></a> - -<table> -<caption><span class="tablecap">Table 7. Create Region Parameters</span></caption> -<colgroup> -<col width="20%" /> -<col width="50%" /> -<col width="30%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Name</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td><span class="keyword parmname">\-\-name</span></td> -<td><em>Required.</em> Name/Path of the region to be created.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-type</span></td> -<td><em>Required</em> (if template-region is not specified.) Type of region to create. Options include: PARTITION, PARTITION_REDUNDANT, REPLICATE, LOCAL, etc. -<p>To get a list of of all region type options, add the <span class="keyword parmname">\-\-type</span> parameter and then select the TAB key to display a full list.</p></td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-template-region </span></td> -<td><em>Required</em> (if type is not specified.) Name/Path of the region whose attributes should be duplicated when creating this region.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-group</span></td> -<td>Group(s) of members on which the region will be created.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-skip-if-exists</span></td> -<td>Skip region creation if the region already exists. 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.</td> -<td><code class="ph codeph">true</code></td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-key-constraint</span></td> -<td>Fully qualified class name of the objects allowed as region keys. Ensures that keys for region entries are all of the same class.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-value-constraint </span></td> -<td>Fully qualified class name of the objects allowed as region values. If not specified, then region values can be of any class.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-enable-statistics</span></td> -<td>Whether to gather statistics for the region. Must be true to use expiration on the region.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-entry-idle-time-expiration</span></td> -<td>How long the region's entries can remain in the cache without being accessed.</td> -<td>no expiration</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-entry-idle-time-expiration-action </span></td> -<td>Action to be taken on an entry that has exceeded the idle expiration. Valid expiration actions include destroy, local-destroy, invalidate (default), local-invalidate.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-entry-time-to-live-expiration</span></td> -<td>How long the region's entries can remain in the cache without being accessed or updated. The default is no expiration of this type.</td> -<td>no expiration</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-entry-time-to-live-expiration-action</span></td> -<td>Action to be taken on an entry that has exceeded the TTL expiration. Valid expiration actions include destroy, local-destroy, invalidate (default), local-invalidate.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-region-idle-time-expiration</span></td> -<td>How long the region can remain in the cache without being accessed. The default is no expiration of this type.</td> -<td>no expiration</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-region-idle-time-expiration-action </span></td> -<td>Action to be taken on a region that has exceeded the idle expiration. Valid expiration actions include destroy, local-destroy, invalidate (default), local-invalidate.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-region-time-to-live-expiration </span></td> -<td>How long the region can remain in the cache without being accessed or updated. The default is no expiration of this type.</td> -<td>no expiration</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-region-time-to-live-expiration-action</span></td> -<td>Action to be taken on a region that has exceeded the TTL expiration. Valid expiration actions include destroy, local-destroy, invalidate (default), local-invalidate.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-disk-store</span></td> -<td>Disk Store to be used by this region. The [list disk-stores](list.html#topic_BC14AD57EA304FB3845766898D01BD04) command can be used to display existing disk stores.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-enable-synchronous-disk</span></td> -<td>Whether writes are done synchronously for regions that persist data to disk.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-enable-async-conflation</span></td> -<td>Whether to allow aggregation of asynchronous TCP/IP messages sent by the producer member of the region. A false value causes all asynchronous messages to be sent individually.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-enable-subscription-conflation</span></td> -<td>Whether the server should conflate its messages to the client. A false value causes all server-client messages to be sent individually.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-cache-listener</span></td> -<td>Fully qualified class name of a plug-in to be instantiated for receiving after-event notification of changes to the region and its entries. Any number of cache listeners can be configured.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-cache-loader</span></td> -<td>Fully qualified class name of a plug-in to be instantiated for receiving notification of cache misses in the region. At most, one cache loader can be defined in each member for the region. For distributed regions, a cache loader may be invoked remotely from other members that have the region defined.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-cache-writer</span></td> -<td>Fully qualified class name of a plug-in to be instantiated for receiving before-event notification of changes to the region and its entries. The plug-in may cancel the event. At most, one cache writer can be defined in each member for the region.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-async-event-queue-id</span></td> -<td>IDs of the Async Event Queues that will be used for write-behind operations.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-gateway-sender-id</span></td> -<td>IDs of the Gateway Senders to which data will be routed.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-enable-concurrency-checks</span></td> -<td>Whether Region Version Vectors are implemented. Region Version Vectors are an extension to the versioning scheme that aid in synchronization of replicated regions.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-enable-cloning</span></td> -<td>Determines how fromDelta applies deltas to the local cache for delta propagation. When true, the updates are applied to a clone of the value and then the clone is saved to the cache. When false, the value is modified in place in the cache.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-concurrency-level </span></td> -<td>Estimate of the maximum number of application threads that will concurrently access a region entry at one time. This attribute does not apply to partitioned regions.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-colocated-with </span></td> -<td>Central Region with which this region should be colocated.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-local-max-memory</span></td> -<td>Maximum amount of memory, in megabytes, to be used by the region in this process. (The default is 90% of available heap.)</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-recovery-delay </span></td> -<td>Delay in milliseconds that existing members will wait before satisfying redundancy after another member crashes. The default (value of -1) indicates that redundancy will not be recovered after a a failure.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-redundant-copies </span></td> -<td>Number of extra copies of buckets desired. Extra copies allow for both high availability in the face of VM departure (intended or unintended) and load balancing read operations. (Allowed values: 0, 1, 2 and 3)</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-startup-recovery-delay </span></td> -<td>Delay in milliseconds that new members will wait before satisfying redundancy. -1 indicates that adding new members will not trigger redundancy recovery.</td> -<td>The default is to recover redundancy immediately when a new member is added.</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-total-max-memory </span></td> -<td>Maximum amount of memory, in megabytes, to be used by the region in all processes.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-total-num-buckets </span></td> -<td>Total number of hash buckets to be used by the region in all processes.</td> -<td>113</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-compressor</span></td> -<td>Java class name that implements compression for the region. You can write a custom compressor that implements <code class="ph codeph">org.apache.geode.compression.Compressor</code> or you can specify the Snappy compressor (<code class="ph codeph">org.apache.geode.compression.SnappyCompressor</code>), which is bundled with Geode. See <a href="../../../managing/region_compression/region_compression.html#topic_r43_wgc_gl">Region Compression</a>.</td> -<td>no compression</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-off-heap</span></td> -<td>Specifies whether the region values are stored in heap memory or off-heap memory. When true, region values are in off-heap memory. If the parameter is specified without a value, the value of true is used.</td> -<td>false</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 7. Create Region Parameters</span> - -**Example Commands:** - -``` pre -create region --name=region1 --type=REPLICATE_PERSISTENT \ ---cache-writer=org.apache.geode.examples.MyCacheWriter \ ---group=Group1 --disk-store=DiskStore1 - -create region --name=region12 --template-region=/region1 - -create region --name=region2 --type=REPLICATE \ ---cache-listener=org.apache.geode.examples.MyCacheListener1,\ -org.apache.geode.examples.MyCacheListener2 \ ---group=Group1,Group2 - -create region --name=region3 --type=PARTITION_PERSISTENT --redundant-copies=2 --total-max-memory=1000 \ ---startup-recovery-delay=5 --total-num-buckets=100 --disk-store=DiskStore2 \ ---cache-listener=org.apache.geode.examples.MyCacheListener3 \ ---group=Group2 - -create region --name=region4 --type=REPLICATE_PROXY --cache-listener=org.apache.geode.examples.MyCacheListener1 ---group=Group1,Group2 -``` - -**Sample Output:** - -``` pre -gfsh>create region --name=myRegion --type=LOCAL -Member | Status -------- | --------------------------------------- -server1 | Region "/myRegion" created on "server1" -``` - -
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/debug.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/debug.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/debug.html.md.erb deleted file mode 100644 index 38cf379..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/debug.html.md.erb +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: debug ---- - -Enable or disable debugging output in `gfsh`. - -**Availability:** Online or offline. - -**Syntax:** - -``` pre -debug --state=value -``` - -<a id="concept_B70E7B27CEF1496CB3B7217B15FF4726__table_B6D7C12CE550464CB7D6B2159BD94A1E"></a> - -| Name | Description | Default Value | -|------------------------------------------------|------------------------------------------------------------------------------------|---------------| -| <span class="keyword parmname">‑‑state </span> | Whether to turn debugging ON or OFF. Valid options are: ON, OFF (Case insensitive) | OFF | - -<span class="tablecap">Table 1. Debug Parameters</span> - -**Example Commands:** - -``` pre -debug --state=off -debug --state=on -``` - -**Sample Output:** - -``` pre -gfsh>debug --state=on -Debug is on -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/define.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/define.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/define.html.md.erb deleted file mode 100644 index 32c0df0..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/define.html.md.erb +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: define index ---- - -Define an index that can be used when executing queries. Then, you can execute a single command to create multiple indexes all at once using `create defined indexes`. - -**Availability:** Online or offline. - -**Syntax:** - -``` pre -define index --name=value --expression=value --region=value [--type=value] -``` - -<a id="concept_B70E7B27CEF1496CB3B7217B15FF4726__table_B6D7C12CE550464CB7D6B2159BD94A1E"></a> - -| Name | Description | Default Value | -|----------------------------------------------------|----------------------------------------------------------------------------------------|---------------| -| <span class="keyword parmname">\\-\\-name </span> | *Required.* Name of the index to define. | Â | -| <span class="keyword parmname">‑‑expression</span> | *Required.* Field of the region values that are referenced by the index. | Â | -| <span class="keyword parmname">\\-\\-region</span> | *Required.* Name/Path of the region which corresponds to the "from" clause in a query. | Â | -| <span class="keyword parmname">\\-\\-type</span> | Type of the index. Valid values are: range, key and hash. | range | - -<span class="tablecap">Table 1. Define Index Parameters</span> - -**Example Commands:** - -``` pre -gfsh> define index --name=myIndex1 --expression=exp1 --region=/exampleRegion - -gfsh> define index --name=myIndex2 --expression=âc.exp2â --region="/exampleRegion e, e.collection1 c" - -gfsh> define index --name=myIndex3 --expression=exp3 --region=/exampleRegion --type=hash - -//then to create the indexes, execute: - -gfsh> create defined indexes - -``` - -**Sample Output:** - -``` pre -gfsh>define index --name=myIndex1 --expression=exp1 --region=/exampleRegion -Index successfully defined with following details -Name : myIndex1 -Expression : exp1 -RegionPath : /exampleRegion -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/deploy.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/deploy.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/deploy.html.md.erb deleted file mode 100644 index 22eab4e..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/deploy.html.md.erb +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: deploy ---- - -Deploy JAR-packaged applications to a member or members. - -Only one of either `--jar` or `--dir` may be specified. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -deploy [--group=value(,value)*] [--jar=value] [--dir=value] -``` - -<a id="concept_6B38CB283BC048778A8E3908C1BDF221__table_gfk_42h_2w"></a> - -| Name | Description | -|-----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| -| <span class="keyword parmname">‑‑group</span> | Group(s) to which the specified JARs will be deployed. If this option is not specified, the deployment will occur on all members. | -| <span class="keyword parmname">\\-\\-jar</span> | Path of the JAR to deploy. | -| <span class="keyword parmname">\\-\\-dir</span> | Directory from which to deploy the JARs. | - -<span class="tablecap">Table 1. Deploy Parameters</span> - -**Example Commands:** - -``` pre -deploy --jar=group1_functions.jar --group=Group1 - -deploy --dir=libs/group1-libs --group=Group2 -``` - -**Sample Output:** - -``` pre -gfsh> deploy --jar=group1_functions.jar --group=Group1 - - Member | Deployed JAR | Deployed JAR Location ---------- | -------------------- | --------------------------------------------------- -datanode1 | group1_functions.jar | /usr/local/gemfire/deploy/GF#group1_functions.jar#1 -datanode2 | group1_functions.jar | /usr/local/gemfire/deploy/GF#group1_functions.jar#1 - - -gfsh> deploy --dir=libs/group1-libs --group=Group2 - -Deploying files: group2_functions.jar, group2_dependencies.jar -Total file size is: 0.64MB - -Continue? (Y/n): Y - - Member | Deployed JAR | Deployed JAR Location ---------- | ----------------------- | --------------------------------------------- -datanode3 | group2_functions.jar | /usr/local/gemfire/deploy/GF#group2_functions.jar#1 -datanode3 | group2_dependencies.jar | /usr/local/gemfire/deploy/GF#group2_dependencies.jar#1 -datanode4 | group2_functions.jar | /usr/local/gemfire/deploy/GF#group2_functions.jar#1 -datanode4 | group2_dependencies.jar | /usr/local/gemfire/deploy/GF#group2_dependencies.jar#1 -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/describe.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/describe.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/describe.html.md.erb deleted file mode 100644 index 0d1341f..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/describe.html.md.erb +++ /dev/null @@ -1,392 +0,0 @@ ---- -title: describe ---- -<a id="concept_B8A3E21674294C65AE9F9A60F37A284E"></a> - - -Display details of a member's configuration, shell connection, disk-stores, members, or regions. - -- **[describe client](../../../tools_modules/gfsh/command-pages/describe.html#topic_gyr_jgz_ck)** - - Displays details about a specified client. - -- **[describe config](../../../tools_modules/gfsh/command-pages/describe.html#topic_3C2C817D999C4E40AF788808B7B6AF99)** - - Display the configuration of a member. - -- **[describe connection](../../../tools_modules/gfsh/command-pages/describe.html#topic_591DC6B781B641168E6173E69AC6D201)** - - Display connection information details. - -- **[describe disk-store](../../../tools_modules/gfsh/command-pages/describe.html#topic_C635B500BE6A4F1D9572D0BC98A224F2)** - - Display information about a member's disk store. - -- **[describe member](../../../tools_modules/gfsh/command-pages/describe.html#topic_D62F3D42B1D84CF68F03D54D5122806A)** - - Display details of a member with given name/id. - -- **[describe offline-disk-store](../../../tools_modules/gfsh/command-pages/describe.html#topic_kys_yvk_2l)** - - Display information about an offline member's disk store. - -- **[describe region](../../../tools_modules/gfsh/command-pages/describe.html#topic_DECF7D3D33F54071B6B8AD4EA7E3F90B)** - - Display the attributes and key information of a region. - -## <a id="topic_gyr_jgz_ck" class="no-quick-link"></a>describe client - -Displays details about a specified client. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -describe client --clientID=value -``` - -<a id="topic_gyr_jgz_ck__table_pzd_qdh_2w"></a> - -| Name | Description | -|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| -| <span class="keyword parmname">‑‑clientID</span> | *Required.* ID of the client. To find a client ID, you can use the `list clients` command to display a list of connected clients and their IDs. | - -<span class="tablecap">Table 1. Describe Client Parameters</span> - -**Example Commands:** - -``` pre -describe client --clientID=192.0.2.0(4987:loner):58922:7b3398cf -``` - -**Sample Output:** - -``` pre -gfsh>describe client --clientID=192.0.2.0(4987:loner):58922:7b3398cf -------------------------------------------------------------------- -Primary Servers : 192.0.2.0(server1:5764)<v1>:15189 -Secondary Servers : 192.0.2.0(server2:5891)<v2>:39082 -CPU : 0 -Number of Cache Listner Calls : 0 -Number of Gets : 0 -Number of Misses : 0 -Number of Puts : 0 -Number of Threads : 0 -Process CPU Time (nanoseconds) : 0 -Queue size : 1 -UP Time (seconds) : 67 -Is Durable : No -``` - -## <a id="topic_3C2C817D999C4E40AF788808B7B6AF99" class="no-quick-link"></a>describe config - -Display the configuration of a member. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -describe config --member=value [--hide-defaults(=value)?] -``` - -<a id="topic_3C2C817D999C4E40AF788808B7B6AF99__table_ohx_tdh_2w"></a> - -| Name | Description | Default Value | -|-------------------------------------------------------|----------------------------------------------------------------------------------|---------------| -| <span class="keyword parmname">\\-\\-member </span> | Name or ID of a member whose configuration is to be shown. | Â | -| <span class="keyword parmname">\\-\\-hide-defaults</span> | Whether to hide configuration information for properties with the default value. | true | - -<span class="tablecap">Table 2. Describe Config Parameters</span> - -**Example Commands:** - -``` pre -describe config --member=Member1; -``` - -**Sample Output:** - -``` pre -gfsh>describe config --member=server1 -Configuration of member : "server1" - - -JVM command line arguments ------------------------------------ --Dgemfire.mcast-port=0 --Dgemfire.locators=localhost[10334] - -GemFire properties defined using the API -................................................ -log-file : vf.gf.server.log -name : server1 - -GemFire properties defined at the runtime -................................................ -log-level : finest -statistic-sampling-enabled : true - -Cache attributes -................................................ -is-server : true - -Cache-server attributes - . bind-address : localhost -``` - -## <a id="topic_591DC6B781B641168E6173E69AC6D201" class="no-quick-link"></a>describe connection - -Display connection information details. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -describe connection -``` - -**Example Commands:** - -``` pre -describe connection -``` - -**Sample Output:** - -``` pre -gfsh>describe connection -Connection Endpoints --------------------- -GemFireUser[1099] -``` - -## <a id="topic_C635B500BE6A4F1D9572D0BC98A224F2" class="no-quick-link"></a>describe disk-store - -Display information about a member's disk store. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -describe disk-store --member=value --name=value -``` - -<a id="topic_C635B500BE6A4F1D9572D0BC98A224F2__table_xs1_12h_2w"></a> - -| Name | Description | -|------------------------------------------------|------------------------------------------------------------------------| -| <span class="keyword parmname">\\-\\-member</span> | *Required.* Name/ID of the member with the disk store to be described. | -| <span class="keyword parmname">\\-\\-name </span> | *Required*. Name of the disk store to be described. | - -<span class="tablecap">Table 3. Describe Disk-Store Parameters</span> - -**Example Commands:** - -``` pre -describe disk-store --member=server1 --name=DiskStore1 -``` - -**Sample Output:** - -``` pre -gfsh>describe disk-store --name=disk1 --member=server1 -Disk Store ID : a531bc7b-5188-4510-85d7-de7de30c6671 -Disk Store Name : disk1 -Member ID : ubuntu(server1:7467)<v1>:35249 -Member Name : server1 -Allow Force Compaction : No -Auto Compaction : Yes -Compaction Threshold : 50 -Max Oplog Size : 1024 -Queue Size : 0 -Time Interval : 1000 -Write Buffer Size : 32768 -Disk Usage Warning Percentage : 90 -Disk Usage Critical Percentage : 99 -PDX Serialization Meta-Data Stored : No - - - Disk Directory | Size -------------------------------- | ---------- -/home/user/server1/DiskStore1 | 2147483647 - -``` - -## <a id="topic_D62F3D42B1D84CF68F03D54D5122806A" class="no-quick-link"></a>describe member - -Display details of a member with given name/id. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -describe member --name=value -``` - -<a id="topic_D62F3D42B1D84CF68F03D54D5122806A__table_psn_c2h_2w"></a> - -| Name | Description | -|-----------------------------------------------|-------------------------------------------------------------------------------------------| -| <span class="keyword parmname">‑‑name </span> | *Required.* Display information about a member, including name, ID, groups, regions, etc. | - -<span class="tablecap">Table 4. Describe Member Parameters</span> - -**Example Commands:** - -``` pre -describe member --name=server1 -``` - -**Sample Output:** - -``` pre -gfsh>describe member --name=server1 -Name : server1 -Id : GemFireUser(server1:240)<v1>:64871 -Host : 192.0.2.0 -Regions : region4 -region5 -region3 -region2 -region1 - -PID : 240 -Groups : -Used Heap : 5M -Max Heap : 123M -Working Dir : c:\PivotalGemFire70\Latest\server1 -Log file : C:\PivotalGemFire70\Latest\server1\vf.gf.server.log -Locators : localhost[10334] - -Server Bind : localhost -Server Port : 40404 -Running : true -Client Connections : 0 -``` - -## <a id="topic_kys_yvk_2l" class="no-quick-link"></a>describe offline-disk-store - -Display information about an offline member's disk store. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -describe offline-disk-store --name=value --disk-dirs=value(,value)* [--pdx=value] [--region=value] -``` - -<a id="topic_kys_yvk_2l__table_rlg_f2h_2w"></a> - -| Name | Description | -|----------------------------------------------------|------------------------------------------------------------------------------| -| <span class="keyword parmname">\\-\\-name</span> | *Required.* Name of the disk store to be described. | -| <span class="keyword parmname">\\-\\-disk-dirs </span> | *Required.* Directory that contains the disk store files. | -| <span class="keyword parmname">\\-\\-pdx</span> | If set (or set to true), display all the pdx types stored in the disk store. | -| <span class="keyword parmname">\\-\\-region</span> | Name and path of the region in the disk store to be described. | - -<span class="tablecap">Table 5. Describe Offline-Disk-Store Parameters</span> - -**Example Commands:** - -``` pre -describe offline-disk-store --name=DiskStore1\ - --disk-dirs=/home/username/gemfire/mydiskStore1Dir - -describe offline-disk-store --name=DiskStore1 --disk-dirs=/DiskDir1 --pdx=true -``` - -**Sample Output:** - -``` pre -gfsh>describe offline-disk-store --name=DiskStore1 --disk-dirs=/DiskDir1 --pdx=true -Regions in the disk store: - /PdxTypes: -lru=none -concurrencyLevel=16 -initialCapacity=16 -loadFactor=0.75 -compressor=none -statisticsEnabled=false - /Region1: -lru=none -concurrencyLevel=16 -initialCapacity=16 -loadFactor=0.75 -compressor=none -statisticsEnabled=false -PDX Types: - com.app.data.PositionPdx: id=1 - long avg20DaysVol; - String bondRating; - double convRatio; - String country; - double delta; - long industry; - long issuer; - double mktValue; - double qty; - String secId; // identity - String secIdIndexed; - String secLinks; - double sharesOutstanding; - String underlyer; - long volatility; - int pid; - int portfolioId; - com.app.data.StockPdx: id=2 - int ID; // identity - String pkid; - Object position1; - Object position2; - Object positions; - Object collectionHolderMap; - String type; - String status; - String[] names; - String description; - long createTime; - Object[] position3; - Object aDay; - Date date; -PDX Enums: - com.app.data.StockPdx$Day.Monday -``` - -## <a id="topic_DECF7D3D33F54071B6B8AD4EA7E3F90B" class="no-quick-link"></a>describe region - -Display the attributes and key information of a region. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -describe region --name=value -``` - -<a id="topic_DECF7D3D33F54071B6B8AD4EA7E3F90B__table_wvt_32h_2w"></a> - -| Name | Description | -|-----------------------------------------------|------------------------------------------------------| -| <span class="keyword parmname">\\-\\-name </span> | *Required.* Name/Path of the region to be described. | - -<span class="tablecap">Table 6. Describe Region Parameters</span> - -**Example Commands:** - -``` pre -describe region --name=region1 -``` - -**Sample Output:** - -``` pre -gfsh>describe region --name=region1 -.......................................................... -Name : region1 -Data Policy : normal -Hosting Members : server1 -server2 - - -Non-Default Attributes Shared By Hosting Members - - Type | Name | Value ------- | ----------- | ------ -Region | data-policy | NORMAL - | size | 0 -``` http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/destroy.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/destroy.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/destroy.html.md.erb deleted file mode 100644 index a90c088..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/destroy.html.md.erb +++ /dev/null @@ -1,161 +0,0 @@ ---- -title: destroy ---- -<a id="concept_B8A3E21674294C65AE9F9A60F37A284E"></a> - - -Delete or unregister functions, remove indexes, disk stores and regions. - -- **[destroy disk-store](../../../tools_modules/gfsh/command-pages/destroy.html#topic_yfr_l2z_ck)** - - Deletes a disk store and all files on disk used by the disk store. Data for closed regions that previously used this disk store is lost. - -- **[destroy function](../../../tools_modules/gfsh/command-pages/destroy.html#topic_E48C2DF809054C12A162026D8A2139BB)** - - Destroy or unregister a function. - -- **[destroy index](../../../tools_modules/gfsh/command-pages/destroy.html#topic_D00219CCD6F64C1582A0802AC5CDF3F3)** - - Destroy or remove the specified index. - -- **[destroy region](../../../tools_modules/gfsh/command-pages/destroy.html#topic_BEDACECF4599407794ACBC0E56B30F65)** - - Destroy or remove a region. - -## <a id="topic_yfr_l2z_ck" class="no-quick-link"></a>destroy disk-store - -Deletes a disk store and all files on disk used by the disk store. Data for closed regions that previously used this disk store are lost. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -destroy disk-store --name=value [--group=value(,value)*] -``` - -<a id="topic_yfr_l2z_ck__table_ypc_1dh_2w"></a> - -| Name | Description | -|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| -| <span class="keyword parmname">\\-\\-name</span> | *Required.* Name of the disk store to be deleted. | -| <span class="keyword parmname">‑‑group</span> | Group(s) of members on which the disk store will be destroyed. If no group is specified, the disk store is destroyed on all members. | - -<span class="tablecap">Table 1. Destroy Disk-Store Parameters</span> - -**Example Commands:** - -``` pre -destroy disk-store --name=store1 -``` - -**Sample Output:** - -``` pre -gfsh>destroy disk-store --name=store1 -Member | Result -------- | ------- -server1 | Success -``` - -## <a id="topic_E48C2DF809054C12A162026D8A2139BB" class="no-quick-link"></a>destroy function - -Destroy or unregister a function. - -The default is for the function to be unregistered from all members. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -destroy function --id=value [--group=value] [--member=value] -``` - -<a id="topic_E48C2DF809054C12A162026D8A2139BB__table_rq1_ddh_2w"></a> - -| Name | Description | -|------------------------------------------------|--------------------------------------------------------------------------------------------| -| <span class="keyword parmname">\\-\\-id</span> | *Required.* Unique function identifier. Use the `list functions` command to obtain the ID. | -| <span class="keyword parmname">\\-\\-groups</span> | One or more groups of members from which this function will be unregistered. | -| <span class="keyword parmname">‑‑member</span> | Name or ID of the member from which this function will be unregistered. | - -<span class="tablecap">Table 2. Destroy Function Parameters</span> - -**Example Commands:** - -``` pre -(1) destroy function --id=InterestCalculations -(2) destroy function --id=InterestCalculations --member=server1 -(3) destroy function --id=InterestCalculations --group=Group1 -``` - -## <a id="topic_D00219CCD6F64C1582A0802AC5CDF3F3" class="no-quick-link"></a>destroy index - -Destroy or remove the specified index. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -destroy index [--name=value] [--region=value] [--member=value] -[--group=value] -``` - -**Note:** -You must specify at least one of the parameter options. If you enter `destroy index` without any parameters, the command will ask you to specify at least one option. - -<a id="topic_D00219CCD6F64C1582A0802AC5CDF3F3__table_n24_fdh_2w"></a> - -| Name | Description | -|------------------------------------------------|------------------------------------------------------------------------------| -| <span class="keyword parmname">\\-\\-name</span> | Name for the index to be removed. | -| <span class="keyword parmname">\\-\\-member</span> | Id of the member on which index is to be created. | -| <span class="keyword parmname">\\-\\-region</span> | Name of the region , from where an index or all indexes are to be destroyed. | -| <span class="keyword parmname">\\-\\-group</span> | The index will be created on all the members in this member group. | - -<span class="tablecap">Table 3. Destroy Index Parameters</span> - -**Example Commands:** - -``` pre -destroy index --member=server2 -destroy index --name=MyKeyIndex -``` - -## <a id="topic_BEDACECF4599407794ACBC0E56B30F65" class="no-quick-link"></a>destroy region - -Destroy or remove a region. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -destroy region --name=value -``` - -<a id="topic_BEDACECF4599407794ACBC0E56B30F65__table_yb5_3dh_2w"></a> - -| Name | Description | -|----------------------------------------------|--------------------------------------------------------| -| <span class="keyword parmname">\\-\\-name</span> | *Required.* Name and path of the region to be removed. | - -<span class="tablecap">Table 4. Destroy Region Parameters</span> - -**Example Commands:** - -``` pre -destroy region --name=region4 -destroy region --name=/region1/subregion1 -``` - -**Sample Output:** - -``` pre -gfsh>destroy region --name=region1 -"region1" destroyed successfully. -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/disconnect.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/disconnect.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/disconnect.html.md.erb deleted file mode 100644 index 874fc54..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/disconnect.html.md.erb +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: disconnect ---- - -Close any active connection(s). - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -disconnect -``` - -**Example Commands:** - -``` pre -disconnect -``` - -**Sample Output:** - -``` pre -gfsh>disconnect -Disconnecting from: Locator1[1099] -Disconnected from : Locator1[1099] -``` - -**Error Messages:** - -``` pre -Error occurred while disconnecting: {0} -``` - -``` pre -Not connected! -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/echo.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/echo.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/echo.html.md.erb deleted file mode 100644 index 91b775e..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/echo.html.md.erb +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: echo ---- - -Echo the given text, which may include system and user variables. - -The command can also echo gfsh environment properties (using '[set variable](set.html)' command) if variable name is pre-pended with '$' - like UNIX. - -See [Useful gfsh Shell Variables](../useful_gfsh_shell_variables.html#concept_731ECA5E40E943CBA5C1198A0745D8EE) for a list of gfsh environment variables. - -**Availability:** Online or offline. - -**Syntax:** - -``` pre -echo [--string=value] -``` - -<a id="concept_2828E2617F6A49D7BB811917BE268704__table_uwf_sch_2w"></a> - -| Name | Description | -|-------------------------------------------------|--------------------------------------------------------------------------------------------------------------| -| <span class="keyword parmname">\\-\\-string </span> | String to be echoed. For example, `SYS_USER variable is set to ${SYS_USER}`. | - -<span class="tablecap">Table 1. Echo Parameters</span> - -**Example Commands:** - -``` pre -echo --string="Hello World!" -echo --string="Hello World! This is ${SYS_USER}" -echo --string=${APP_FETCH_SIZE} -``` - -To see all the variable set in the shell: - -``` pre -echo --string=$* -``` - -**Sample Output:** - -``` pre -gfsh>echo --string=${SYS_JAVA_VERSION} -Post substitution: echo --string=1.8.0_60 -1.8.0_60 -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/encrypt.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/encrypt.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/encrypt.html.md.erb deleted file mode 100644 index 1220690..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/encrypt.html.md.erb +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: encrypt password ---- - -Encrypt a password for later use. - -## <a id="concept_2B834B0AC8EE44C6A7F85CC66B1D6E18__section_F3D0959AF6264A3CB1821383B2AE4407" class="no-quick-link"></a>encrypt password - -Encrypt a password for use in data source configuration. See [Configuring Database Connections Using JNDI](../../../developing/transactions/configuring_db_connections_using_JNDI.html#topic_A5E3A67C808D48C08E1F0DC167C5C494) and [Encrypting Passwords for Use in cache.xml](../../../managing/security/encrypting_passwords.html#topic_730CC61BA84F421494956E2B98BDE2A1) for more information on how to use these encrypted passwords. - -**Availability:** Online or offline. - -**Syntax:** - -``` pre -encrypt password --password=value -``` - -<a id="concept_2B834B0AC8EE44C6A7F85CC66B1D6E18__table_uvh_gch_2w"></a> - -| | | -|---------------------------------------------------|----------------------------------------------| -| <span class="keyword parmname">\\-\\-password </span> | *Required.* Password string to be encrypted. | - -<span class="tablecap">Table 1. Encrypt Password Parameters</span> - -**Example Commands:** - -``` pre -encrypt password --password=Aht23fbd1234#q -``` - -**Sample Output:** - -``` pre -gfsh>encrypt password --password=Aht23fbd1234#q -21793243D4F4B1C90B032D0CC0A80821 -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/execute.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/execute.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/execute.html.md.erb deleted file mode 100644 index eb29fc1..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/execute.html.md.erb +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: execute function ---- - -Execute functions on members or regions. - -## <a id="concept_F2ED1987126E4338AEB14A7C8F561A2A__section_FB435A8AC76E4E1A8E72DBEA64BA2E57" class="no-quick-link"></a>execute function - -Execute the function with the specified ID. By default, the function executes on all members. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -execute function --id=value [--group=value] [--member=value] [--region=value] -[--arguments=value(,value)*] [--result-collector=value] [--filter=value] -``` - -<a id="concept_F2ED1987126E4338AEB14A7C8F561A2A__table_i4q_dch_2w"></a> - -| | | -|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------| -| <span class="keyword parmname">\\-\\-id</span> | *Required.* ID of the function to execute. | -| <span class="keyword parmname">\\-\\-groups</span> | One or more groups of members on which this function should be executed. | -| <span class="keyword parmname">\\-\\-member</span> | Name/ID of the member on which the function will be executed. | -| <span class="keyword parmname">\\-\\-region</span> | Region on which the data dependent function will be executed. | -| <span class="keyword parmname">\\-\\-arguments</span> | Arguments to the function in comma separated string format. | -| <span class="keyword parmname">\\-\\-result-collector</span> | Fully qualified class name of the `ResultCollector` to instantiate for gathering results. | -| <span class="keyword parmname">\\-\\-filter</span> | Key list which causes the function to only be executed on members which have entries with these keys. | - -<span class="tablecap">Table 1. Execute Function Parameters</span> - -**Example Commands:** - -``` pre -execute function --id=InterestCalculations --region=/InterestRegion -execute function --id=InterestCalculations --member=server1 -execute function --id=InterestCalculations --group=Group1 -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/exit.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/exit.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/exit.html.md.erb deleted file mode 100644 index 12a6086..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/exit.html.md.erb +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: exit ---- - -Exit the `gfsh` shell. You can also use `quit` to exit the shell. - -Exits the gfsh shell and returns to the OS shell. - -**Availability:** Online or offline. - -**Syntax:** - -``` pre -exit -``` - -**Example Commands:** - -``` pre -exit -``` - -
