http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb deleted file mode 100644 index 1bbb070..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb +++ /dev/null @@ -1,503 +0,0 @@ ---- -title: alter ---- -<a id="topic_9323467A645D4F2B82EC236448030D14"></a> - - -Modify an existing Geode resource. - -- **[alter disk-store](../../../tools_modules/gfsh/command-pages/alter.html#topic_99BCAD98BDB5470189662D2F308B68EB)** - - Modify or remove a region from an offline disk-store. - -- **[alter region](../../../tools_modules/gfsh/command-pages/alter.html#topic_E74ED23CB60342538B2175C326E7D758)** - - Alters the configuration of a region. - -- **[alter runtime](../../../tools_modules/gfsh/command-pages/alter.html#topic_7E6B7E1B972D4F418CB45354D1089C2B)** - - Alters configuration properties for all members or a subset of members while the member or members are running. - -## <a id="topic_99BCAD98BDB5470189662D2F308B68EB" class="no-quick-link"></a>alter disk-store - -Modify or remove a region from an offline disk-store. - -When modifying a region's configuration, it is customary to take the region off-line and restart using the new configuration. You can use the `alter disk-store` command to change the configuration of the region stored in the disk-store to match the configuration you will use at restart. - -**Availability:** Offline. - -**Syntax:** - -``` pre -alter disk-store --name=value --region=value --disk-dirs=value(,value)* - [--compressor(=value)] [--concurrency-level=value] - [--enable-statistics=value] [--initial-capacity=value] [--load-factor=value] - [--lru-algorithm=value] [--lru-action=value] [--lru-limit=value] - [--off-heap(=value)] [--remove(=value)] -``` - -The three required options, `--name`, `--region`, and `--disk-dirs`, identify the disk store and region to be altered. If no additional options are specified, `gfsh` displays the current configuration without making any changes. - -<table> -<colgroup> -<col width="50%" /> -<col width="50%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Name</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td><span class="keyword parmname">\-\-name</span></td> -<td><em>Required</em>. Name of the disk-store whose contents will be altered.</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-region</span></td> -<td><em>Required</em>. Name (including path) of the region using the disk store.</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-disk-dirs</span></td> -<td><em>Required</em>. Directories where the data for the disk store was previously written.</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-compressor</span></td> -<td>The fully-qualified class name of the compressor to use when compressing region entry values. A value of <code class="ph codeph">none</code> removes the compressor.</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-concurrency-level</span></td> -<td>An estimate of the maximum number of application threads that will concurrently access a region entry. Together with <span class="keyword parmname">\-\-initial-capacity</span> and <span class="keyword parmname">\-\-load-factor</span>, sets the parameters on the underlying <code class="ph codeph">java.util.ConcurrentHashMap</code> used for storing region entries. This attribute does not apply to partitioned regions.</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-enable-statistics</span></td> -<td>Enables statistics for the region. Valid values are true or false. If the parameter is specified without a value, the value of true is used.</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-initial-capacity</span></td> -<td>Together with <span class="keyword parmname">\-\-concurrency-level</span> and <span class="keyword parmname">\-\-load-factor</span>, sets the parameters on the underlying <code class="ph codeph">java.util.ConcurrentHashMap</code> used for storing region entries.</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-load-factor</span></td> -<td>Together with <span class="keyword parmname">\-\-concurrency-level</span> and <span class="keyword parmname">\-\-initial-capacity</span>, sets the parameters on the underlying <code class="ph codeph">java.util.ConcurrentHashMap</code> used for storing region entries. This must be a floating point number between 0 and 1, inclusive.</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-lru-action</span></td> -<td>Action to take when evicting entries from the region. Valid values are: -<ul> -<li><code class="ph codeph">none</code></li> -<li><code class="ph codeph">overflow-to-disk</code></li> -<li><code class="ph codeph">local-destroy</code></li> -</ul></td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-lru-algorithm</span></td> -<td>Least recently used eviction algorithm. Valid types are: -<ul> -<li><code class="ph codeph">none</code></li> -<li><code class="ph codeph">lru-entry-count</code></li> -<li><code class="ph codeph">lru-heap-percentage</code></li> -<li><code class="ph codeph">lru-memory-size</code></li> -</ul></td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-lru-limit</span></td> -<td>Number of entries allowed in the region before eviction occurs.</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-off-heap</span></td> -<td>Specifies whether the region values are 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> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-remove</span></td> -<td>Specifies whether to remove the region from the disk-store. If the parameter is specified without a value, the value of true is used. Note: <span class="keyword parmname">\-\-remove</span> deletes all persistent data for the region. Consider copying the disk store files to a backup before using this option if you might want to retrieve the data at a later date.</td> -</tr> -</tbody> -</table> - -**Example Commands:** - -``` pre -alter disk-store --name=DiskStore1 --region=region1 --disk-dirs=/Disks/DiskStore1 --off-heap -alter disk-store --name=DiskStore1 --region=region1 --disk-dirs=/Disks/DiskStore1 --remove -``` - -## <a id="topic_E74ED23CB60342538B2175C326E7D758" class="no-quick-link"></a>alter region - -Alters the configuration of a region. - -**Availability:** Online. You must be connected in <span class="keyword parmname">gfsh</span> to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -alter region --name=value [--group=value(,value)*] - [--entry-idle-time-expiration(=value)?] - [--entry-idle-time-expiration-action(=value)?] - [--entry-time-to-live-expiration(=value)?] - [--entry-time-to-live-expiration-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)?] - [--cache-listener=value(,value)*] [--cache-loader(=value)?] - [--cache-writer(=value)?] [--async-event-queue-id=value(,value)*] - [--gateway-sender-id=value(,value)*] [--enable-cloning(=value)?] - [--eviction-max(=value)?] -``` - -<a id="topic_E74ED23CB60342538B2175C326E7D758__table_2277A2CE8F6E4731B45FEFA2B1366DB6"></a> - -<table> -<caption><span class="tablecap">Table 1. Alter Region Parameters</span></caption> -<colgroup> -<col width="25%" /> -<col width="60%" /> -<col width="15%" /> -</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">\-\-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="even"> -<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="odd"> -<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="even"> -<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="odd"> -<td><span class="keyword parmname">\-\-enable-cloning</span></td> -<td><p>Determines how <code class="ph codeph">fromDelta</code> 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.</p></td> -<td><code class="ph codeph">false</code></td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-entry-idle-time-expiration</span></td> -<td>Number of seconds before a region or an entry expires. Specify <code class="ph codeph">-1</code> to indicate that there is no expiration of this type</td> -<td>-1</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-entry-idle-time-expiration-action</span></td> -<td>Action that should take place when a region or an entry expires. -<div class="p"> -Select one of the following expiration actions: -<table> -<tbody> -<tr class="odd"> -<td><span class="keyword option">local-destroy</span></td> -<td>Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">destroy</span></td> -<td>Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.</td> -</tr> -<tr class="odd"> -<td><span class="keyword option">invalidate</span></td> -<td>Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">local-invalidate</span></td> -<td>Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.</td> -</tr> -</tbody> -</table> -</div></td> -<td><code class="ph codeph">invalidate</code></td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-entry-time-to-live-expiration</span></td> -<td>Number of seconds before a region or an entry expires. Specify <code class="ph codeph">-1</code> to indicate that there is no expiration of this type.</td> -<td>-1</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-entry-time-to-live-expiration-action</span></td> -<td>Action that should take place when a region or an entry expires. -<div class="p"> -Select one of the following expiration actions: -<table> -<tbody> -<tr class="odd"> -<td><span class="keyword option">local-destroy</span></td> -<td>Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">destroy</span></td> -<td>Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.</td> -</tr> -<tr class="odd"> -<td><span class="keyword option">invalidate</span></td> -<td>Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">local-invalidate</span></td> -<td>Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.</td> -</tr> -</tbody> -</table> -</div></td> -<td><code class="ph codeph">invalidate</code></td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-eviction-max</span></td> -<td>Maximum value for the Eviction Attributes that the eviction algorithm uses to determine when to perform its eviction action. The unit of the maximum value is determined by the Eviction Algorithm.</td> -<td>0</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-gateway-sender-id</span></td> -<td>IDs of the Gateway Senders where data is routed.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-group</span></td> -<td>Group(s) of members where the region will be altered.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-name</span></td> -<td>Required. Name (including path) of the region.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-region-idle-time-expiration</span></td> -<td>Number of seconds before a region or an entry expires. If timeout is not specified, it defaults to zero (which means no expiration).</td> -<td>-1</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-region-idle-time-expiration-action</span></td> -<td>Action that should take place when a region or an entry expires. -<div class="p"> -Select one of the following expiration actions: -<table> -<tbody> -<tr class="odd"> -<td><span class="keyword option">local-destroy</span></td> -<td>Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">destroy</span></td> -<td>Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.</td> -</tr> -<tr class="odd"> -<td><span class="keyword option">invalidate</span></td> -<td>Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">local-invalidate</span></td> -<td>Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.</td> -</tr> -</tbody> -</table> -</div></td> -<td><code class="ph codeph">invalidate</code></td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-region-time-to-live-expiration </span></td> -<td>Number of seconds before a region or an entry expires. If timeout is not specified, it defaults to zero (which means no expiration).</td> -<td>-1</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-region-time-to-live-expiration-action</span></td> -<td>Action that should take place when a region or an entry expires. -<div class="p"> -Select one of the following expiration actions: -<table> -<tbody> -<tr class="odd"> -<td><span class="keyword option">local-destroy</span></td> -<td>Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">destroy</span></td> -<td>Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.</td> -</tr> -<tr class="odd"> -<td><span class="keyword option">invalidate</span></td> -<td>Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">local-invalidate</span></td> -<td>Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.</td> -</tr> -</tbody> -</table> -</div></td> -<td><code class="ph codeph">invalidate</code></td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 1. Alter Region Parameters</span> - -**Example Commands:** - -``` pre -alter region --name=region1 --eviction-max=5000 [-group=all] -``` - -**Sample Output:** - -``` pre -gfsh>alter region --name=customer --eviction-max=5000 -Member | Status -------- | ---------------------------------- -server1 | Region "/customer" altered on "server1" -``` - -## <a id="topic_7E6B7E1B972D4F418CB45354D1089C2B" class="no-quick-link"></a>alter runtime - -Alters configuration properties for all members or a subset of members while the member or members are running. - -For more information on these configuration properties, see [cache.xml](../../../reference/topics/chapter_overview_cache_xml.html#cache_xml) and configuration parameter reference. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -alter runtime [--member=value] [--group=value] [--archive-disk-space-limit=value] - [--archive-file-size-limit=value] [--log-disk-space-limit=value] - [--log-file-size-limit=value] [--log-level=value] - [--statistic-archive-file=value] [--statistic-sample-rate=value] - [--enable-statistics=value] [--copy-on-read(=value)?] [--lock-lease=value] - [--lock-timeout=value] [--message-sync-interval=value] [--search-timeout=value] -``` - -<a id="topic_7E6B7E1B972D4F418CB45354D1089C2B__table_09BEBCECA4A44286A2A56C3714A4F6A3"></a> - -<table> -<caption><span class="tablecap">Table 2. Alter Runtime 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">\-\-member</span></td> -<td>Name or ID of the member whose configuration is to be altered at runtime. If you do not specify this parameter, the configuration properties are modified for all cluster members using the cluster configuration service.</td> -<td>If not specified, all members using the cluster configuration service</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-group</span></td> -<td>Name of the group whose members's runtime configuration is to be altered. If you do not specify this parameter, the configuration properties are modified for all cluster members using the cluster configuration service.</td> -<td>If not specified, all members using the cluster configuration service</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-archive-disk-space-limit</span></td> -<td>Archive disk space limit. Maximum size (in megabytes) of all inactive statistic archive files combined. If this limit is exceeded, inactive archive files are deleted, oldest first, until the total size is within the limit. If set to zero, disk space use is unlimited. Valid values are (in megabytes): 0 - 1000000.</td> -<td>0</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-archive-file-size-limit</span></td> -<td>Archive file size limit. The maximum size (in megabytes) of a single statistic archive file. Once this limit is exceeded, a new statistic archive file is created, and the current archive file becomes inactive. If set to zero, file size is unlimited. Valid values are (in megabytes): 0 - 1000000.</td> -<td>0</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-log-disk-space-limit </span></td> -<td>Log disk space limit. Maximum size in megabytes of all inactive log files combined. If this limit is exceeded, inactive log files are deleted, oldest first, until the total size is within the limit. If set to zero, disk space use is unlimited. Valid values are (in megabytes): 0 - 1000000.</td> -<td>0</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-log-file-size-limit</span></td> -<td>Log file size limit. Maximum size in megabytes of a log file before it is closed and logging rolls on to a new (child) log file. If set to zero, log rolling is disabled. Valid values are (in megabytes): 0 - 1000000.</td> -<td>0</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-log-level </span></td> -<td>Log level. Valid values are: -<ul> -<li><code class="ph codeph">none</code></li> -<li><code class="ph codeph">error</code></li> -<li><code class="ph codeph">info</code></li> -<li><code class="ph codeph">config</code></li> -<li><code class="ph codeph">warning</code></li> -<li><code class="ph codeph">severe</code></li> -<li><code class="ph codeph">fine</code></li> -<li><code class="ph codeph">finer</code></li> -<li><code class="ph codeph">finest</code></li> -</ul></td> -<td>config</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-statistic-archive-file </span></td> -<td>The file to which the running system member writes statistic samples. For example: "StatisticsArchiveFile.gfs". An empty string disables archiving. Adding .gz suffix to the file name causes it to be compressed. See <a href="../../../managing/statistics/chapter_overview.html">Statistics</a>.</td> -<td><em>not set</em></td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-statistic-sample-rate </span></td> -<td>Statistic sampling rate. Valid values are (in milliseconds): 100 - 60000. See <a href="../../../managing/statistics/chapter_overview.html">Statistics</a>.</td> -<td>1000</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-enable-statistics</span></td> -<td>Whether statistic sampling should be enabled. Valid values are: <code class="ph codeph">true</code> and <code class="ph codeph">false</code>. See <a href="../../../managing/statistics/chapter_overview.html">Statistics</a>.</td> -<td>false</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-copy-on-read</span></td> -<td>True or false. Sets the "copy on read" feature for cache read operations. See <a href="../../../basic_config/data_entries_custom_classes/managing_data_entries.html#managing_data_entries__section_A0E0F889AC344EFA8DF304FD64418809">Safe Entry Modification</a>.</td> -<td>false</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-lock-lease</span></td> -<td>Sets the length, in seconds, of distributed lock leases obtained by this cache. See <a href="../../../managing/monitor_tune/performance_controls_setting_cache_timeouts.html#perf">Setting Cache Timeouts</a>.</td> -<td>120</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-lock-timeout</span></td> -<td>Sets the number of seconds a cache operation may wait to obtain a distributed lock lease before timing out. See <a href="../../../managing/monitor_tune/performance_controls_setting_cache_timeouts.html#perf">Setting Cache Timeouts</a>.</td> -<td>60</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-message-sync-interval</span></td> -<td>Sets the frequency (in seconds) at which a message will be sent by the primary cache-server node to all the secondary cache-server nodes to remove the events which have already been dispatched from the queue. See <a href="../../../developing/events/ha_event_messaging_whats_next.html#ha_event_messaging_whats_next__section_741052B413F24F47A14F5B7D7955F0AA">Change Server Queue Synchronization Frequency</a>.</td> -<td>1</td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-search-timeout</span></td> -<td>Sets the number of seconds a cache get operation can spend searching for a value. See <a href="../../../managing/monitor_tune/performance_controls_setting_cache_timeouts.html#perf">Setting Cache Timeouts</a>.</td> -<td>300</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 2. Alter Runtime Parameters</span> - -**Example Commands:** - -``` pre -alter runtime --member=server1 --log-level=finest --enable-statistics=true -``` - -**Sample Output:** - -``` pre -gfsh>alter runtime --member=server1 --log-level=finest --enable-statistics=true -Runtime configuration altered successfully for the following member(s) -192.0.2.0(server1:240)<v1>:64871 -```
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/backup.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/backup.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/backup.html.md.erb deleted file mode 100644 index d1cc911..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/backup.html.md.erb +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: backup disk-store ---- -<a id="topic_E74ED23CB60342538B2175C326E7D758"></a> - - -Back up persistent data from all members to the specified directory. - -The specified directory must exist on all members, but it can be a local directory on each machine. This command ensures that backup files are not corrupted by concurrent operations. Backing up a running system using the operating system copy command is not recommended. - -You can also use this command to perform an incremental backup. See [Creating Backups for System Recovery and Operational Management](../../../managing/disk_storage/backup_restore_disk_store.html#backup_restore_disk_store) for more information on incremental backup. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -backup disk-store --dir=value [--baseline-dir=value] -``` - -<a id="topic_E74ED23CB60342538B2175C326E7D758__table_2277A2CE8F6E4731B45FEFA2B1366DB6"></a> - -<table> -<caption><span class="tablecap">Table 1. Backup Disk-Store Parameters</span></caption> -<colgroup> -<col width="50%" /> -<col width="50%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Name</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td><span class="keyword parmname">\-\-dir</span></td> -<td><em>Required.</em> Directory to which backup files are written.</td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-baseline-dir</span></td> -<td>Directory that contains the baseline backup used for comparison during an incremental backup. -<p>An incremental backup operation backs up any data that is not present in the directory specified in <span class="keyword parmname">\-\-baseline-dir</span>. If the member cannot find previously backed up data or if the previously backed up data is corrupt, the command performs a full backup on that member.</p></td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 1. Backup Disk-Store Parameters</span> - -**Example Commands:** - -``` pre -backup disk-store --dir=data/backups - -backup disk-store --dir=data/backup/disk-store --baselineDir=data/backups/2012-09-24-17-08-50 -``` - -**Sample Output:** - -``` pre -gfsh>backup disk-store --dir=data/backups -The following disk stores were backed up successfully - -Member | UUID | Directory | Host -------- | ------------------------------------ | ------------------------------------ | --------------- -server2 | a6bb11f0-0baa-45c9-b23e-64876d02a586 | c:\PivotalGemFire70\Latest\server2\. | 192.0.2.0 -server1 | 8dc365bd-c086-4af4-99d0-86b0b521aa04 | c:\PivotalGemFire70\Latest\server1\. | 192.0.2.0 -``` http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/change.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/change.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/change.html.md.erb deleted file mode 100644 index a454ae8..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/change.html.md.erb +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: change loglevel ---- -<a id="topic_E74ED23CB60342538B2175C326E7D758"></a> - -Changes the logging level on specified members. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -change loglevel --loglevel=value [--members=value(nullvalue)*] [--groups=value(nullvalue)*] -``` - -<a id="topic_E74ED23CB60342538B2175C326E7D758__table_2277A2CE8F6E4731B45FEFA2B1366DB6"></a> - -<table> -<caption><span class="tablecap">Table 1. Change Loglevel 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">\-\-members</span></td> -<td>Name or ID of one or more Geode distributed system member(s) whose logging level you want to change.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-groups</span></td> -<td>One or more group names. The logging level changes for all members of these groups.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-loglevel</span></td> -<td><em>Required.</em> Log level to change. Valid options are: -<ul> -<li><code class="ph codeph">all</code></li> -<li><code class="ph codeph">finest</code></li> -<li><code class="ph codeph">finer</code></li> -<li><code class="ph codeph">fine</code></li> -<li><code class="ph codeph">config</code></li> -<li><code class="ph codeph">info</code></li> -<li><code class="ph codeph">warning</code></li> -<li><code class="ph codeph">error</code></li> -<li><code class="ph codeph">severe</code></li> -<li><code class="ph codeph">none</code></li> -</ul></td> -<td>Â </td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 1. Change Loglevel Parameters</span> - -**Example Commands:** - -``` pre -gfsh>change loglevel --loglevel=severe --members=server1 -``` - -**Sample Output:** - -``` pre -gfsh>change loglevel --loglevel=severe --members=server1 - -Summary - - Member | Changed log-level ---------------------------------- | ----------------- -192.0.2.0(server1:3060)<v1>:24653 | true -``` http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/clear.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/clear.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/clear.html.md.erb deleted file mode 100644 index 6146a4d..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/clear.html.md.erb +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: clear defined indexes ---- - -Clears all the defined indexes. - -Index definitions are stored locally on the `gfsh` client. If you want to create a new set of indexes or if one or more of the index creations fail, you might want to clear the definitions - -See also [define index](define.html). - -**Availability:** Online or offline. - -**Syntax:** - -``` pre -clear defined indexes -``` - -**Example Commands:** - -``` pre -gfsh> clear defined indexes - -``` - -**Sample Output:** - -``` pre -gfsh>clear defined indexes -Index definitions successfully cleared -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/close.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/close.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/close.html.md.erb deleted file mode 100644 index 0776a7f..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/close.html.md.erb +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: close ---- - -Close durable client CQs and durable clients. - -- **[close durable-client](../../../tools_modules/gfsh/command-pages/close.html#topic_4125AAAB9FE44CD787166E48B694C41D)** - - Attempts to close a durable client. The client must be disconnected for this command to work. - -- **[close durable-cq](../../../tools_modules/gfsh/command-pages/close.html#topic_1BC15B3132BA480DB227921A9B3ABDD1)** - - Closes the durable continuous query (CQ) registered by the durable client and drain events held for the durable CQ from the subscription queue. - -## <a id="topic_4125AAAB9FE44CD787166E48B694C41D" class="no-quick-link"></a>close durable-client - -Attempts to close a durable client. The client must be disconnected for this command to work. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -close durable-client --durable-client-id=value [--member=value] [--group=value] -``` - -<a id="topic_4125AAAB9FE44CD787166E48B694C41D__table_618C978BA2B442A9A979243B50856885"></a> - -| Name | Description | -|------------------------------------------------------------|------------------------------------------------------------------------| -| \\-\\-durable-client-id | *Required.* The ID of the durable client. | -| \\-\\-member | Name or ID of the member for which the durable client is to be closed. | -| \\-\\-group | Group of members for which the durable client is to be closed. | - -<span class="tablecap">Table 1. Close Durable-Client Parameters</span> - -**Example Commands**: - -``` pre -close durable-client --durable-client-id=client1 -``` - -**Sample Output**: - -``` pre -gfsh>close durable-client --durable-client-id=client1 -Closed the durable client : "client1". on following members. -1.server4 -2.server3 -``` - -**Error Messages:** - -``` pre -gfsh>close durable-cq --durable-cq-name=cq1 --durable-client-id=client1 - -Could not close the durable-cq : "cq1" for the durable-client-id : "client1" due to following reasons. - -CacheClientProxy: Could not drain cq cq1 because client proxy id client1 is connected. -Occurred on members -1.server4 -2.server3 - -No client found with client-id : client1 -Occurred on members -1.server1 -``` - -## <a id="topic_1BC15B3132BA480DB227921A9B3ABDD1" class="no-quick-link"></a>close durable-cq - -Closes the durable continuous query (CQ) registered by the durable client and drain events held for the durable CQ from the subscription queue. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -close durable-cq --durable-client-id=value --durable-cq-name=value -[--member=value] [--group=value] -``` - -<a id="topic_1BC15B3132BA480DB227921A9B3ABDD1__table_CEFFFECABBDF4DC4A37E8861422EEB5C"></a> - -| Name | Description | -|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------| -| \\-\\-durable-client-id | Required. The ID of the durable client. | -| \\-\\-durable-cq-name | Required. Name of the CQ to be closed. | -| \\-\\-member | Name or ID of the member for which the durable client is registered and the durable CQ to be closed. | -| \\-\\-group | Group of members for which the durable client is registered and the durable CQ to be closed. | - -<span class="tablecap">Table 2. Close Durable-CQ Parameters</span> - -**Example Commands:** - -``` pre -close durable-cq --durable-client-id=client1 --durable-cq-name=cq1 -``` - -**Sample Output:** - -``` pre -gfsh>close durable-cq --durable-cq-name=cq1 --durable-client-id=client1 -Closed the durable cq : "cq1" for the durable client : "client1". on following members. -1.server4 -2.server3 -``` - -**Error Messages:** - -``` pre -gfsh>close durable-client --durable-client-id=client1 -Unable to close the durable client : "client1" due to following reasons. - -Cannot close a running durable client : client1 -Occurred on members -1.server4 -2.server3 - -No client found with client-id : client1 -Occurred on members -1.server1 -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/compact.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/compact.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/compact.html.md.erb deleted file mode 100644 index 144a21f..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/compact.html.md.erb +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: compact ---- -<a id="topic_2522766FD5DD45D991A523F84BD54920"></a> - - -Compact online and offline disk-stores. - -- **[compact disk-store](../../../tools_modules/gfsh/command-pages/compact.html#topic_F113C95C076F424E9AA8AC4F1F6324CC)** - - Compact a disk store on all members with that disk store. - -- **[compact offline-disk-store](../../../tools_modules/gfsh/command-pages/compact.html#topic_9CCFCB2FA2154E16BD775439C8ABC8FB)** - - Compact an offline disk store. - -## <a id="topic_F113C95C076F424E9AA8AC4F1F6324CC" class="no-quick-link"></a>compact disk-store - -Compact a disk store on all members with that disk store. - -This command uses the compaction threshold that each member has configured for its disk stores. The disk store must have the `allow-force-compaction` property set to `true`. - -See [Running Compaction on Disk Store Log Files](../../../managing/disk_storage/compacting_disk_stores.html#compacting_disk_stores) for more information. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -compact disk-store --name=value [--group=value(,value)*] -``` - -<a id="topic_F113C95C076F424E9AA8AC4F1F6324CC__table_7039256EA2014AE5BFAB63697FF35AB6"></a> - -| Name | Description | -|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| <span class="keyword parmname">\\-\\-name</span> | *Required.* Name of the disk store to be compacted. | -| <span class="keyword parmname">\\-\\-group</span> | Group(s) of members that perform disk compaction. If no group is specified, then the disk store is compacted by all members. | - -<span class="tablecap">Table 1. Compact Disk-Store Parameters</span> - -**Example Commands:** - -``` pre -compact disk-store --name=Disk1 -compact disk-store --name=Disk1 --group=MemberGroup1,MemberGroup2 -``` - -**Error Messages:** - -``` pre -"Disk store \"{0}\" does not exist."; - " for group(s) \"{0}\""; -"No members found in the specified group(s) \"{0}\"."; -"Compaction was attempted but nothing to compact."; -"Error occurred while doing compaction. Reason: \"{0}\""; -``` - -## <a id="topic_9CCFCB2FA2154E16BD775439C8ABC8FB" class="no-quick-link"></a>compact offline-disk-store - -Compact an offline disk store. - -If the disk store is large, you may need to allocate additional memory to the process by using the `--J=-XmxNNNm` parameter. - -See [Running Compaction on Disk Store Log Files](../../../managing/disk_storage/compacting_disk_stores.html#compacting_disk_stores) for more information. - -**Note:** -Do not perform offline compaction on the baseline directory of an incremental backup. - -**Availability:** Online or offline. - -**Syntax:** - -``` pre -compact offline-disk-store --name=value --disk-dirs=value(,value)* -[--max-oplog-size=value] [--J=value(,value)*] -``` - -<a id="topic_9CCFCB2FA2154E16BD775439C8ABC8FB__table_BDB9B26709D841F08BCD75087AF596D8"></a> - -| Name | Description | Default Value | -|--------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| -| <span class="keyword parmname">\\-\\-name</span> | *Required.* Name of the offline disk store to be compacted. | Â | -| <span class="keyword parmname">\\-\\-disk-dirs</span> | *Required.* One or more directories where data for the disk store was previously written. Separate directories with commas. | Â | -| <span class="keyword parmname">\\-\\-max-oplog-size</span> | Maximum size (in megabytes) of the oplogs created by compaction. | -1 | -| <span class="keyword parmname">\\-\\-J</span> | Arguments passed to the Java Virtual Machine performing the compact operation on the disk store. For example: `-J=-Xmx1024m`. | Â | - -<span class="tablecap">Table 2. Compact Offline-Disk-Store Parameters</span> - -**Example Commands:** - -``` pre -compact offline-disk-store --name=Disk2 --disk-dirs=/Disks/Disk2 -compact offline-disk-store --name=Disk2 --disk-dirs=/Disks/Disk2 --max-oplog-size=512 -J=-Xmx1024m -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/configure.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/configure.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/configure.html.md.erb deleted file mode 100644 index 76aaddf..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/configure.html.md.erb +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: configure ---- - -<a id="concept_C2DCEE6743304549825C9B62E66DBADF"></a> - - -Configure Portable Data eXchange for all the cache(s) in the cluster. - -## <a id="topic_jdkdiqbgphqh" class="no-quick-link"></a>configure pdx - -<a id="topic_jdkdiqbgphqh__section_C27BE964CE554180A65968DBEBF50B23"></a> -Configures Geode's Portable Data eXchange for all the cache(s) in the cluster. This command does not effect on the running members in the system. This command persists the pdx configuration in the locator with cluster configuration service. - -**Note:** -This command should be issued before starting any data members. - -**Availability:** Online. - -**Syntax:** - -``` pre -configure pdx [--read-serialized=value] [--ignore-unread-fields=value] - [--disk-store=value] [--auto-serializable-classes=value(,value)*] - [--portable-auto-serializable-classes=value(,value)* -``` - -<a id="topic_jdkdiqbgphqh__table_B25D38C67FA047EB8F00A521573F1375"></a> - -| Name | Description | Default | -|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| -| <span class="keyword parmname">\\-\\-read-serialized</span> | Set to true to have PDX deserialization produce a PdxInstance instead of an instance of the domain class. | false | -| <span class="keyword parmname">\\-\\-ignore-unread-fields</span> | Controls whether PDX ignores fields that were unread during deserialization. The default is to preserve unread fields be including their data during serialization. However, if you configure the cache to ignore unread fields then their data will be lost during serialization.You should only set this attribute to true if you know this member will only be reading cache data. In this use case you do not need to pay the cost of preserving the unread fields since you will never be reserializing PDX data. | false | -| <span class="keyword parmname">\\-\\-disk-store</span> | Named disk store where the PDX type data will be stored. | none | -| <span class="keyword parmname">\\-\\-auto-serializable-classes</span> | Configures ReflectionBasedAutoSerializer as the PDX serializer for member classes. The patterns that are matched against domain class names to determine whether they should be auto-serialized. Classes are not checked for portability to non-java languages (equivalent to `check-portability=false`). | none | -| <span class="keyword parmname">\\-\\-portable-auto-serializable-classes</span> | Configures ReflectionBasedAutoSerializer as the PDX serializer for member classes. The patterns that are matched against domain class names to determine whether they should be serialized. Serialization done by the PDX autoserializer will throw an exception if the object of these classes are not portable to non-Java languages (equivalent to `check-portability=true`). | none | - -<span class="tablecap">Table 1. Configure PDX Parameters</span> - -**Example Commands:** - -``` pre -gfsh>configure pdx --read-serialized=true -``` - -**Sample Output:** - -``` pre -gfsh>configure pdx --read-serialized=true -persistent = false -read-serialized = true -ignore-unread-fields = false - -gfsh>configure pdx --disk-store=/home/username/server4/DEFAULT.drf -persistent = true -disk-store = /home/username/server4/DEFAULT.drf -read-serialized = false -ignore-unread-fields = false -``` - -**Error Messages:** - -``` pre -"Failed to persist the configuration changes due to this command, Revert the command to maintain consistency. -Please use "status cluster-config-service" to determing whether Cluster configuration service is RUNNING." -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/connect.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/connect.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/connect.html.md.erb deleted file mode 100644 index cdc8c48..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/connect.html.md.erb +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: connect ---- - -Connect to a jmx-manager either directly or via a locator. - -<a id="concept_C2DCEE6743304549825C9B62E66DBADF__section_C27BE964CE554180A65968DBEBF50B23"></a> -If you are connecting via a locator, and a jmx-manager does not already exist, the locator starts one. - -gfsh connects as a discovery client to the locator service and asks where the JMX Manager is. The locator knows when there is no member currently configured as the JMX manager and simply starts up the JMX manager service within itself. gfsh connects as a JMX client to locator JMX RMI port. - -You can also connect to a remote locator using the HTTP protocol, as illustrated by the second example below. - -**Availability:** Offline. You will receive a notification "Already connected to: host\[port\]" if you are already connected. - -**Syntax:** - -``` pre -connect [--locator=value] [--jmx-manager=value] [--use-http(=value)?] [--url=value] - [--user=value][--password=value] [--key-store=value] [--key-store-password=value] - [--trust-store=value] [--trust-store-password=value] [--ciphers=value] [--protocols=value] - [--security-properties-file=value] [--use-ssl(=value)?] -``` - -<a id="concept_C2DCEE6743304549825C9B62E66DBADF__table_B25D38C67FA047EB8F00A521573F1375"></a> - -<table> -<caption><span class="tablecap">Table 1. Connect 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</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td><span class="keyword parmname">\-\-locator</span></td> -<td>Network address of the Locator in the form: <code class="ph codeph">host[port]</code>.</td> -<td><code class="ph codeph">localhost[10334]</code></td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-jmx-manager </span></td> -<td>Network address of the jmx-manager in the form: <code class="ph codeph">host[port]</code>.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-use-http</span></td> -<td>Connects to a JMX manager HTTP service using the HTTP protocol.</td> -<td><ul> -<li>If the parameter is not specified: <code class="ph codeph">false</code></li> -<li>If the parameter is specified without a value: <code class="ph codeph">true</code></li> -</ul></td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-url</span></td> -<td>URL used to connect to a JMX manager's HTTP service</td> -<td><code class="ph codeph">http://localhost:8080/gemfire/v1</code></td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-user</span></td> -<td>User name to securely connect to the jmx-manager. If the <code class="ph codeph">--password</code> parameter is not specified then it will be prompted for.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-password</span></td> -<td>Password to be used as credential which is required to connect to a jmx-manager securely.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-key-store</span></td> -<td>Java keystore file containing this application's certificate and private key. If the<code class="ph codeph"> --key-store-password</code> parameter is not specified, gfsh prompts the operator for the password.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-key-store-password</span></td> -<td>Password to access the private key from the keystore file specified by <code class="ph codeph">--key-store</code>.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-trust-store</span></td> -<td>Java keystore file containing the collection of CA certificates trusted by this application. If the <code class="ph codeph">--trust-store-password</code> parameter is not specified, gfsh prompts the operator for the password.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-trust-store-password</span></td> -<td>Password to unlock the keystore file specified by <code class="ph codeph">--trust-store</code>.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-ciphers</span></td> -<td>SSL/TLS ciphers used when encrypting the connection. The default is "any".</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-protocols</span></td> -<td>SSL/TLS protocol versions to enable when encrypting the connection. The default is "any".</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td><span class="keyword parmname">\-\-security-properties-file</span></td> -<td>The <code class="ph codeph">gfsecurity.properties</code> file for configuring gfsh to connect to the Locator/Manager. The file path can be absolute or relative to the current gfsh directory.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td><span class="keyword parmname">\-\-use-ssl</span></td> -<td>Whether to use SSL for communication with Locator and/or JMX Manager. If set to <code class="ph codeph">true</code>, the connect command also reads <code class="ph codeph">gfsecurity.properties</code>. SSL Options take precedence over values set in the properties file. If none are specified, defaults are used.</td> -<td><ul> -<li>If the parameter is not specified: <code class="ph codeph">false</code></li> -<li>If the parameter is specified without a value: <code class="ph codeph">true</code></li> -</ul></td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 1. Connect Parameters</span> - -**Example Commands:** - -If you do not specify a locator or jmx-manager, `gfsh` connects to the locator on the localhost at the default port. - -``` pre -gfsh>connect -``` - -**Sample Output:** - -``` pre -gfsh>connect -Connecting to Locator at [host=localhost, port=10334] .. -Connecting to Manager at [host=GemFireStymon, port=1099] .. -Successfully connected to: [host=GemFireStymon, port=1099] -``` - -**Example of connecting to a remote locator over HTTP:** - -``` pre -gfsh>connect --use-http=true --url="http://myLocatorHost.example.com:8080/gemfire/v1"; -Successfully connected to: GemFire Manager's HTTP service @ http://myLocatorHost.example.com:8080/gemfire/v1 -``` - -**Error Messages:** - -``` pre -"Locator could not find a JMX Manager"; -"jmx password must be specified."; -"Could not connect to : {0}. {1}"; -"Could not find a GemFire jmx-manager service running at {0}."; -"Could not connect to GemFire Locator service at {0}." -```
