Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 0E3AE2009C6 for ; Tue, 17 May 2016 02:38:37 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 0CA65160A19; Tue, 17 May 2016 00:38:37 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 875D8160A16 for ; Tue, 17 May 2016 02:38:34 +0200 (CEST) Received: (qmail 23834 invoked by uid 500); 17 May 2016 00:38:33 -0000 Mailing-List: contact commits-help@geode.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.incubator.apache.org Delivered-To: mailing list commits@geode.incubator.apache.org Received: (qmail 23825 invoked by uid 99); 17 May 2016 00:38:33 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 17 May 2016 00:38:33 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 30FE41803EA for ; Tue, 17 May 2016 00:38:33 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -4.021 X-Spam-Level: X-Spam-Status: No, score=-4.021 tagged_above=-999 required=6.31 tests=[KAM_LAZY_DOMAIN_SECURITY=1, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.001] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id Y2VJDW9KRiff for ; Tue, 17 May 2016 00:38:17 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id 732305FCD4 for ; Tue, 17 May 2016 00:38:14 +0000 (UTC) Received: (qmail 14492 invoked by uid 99); 17 May 2016 00:38:11 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 17 May 2016 00:38:11 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id B8D75E38A4; Tue, 17 May 2016 00:38:11 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: agingade@apache.org To: commits@geode.incubator.apache.org Date: Tue, 17 May 2016 00:38:49 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [40/50] [abbrv] incubator-geode git commit: GEODE-1390: Move gfsh help tests from closed to open archived-at: Tue, 17 May 2016 00:38:37 -0000 http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/2e1aa799/geode-core/src/test/resources/com/gemstone/gemfire/management/internal/cli/commands/golden-help-offline.properties ---------------------------------------------------------------------- diff --git a/geode-core/src/test/resources/com/gemstone/gemfire/management/internal/cli/commands/golden-help-offline.properties b/geode-core/src/test/resources/com/gemstone/gemfire/management/internal/cli/commands/golden-help-offline.properties new file mode 100644 index 0000000..a9dc64c --- /dev/null +++ b/geode-core/src/test/resources/com/gemstone/gemfire/management/internal/cli/commands/golden-help-offline.properties @@ -0,0 +1,2997 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# This file is generated with a script something like the following. The resulting output +# needs a bit of cleanup at the beginning and end. +# +# #!/usr/bin/env bash +# +# set -e +# +# # Preserve leading whitespace for read loops +# IFS='' +# +# $GFSH -e "help" | awk '/^[^ ]/ {print $0}' | sed -e "s/\(.*\) (.*/\1/" | \ +# while read i; do +# PARAM="$(echo $i | sed -Ee 's/[[:space:]]+/-/g').help=\\" +# echo $PARAM +# $GFSH help $i | \ +# while read j; do +# if [ -n "$j" ]; then +# echo "$j\\" | sed -E -e ':a' -e 's/^([[:space:]]*)[[:space:]]/\1\\ /;ta' +# fi +# done +# echo "" +# done + +alter-disk-store.help=\ +NAME\n\ +\ \ \ \ alter disk-store\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Alter some options for a region or remove a region in an offline disk store.\n\ +SYNTAX\n\ +\ \ \ \ alter disk-store --name=value --region=value --disk-dirs=value(,value)* [--compressor(=value)?]\n\ +\ \ \ \ [--concurrency-level=value] [--enable-statistics=value] [--initial-capacity=value]\n\ +\ \ \ \ [--load-factor=value] [--lru-action=value] [--lru-algorthm=value] [--lru-limit=value]\n\ +\ \ \ \ [--off-heap=value] [--remove(=value)?]\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name of the disk store whose contents will be altered.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ region\n\ +\ \ \ \ \ \ \ \ Name/Path of the region in the disk store to alter.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ disk-dirs\n\ +\ \ \ \ \ \ \ \ Directories where data for the disk store was previously written.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ compressor\n\ +\ \ \ \ \ \ \ \ The fully-qualifed class name of the Compressor to use when compressing region entry\n\ +\ \ \ \ \ \ \ \ values. A value of 'none' will remove the Compressor.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): none\n\ +\ \ \ \ concurrency-level\n\ +\ \ \ \ \ \ \ \ An estimate of the maximum number of application threads that will concurrently modify a\n\ +\ \ \ \ \ \ \ \ region at one time. This attribute does not apply to partitioned regions.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-statistics\n\ +\ \ \ \ \ \ \ \ Whether to enable statistics. Valid values are: true and false.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ initial-capacity\n\ +\ \ \ \ \ \ \ \ Together with --load-factor, sets the parameters on the underlying\n\ +\ \ \ \ \ \ \ \ java.util.ConcurrentHashMap used for storing region entries.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ load-factor\n\ +\ \ \ \ \ \ \ \ Together with --initial-capacity, sets the parameters on the underlying\n\ +\ \ \ \ \ \ \ \ java.util.ConcurrentHashMap used for storing region entries. This must be a floating point\n\ +\ \ \ \ \ \ \ \ number between 0 and 1, inclusive.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ lru-action\n\ +\ \ \ \ \ \ \ \ Action to take when evicting entries from the region. Valid values are: none,\n\ +\ \ \ \ \ \ \ \ overflow-to-disk and local-destroy.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ lru-algorthm\n\ +\ \ \ \ \ \ \ \ Least recently used eviction algorithm. Valid values are: none, lru-entry-count,\n\ +\ \ \ \ \ \ \ \ lru-heap-percentage and lru-memory-size.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ lru-limit\n\ +\ \ \ \ \ \ \ \ Number of entries allowed in the region before eviction will occur.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ off-heap\n\ +\ \ \ \ \ \ \ \ Whether to use off-heap memory for the region. Valid values are: true and false.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ remove\n\ +\ \ \ \ \ \ \ \ Whether to remove the region from the disk store.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ + +alter-region.help=\ +NAME\n\ +\ \ \ \ alter region\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Alter a region with the given path and configuration.\n\ +SYNTAX\n\ +\ \ \ \ alter region --name=value [--group=value(,value)*] [--entry-idle-time-expiration(=value)?]\n\ +\ \ \ \ [--entry-idle-time-expiration-action(=value)?] [--entry-time-to-live-expiration(=value)?]\n\ +\ \ \ \ [--entry-time-to-live-expiration-action(=value)?] [--region-idle-time-expiration(=value)?]\n\ +\ \ \ \ [--region-idle-time-expiration-action(=value)?] [--region-time-to-live-expiration(=value)?]\n\ +\ \ \ \ [--region-time-to-live-expiration-action(=value)?] [--cache-listener=value(,value)*]\n\ +\ \ \ \ [--cache-loader(=value)?] [--cache-writer(=value)?] [--async-event-queue-id=value(,value)*]\n\ +\ \ \ \ [--gateway-sender-id=value(,value)*] [--enable-cloning(=value)?] [--eviction-max(=value)?]\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name/Path of the region to be altered.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members on which the region will be altered.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ entry-idle-time-expiration\n\ +\ \ \ \ \ \ \ \ How long the region's entries can remain in the cache without being accessed. The default\n\ +\ \ \ \ \ \ \ \ is no expiration of this type.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): -1\n\ +\ \ \ \ entry-idle-time-expiration-action\n\ +\ \ \ \ \ \ \ \ Action to be taken on an entry that has exceeded the idle expiration.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): __DEFAULT__\n\ +\ \ \ \ entry-time-to-live-expiration\n\ +\ \ \ \ \ \ \ \ How long the region's entries can remain in the cache without being accessed or updated.\n\ +\ \ \ \ \ \ \ \ The default is no expiration of this type.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): -1\n\ +\ \ \ \ entry-time-to-live-expiration-action\n\ +\ \ \ \ \ \ \ \ Action to be taken on an entry that has exceeded the TTL expiration.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): __DEFAULT__\n\ +\ \ \ \ region-idle-time-expiration\n\ +\ \ \ \ \ \ \ \ How long the region can remain in the cache without being accessed. The default is no\n\ +\ \ \ \ \ \ \ \ expiration of this type.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): -1\n\ +\ \ \ \ region-idle-time-expiration-action\n\ +\ \ \ \ \ \ \ \ Action to be taken on a region that has exceeded the idle expiration.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): __DEFAULT__\n\ +\ \ \ \ region-time-to-live-expiration\n\ +\ \ \ \ \ \ \ \ How long the region can remain in the cache without being accessed or updated. The default\n\ +\ \ \ \ \ \ \ \ is no expiration of this type.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): -1\n\ +\ \ \ \ region-time-to-live-expiration-action\n\ +\ \ \ \ \ \ \ \ Action to be taken on a region that has exceeded the TTL expiration.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): __DEFAULT__\n\ +\ \ \ \ cache-listener\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of a plug-in to be instantiated for receiving after-event\n\ +\ \ \ \ \ \ \ \ notification of changes to the region and its entries. Any number of cache listeners can be\n\ +\ \ \ \ \ \ \ \ configured.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ cache-loader\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of a plug-in to be instantiated for receiving notification of\n\ +\ \ \ \ \ \ \ \ cache misses in the region. At most, one cache loader can be defined in each member for the\n\ +\ \ \ \ \ \ \ \ region. For distributed regions, a cache loader may be invoked remotely from other members\n\ +\ \ \ \ \ \ \ \ that have the region defined.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): __DEFAULT__\n\ +\ \ \ \ cache-writer\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of a plug-in to be instantiated for receiving before-event\n\ +\ \ \ \ \ \ \ \ notification of changes to the region and its entries. The plug-in may cancel the event. At\n\ +\ \ \ \ \ \ \ \ most, one cache writer can be defined in each member for the region.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): __DEFAULT__\n\ +\ \ \ \ async-event-queue-id\n\ +\ \ \ \ \ \ \ \ IDs of the Async Event Queues that will be used for write-behind operations.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ gateway-sender-id\n\ +\ \ \ \ \ \ \ \ IDs of the Gateway Senders to which data will be routed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-cloning\n\ +\ \ \ \ \ \ \ \ Determines how fromDelta applies deltas to the local cache for delta propagation. When\n\ +\ \ \ \ \ \ \ \ true, the updates are applied to a clone of the value and then the clone is saved to the\n\ +\ \ \ \ \ \ \ \ cache. When false, the value is modified in place in the cache.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): false\n\ +\ \ \ \ eviction-max\n\ +\ \ \ \ \ \ \ \ Maximum value for the Eviction Attributes which the Eviction Algorithm uses to determine\n\ +\ \ \ \ \ \ \ \ when to perform its Eviction Action. The unit of the maximum value is determined by the\n\ +\ \ \ \ \ \ \ \ Eviction Algorithm.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): 0\n\ + +alter-runtime.help=\ +NAME\n\ +\ \ \ \ alter runtime\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Alter a subset of member or members configuration properties while running.\n\ +SYNTAX\n\ +\ \ \ \ alter runtime [--member=value] [--group=value] [--archive-disk-space-limit=value]\n\ +\ \ \ \ [--archive-file-size-limit=value] [--log-disk-space-limit=value] [--log-file-size-limit=value]\n\ +\ \ \ \ [--log-level=value] [--statistic-archive-file=value] [--statistic-sample-rate=value]\n\ +\ \ \ \ [--enable-statistics=value] [--copy-on-read(=value)?] [--lock-lease=value]\n\ +\ \ \ \ [--lock-timeout=value] [--message-sync-interval=value] [--search-timeout=value]\n\ +PARAMETERS\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member in whose configuration will be altered.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Name/Id of the member in whose configuration will be altered.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ archive-disk-space-limit\n\ +\ \ \ \ \ \ \ \ Archive disk space limit. Valid values are (in megabytes): 0 - 1000000.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ archive-file-size-limit\n\ +\ \ \ \ \ \ \ \ Archive file size limit. Valid values are (in megabytes): 0 - 1000000.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ log-disk-space-limit\n\ +\ \ \ \ \ \ \ \ Log disk space limit. Valid values are (in megabytes): 0 - 1000000.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ log-file-size-limit\n\ +\ \ \ \ \ \ \ \ Log file size limit. Valid values are (in megabytes): 0 - 1000000.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ log-level\n\ +\ \ \ \ \ \ \ \ Log level. Valid values are: none, error, info, config , warning, severe, fine, finer and\n\ +\ \ \ \ \ \ \ \ finest.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ statistic-archive-file\n\ +\ \ \ \ \ \ \ \ File to which the statistics will be written.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ statistic-sample-rate\n\ +\ \ \ \ \ \ \ \ Statistic sampling rate. Valid values are (in milliseconds): 100 - 60000.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-statistics\n\ +\ \ \ \ \ \ \ \ Whether statistic sampling should be enabled. Valid values are: true and false.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ copy-on-read\n\ +\ \ \ \ \ \ \ \ Sets the "copy on read" feature for cache read operations\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): false\n\ +\ \ \ \ lock-lease\n\ +\ \ \ \ \ \ \ \ Sets the length, in seconds, of distributed lock leases obtained by this cache.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ lock-timeout\n\ +\ \ \ \ \ \ \ \ Sets the number of seconds a cache operation may wait to obtain a distributed lock lease\n\ +\ \ \ \ \ \ \ \ before timing out.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ message-sync-interval\n\ +\ \ \ \ \ \ \ \ Sets the frequency (in seconds) at which a message will be sent by the primary cache-server\n\ +\ \ \ \ \ \ \ \ node to all the secondary cache-server nodes to remove the events which have already been\n\ +\ \ \ \ \ \ \ \ dispatched from the queue\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ search-timeout\n\ +\ \ \ \ \ \ \ \ Sets the number of seconds a cache get operation can spend searching for a value.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +backup-disk-store.help=\ +NAME\n\ +\ \ \ \ backup disk-store\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Perform a backup on all members with persistent data. The target directory must exist on all\n\ +\ \ \ \ members, but can be either local or shared. This command can safely be executed on active\n\ +\ \ \ \ members and is strongly recommended over copying files via operating system commands.\n\ +SYNTAX\n\ +\ \ \ \ backup disk-store --dir=value [--baseline-dir=value]\n\ +PARAMETERS\n\ +\ \ \ \ dir\n\ +\ \ \ \ \ \ \ \ Directory to which backup files will be written.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ baseline-dir\n\ +\ \ \ \ \ \ \ \ Directory which contains the baseline backup used for comparison during an incremental\n\ +\ \ \ \ \ \ \ \ backup.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +change-loglevel.help=\ +NAME\n\ +\ \ \ \ change loglevel\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ This command changes log-level run time on specified servers.\n\ +SYNTAX\n\ +\ \ \ \ change loglevel --loglevel=value [--members=value(nullvalue)*] [--groups=value(nullvalue)*]\n\ +PARAMETERS\n\ +\ \ \ \ members\n\ +\ \ \ \ \ \ \ \ Name/Id of the member to change the log-level\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ groups\n\ +\ \ \ \ \ \ \ \ Groups of members to change the log-level\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ loglevel\n\ +\ \ \ \ \ \ \ \ Log level to change to\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +clear-defined-indexes.help=\ +NAME\n\ +\ \ \ \ clear defined indexes\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Clears all the defined indexes.\n\ +SYNTAX\n\ +\ \ \ \ clear defined indexes\n\ + +close-durable-client.help=\ +NAME\n\ +\ \ \ \ close durable-client\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Attempts to close the durable client, the client must be disconnected.\n\ +SYNTAX\n\ +\ \ \ \ close durable-client --durable-client-id=value [--member=value] [--group=value]\n\ +PARAMETERS\n\ +\ \ \ \ durable-client-id\n\ +\ \ \ \ \ \ \ \ The id used to identify the durable client.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member for which the durable client is to be closed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group of members for which the subscription queue events are to be counted.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +close-durable-cq.help=\ +NAME\n\ +\ \ \ \ close durable-cq\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Closes the durable cq registered by the durable client and drains events held for the durable\n\ +\ \ \ \ cq from the subscription queue.\n\ +SYNTAX\n\ +\ \ \ \ close durable-cq --durable-client-id=value --durable-cq-name=value [--member=value]\n\ +\ \ \ \ [--group=value]\n\ +PARAMETERS\n\ +\ \ \ \ durable-client-id\n\ +\ \ \ \ \ \ \ \ The id of the durable client\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ durable-cq-name\n\ +\ \ \ \ \ \ \ \ Name of the cq to be closed.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member for which the durable client is registered and the cq to be closed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group of members for which the durable client is registered and the cq to be closed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +compact-disk-store.help=\ +NAME\n\ +\ \ \ \ compact disk-store\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Compact a disk store on all members with that disk store. This command uses the compaction\n\ +\ \ \ \ threshold that each member has configured for its disk stores. The disk store must have\n\ +\ \ \ \ "allow-force-compaction" set to true.\n\ +SYNTAX\n\ +\ \ \ \ compact disk-store --name=value [--group=value(,value)*]\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name of the disk store to be compacted.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members that will perform disk compaction. If no group is specified the disk\n\ +\ \ \ \ \ \ \ \ store will be compacted by all members.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +compact-offline-disk-store.help=\ +NAME\n\ +\ \ \ \ compact offline-disk-store\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Compact an offline disk store. If the disk store is large, additional memory may need to be\n\ +\ \ \ \ allocated to the process using the --J=-Xmx??? parameter.\n\ +SYNTAX\n\ +\ \ \ \ compact offline-disk-store --name=value --disk-dirs=value(,value)* [--max-oplog-size=value]\n\ +\ \ \ \ [--J=value(,value)*]\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name of the offline disk store to be compacted.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ disk-dirs\n\ +\ \ \ \ \ \ \ \ Directories where data for the disk store was previously written.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ max-oplog-size\n\ +\ \ \ \ \ \ \ \ Maximum size (in megabytes) of the oplogs created by compaction.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): -1\n\ +\ \ \ \ J\n\ +\ \ \ \ \ \ \ \ Arguments passed to the Java Virtual Machine performing the compact operation on the disk\n\ +\ \ \ \ \ \ \ \ store.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +configure-pdx.help=\ +NAME\n\ +\ \ \ \ configure pdx\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Configures GemFire's Portable Data eXchange for all the cache(s) in the cluster. This command\n\ +\ \ \ \ would not take effect on the running members in the system.\n\ +\ \ \ \ \ This command persists the pdx configuration in the locator with cluster configuration service.\n\ +\ \ \ \ \n\ +\ \ \ \ \ This command should be issued before starting any data members.\n\ +SYNTAX\n\ +\ \ \ \ configure pdx [--read-serialized=value] [--ignore-unread-fields=value] [--disk-store=value]\n\ +\ \ \ \ [--auto-serializable-classes=value(,value)*]\n\ +\ \ \ \ [--portable-auto-serializable-classes=value(,value)*]\n\ +PARAMETERS\n\ +\ \ \ \ read-serialized\n\ +\ \ \ \ \ \ \ \ Set to true to have PDX deserialization produce a PdxInstance instead of an instance of the\n\ +\ \ \ \ \ \ \ \ domain class\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ ignore-unread-fields\n\ +\ \ \ \ \ \ \ \ Control whether pdx ignores fields that were unread during deserialization. The default is\n\ +\ \ \ \ \ \ \ \ to preserve unread fields be including their data during serialization. But if you\n\ +\ \ \ \ \ \ \ \ configure the cache to ignore unread fields then their data will be lost during\n\ +\ \ \ \ \ \ \ \ serialization.You should only set this attribute to true if you know this member will only\n\ +\ \ \ \ \ \ \ \ be reading cache data. In this use case you do not need to pay the cost of preserving the\n\ +\ \ \ \ \ \ \ \ unread fields since you will never be reserializing pdx data.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ disk-store\n\ +\ \ \ \ \ \ \ \ Named disk store where the PDX type data will be stored\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ auto-serializable-classes\n\ +\ \ \ \ \ \ \ \ the patterns which are matched against domain class names to determine whether they should\n\ +\ \ \ \ \ \ \ \ be serialized, serialization done by the auto-serializer will throw an exception if the\n\ +\ \ \ \ \ \ \ \ object of these classes are not portable to non-java languages\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ portable-auto-serializable-classes\n\ +\ \ \ \ \ \ \ \ the patterns which are matched against domain class names to determine whether they should\n\ +\ \ \ \ \ \ \ \ be serialized\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +connect.help=\ +NAME\n\ +\ \ \ \ connect\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Connect to a jmx-manager either directly or via a Locator. If connecting via a Locator, and a\n\ +\ \ \ \ jmx-manager doesn't already exist, the Locator will start one.\n\ +SYNTAX\n\ +\ \ \ \ connect [--locator=value] [--jmx-manager=value] [--use-http(=value)?] [--url=value]\n\ +\ \ \ \ [--user=value] [--password=value] [--key-store=value] [--key-store-password=value]\n\ +\ \ \ \ [--trust-store=value] [--trust-store-password=value] [--ciphers=value] [--protocols=value]\n\ +\ \ \ \ [--security-properties-file=value] [--use-ssl(=value)?]\n\ +MODES\n\ +\ \ \ \ Default Options\n\ +\ \ \ \ \ \ \ \ connect [--use-ssl(=value)?] [--key-store=value] [--key-store-password=value]\n\ +\ \ \ \ \ \ \ \ [--trust-store=value] [--trust-store-password=value] [--ciphers=value] [--protocols=value]\n\ +\ \ \ \ \ \ \ \ [--security-properties-file=value] [--user=value] [--password=value]\n\ +\ \ \ \ Using JMX Manager\n\ +\ \ \ \ \ \ \ \ connect --jmx-manager=value\n\ +\ \ \ \ Using HTTP REST Mode\n\ +\ \ \ \ \ \ \ \ connect --use-http(=value)? [--url=value]\n\ +\ \ \ \ Using Locator\n\ +\ \ \ \ \ \ \ \ connect --locator=value\n\ +PARAMETERS\n\ +\ \ \ \ locator\n\ +\ \ \ \ \ \ \ \ Network address of the Locator in the form: host[port].\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): localhost[10334]\n\ +\ \ \ \ jmx-manager\n\ +\ \ \ \ \ \ \ \ Network address of the jmx-manager in the form: host[port].\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ use-http\n\ +\ \ \ \ \ \ \ \ Connects to Manager by sending HTTP requests to HTTP service hostint the Management REST\n\ +\ \ \ \ \ \ \ \ API. You must first 'disconnect' in order to reconnect to the Manager via locator or\n\ +\ \ \ \ \ \ \ \ jmx-manager using JMX.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ +\ \ \ \ url\n\ +\ \ \ \ \ \ \ \ Indicates the base URL to the Manager's HTTP service. For example:\n\ +\ \ \ \ \ \ \ \ 'http://:/gemfire/v1' Default is 'http://localhost:7070/gemfire/v1'\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): http://localhost:7070/gemfire/v1\n\ +\ \ \ \ user\n\ +\ \ \ \ \ \ \ \ User name to securely connect to the jmx-manager. If the --password parameter is not\n\ +\ \ \ \ \ \ \ \ specified then it will be prompted for.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ password\n\ +\ \ \ \ \ \ \ \ Password to securely connect to the jmx-manager.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ key-store\n\ +\ \ \ \ \ \ \ \ Java keystore file containing this application's certificate and private key. If the\n\ +\ \ \ \ \ \ \ \ --key-store-password parameter is not specified then it will be prompted for.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ key-store-password\n\ +\ \ \ \ \ \ \ \ Password to access the private key from the keystore file specified by --key-store.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ trust-store\n\ +\ \ \ \ \ \ \ \ Java keystore file containing the collection of CA certificates trusted by this\n\ +\ \ \ \ \ \ \ \ application. If the --trust-store-password parameter is not specified then it will be\n\ +\ \ \ \ \ \ \ \ prompted for.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ trust-store-password\n\ +\ \ \ \ \ \ \ \ Password to unlock the keystore file specified by --trust-store\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ ciphers\n\ +\ \ \ \ \ \ \ \ SSL/TLS ciphers used when encrypting the connection. The default is "any".\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ protocols\n\ +\ \ \ \ \ \ \ \ SSL/TLS protocol versions to enable when encrypting the connection. The default is "any".\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ security-properties-file\n\ +\ \ \ \ \ \ \ \ The gfsecurity.properties file for configuring gfsh to connect to the Locator/Manager. The\n\ +\ \ \ \ \ \ \ \ file's path can be absolute or relative to gfsh directory.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ use-ssl\n\ +\ \ \ \ \ \ \ \ Whether to use SSL for communication with Locator and/or JMX Manager. If set to "true",\n\ +\ \ \ \ \ \ \ \ will also read "gfsecurity.properties". SSL Options take precedence over proeprties file.\n\ +\ \ \ \ \ \ \ \ If none are specified, defaults will be used. The default value for this options is\n\ +\ \ \ \ \ \ \ \ "false".\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ + +create-async-event-queue.help=\ +NAME\n\ +\ \ \ \ create async-event-queue\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Create Async Event Queue.\n\ +SYNTAX\n\ +\ \ \ \ create async-event-queue --id=value --listener=value [--group=value(nullvalue)*]\n\ +\ \ \ \ [--parallel(=value)?] [--enable-batch-conflation(=value)?] [--batch-size=value]\n\ +\ \ \ \ [--batch-time-interval=value] [--persistent(=value)?] [--disk-store=value]\n\ +\ \ \ \ [--disk-synchronous(=value)?] [--max-queue-memory=value] [--dispatcher-threads=value]\n\ +\ \ \ \ [--order-policy=value] [--gateway-event-filter=value(,value)*]\n\ +\ \ \ \ [--gateway-event-substitution-filter=value] [--listener-param=value(,value)*]\n\ +PARAMETERS\n\ +\ \ \ \ id\n\ +\ \ \ \ \ \ \ \ ID of the queue to be created.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members on which queue will be created. If no group is specified the queue will\n\ +\ \ \ \ \ \ \ \ be created on all members.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ parallel\n\ +\ \ \ \ \ \ \ \ Whether this queue is parallel.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ +\ \ \ \ enable-batch-conflation\n\ +\ \ \ \ \ \ \ \ Whether to enable batch conflation.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ +\ \ \ \ batch-size\n\ +\ \ \ \ \ \ \ \ Maximum number of events that a batch can contain.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): 100\n\ +\ \ \ \ batch-time-interval\n\ +\ \ \ \ \ \ \ \ Maximum amount of time, in ms, that can elapse before a batch is delivered.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): 1000\n\ +\ \ \ \ persistent\n\ +\ \ \ \ \ \ \ \ Whether events should be persisted to a disk store.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ +\ \ \ \ disk-store\n\ +\ \ \ \ \ \ \ \ Disk store to be used by this queue.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ disk-synchronous\n\ +\ \ \ \ \ \ \ \ Whether disk writes are synchronous.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): true\n\ +\ \ \ \ max-queue-memory\n\ +\ \ \ \ \ \ \ \ Maximum amount of memory, in megabytes, that the queue can consume before overflowing to\n\ +\ \ \ \ \ \ \ \ disk.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): 100\n\ +\ \ \ \ dispatcher-threads\n\ +\ \ \ \ \ \ \ \ Number of threads to use for sending events.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): 1\n\ +\ \ \ \ order-policy\n\ +\ \ \ \ \ \ \ \ Policy for dispatching events when --dispatcher-threads is > 1. Possible values are\n\ +\ \ \ \ \ \ \ \ 'THREAD', 'KEY', 'PARTITION'.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): KEY\n\ +\ \ \ \ gateway-event-filter\n\ +\ \ \ \ \ \ \ \ List of fully qualified class names of GatewayEventFilters for this queue. These classes\n\ +\ \ \ \ \ \ \ \ filter events before dispatching to remote servers.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ gateway-event-substitution-filter\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of the GatewayEventSubstitutionFilter for this queue.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ listener\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of the AsyncEventListener for this queue.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ listener-param\n\ +\ \ \ \ \ \ \ \ Parameter name for the AsyncEventListener. Optionally, parameter names may be followed by\n\ +\ \ \ \ \ \ \ \ # and a value for the parameter. Example: --listener-param=loadAll\n\ +\ \ \ \ \ \ \ \ --listener-param=maxRead#1024\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +create-defined-indexes.help=\ +NAME\n\ +\ \ \ \ create defined indexes\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Creates all the defined indexes.\n\ +SYNTAX\n\ +\ \ \ \ create defined indexes [--member=value] [--group=value]\n\ +PARAMETERS\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member in which the index will be created.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group of members in which the index will be created.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +create-disk-store.help=\ +NAME\n\ +\ \ \ \ create disk-store\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Create a disk store.\n\ +SYNTAX\n\ +\ \ \ \ create disk-store --name=value --dir=value(,value)* [--allow-force-compaction(=value)?]\n\ +\ \ \ \ [--auto-compact(=value)?] [--compaction-threshold=value] [--max-oplog-size=value]\n\ +\ \ \ \ [--queue-size=value] [--time-interval=value] [--write-buffer-size=value]\n\ +\ \ \ \ [--group=value(,value)*] [--disk-usage-warning-percentage=value]\n\ +\ \ \ \ [--disk-usage-critical-percentage=value]\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name of the disk store to be created.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ allow-force-compaction\n\ +\ \ \ \ \ \ \ \ Whether to allow manual compaction through the API or command-line tools.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ +\ \ \ \ auto-compact\n\ +\ \ \ \ \ \ \ \ Whether to automatically compact a file when it reaches the compaction-threshold.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): true\n\ +\ \ \ \ compaction-threshold\n\ +\ \ \ \ \ \ \ \ Percentage of garbage allowed in the file before it is eligible for compaction.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): 50\n\ +\ \ \ \ max-oplog-size\n\ +\ \ \ \ \ \ \ \ The largest size, in megabytes, to allow an operation log to become before automatically\n\ +\ \ \ \ \ \ \ \ rolling to a new file.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): 1024\n\ +\ \ \ \ queue-size\n\ +\ \ \ \ \ \ \ \ For asynchronous queueing. The maximum number of operations to allow into the write queue\n\ +\ \ \ \ \ \ \ \ before automatically flushing the queue. The default of 0 indicates no limit.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): 0\n\ +\ \ \ \ time-interval\n\ +\ \ \ \ \ \ \ \ For asynchronous queueing. The number of milliseconds that can elapse before data is\n\ +\ \ \ \ \ \ \ \ flushed to disk. Reaching this limit or the queue-size limit causes the queue to flush.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): 1000\n\ +\ \ \ \ write-buffer-size\n\ +\ \ \ \ \ \ \ \ Size of the buffer used to write to disk.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): 32768\n\ +\ \ \ \ dir\n\ +\ \ \ \ \ \ \ \ Directories where the disk store files will be written, the directories will be created if\n\ +\ \ \ \ \ \ \ \ they don't exist. Optionally, directory names may be followed by # and the maximum number\n\ +\ \ \ \ \ \ \ \ of megabytes that the disk store can use in the directory. Example: --dir=/data/ds1\n\ +\ \ \ \ \ \ \ \ --dir=/data/ds2#5000\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members on which the disk store will be created. If no group is specified the\n\ +\ \ \ \ \ \ \ \ disk store will be created on all members.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ disk-usage-warning-percentage\n\ +\ \ \ \ \ \ \ \ Warning percentage for disk volume usage.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): 90\n\ +\ \ \ \ disk-usage-critical-percentage\n\ +\ \ \ \ \ \ \ \ Critical percentage for disk volume usage.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): 99\n\ + +create-gateway-receiver.help=\ +NAME\n\ +\ \ \ \ create gateway-receiver\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Create the Gateway Receiver on a member or members.\n\ +SYNTAX\n\ +\ \ \ \ create gateway-receiver [--group=value(,value)*] [--member=value(,value)*]\n\ +\ \ \ \ [--manual-start=value] [--start-port=value] [--end-port=value] [--bind-address=value]\n\ +\ \ \ \ [--maximum-time-between-pings=value] [--socket-buffer-size=value]\n\ +\ \ \ \ [--gateway-transport-filter=value(,value)*]\n\ +PARAMETERS\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members on which to create the Gateway Receiver.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member on which to create the Gateway Receiver.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ manual-start\n\ +\ \ \ \ \ \ \ \ Whether manual start is to be enabled or the receiver will start automatically after\n\ +\ \ \ \ \ \ \ \ creation.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ start-port\n\ +\ \ \ \ \ \ \ \ Starting value of the port range from which the GatewayReceiver's port will be chosen.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ end-port\n\ +\ \ \ \ \ \ \ \ End value of the port range from which the GatewayReceiver's port will be chosen.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ bind-address\n\ +\ \ \ \ \ \ \ \ The IP address or host name that the receiver's socket will listen on for client\n\ +\ \ \ \ \ \ \ \ connections.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ maximum-time-between-pings\n\ +\ \ \ \ \ \ \ \ The maximum amount of time between client pings.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ socket-buffer-size\n\ +\ \ \ \ \ \ \ \ The buffer size in bytes of the socket connection for this GatewayReceiver.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ gateway-transport-filter\n\ +\ \ \ \ \ \ \ \ The fully qualified class names of GatewayTransportFilters (separated by comma) to be added\n\ +\ \ \ \ \ \ \ \ to the GatewayReceiver. e.g.\n\ +\ \ \ \ \ \ \ \ gateway-transport-filter=com.user.filters.MyFilter1,com.user.filters.MyFilters2\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +create-gateway-sender.help=\ +NAME\n\ +\ \ \ \ create gateway-sender\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Create the Gateway Sender on a member or members.\n\ +SYNTAX\n\ +\ \ \ \ create gateway-sender --id=value --remote-distributed-system-id=value [--group=value(,value)*]\n\ +\ \ \ \ [--member=value(,value)*] [--parallel=value] [--manual-start=value]\n\ +\ \ \ \ [--socket-buffer-size=value] [--socket-read-timeout=value] [--enable-batch-conflation=value]\n\ +\ \ \ \ [--batch-size=value] [--batch-time-interval=value] [--enable-persistence=value]\n\ +\ \ \ \ [--disk-store-name=value] [--disk-synchronous=value] [--maximum-queue-memory=value]\n\ +\ \ \ \ [--alert-threshold=value] [--dispatcher-threads=value] [--order-policy=value]\n\ +\ \ \ \ [--gateway-event-filter=value(,value)*] [--gateway-transport-filter=value(,value)*]\n\ +PARAMETERS\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members on which to create the Gateway Sender.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member on which to create the Gateway Sender.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ id\n\ +\ \ \ \ \ \ \ \ Id of the GatewaySender.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ remote-distributed-system-id\n\ +\ \ \ \ \ \ \ \ Id of the remote distributed system to which the sender will send events.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ parallel\n\ +\ \ \ \ \ \ \ \ Whether this is Parallel GatewaySender.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ manual-start\n\ +\ \ \ \ \ \ \ \ Whether manual start is to be enabled or the sender will start automatically after\n\ +\ \ \ \ \ \ \ \ creation.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ socket-buffer-size\n\ +\ \ \ \ \ \ \ \ The buffer size of the socket connection between this GatewaySender and its receiving\n\ +\ \ \ \ \ \ \ \ GatewayReceiver.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ socket-read-timeout\n\ +\ \ \ \ \ \ \ \ The amount of time in milliseconds that a socket read between a sending GatewaySender and\n\ +\ \ \ \ \ \ \ \ its receiving GatewayReceiver will block.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-batch-conflation\n\ +\ \ \ \ \ \ \ \ Whether batch conflation is to be enabled for a GatewaySender.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ batch-size\n\ +\ \ \ \ \ \ \ \ The batch size for the GatewaySender.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ batch-time-interval\n\ +\ \ \ \ \ \ \ \ The batch time interval for the GatewaySender.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-persistence\n\ +\ \ \ \ \ \ \ \ Whether persistence is to be enabled for the GatewaySender.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ disk-store-name\n\ +\ \ \ \ \ \ \ \ The disk store name to be configured for overflow or persistence.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ disk-synchronous\n\ +\ \ \ \ \ \ \ \ Whether writes to the disk in case of persistence are synchronous.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ maximum-queue-memory\n\ +\ \ \ \ \ \ \ \ The maximum amount of memory (in MB) for a GatewaySender's queue.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ alert-threshold\n\ +\ \ \ \ \ \ \ \ The alert threshold for entries in a GatewaySender's queue.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ dispatcher-threads\n\ +\ \ \ \ \ \ \ \ The number of dispatcher threads working for this GatewaySender. When dispatcher threads is\n\ +\ \ \ \ \ \ \ \ set to > 1, appropriate order policy is required to be set.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ order-policy\n\ +\ \ \ \ \ \ \ \ The order policy followed while dispatching the events to remote distributed system. Order\n\ +\ \ \ \ \ \ \ \ policy is set only when dispatcher threads are > 1. Possible values are 'THREAD', 'KEY',\n\ +\ \ \ \ \ \ \ \ 'PARTITION'.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ gateway-event-filter\n\ +\ \ \ \ \ \ \ \ The list of fully qualified class names of GatewayEventFilters (separated by comma) to be\n\ +\ \ \ \ \ \ \ \ associated with the GatewaySender. This serves as a callback for users to filter out events\n\ +\ \ \ \ \ \ \ \ before dispatching to remote distributed system. e.g\n\ +\ \ \ \ \ \ \ \ gateway-event-filter=com.user.filters.MyFilter1,com.user.filters.MyFilters2\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ gateway-transport-filter\n\ +\ \ \ \ \ \ \ \ The fully qualified class name of GatewayTransportFilter to be added to the GatewaySender. \n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +create-index.help=\ +NAME\n\ +\ \ \ \ create index\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Create an index that can be used when executing queries.\n\ +SYNTAX\n\ +\ \ \ \ create index --name=value --expression=value --region=value [--member=value] [--type=value]\n\ +\ \ \ \ [--group=value]\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name of the index to create.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ expression\n\ +\ \ \ \ \ \ \ \ Field of the region values that are referenced by the index.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ region\n\ +\ \ \ \ \ \ \ \ Name/Path of the region which corresponds to the "from" clause in a query.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member in which the index will be created.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ type\n\ +\ \ \ \ \ \ \ \ Type of the index. Valid values are: range, key and hash.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): range\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group of members in which the index will be created.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +create-region.help=\ +NAME\n\ +\ \ \ \ create region\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Create a region with the given path and configuration. Specifying a --key-constraint and\n\ +\ \ \ \ --value-constraint makes object type information available during querying and indexing.\n\ +SYNTAX\n\ +\ \ \ \ create region --name=value [--type=value] [--template-region=value] [--group=value(,value)*]\n\ +\ \ \ \ [--skip-if-exists(=value)?] [--async-event-queue-id=value(,value)*]\n\ +\ \ \ \ [--cache-listener=value(,value)*] [--cache-loader=value] [--cache-writer=value]\n\ +\ \ \ \ [--colocated-with=value] [--compressor=value] [--concurrency-level=value] [--disk-store=value]\n\ +\ \ \ \ [--enable-async-conflation=value] [--enable-cloning=value] [--enable-concurrency-checks=value]\n\ +\ \ \ \ [--enable-multicast=value] [--enable-statistics=value] [--enable-subscription-conflation=value]\n\ +\ \ \ \ [--enable-synchronous-disk=value] [--entry-idle-time-expiration=value]\n\ +\ \ \ \ [--entry-idle-time-expiration-action=value] [--entry-time-to-live-expiration=value]\n\ +\ \ \ \ [--entry-time-to-live-expiration-action=value] [--gateway-sender-id=value(,value)*]\n\ +\ \ \ \ [--key-constraint=value] [--local-max-memory=value] [--off-heap(=value)?]\n\ +\ \ \ \ [--region-idle-time-expiration=value] [--region-idle-time-expiration-action=value]\n\ +\ \ \ \ [--region-time-to-live-expiration=value] [--region-time-to-live-expiration-action=value]\n\ +\ \ \ \ [--recovery-delay=value] [--redundant-copies=value] [--startup-recovery-delay=value]\n\ +\ \ \ \ [--total-max-memory=value] [--total-num-buckets=value] [--value-constraint=value]\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name/Path of the region to be created.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ type\n\ +\ \ \ \ \ \ \ \ Type of region to create. The following types are pre-defined by the product (see\n\ +\ \ \ \ \ \ \ \ RegionShortcut javadocs for more information): PARTITION, PARTITION_REDUNDANT,\n\ +\ \ \ \ \ \ \ \ PARTITION_PERSISTENT, PARTITION_REDUNDANT_PERSISTENT, PARTITION_OVERFLOW,\n\ +\ \ \ \ \ \ \ \ PARTITION_REDUNDANT_OVERFLOW, PARTITION_PERSISTENT_OVERFLOW,\n\ +\ \ \ \ \ \ \ \ PARTITION_REDUNDANT_PERSISTENT_OVERFLOW, PARTITION_HEAP_LRU, PARTITION_REDUNDANT_HEAP_LRU,\n\ +\ \ \ \ \ \ \ \ REPLICATE, REPLICATE_PERSISTENT, REPLICATE_OVERFLOW, REPLICATE_PERSISTENT_OVERFLOW,\n\ +\ \ \ \ \ \ \ \ REPLICATE_HEAP_LRU, LOCAL, LOCAL_PERSISTENT, LOCAL_HEAP_LRU, LOCAL_OVERFLOW,\n\ +\ \ \ \ \ \ \ \ LOCAL_PERSISTENT_OVERFLOW, PARTITION_PROXY, PARTITION_PROXY_REDUNDANT, and REPLICATE_PROXY.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ template-region\n\ +\ \ \ \ \ \ \ \ Name/Path of the region whose attributes should be duplicated when creating this region.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members on which the region will be created.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ skip-if-exists\n\ +\ \ \ \ \ \ \ \ Skip region ceation if the region already exists.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): true\n\ +\ \ \ \ async-event-queue-id\n\ +\ \ \ \ \ \ \ \ IDs of the Async Event Queues that will be used for write-behind operations.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ cache-listener\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of a plug-in to be instantiated for receiving after-event\n\ +\ \ \ \ \ \ \ \ notification of changes to the region and its entries. Any number of cache listeners can be\n\ +\ \ \ \ \ \ \ \ configured.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ cache-loader\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of a plug-in to be instantiated for receiving notification of\n\ +\ \ \ \ \ \ \ \ cache misses in the region. At most, one cache loader can be defined in each member for the\n\ +\ \ \ \ \ \ \ \ region. For distributed regions, a cache loader may be invoked remotely from other members\n\ +\ \ \ \ \ \ \ \ that have the region defined.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ cache-writer\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of a plug-in to be instantiated for receiving before-event\n\ +\ \ \ \ \ \ \ \ notification of changes to the region and its entries. The plug-in may cancel the event. At\n\ +\ \ \ \ \ \ \ \ most, one cache writer can be defined in each member for the region.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ colocated-with\n\ +\ \ \ \ \ \ \ \ Central Region with which this region should be colocated.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ compressor\n\ +\ \ \ \ \ \ \ \ The fully-qualifed class name of the Compressor to use when compressing region entry\n\ +\ \ \ \ \ \ \ \ values. The default is no compression.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ concurrency-level\n\ +\ \ \ \ \ \ \ \ An estimate of the maximum number of application threads that will concurrently access a\n\ +\ \ \ \ \ \ \ \ region entry at one time. This attribute does not apply to partitioned regions.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ disk-store\n\ +\ \ \ \ \ \ \ \ Disk Store to be used by this region. "list disk-store" can be used to display existing\n\ +\ \ \ \ \ \ \ \ disk stores.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-async-conflation\n\ +\ \ \ \ \ \ \ \ Whether to allow aggregation of asynchronous TCP/IP messages sent by the producer member of\n\ +\ \ \ \ \ \ \ \ the region. A false value causes all asynchronous messages to be sent individually.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-cloning\n\ +\ \ \ \ \ \ \ \ Determines how fromDelta applies deltas to the local cache for delta propagation. When\n\ +\ \ \ \ \ \ \ \ true, the updates are applied to a clone of the value and then the clone is saved to the\n\ +\ \ \ \ \ \ \ \ cache. When false, the value is modified in place in the cache.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-concurrency-checks\n\ +\ \ \ \ \ \ \ \ Enables a versioning system that detects concurrent modifications and ensures that region\n\ +\ \ \ \ \ \ \ \ contents are consistent across the distributed system.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-multicast\n\ +\ \ \ \ \ \ \ \ Enables multicast messaging on the region. Multicast must also be enabled in the cache\n\ +\ \ \ \ \ \ \ \ distributed system properties. This is primarily useful for replicated regions that are in\n\ +\ \ \ \ \ \ \ \ all servers.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-statistics\n\ +\ \ \ \ \ \ \ \ Whether to gather statistics for the region. Must be true to use expiration on the region.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-subscription-conflation\n\ +\ \ \ \ \ \ \ \ Whether the server should conflate its messages to the client. A false value causes all\n\ +\ \ \ \ \ \ \ \ server-client messages to be sent individually.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ enable-synchronous-disk\n\ +\ \ \ \ \ \ \ \ Whether writes are done synchronously for regions that persist data to disk.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ entry-idle-time-expiration\n\ +\ \ \ \ \ \ \ \ How long the region's entries can remain in the cache without being accessed. The default\n\ +\ \ \ \ \ \ \ \ is no expiration of this type.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ entry-idle-time-expiration-action\n\ +\ \ \ \ \ \ \ \ Action to be taken on an entry that has exceeded the idle expiration.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ entry-time-to-live-expiration\n\ +\ \ \ \ \ \ \ \ How long the region's entries can remain in the cache without being accessed or updated.\n\ +\ \ \ \ \ \ \ \ The default is no expiration of this type.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ entry-time-to-live-expiration-action\n\ +\ \ \ \ \ \ \ \ Action to be taken on an entry that has exceeded the TTL expiration.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ gateway-sender-id\n\ +\ \ \ \ \ \ \ \ IDs of the Gateway Senders to which data will be routed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ key-constraint\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of the objects allowed as region keys. Ensures that keys for\n\ +\ \ \ \ \ \ \ \ region entries are all of the same class.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ local-max-memory\n\ +\ \ \ \ \ \ \ \ Sets the maximum amount of memory, in megabytes, to be used by the region in this process.\n\ +\ \ \ \ \ \ \ \ (Default: 90% of available heap)\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ off-heap\n\ +\ \ \ \ \ \ \ \ Causes the values of the region to be stored in off-heap memory. The default is on heap.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ region-idle-time-expiration\n\ +\ \ \ \ \ \ \ \ How long the region can remain in the cache without being accessed. The default is no\n\ +\ \ \ \ \ \ \ \ expiration of this type.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ region-idle-time-expiration-action\n\ +\ \ \ \ \ \ \ \ Action to be taken on a region that has exceeded the idle expiration.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ region-time-to-live-expiration\n\ +\ \ \ \ \ \ \ \ How long the region can remain in the cache without being accessed or updated. The default\n\ +\ \ \ \ \ \ \ \ is no expiration of this type.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ region-time-to-live-expiration-action\n\ +\ \ \ \ \ \ \ \ Action to be taken on a region that has exceeded the TTL expiration.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ recovery-delay\n\ +\ \ \ \ \ \ \ \ Sets the delay in milliseconds that existing members will wait before satisfying redundancy\n\ +\ \ \ \ \ \ \ \ after another member crashes. -1 (the default) indicates that redundancy will not be\n\ +\ \ \ \ \ \ \ \ recovered after a failure.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ redundant-copies\n\ +\ \ \ \ \ \ \ \ Sets the number of extra copies of buckets desired. Extra copies allow for both high\n\ +\ \ \ \ \ \ \ \ availability in the face of VM departure (intended or unintended) and and load balancing\n\ +\ \ \ \ \ \ \ \ read operations. (Allowed values: 0, 1, 2 and 3)\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ startup-recovery-delay\n\ +\ \ \ \ \ \ \ \ Sets the delay in milliseconds that new members will wait before satisfying redundancy. -1\n\ +\ \ \ \ \ \ \ \ indicates that adding new members will not trigger redundancy recovery. The default is to\n\ +\ \ \ \ \ \ \ \ recover redundancy immediately when a new member is added.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ total-max-memory\n\ +\ \ \ \ \ \ \ \ Sets the maximum amount of memory, in megabytes, to be used by the region in all processes.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ total-num-buckets\n\ +\ \ \ \ \ \ \ \ Sets the total number of hash buckets to be used by the region in all processes. (Default:\n\ +\ \ \ \ \ \ \ \ 113).\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ value-constraint\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of the objects allowed as region values. If not specified then\n\ +\ \ \ \ \ \ \ \ region values can be of any class.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +debug.help=\ +NAME\n\ +\ \ \ \ debug\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Enable/Disable debugging output in GFSH.\n\ +SYNTAX\n\ +\ \ \ \ debug --state=value\n\ +PARAMETERS\n\ +\ \ \ \ state\n\ +\ \ \ \ \ \ \ \ ON or OFF to enable or disable debugging output.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): OFF\n\ + +define-index.help=\ +NAME\n\ +\ \ \ \ define index\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Define an index that can be used when executing queries.\n\ +SYNTAX\n\ +\ \ \ \ define index --name=value --expression=value --region=value [--type=value]\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Define an index that can be used when executing queries.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ expression\n\ +\ \ \ \ \ \ \ \ Field of the region values that are referenced by the index.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ region\n\ +\ \ \ \ \ \ \ \ Name/Path of the region which corresponds to the "from" clause in a query.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ type\n\ +\ \ \ \ \ \ \ \ Type of the index. Valid values are: range, key and hash.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): range\n\ + +deploy.help=\ +NAME\n\ +\ \ \ \ deploy\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Deploy JARs to a member or members. Only one of either --jar or --dir may be specified.\n\ +SYNTAX\n\ +\ \ \ \ deploy [--group=value(,value)*] [--jar=value] [--dir=value]\n\ +PARAMETERS\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) to which the specified JARs will be deployed. If not specified, deploy will occur\n\ +\ \ \ \ \ \ \ \ on all members.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ jar\n\ +\ \ \ \ \ \ \ \ Path of the JAR to deploy.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ dir\n\ +\ \ \ \ \ \ \ \ Directory from which to deploy the JARs.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +describe-client.help=\ +NAME\n\ +\ \ \ \ describe client\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display details of specified client\n\ +SYNTAX\n\ +\ \ \ \ describe client --clientID=value\n\ +PARAMETERS\n\ +\ \ \ \ clientID\n\ +\ \ \ \ \ \ \ \ ID of a client for which details are needed\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +describe-config.help=\ +NAME\n\ +\ \ \ \ describe config\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display configuration details of a member or members.\n\ +SYNTAX\n\ +\ \ \ \ describe config --member=value [--hide-defaults(=value)?]\n\ +PARAMETERS\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member whose configuration will be described.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ hide-defaults\n\ +\ \ \ \ \ \ \ \ Whether to hide configuration information for properties with the default value.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): true\n\ + +describe-connection.help=\ +NAME\n\ +\ \ \ \ describe connection\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Display information about the current connection.\n\ +SYNTAX\n\ +\ \ \ \ describe connection\n\ + +describe-disk-store.help=\ +NAME\n\ +\ \ \ \ describe disk-store\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display information about a member's disk store.\n\ +SYNTAX\n\ +\ \ \ \ describe disk-store --member=value --name=value\n\ +PARAMETERS\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member with the disk store to be described.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name of the disk store to be described.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +describe-member.help=\ +NAME\n\ +\ \ \ \ describe member\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display information about a member, including name, id, groups, regions, etc.\n\ +SYNTAX\n\ +\ \ \ \ describe member --name=value\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Display information about a member, including name, id, groups, regions, etc.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +describe-offline-disk-store.help=\ +NAME\n\ +\ \ \ \ describe offline-disk-store\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Display information about an offline disk store.\n\ +SYNTAX\n\ +\ \ \ \ describe offline-disk-store --name=value --disk-dirs=value(,value)* [--pdx=value]\n\ +\ \ \ \ [--region=value]\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name of the disk store to be described.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ disk-dirs\n\ +\ \ \ \ \ \ \ \ Directories which contain the disk store files.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ pdx\n\ +\ \ \ \ \ \ \ \ Display all the pdx types stored in the disk store\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ region\n\ +\ \ \ \ \ \ \ \ Name/Path of the region in the disk store to be described.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +describe-region.help=\ +NAME\n\ +\ \ \ \ describe region\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display the attributes and key information of a region.\n\ +SYNTAX\n\ +\ \ \ \ describe region --name=value\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name/Path of the region to be described.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +destroy-disk-store.help=\ +NAME\n\ +\ \ \ \ destroy disk-store\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Destroy a disk store, including deleting all files on disk used by the disk store. Data for\n\ +\ \ \ \ closed regions previously using the disk store will be lost.\n\ +SYNTAX\n\ +\ \ \ \ destroy disk-store --name=value [--group=value(,value)*]\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name of the disk store that will be destroyed.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members on which the disk store will be destroyed. If no group is specified the\n\ +\ \ \ \ \ \ \ \ disk store will be destroyed on all members.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +destroy-function.help=\ +NAME\n\ +\ \ \ \ destroy function\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Destroy/Unregister a function. The default is for the function to be unregistered from all\n\ +\ \ \ \ members.\n\ +SYNTAX\n\ +\ \ \ \ destroy function --id=value [--groups=value(nullvalue)*] [--member=value]\n\ +PARAMETERS\n\ +\ \ \ \ id\n\ +\ \ \ \ \ \ \ \ Destroy/Unregister a function. The default is for the function to be unregistered from all\n\ +\ \ \ \ \ \ \ \ members.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ groups\n\ +\ \ \ \ \ \ \ \ Groups of members from which this function will be unregistered.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member from which this function will be unregistered.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +destroy-index.help=\ +NAME\n\ +\ \ \ \ destroy index\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Destroy/Remove the specified index.\n\ +SYNTAX\n\ +\ \ \ \ destroy index [--name=value] [--region=value] [--member=value] [--group=value]\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name of the index to remove.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ region\n\ +\ \ \ \ \ \ \ \ Name/Path of the region from which the index will be removed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member from which the index will be removed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group of members from which the index will be removed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +destroy-region.help=\ +NAME\n\ +\ \ \ \ destroy region\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Destroy/Remove a region.\n\ +SYNTAX\n\ +\ \ \ \ destroy region --name=value\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name/Path of the region to be removed.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +disconnect.help=\ +NAME\n\ +\ \ \ \ disconnect\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Close the current connection, if one is open.\n\ +SYNTAX\n\ +\ \ \ \ disconnect\n\ + +echo.help=\ +NAME\n\ +\ \ \ \ echo\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Echo the given text which may include system and user variables.\n\ +SYNTAX\n\ +\ \ \ \ echo --string=value\n\ +PARAMETERS\n\ +\ \ \ \ string\n\ +\ \ \ \ \ \ \ \ String to be echoed. For example, "SYS_USER variable is set to ${SYS_USER}".\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +encrypt-password.help=\ +NAME\n\ +\ \ \ \ encrypt password\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Encrypt a password for use in data source configuration.\n\ +SYNTAX\n\ +\ \ \ \ encrypt password --password=value\n\ +PARAMETERS\n\ +\ \ \ \ password\n\ +\ \ \ \ \ \ \ \ Password to be encrypted.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +execute-function.help=\ +NAME\n\ +\ \ \ \ execute function\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Execute the function with the specified ID. By default will execute on all members.\n\ +SYNTAX\n\ +\ \ \ \ execute function --id=value [--groups=value(nullvalue)*] [--member=value] [--region=value]\n\ +\ \ \ \ [--arguments=value(nullvalue)*] [--result-collector=value] [--filter=value]\n\ +PARAMETERS\n\ +\ \ \ \ id\n\ +\ \ \ \ \ \ \ \ ID of the function to execute.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ groups\n\ +\ \ \ \ \ \ \ \ Groups of members on which the function will be executed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member on which the function will be executed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ region\n\ +\ \ \ \ \ \ \ \ Region on which the data dependent function will be executed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ arguments\n\ +\ \ \ \ \ \ \ \ Arguments to the function in comma separated String format.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ result-collector\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of the ResultCollector to instantiate for gathering results.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ filter\n\ +\ \ \ \ \ \ \ \ Key list which causes the function to only be executed on members which have entries with\n\ +\ \ \ \ \ \ \ \ these keys.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +exit.help=\ +NAME\n\ +\ \ \ \ exit\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNONYMS\n\ +\ \ \ \ quit\n\ +SYNOPSIS\n\ +\ \ \ \ Exit GFSH and return control back to the calling process.\n\ +SYNTAX\n\ +\ \ \ \ exit\n\ + +export-cluster-configuration.help=\ +NAME\n\ +\ \ \ \ export cluster-configuration\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Exports the cluster configuration artifacts as a zip file.\n\ +SYNTAX\n\ +\ \ \ \ export cluster-configuration --zip-file-name=value [--dir=value]\n\ +PARAMETERS\n\ +\ \ \ \ zip-file-name\n\ +\ \ \ \ \ \ \ \ Name of the zip file containing the exported cluster configuration artifacts\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ dir\n\ +\ \ \ \ \ \ \ \ The directory in which the exported cluster configuration artifacts will be saved\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +export-config.help=\ +NAME\n\ +\ \ \ \ export config\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Export configuration properties for a member or members.\n\ +SYNTAX\n\ +\ \ \ \ export config [--member=value(,value)*] [--group=value(,value)*] [--dir=value]\n\ +PARAMETERS\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member(s) whose configuration will be exported.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members whose configuration will be exported.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ dir\n\ +\ \ \ \ \ \ \ \ Directory to which the exported configuration files will be written.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +export-data.help=\ +NAME\n\ +\ \ \ \ export data\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Export user data from a region to a file.\n\ +SYNTAX\n\ +\ \ \ \ export data --region=value --file=value --member=value\n\ +PARAMETERS\n\ +\ \ \ \ region\n\ +\ \ \ \ \ \ \ \ Region from which data will be exported.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ file\n\ +\ \ \ \ \ \ \ \ File to which the exported data will be written. The file must have an extension of ".gfd".\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of a member which hosts the region. The data will be exported to the specified file\n\ +\ \ \ \ \ \ \ \ on the host where the member is running.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +export-logs.help=\ +NAME\n\ +\ \ \ \ export logs\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Export the log files for a member or members.\n\ +SYNTAX\n\ +\ \ \ \ export logs --dir=value [--group=value(nullvalue)*] [--member=value] [--log-level=value]\n\ +\ \ \ \ [--only-log-level=value] [--merge-log=value] [--start-time=value] [--end-time=value]\n\ +PARAMETERS\n\ +\ \ \ \ dir\n\ +\ \ \ \ \ \ \ \ Directory to which log files will be written.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group of members whose log files will be exported.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member whose log files will be exported.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ log-level\n\ +\ \ \ \ \ \ \ \ Minimum level of log entries to export. Valid values are: none, error, info, config , fine,\n\ +\ \ \ \ \ \ \ \ finer and finest. The default is "info".\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ only-log-level\n\ +\ \ \ \ \ \ \ \ Whether to only include those entries that exactly match the --log-level specified.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ +\ \ \ \ merge-log\n\ +\ \ \ \ \ \ \ \ Whether to merge logs after exporting to the target directory.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ +\ \ \ \ start-time\n\ +\ \ \ \ \ \ \ \ Log entries that occurred after this time will be exported. The default is no limit.\n\ +\ \ \ \ \ \ \ \ Format: yyyy/MM/dd/HH/mm/ss/SSS/z OR yyyy/MM/dd\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ end-time\n\ +\ \ \ \ \ \ \ \ Log entries that occurred before this time will be exported. The default is no limit.\n\ +\ \ \ \ \ \ \ \ Format: yyyy/MM/dd/HH/mm/ss/SSS/z OR yyyy/MM/dd\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +export-offline-disk-store.help=\ +NAME\n\ +\ \ \ \ export offline-disk-store\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Export region data from an offline disk store into gemfire snapshot files.\n\ +SYNTAX\n\ +\ \ \ \ export offline-disk-store --name=value --disk-dirs=value(,value)* --dir=value\n\ +PARAMETERS\n\ +\ \ \ \ name\n\ +\ \ \ \ \ \ \ \ Name of the disk store to be exported.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ disk-dirs\n\ +\ \ \ \ \ \ \ \ Directories which contain the disk store files.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ dir\n\ +\ \ \ \ \ \ \ \ Directory to export snapshot files to.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +export-stack-traces.help=\ +NAME\n\ +\ \ \ \ export stack-traces\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Export the stack trace for a member or members.\n\ +SYNTAX\n\ +\ \ \ \ export stack-traces --file=value [--member=value] [--group=value]\n\ +PARAMETERS\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Export the stack trace for a member or members.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ file\n\ +\ \ \ \ \ \ \ \ Name of the file to which the stack traces will be written.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +gc.help=\ +NAME\n\ +\ \ \ \ gc\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Force GC (Garbage Collection) on a member or members. The default is for garbage collection to\n\ +\ \ \ \ occur on all caching members.\n\ +SYNTAX\n\ +\ \ \ \ gc [--group=value(nullvalue)*] [--member=value]\n\ +PARAMETERS\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members on which garbage collection will be done.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member on which garbage collection will be done.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +get.help=\ +NAME\n\ +\ \ \ \ get\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display an entry in a region. If using a region whose key and value classes have been set, then\n\ +\ \ \ \ specifying --key-class and --value-class is unnecessary.\n\ +SYNTAX\n\ +\ \ \ \ get --key=value --region=value [--key-class=value] [--value-class=value]\n\ +\ \ \ \ [--load-on-cache-miss(=value)?]\n\ +PARAMETERS\n\ +\ \ \ \ key\n\ +\ \ \ \ \ \ \ \ String or JSON text from which to create the key. Examples include: "James", "100L" and\n\ +\ \ \ \ \ \ \ \ "('id': 'l34s')".\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ region\n\ +\ \ \ \ \ \ \ \ Region from which to get the entry.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ key-class\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of the key's type. The default is the key constraint for the\n\ +\ \ \ \ \ \ \ \ current region or String.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ value-class\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of the value's type. The default is the value constraint for the\n\ +\ \ \ \ \ \ \ \ current region or String.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ load-on-cache-miss\n\ +\ \ \ \ \ \ \ \ Explicitly enables or disables the use of any registered CacheLoaders on the specified\n\ +\ \ \ \ \ \ \ \ Region when retrieving a value for the specified Key on Cache misses. (Default is true, or\n\ +\ \ \ \ \ \ \ \ enabled)\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): true\n\ + +help.help=\ +NAME\n\ +\ \ \ \ help\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Display syntax and usage information for all commands or list all available commands if\n\ +\ \ \ \ isn't specified.\n\ +SYNTAX\n\ +\ \ \ \ help [command]\n\ +ARGUMENTS\n\ +\ \ \ \ command\n\ +\ \ \ \ \ \ \ \ Name of the command for which help will be displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +hint.help=\ +NAME\n\ +\ \ \ \ hint\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Provide hints for a topic or list all available topics if "topic" isn't specified.\n\ +SYNTAX\n\ +\ \ \ \ hint [topic]\n\ +ARGUMENTS\n\ +\ \ \ \ topic\n\ +\ \ \ \ \ \ \ \ topic\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +history.help=\ +NAME\n\ +\ \ \ \ history\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Display or export previously executed GFSH commands.\n\ +SYNTAX\n\ +\ \ \ \ history [--file=value] [--clear(=value)?]\n\ +PARAMETERS\n\ +\ \ \ \ file\n\ +\ \ \ \ \ \ \ \ File to which the history will be written.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ clear\n\ +\ \ \ \ \ \ \ \ Clears the history of GFSH commands. Takes value as true or false\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ + +import-cluster-configuration.help=\ +NAME\n\ +\ \ \ \ import cluster-configuration\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Imports configuration into cluster configuration hosted at the locators\n\ +SYNTAX\n\ +\ \ \ \ import cluster-configuration --zip-file-name=value\n\ +PARAMETERS\n\ +\ \ \ \ zip-file-name\n\ +\ \ \ \ \ \ \ \ The zip file containing the cluster configuration artifacts, which are to be imported\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +import-data.help=\ +NAME\n\ +\ \ \ \ import data\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Import user data from a file to a region.\n\ +SYNTAX\n\ +\ \ \ \ import data --region=value --file=value --member=value\n\ +PARAMETERS\n\ +\ \ \ \ region\n\ +\ \ \ \ \ \ \ \ Region into which data will be imported.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ file\n\ +\ \ \ \ \ \ \ \ File from which the imported data will be read. The file must have an extension of ".gfd".\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of a member which hosts the region. The data will be imported from the specified\n\ +\ \ \ \ \ \ \ \ file on the host where the member is running.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +list-async-event-queues.help=\ +NAME\n\ +\ \ \ \ list async-event-queues\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display the Async Event Queues for all members.\n\ +SYNTAX\n\ +\ \ \ \ list async-event-queues\n\ + +list-clients.help=\ +NAME\n\ +\ \ \ \ list clients\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display list of connected clients\n\ +SYNTAX\n\ +\ \ \ \ list clients\n\ + +list-deployed.help=\ +NAME\n\ +\ \ \ \ list deployed\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display a list of JARs that were deployed to members using the "deploy" command.\n\ +SYNTAX\n\ +\ \ \ \ list deployed [--group=value(,value)*]\n\ +PARAMETERS\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members for which deployed JARs will be displayed. If not specified, JARs for\n\ +\ \ \ \ \ \ \ \ all members will be displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +list-disk-stores.help=\ +NAME\n\ +\ \ \ \ list disk-stores\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display disk stores for all members.\n\ +SYNTAX\n\ +\ \ \ \ list disk-stores\n\ + +list-durable-cqs.help=\ +NAME\n\ +\ \ \ \ list durable-cqs\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ List durable client cqs associated with the specified durable client id.\n\ +SYNTAX\n\ +\ \ \ \ list durable-cqs --durable-client-id=value [--member=value] [--group=value]\n\ +PARAMETERS\n\ +\ \ \ \ durable-client-id\n\ +\ \ \ \ \ \ \ \ The id used to identify the durable client\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member for which the durable client is registered and durable cqs will be\n\ +\ \ \ \ \ \ \ \ displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group of members for which the durable client is registered and durable cqs will be\n\ +\ \ \ \ \ \ \ \ displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +list-functions.help=\ +NAME\n\ +\ \ \ \ list functions\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display a list of registered functions. The default is to display functions for all members.\n\ +SYNTAX\n\ +\ \ \ \ list functions [--matches=value] [--group=value(,value)*] [--member=value(,value)*]\n\ +PARAMETERS\n\ +\ \ \ \ matches\n\ +\ \ \ \ \ \ \ \ Pattern that the function ID must match in order to be included. Uses Java pattern matching\n\ +\ \ \ \ \ \ \ \ rules, not UNIX. For example, to match any character any number of times use ".*" instead\n\ +\ \ \ \ \ \ \ \ of "*".\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members for which functions will be displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member(s) for which functions will be displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +list-gateways.help=\ +NAME\n\ +\ \ \ \ list gateways\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display the Gateway Senders and Receivers for a member or members.\n\ +SYNTAX\n\ +\ \ \ \ list gateways [--member=value(,value)*] [--group=value(,value)*]\n\ +PARAMETERS\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Member(s) for which Gateway Senders and Receivers will be displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members for which Gateway Senders and Receivers will be displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +list-indexes.help=\ +NAME\n\ +\ \ \ \ list indexes\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display the list of indexes created for all members.\n\ +SYNTAX\n\ +\ \ \ \ list indexes [--with-stats(=value)?]\n\ +PARAMETERS\n\ +\ \ \ \ with-stats\n\ +\ \ \ \ \ \ \ \ Whether statistics should also be displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ + +list-members.help=\ +NAME\n\ +\ \ \ \ list members\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display all or a subset of members.\n\ +SYNTAX\n\ +\ \ \ \ list members [--group=value]\n\ +PARAMETERS\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group name for which members will be displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +list-regions.help=\ +NAME\n\ +\ \ \ \ list regions\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Display regions of a member or members.\n\ +SYNTAX\n\ +\ \ \ \ list regions [--group=value] [--member=value]\n\ +PARAMETERS\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group of members for which regions will be displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member for which regions will be displayed.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +load-balance-gateway-sender.help=\ +NAME\n\ +\ \ \ \ load-balance gateway-sender\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Cause the Gateway Sender to close its current connections so that it reconnects to its remote\n\ +\ \ \ \ receivers in a more balanced fashion.\n\ +SYNTAX\n\ +\ \ \ \ load-balance gateway-sender --id=value\n\ +PARAMETERS\n\ +\ \ \ \ id\n\ +\ \ \ \ \ \ \ \ ID of the Gateway Sender.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +locate-entry.help=\ +NAME\n\ +\ \ \ \ locate entry\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Identifies the location, including host, member and region, of entries that have the specified\n\ +\ \ \ \ key.\n\ +SYNTAX\n\ +\ \ \ \ locate entry --key=value --region=value [--key-class=value] [--value-class=value]\n\ +\ \ \ \ [--recursive=value]\n\ +PARAMETERS\n\ +\ \ \ \ key\n\ +\ \ \ \ \ \ \ \ String or JSON text from which to create a key. Examples include: "James", "100L" and\n\ +\ \ \ \ \ \ \ \ "('id': 'l34s')".\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ region\n\ +\ \ \ \ \ \ \ \ Region in which to locate values.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ key-class\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of the key's type. The default is java.lang.String.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ value-class\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of the value's type. The default is java.lang.String.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ recursive\n\ +\ \ \ \ \ \ \ \ Whether to traverse regions and subregions recursively.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ + +netstat.help=\ +NAME\n\ +\ \ \ \ netstat\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Report network information and statistics via the "netstat" operating system command.\n\ +SYNTAX\n\ +\ \ \ \ netstat [--member=value(,value)*] [--group=value] [--file=value] [--with-lsof(=value)?]\n\ +PARAMETERS\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member(s) on which to run the netstat command.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group of members on which to run the netstat command.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ file\n\ +\ \ \ \ \ \ \ \ Text file to which output from the netstat command will be written. A ".txt" extention will\n\ +\ \ \ \ \ \ \ \ be added if it's not already a part of the specified name.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ with-lsof\n\ +\ \ \ \ \ \ \ \ Whether lsof (list open files) command output should also be displayed. Not applicable for\n\ +\ \ \ \ \ \ \ \ "Microsoft Windows(TM)" hosts.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ + +pause-gateway-sender.help=\ +NAME\n\ +\ \ \ \ pause gateway-sender\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Pause the Gateway Sender on a member or members.\n\ +SYNTAX\n\ +\ \ \ \ pause gateway-sender --id=value [--group=value(,value)*] [--member=value(,value)*]\n\ +PARAMETERS\n\ +\ \ \ \ id\n\ +\ \ \ \ \ \ \ \ ID of the Gateway Sender.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ group\n\ +\ \ \ \ \ \ \ \ Group(s) of members on which to pause the Gateway Sender.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ member\n\ +\ \ \ \ \ \ \ \ Name/Id of the member on which to pause the Gateway Sender.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ + +pdx-rename.help=\ +NAME\n\ +\ \ \ \ pdx rename\n\ +IS AVAILABLE\n\ +\ \ \ \ true\n\ +SYNOPSIS\n\ +\ \ \ \ Renames PDX types in an offline disk store. \n\ +\ \ \ \ \ Any pdx types that are renamed will be listed in the output. \n\ +\ \ \ \ \ If no renames are done or the disk-store is online then this command will fail.\n\ +SYNTAX\n\ +\ \ \ \ pdx rename --old=value --new=value --disk-store=value --disk-dirs=value(,value)*\n\ +PARAMETERS\n\ +\ \ \ \ old\n\ +\ \ \ \ \ \ \ \ If a PDX type's fully qualified class name has a word that matches this text then it will\n\ +\ \ \ \ \ \ \ \ be renamed. Words are delimited by '.' and '$'.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ new\n\ +\ \ \ \ \ \ \ \ The text to replace the word that matched old\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ disk-store\n\ +\ \ \ \ \ \ \ \ Name of the disk store to operate on\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ disk-dirs\n\ +\ \ \ \ \ \ \ \ Directories which contain the disk store files\n\ +\ \ \ \ \ \ \ \ Required: true\n\ + +put.help=\ +NAME\n\ +\ \ \ \ put\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Add/Update an entry in a region. If using a region whose key and value classes have been set,\n\ +\ \ \ \ then specifying --key-class and --value-class is unnecessary.\n\ +SYNTAX\n\ +\ \ \ \ put --key=value --value=value --region=value [--key-class=value] [--value-class=value]\n\ +\ \ \ \ [--skip-if-exists=value]\n\ +PARAMETERS\n\ +\ \ \ \ key\n\ +\ \ \ \ \ \ \ \ String or JSON text from which to create the key. Examples include: "James", "100L" and\n\ +\ \ \ \ \ \ \ \ "('id': 'l34s')".\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ value\n\ +\ \ \ \ \ \ \ \ String or JSON text from which to create the value. Examples include: "manager", "100L"\n\ +\ \ \ \ \ \ \ \ and "('value': 'widget')".\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ region\n\ +\ \ \ \ \ \ \ \ Region into which the entry will be put.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ key-class\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of the key's type. The default is java.lang.String.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ value-class\n\ +\ \ \ \ \ \ \ \ Fully qualified class name of the value's type. The default is java.lang.String.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ skip-if-exists\n\ +\ \ \ \ \ \ \ \ Skip the put operation when an entry with the same key already exists. The default is to\n\ +\ \ \ \ \ \ \ \ overwrite the entry (false).\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ + +query.help=\ +NAME\n\ +\ \ \ \ query\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Run the specified OQL query as a single quoted string and display the results in one or more\n\ +\ \ \ \ pages. Limit will default to the value stored in the "APP_FETCH_SIZE" variable. Page size will\n\ +\ \ \ \ default to the value stored in the "APP_COLLECTION_LIMIT" variable.\n\ +SYNTAX\n\ +\ \ \ \ query --query=value [--step-name=value] [--interactive=value]\n\ +PARAMETERS\n\ +\ \ \ \ query\n\ +\ \ \ \ \ \ \ \ The OQL string.\n\ +\ \ \ \ \ \ \ \ Required: true\n\ +\ \ \ \ step-name\n\ +\ \ \ \ \ \ \ \ Step name\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): ALL\n\ +\ \ \ \ interactive\n\ +\ \ \ \ \ \ \ \ Whether or not this query is interactive. If false then all results will be displayed at\n\ +\ \ \ \ \ \ \ \ once.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): true\n\ + +rebalance.help=\ +NAME\n\ +\ \ \ \ rebalance\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Rebalance partitioned regions. The default is for all partitioned regions to be rebalanced.\n\ +SYNTAX\n\ +\ \ \ \ rebalance [--include-region=value(nullvalue)*] [--exclude-region=value(nullvalue)*]\n\ +\ \ \ \ [--time-out=value] [--simulate(=value)?]\n\ +PARAMETERS\n\ +\ \ \ \ include-region\n\ +\ \ \ \ \ \ \ \ Partitioned regions to be included when rebalancing. Includes take precedence over\n\ +\ \ \ \ \ \ \ \ excludes.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ exclude-region\n\ +\ \ \ \ \ \ \ \ Partitioned regions to be excluded when rebalancing.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ time-out\n\ +\ \ \ \ \ \ \ \ Time to wait (in seconds) before GFSH returns to a prompt while rebalancing continues in\n\ +\ \ \ \ \ \ \ \ the background. The default is to wait for rebalancing to complete.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): -1\n\ +\ \ \ \ simulate\n\ +\ \ \ \ \ \ \ \ Whether to only simulate rebalancing. The --time-out parameter is not available when\n\ +\ \ \ \ \ \ \ \ simulating.\n\ +\ \ \ \ \ \ \ \ Required: false\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is specified without value): true\n\ +\ \ \ \ \ \ \ \ Default (if the parameter is not specified): false\n\ + +remove.help=\ +NAME\n\ +\ \ \ \ remove\n\ +IS AVAILABLE\n\ +\ \ \ \ false\n\ +SYNOPSIS\n\ +\ \ \ \ Remove an entry from a region. If using a region whose key class has been set, then specifying\n\ +\ \ \ \ --key-class is unnecessary.\n\ +SYNTAX\n\ +\ \ \ \ remove --region=value [--key=value] [--all(=value)?] [--key-class=value]\n\ +PAR