工具和模块

工具和模块描述了与Apache Geode相关的工具和模块。

• gfsh

  gfsh（发音为"jee-fish"）提供了一个强大的命令行界面，您可以从中启动，管理和监控Geode进程，数据和应用程序。

• Gemcached

  Gemcached是一个Geode适配器，允许Memcached客户端与Geode服务器集群通信，就像服务器是memcached服务器一样。 Memcached是一个开源缓存解决方案，它使用分布式内存中的哈希映射来存储字符串或对象数据的键值对。

• HTTP Session Management Modules

  Apache Geode HTTP会话管理模块为HTTP服务器提供快速，可扩展且可靠的会话复制，而无需更改应用程序。

• Geode Pulse

  Geode Pulse是一个Web应用程序，它提供了一个图形仪表板，用于监视Geode集群，成员和区域的重要实时运行状况和性能。

• Geode Redis Adapter

  Geode Redis适配器允许Geode作为Redis数据存储的直接替代品，让Redis应用程序可以利用Geode的扩展功能而无需更改其客户端代码。 Redis客户端使用IP地址和端口号以与连接Redis服务器相同的方式连接到Geode服务器。

• Apache Lucene® Integration

  ApacheLucene®集成使用户能够创建Lucene索引并对存储在Geode中的数据执行Lucene搜索。

gfsh

gfsh（发音为“jee-fish”）提供了一个强大的命令行界面，您可以从中启动，管理和监控Geode进程，数据和应用程序。

• What You Can Do with gfsh](#What You Can Do with gfsh)

  gfsh支持Apache Geode进程和应用程序的管理，调试和部署。

• Startinggfsh

  在开始gfsh之前，请确认您已设置JAVA_HOME，并且您的PATH变量包含gfsh可执行文件。

• Configuring the gfsh Environment

  gfsh.bat和gfsh bash脚本自动将所需的Apache Geode和JDK的.jar库附加到现有的CLASSPATH。 您可以为安全性，环境变量，日志记录和故障排除设置用户可配置的属性。

• Useful gfsh Shell Variables

  您可以在脚本中使用内置的gfsh shell变量。

• Basic Shell Features and Command-Line Usage

  gfsh实用程序为shell环境提供了有用的功能，包括命令自动完成，保留的命令历史记录和多行命令的分隔。 上下文相关的帮助可通过命令和主题获得。

• Specifying JSON within Command-Line Options

  一些gfsh命令允许在命令行选项中使用JSON规范。

• Tutorial—Performing Common Tasks with gfsh

  本主题将指导您在启动gfsh后执行的典型任务序列。

• Quick Reference of gfsh Commands by Functional Area

  此快速参考将所有命令分类到功能区域。

• gfsh Command Help

  本节提供按字母顺序列出的所有gfsh命令的帮助和用法信息。

• Creating and Running gfsh Command Scripts

  gfsh提供了几种在脚本环境中运行命令的方法。

• Running gfsh Commands on the OS Command Line

• Mapping of cache.xml Elements to gfsh Configuration Commands.

  您可以使用cache.xml文件配置Geode集群，也可以使用gfsh和集群配置服务来配置集群。 本节将cache.xml元素映射到配置和管理集群的gfsh命令。

你可以用gfsh做什么

gfsh支持Apache Geode进程和应用程序的管理，调试和部署。

使用gfsh，您可以:

• 启动和停止Apache Geode进程，例如定位器和缓存服务器
• 启动和停止网关发送方和网关接收方进程
• 部署应用程序
• 创建和销毁区域
• 执行函数
• 管理磁盘存储
• 导入和导出数据
• 监控Apache Geode进程
• 启动Apache Geode监控工具

gfsh命令行界面使开发人员可以花更少的时间配置缓存实例XML，属性，日志和统计信息。 gfsh命令生成报告; 捕获集群范围的统计数据; 并支持导出统计信息，日志和配置。 与Spring Roo一样，gfsh具有命令完成功能（因此您无需了解语法），上下文相关帮助，脚本以及使用简单API从应用程序内调用任何命令的功能。 gfsh接口使用JMX/RMI与Apache Geode进程通信。

您可以使用HTTP协议将gfsh连接到远程群集。 请参阅使用gfsh通过HTTP或HTTPS管理远程群集。

默认情况下，群集配置服务会在您使用gfsh创建Apache Geode对象时保存Apache Geode群集的配置。 您可以导出此配置并将其导入另一个Apache Geode集群。 请参见群集配置服务概述。

启动gfsh

在启动gfsh之前，请确认您已设置JAVA_HOME并且您的PATH变量包含gfsh可执行文件。

注意:在Windows上，必须正确设置JAVA_HOME环境变量，才能对定位器和服务器使用start，stop和status命令。

要启动gfsh命令行界面，请在当前随Apache Geode一起安装的任何计算机上的提示符处执行以下命令:

Start gfsh on Windows:

<product_directory>\bin\gfsh.bat

其中<product_directory>对应于安装Apache Geode的位置。

Start gfsh on Unix:

<product_directory>/bin/gfsh

其中<product_directory>对应于安装Apache Geode的位置。 执行时，gfsh脚本将所需的Apache Geode和JDK的Jar库附加到现有的CLASSPATH。

如果您已成功启动gfsh，则会出现gfsh启动画面和提示。

c:\Geode\Latest>gfsh.bat
    _________________________     __
   / _____/ ______/ ______/ /____/ /
  / /  __/ /___  /_____  / _____  /
 / /__/ / ____/  _____/ / /    / /
/______/_/      /______/_/    /_/

Monitor and Manage Geode
gfsh>

您也可以直接在终端中运行一些gfsh命令，而无需输入gfsh提示。 例如，在Unix/Linux上你可以输入:

$ gfsh start server --name=server1

或在Windows上:

prompt> gfsh start server --name=server1

有关详细信息，请参阅创建和运行gfsh命令脚本。

配置gfsh环境

gfsh.bat和gfsh bash脚本自动将所需的Apache Geode和JDK jar库附加到现有的CLASSPATH。 您可以为安全性，环境变量，日志记录和故障排除设置用户可配置的属性。

CLASSPATH中的JAR库

当你启动gfsh时，它会自动加载已经打包在gfsh-dependencies.jar文件中的所需JAR文件。 您无需修改CLASSPATH即可运行gfsh。

JAR文件打包在lib目录的安装目录中。

机器主机名

在某些操作系统上，您可能需要确保在系统主机文件中配置了计算机的主机名。 例如，在macOS上，您可能需要将机器的主机名映射到/etc/hosts文件中的IP地址，以便gfsh和Pulse正常运行。

配置gfsh安全性

由于gfsh必须连接到JMX Manager成员才能运行某些命令（即管理和监视其他成员的那些命令），因此JMX Manager配置属性可能会影响gfsh安全性。 在gemfire.properties中，以下Geode属性可以影响JMX Manager的gfshconnection设置:

• jmx-manager-ssl
• jmx-manager-port
• jmx-manager-password-file
• jmx-manager-access-file

您可能还需要验证端口是否可用并对客户端连接开放。 有关这些安全属性的详细信息，请参阅配置JMX Manager。

配置gfsh环境变量

此外，您可以使用set variable命令设置特定于gfsh的预设SHELL变量。 例如，您可以将gfsh设置为以安静模式运行。 并非所有gfsh变量都是可修改的。 用户可配置的变量包括:

• APP_FETCH_SIZE
• APP_QUIET_EXECUTION

有关详细信息，请参阅有用的gfsh Shell变量。

配置gfsh会话日志记录

默认情况下，禁用gfsh会话日志记录。 要启用gfsh日志记录，必须设置Java系统属性-Dgfsh.log-level=desired_log_level，其中desired_log _level是以下值之一:severe，warning，info，config，fine，fine，finest。 例如，在Linux中:

export JAVA_ARGS=-Dgfsh.log-level=info

然后，启动gfsh。

gfsh生成一个名为gfsh-%u_%g.log的日志文件。 此日志文件记录单个gfsh会话的事件。 它包括环境信息，例如Java和系统信息，以及详细的命令执行。 变量替换如下:

• %u - 解决冲突的唯一编号
• %g - 用于区分旋转日志的世代号

gfsh使用JDK Logger生成gfsh会话日志文件。 有关如何在命名日志文件时使用变量的说明，请参见http://docs.oracle.com/javase/7/docs/api/java/util/logging/FileHandler.html。 无法更改生成的gfsh日志文件的默认名称。

默认情况下，日志文件将写入您执行gfsh或gfsh.bat脚本的当前工作目录。 要修改写入日志文件的目录位置，请使用gfsh.log-dir Java系统属性。 例如:

export JAVA_ARGS="-Dgfsh.log-level=info -Dgfsh.log-dir=/machinename/logs"

然后，启动gfsh。

另外，gfsh在${SYS_USER_HOME}/.geode/.gfsh.history文件中记录了命令的历史记录，您可以使用它来创建脚本或查看过去的命令。

成员日志文件

gfsh为通过gfsh启动的任何成员写入几个日志文件。 有用的成员日志文件包括:

• .log. 详细说明定位器的配置（包括所有gemfire.properties）以及启动后定位器上发生的所有活动。 此日志文件将写入以定位符命名的目录。 例如，如果启动名为locator1的定位器，则该文件将在<product_dir>/locator1目录中写为locator1.log。
• vf.gf.locator.pid. 包含定位器的进程ID。 您可以使用PID来停止或查看此定位器的状态。 此文件将写入与定位器日志文件相同的目录位置。
• .log. 详细说明服务器的配置（包括所有gemfire.properties）以及启动后服务器上发生的所有活动。 此日志文件将写入以服务器命名的目录。 例如，如果启动名为server1的服务器，则该文件将在<product_dir>/server1目录中写为server1.log。 如果停止并以相同的名称启动服务器，则较旧的日志文件将保留在同一目录中，但会重命名以进行版本控制。
• vf.gf.server.pid. 包含服务器的进程ID。 您可以使用PID来停止或查看此服务器的状态。 此文件将写入与服务器日志文件相同的位置。

查看标准输出和标准错误

默认情况下，Geode不会将应用程序写入的消息显示为标准输出和标准错误。 要允许将这些消息分别写入定位器和服务器日志文件，请使用gfshstart locator或start server命令指定--redirect-output选项。 例如，以下命令会将stdout和stderr消息写入locator1.log文件:

gfsh> start locator --name=locator1 --redirect-output

Tab自动补全

本节仅适用于UNIX安装.

从UNIX bash shell运行gfsh命令时，可以通过运行以下命令在shell中启用自动tab-completion:

source <gemfire-install-directory>/bin/gfsh-completion.bash

运行此命令后，您可以在从bash shell运行gfsh命令时使用自动完成。

请参阅使用TAB自动补全。

命令历史和gfsh.history

已成功执行的命令历史记录在运行gfsh的用户的主目录下的.gemfire目录中的.gfsh.history文件中。 您还可以使用history --file=your_file_name命令导出历史文件。

JMX Manager更新率和系统监控

当您执行数据操作（例如put）然后监视系统状态（例如使用gfshshow metrics命令或Geode Pulse）时，受监视的系统可能不会立即反映最近的操作。 例如，如果执行put操作然后立即执行show metrics gfsh命令，则可能看不到该区域中正确的条目数。 管理层每2秒更新一次。 执行操作活动后等待几秒钟以查看最准确的结果。

您可以修改gemfire.properties中的jmx-manager-update-rate属性，以增加或减少将更新推送到JMX Manager的速率（以毫秒为单位）。 此属性设置应大于或等于statistic-sample-rate。 如果遇到性能问题，您可能希望提高此间隔; 但是，将此值设置得太高会导致在gfsh和Geode Pulse中看到陈旧值。

格式化结果

本节仅适用于UNIX安装.

诸如query之类的gfsh命令产生具有宽列的输出，这些列可能会变得不对齐并需要手动重新格式化以查看输出。 如果输出无法适应终端的可用宽度，gfsh会自动修剪列宽以适应。 您可以通过将gfsh环境变量GFSH.TRIMSCRWIDTH设置为false来禁用此行为。

您可以将APP_RESULT_VIEWER变量设置为external，以便使用UNIXless命令查看输出。

请参阅配置gfsh环境变量。

有用的gfsh Shell变量

您可以在脚本中使用内置的gfsh shell变量。

您还可以使用set variable命令修改shell行为或定义自己的变量。

要查看所有gfsh shell变量及其当前值的列表，请使用以下命令:

gfsh>echo --string=$*

要获取现有变量的当前值，请使用以下命令语法（该变量必须括在大括号中）:

gfsh>echo --string=${VARIABLE}

例如:

gfsh>echo --string=${SYS_CLASSPATH}

系统变量

GFSH环境变量

基本Shell功能和命令行用法

gfsh实用程序为shell环境提供了有用的功能，包括命令自动完成，保留的命令历史记录和多行命令的分隔。 上下文相关的帮助可通过命令和主题获得。

要查看可用的gfsh命令列表，请在空提示符下按Tab键.

您看到的命令列表取决于您是否连接到Geode群集。 如果未连接，则会看到可用的本地命令列表。

使用hint命令获取有关特定主题的信息.

hint命令显示指定主题的单行描述和关联命令。 例如，hint data返回数据主题的描述以及可用于数据的所有可能操作:

gfsh>hint Data
User data as stored in regions of the Geode distributed system.

create index  : Create an index that can be used when executing queries.
destroy index : Destroy/Remove the specified index.
export data   : Export user data from a region to a file.
get           : Display an entry in a region. If using a region whose key and value classes have been set, then specifying --key-class and --value-class is unnecessary.
import data   : Import user data from a file to a region.
list indexes  : Display the list of indexes created for all members.
locate entry  : Identifies the location, including host, member and region, of entries that have the specified key.
put           : Add/Update an entry in a region. If using a region whose key and value classes have been set, then specifying --key-class and --value-class is unnecessary.
query         : Run the specified OQL query as a single quoted string and display the results in one or more pages. Limit will default to the value stored in the "APP_FETCH_SIZE" variable. Page size will default to the value stored in the "APP_COLLECTION_LIMIT" variable.
rebalance     : Rebalance partitioned regions. The default is for all partitioned regions to be rebalanced.
remove        : Remove an entry from a region. If using a region whose key class has been set, then specifying --key-class is unnecessary.

要查看提示主题列表，请键入hint。

使用help命令获取有关特定命令的信息.

根据命令，键入help <command-name>将显示该特定命令的使用信息或与该命令相关的命令列表。

例如，键入help start以显示带有简短描述的启动命令列表。 说明指示命令是否可用，并取决于gfsh的连接状态。 以下示例假定gfsh当前未连接（通过连接到JMX Manager节点），因此某些启动命令不可用。

gfsh>help start
start gateway-receiver (Not Available)
    Start the Gateway Receiver on a member or members.
start gateway-sender (Not Available)
    Start the Gateway Sender on a member or members.
start jconsole (Available)
    Start the JDK's JConsole tool in a separate process. JConsole will be
    launched, but connecting to GemFire must be done manually.
start jvisualvm (Available)
    Start the JDK's Java VisualVM (jvisualvm) tool in a separate process. Java
    VisualVM will be launched, but connecting to GemFire must be done manually.
start locator (Available)
    Start a Locator.
start pulse (Available)
    Open a new window in the default Web browser with the URL for the Pulse
    application.
start server (Available)
    Start a GemFire Cache Server.

使用Tab键自动完成命令或触发可能的完成.

输入部分命令以触发命令的自动完成或可能的命令完成列表后，使用Tab键。 例如，在键入hint后按Tab键会显示所有可用主题:

gfsh>hint

Configuration           Data                    Debug-Utility
Disk Store              Function Execution      GFSH
GemFire                 Help                    JMX
Lifecycle               Locator                 Management-Monitoring
Manager                 Region                  Server
Statistics

键入hint d后按Tab键会显示以d开头的可用主题:

gfsh>hint d

data            debug-Utility   disk Store

自动完成还为命令提供可用参数和参数; 例如，在键入start后点击TAB键将列出可以启动的所有服务。

gfsh>start

start data-browser   start jconsole       start jvisualvm
start locator        start pulse          start server

在start locator之后点击TAB键将在命令后填充--name参数。 （如果您没有指定成员名称，gfsh将自动选择一个随机名称。这对自动化非常有用。）

使用向上箭头访问命令历史记录.

通过使用向上箭头滚动以前的命令来访问shell历史记录中的命令。

使用反斜杠分隔多行命令.

输入长命令时，可以使用反斜杠字符（'\'）作为分隔符来中断命令行。 例如:

gfsh>create region --name=region1 \
--type=REPLICATE_PERSISTENT \
--cache-writer=org.apache.geode.examples.MyCacheWriter \
--group=Group1 --disk-store=DiskStore1

用单引号或双引号括起包含空格或逗号的字符串

在gfsh命令shell中执行gfsh命令时，请在单引号中包含任何包含空格或逗号的字符串。 例如:

gfsh>start locator --name='locator 1'
start locator --name=locator1 --port=9009 --mcast-port=0\
 --J='-Dgemfire.remote-locators=192.0.2.0[9009],192.0.2.1[9009]'

当您从操作系统shell在一行中执行多个gfsh命令时，请将gfsh命令用双引号括起来。 在双引号内，包含任何包含带单引号的空格或逗号的字符串。 例如:

$ gfsh -e "start locator --name='locator 1'" -e "start server --name=server1"

在命令行选项中指定JSON

一些gfsh命令允许在某些选项中使用JSON规范。 这些JSON字符串以键/值对的形式指定初始化属性。

对于那些实现Declarable接口的类，JSON字符串被附加到完全限定的类名。 接口的init方法的参数是一个包含初始化属性的对象。 解析JSON字符串并将其分解为一组定义对象的属性名称和值。

gfsh create region命令中的缓存加载器类的规范可能具有JSON规范。 例如，

gfsh>create region --name=region1 --type=PARTITION \
   --cache-loader=com.example.Setup{'k1':'v1','k2':'v2','k3':'v3'}

此示例中的JSON字符串是

{'k1':'v1','k2':'v2','k3':'v3'}

JSON字符串由大括号括起，并且用逗号分隔。 每对由冒号分隔。 定义一对的两个字符串中的每一个都用单引号或双引号字符括起来。 在使用单引号或双引号字符时，在整个JSON字符串中保持一致。

空格字符分隔gfsh命令行选项，并且在解析JSON字符串之前进行选项的标记化。 如果命令行选项中的值包含空格，请使用双引号将其分隔。

例如，假设有一对，并且该对的值是value with space。 --cache-loader示例选项的右侧变为

gfsh>create region --name=region2 --type=PARTITION \
   --cache-loader="com.example.Setup{'k1': 'value with space'}"

要在值中包含单引号字符，请使用两个反斜杠字符对其进行转义。 例如，

gfsh>create region --name=region3 --type=PARTITION \
   --cache-loader="com.example.Setup{'k1': 'property\\'s value'}"

value的值是 property's value。

教程 - 使用gfsh执行常见任务

本主题将指导您在启动gfsh后执行的典型任务序列。

步骤1:创建临时工作目录并切换到该目录。 例如:

$ mkdir gfsh_tutorial
$ cd gfsh_tutorial

Step 1: 启动gfsh提示符.

$ gfsh
    _________________________     __
   / _____/ ______/ ______/ /____/ /
  / /  __/ /___  /_____  / _____  /
 / /__/ / ____/  _____/ / /    / /
/______/_/      /______/_/    /_/

Monitor and Manage Geode
gfsh>

有关详细信息，请参阅启动gfsh。

Step 2: 启动定位器. 输入以下命令:

gfsh>start locator --name=locator1

出现以下输出:

gfsh>start locator --name=locator1
.....
Locator in /home/username/gfsh_tutorial/locator1 on 192.0.2.0[10334]
as locator1 is currently online.
Process ID: 67666
Uptime: 6 seconds
Geode Version: 1.7
Java Version: 1.8.0_121
Log File: /home/username/gfsh_tutorial/locator1.log
JVM Arguments: -Dgemfire.enable-cluster-configuration=true
 -Dgemfire.load-cluster-configuration-from-dir=false
 -Dgemfire.launcher.registerSignalHandlers=true
 -Djava.awt.headless=true -Dsun.rmi.dgc.server.gcInterval=9223372036854775806
Class-Path: /home/username/geode/geode-assembly/build/install/apache-geode/lib
/geode-core-1.2.0.jar:/home/username/geode/geode-assembly/build/install/apache-geode
/lib/geode-dependencies.jar

Successfully connected to: JMX Manager [host=192.0.2.0, port=1099]

Cluster configuration service is up and running.

如果你从gfsh运行start locator而没有指定成员名，gfsh会自动选择一个随机成员名。 这对自动化很有用。

在文件系统中，检查执行gfsh的文件夹位置。 请注意，start locator命令已自动创建了一个工作目录（使用定位器的名称），并在该工作目录中创建了一个日志文件，一个状态文件和一个.pid（包含定位器的进程ID）对于这个定位器。

此外，由于还没有其他JMX Manager存在，请注意gfsh已在定位器内的端口1099上自动启动嵌入式JMX Manager，并已将您连接到该JMX Manager。

Step 3: 检查现有的gfsh连接.

在当前shell中，键入以下命令:

gfsh>describe connection

如果已连接到在步骤2中启动的定位器中启动的JMX Manager，则会显示以下输出:

gfsh>describe connection
Connection Endpoints
--------------------
ubuntu.local[1099]

请注意，JMX Manager位于1099，而定位器的默认端口为10334。

Step 4: 从不同的终端连接到相同的locator/JMX Manager.

此步骤说明如何连接到locator/JMX Manager。 打开第二个终端窗口，然后启动第二个gfsh提示符。 在第二个提示中键入与步骤3中相同的命令:

gfsh>describe connection

这一次，请注意您未连接到JMX Manager，并显示以下输出:

gfsh>describe connection
Connection Endpoints
--------------------
Not connected

在第二个gfsh终端中键入以下命令:

gfsh>connect

该命令将连接到您在步骤2中启动的当前运行的本地定位器。

gfsh>connect
Connecting to Locator at [host=localhost, port=10334] ..
Connecting to Manager at [host=ubuntu.local, port=1099] ..
Successfully connected to: [host=ubuntu.local, port=1099]

请注意，如果您在启动定位器时使用了自定义--port，或者您从另一个成员的gfsh提示符连接时，您还需要在连接时指定--locator=hostname[port] 到群集。 例如（如果你想尝试下一个命令，首先键入disconnect）:

gfsh>connect --locator=localhost[10334]
Connecting to Locator at [host=localhost, port=10334] ..
Connecting to Manager at [host=ubuntu.local, port=1099] ..
Successfully connected to: [host=ubuntu.local, port=1099]

将gfsh连接到集群的另一种方法是直接连接到定位器内运行的JMX Manager。 例如（如果你想尝试下一个命令，首先键入disconnect）:

gfsh>connect --jmx-manager=localhost[1099]
Connecting to Manager at [host=localhost, port=1099] ..
Successfully connected to: [host=localhost, port=1099]

此外，您还可以通过HTTP连接到远程群集。 请参阅使用gfsh通过HTTP或HTTPS管理远程群集。

Step 5: 断开并关闭第二个终端窗口. 键入以下命令以断开连接并退出第二个gfsh提示符:

gfsh>disconnect
Disconnecting from: localhost[1099]
Disconnected from : localhost[1099]
gfsh>exit

关闭第二个终端窗口。

Step 6: 启动服务器. 返回到第一个终端窗口，然后启动使用您在步骤2中启动的定位器的缓存服务器。键入以下命令:

gfsh>start server --name=server1 --locators=localhost[10334]

如果服务器成功启动，则会显示以下输出:

gfsh>start server --name=server1 --locators=localhost[10334]
Starting a Geode Server in /home/username/gfsh_tutorial/server1/server1.log...
...
Server in /home/username/gfsh_tutorial/server1 on 192.0.2.0[40404] as server1
is currently online.
Process ID: 68375
Uptime: 4 seconds
Geode Version: 1.7
Java Version: 1.8.0_121
Log File: /home/username//gfsh_tutorial/server1/server1.log
JVM Arguments: -Dgemfire.locators=localhost[10334]
 -Dgemfire.use-cluster-configuration=true -Dgemfire.start-dev-rest-api=false
 -XX:OnOutOfMemoryError=kill -KILL %p
 -Dgemfire.launcher.registerSignalHandlers=true
 -Djava.awt.headless=true -Dsun.rmi.dgc.server.gcInterval=9223372036854775806
Class-Path: /home/username/geode/geode-assembly/build/install/apache-geode/lib
/geode-core-1.2.0.jar:/home/username/geode/geode-assembly/build/install
/apache-geode/lib/geode-dependencies.jar

如果从gfsh运行start server而不指定成员名称，gfsh将自动选择一个随机成员名称。 这对自动化很有用。

在文件系统中，检查执行gfsh的文件夹位置。 请注意，就像start locator命令一样，start server命令已经自动创建了一个工作目录（以服务器命名），并且在该工作目录中，它创建了一个日志文件和一个.pid（包含服务器的 进程ID）此缓存服务器。 此外，它还编写了日志文件。

Step 7: 列出成员. 使用list members命令查看刚刚创建的集群的当前成员。

gfsh>list members
  Name       | Id
------------ | ---------------------------------------
Coordinator: | ubuntu(locator1:5610:locator)<ec><v0>:34168
locator1     | ubuntu(locator1:5610:locator)<ec><v0>:34168
server1      | ubuntu(server1:5931)<v1>:35285

Step 8: 通过执行describe member命令查看成员详细信息.

gfsh>describe member --name=server1
Name        : server1
Id          : ubuntu(server1:5931)<v1>:35285
Host        : ubuntu.local
Regions     :
PID         : 5931
Groups      :
Used Heap   : 12M
Max Heap    : 239M
Working Dir : /home/username/gfsh_tutorial/server1
Log file    : /home/username/gfsh_tutorial/server1/server1.log
Locators    : localhost[10334]

Cache Server Information
Server Bind              :
Server Port              : 40404
Running                  : true
Client Connections       : 0

请注意，尚未为此成员分配任何区域。

Step 9: 创建您的第一个区域. 键入以下命令，然后键入Tab键:

gfsh>create region --name=region1 --type=

将显示可能的区域类型列表，后跟您输入的部分命令:

gfsh>create region --name=region1 --type=

PARTITION
PARTITION_REDUNDANT
PARTITION_PERSISTENT
PARTITION_REDUNDANT_PERSISTENT
PARTITION_OVERFLOW
PARTITION_REDUNDANT_OVERFLOW
PARTITION_PERSISTENT_OVERFLOW
PARTITION_REDUNDANT_PERSISTENT_OVERFLOW
PARTITION_HEAP_LRU
PARTITION_REDUNDANT_HEAP_LRU
REPLICATE
REPLICATE_PERSISTENT
REPLICATE_OVERFLOW
REPLICATE_PERSISTENT_OVERFLOW
REPLICATE_HEAP_LRU
LOCAL
LOCAL_PERSISTENT
LOCAL_HEAP_LRU
LOCAL_OVERFLOW
LOCAL_PERSISTENT_OVERFLOW
PARTITION_PROXY
PARTITION_PROXY_REDUNDANT
REPLICATE_PROXY

gfsh>create region --name=region1 --type=

使用您要创建的区域类型完成命令。 例如，创建一个本地区域:

gfsh>create region --name=region1 --type=LOCAL
Member  | Status
------- | --------------------------------------
server1 | Region "/region1" created on "server1"

由于此时集群中只有一台服务器，因此该命令会在server1上创建本地区域。

Step 10: 启动其他服务器. 这次使用不同的服务器端口指定--server-port参数，因为您在同一主机上启动了缓存服务器进程。

gfsh>start server --name=server2 --server-port=40405
Starting a Geode Server in /home/username/gfsh_tutorial/server2...
...
Server in /home/username/gfsh_tutorial/server2 on 192.0.2.0[40405] as
server2 is currently online.
Process ID: 68423
Uptime: 4 seconds
Geode Version: 1.7
Java Version: 1.8.0_121
Log File: /home/username/gfsh_tutorial/server2/server2.log
JVM Arguments: -Dgemfire.default.locators=192.0.2.0[10334]
 -Dgemfire.use-cluster-configuration=true -Dgemfire.start-dev-rest-api=false
 -XX:OnOutOfMemoryError=kill -KILL %p -Dgemfire.launcher.registerSignalHandlers=true
 -Djava.awt.headless=true -Dsun.rmi.dgc.server.gcInterval=9223372036854775806
Class-Path: /home/username/geode/geode-assembly/build/install/apache-geode
/lib/geode-core-1.2.0.jar:/home/username/geode/geode-assembly/build/install
/apache-geode/lib/geode-dependencies.jar

Step 11: 创建复制区域.

gfsh>create region --name=region2 --type=REPLICATE
Member  | Status
------- | --------------------------------------
server1 | Region "/region2" created on "server1"
server2 | Region "/region2" created on "server2"

Step 12: 创建分区区域.

gfsh>create region --name=region3 --type=PARTITION
Member  | Status
------- | --------------------------------------
server1 | Region "/region3" created on "server1"
server2 | Region "/region3" created on "server2"

Step 13: 创建一个复制的持久区域.

gfsh>create region --name=region4 --type=REPLICATE_PERSISTENT
Member  | Status
------- | --------------------------------------
server1 | Region "/region4" created on "server1"
server2 | Region "/region4" created on "server2"

Step 14: 列出区域. 将显示您刚刚创建的所有区域的列表.

gfsh>list regions
List of regions
---------------
region1
region2
region3
region4

Step 15: 通过执行describe member命令再次查看成员详细信息.

gfsh>describe member --name=server1
Name        : server1
Id          : ubuntu(server1:5931)<v1>:35285
Host        : ubuntu.local
Regions     : region4
              region3
              region2
              region1
PID         : 5931
Groups      :
Used Heap   : 14M
Max Heap    : 239M
Working Dir : /home/username/gfsh_tutorial/server1
Log file    : /home/username/gfsh_tutorial/server1/server1.log
Locators    : localhost[10334]

Cache Server Information
Server Bind              :
Server Port              : 40404
Running                  : true
Client Connections       : 0

请注意，您现在创建的所有区域都显示在成员说明的“Regions”部分中。

gfsh>describe member --name=server2
Name        : server2
Id          : ubuntu(server2:6092)<v2>:17443
Host        : ubuntu.local
Regions     : region4
              region3
              region2
              region1
PID         : 6092
Groups      :
Used Heap   : 14M
Max Heap    : 239M
Working Dir : /home/username/gfsh_tutorial/server2
Log file    : /home/username/gfsh_tutorial/server2/server2.log
Locators    : 192.0.2.0[10334]

Cache Server Information
Server Bind              :
Server Port              : 40405
Running                  : true
Client Connections       : 0

请注意，即使您在创建第一个区域（region1）后启动了第二个服务器，第二个服务器仍会列出region1，因为它从群集配置服务中选择了其配置。

Step 16: 将数据放进本地区域. 输入以下put命令:

gfsh>put --key=('123') --value=('ABC') --region=region1
Result      : true
Key Class   : java.lang.String
Key         : ('123')
Value Class : java.lang.String
Old Value   : <NULL>

Step 17: 将数据放在复制区域中. 输入以下put命令:

gfsh>put --key=('123abc') --value=('Hello World!!') --region=region2
Result      : true
Key Class   : java.lang.String
Key         : ('123abc')
Value Class : java.lang.String
Old Value   : <NULL>

Step 18: 检索数据. 您可以使用locate entry,query或get来返回刚刚放入该区域的数据。

例如，使用get命令:

gfsh>get --key=('123') --region=region1
Result      : true
Key Class   : java.lang.String
Key         : ('123')
Value Class : java.lang.String
Value       : ('ABC')

例如，使用locate entry命令:

gfsh>locate entry --key=('123abc') --region=region2
Result          : true
Key Class       : java.lang.String
Key             : ('123abc')
Locations Found : 2


MemberName | MemberId
---------- | -------------------------------
server2    | ubuntu(server2:6092)<v2>:17443
server1    | ubuntu(server1:5931)<v1>:35285

请注意，由于条目已放入复制区域，因此该条目位于两个集群成员上。

例如，使用query命令:

gfsh>query --query='SELECT * FROM /region2'

Result     : true
startCount : 0
endCount   : 20
Rows       : 1

Result
-----------------
('Hello World!!')

NEXT_STEP_NAME : END

Step 19: 导出您的数据. 要保存区域数据，可以使用export data命令。

例如:

gfsh>export data --region=region1 --file=region1.gfd --member=server1

您可以稍后使用import data命令将该数据导入另一个成员的同一区域。

Step 20: 关闭群集.

gfsh>shutdown --include-locators=true

按功能区快速参考gfsh命令

此快速参考将所有命令分类到功能区域。

单击命令可查看其他信息，包括语法，选项列表和示例。

• Basic Geode gfsh Commands
• Configuration Commands
• Data Commands
• Deployment Commands
• Disk Store Commands
• Durable CQ and Client Commands
• Function Execution Commands
• Gateway (WAN) Commands
• Geode Monitoring Commands
• Index Commands
• JMX Connection Commands
• Locator Commands
• Lucene Commands
• PDX Commands
• Region Commands
• Server Commands

基本Geode gfsh命令

配置命令

数据命令

部署命令

磁盘存储命令

持久的CQ和客户端命令

函数执行命令

网关(WAN)命令

Geode 异步事件队列命令

Geode监控命令

索引命令

JMX连接命令

定位器命令

Lucene 命令

PDX 命令

区域 命令

服务器命令

gfsh命令帮助

本节提供按字母顺序列出的所有gfsh命令的帮助和用法信息。

• alter

  修改现有的Geode资源。

• backup disk-store

  将所有成员的持久数据备份到指定目录。

• change loglevel

  更改指定成员的日志记录级别。

• clear defined indexes

  清除所有已定义的索引。

• close

  关闭持久客户CQ和持久客户。

• compact

  压缩在线和离线磁盘存储。

• configure

  为群集中的所有缓存配置Portable Data eXchange。

• connect

  直接或通过定位器连接到jmx-manager。

• create

  创建异步事件队列，磁盘存储，网关接收器，网关发件人，索引和区域。

• debug

  在gfsh中启用或禁用调试输出。

• define index

  定义可在执行查询时使用的索引。 然后，您可以使用create defined indexes执行单个命令以一次创建多个索引。

• deploy

  将JAR打包的应用程序部署到一个或多个成员。

• describe

  显示成员配置，shell连接，磁盘存储，成员或区域的详细信息。

• destroy

  删除或取消注册功能，删除索引，磁盘存储和区域。

• disconnect

  关闭所有活动连接。

• echo

  回显给定文本，其中可能包括系统和用户变量。

• execute function

  在成员或区域上执行功能。

• exit

  退出gfsh shell。 您也可以使用quit退出shell。

• export

  导出配置，数据，日志和堆栈跟踪。

• gc

  对一个或多个成员强制GC（垃圾收集）。

• get

  显示区域中的条目。

• help

  显示所有可用命令的语法和用法信息。

• hint

  显示有关主题的信息以及与主题关联的命令列表。

• history

  显示或保存命令历史记录。

• import

  您可以将数据导入区域或将现有群集配置导入群集。

• list

  列出现有的Geode资源，例如已部署的应用程序，磁盘存储，功能，成员，服务器和区域。

• load-balance gateway-sender

  使指定的网关发送方关闭其当前连接并以更平衡的方式重新连接到远程网关接收方。

• locate entry

  在成员上找到区域条目。

• netstat

  通过“netstat”操作系统命令报告网络信息和统计信息。

• pause gateway-sender

  暂停网关发件人。

• pdx rename

  在脱机磁盘存储中重命名PDX类型。

• put

  添加或更新区域条目。

• query

  对Geode区域运行查询。

• rebalance

  重新平衡分区区域。

• remove

  从区域中删除条目。

• resume gateway-sender

  恢复已暂停的所有网关发件人。

• revoke missing-disk-store

  指示群集的成员停止等待磁盘存储可用。

• run

  执行一组GFSH命令。

• set variable

  在GFSH环境中设置变量。

• sh

  执行操作系统命令。

• show

  显示死锁，日志，指标和丢失的磁盘存储。

• shutdown

  停止所有成员。

• sleep

  延迟gfsh命令执行。

• start

  启动服务器，定位器，网关发送器和网关接收器以及监视工具。

• status

  检查群集配置服务和Geode成员进程的状态，包括定位器，网关接收器，网关发件人和服务器。

• stop

  停止网关接收器，网关发送器，定位器和服务器。

• undeploy

  取消使用deploy命令部署在成员或组上部署的JAR文件。

• validate offline-disk-store

  验证脱机磁盘存储。

• version

  显示产品版本信息。

alter

Modify an existing Geode resource.

• alter async-event-queue

  修改异步事件队列的属性

• alter disk-store

  修改或删除脱机磁盘存储中的区域。

• alter region

  改变区域的配置。

• alter runtime

  在成员或成员运行时更改所有成员或成员子集的配置属性。

alter async-event-queue

更改指定的异步事件队列的属性。 必须重新启动托管指定异步事件队列的每个服务器，新属性设置才能在该服务器上生效。

可用性: Online. 必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

alter async-event-queue --id=value [--batch-size=value] [--batch-time-interval=value]
    [--max-queue-memory=value] [--if-exists(=value)]

必需的选项--id标识要更改的异步事件队列。

Parameters, alter async-event-queue

示例命令:

alter async-event-queue --id=myAsyncEventQueue --batch-size=50 --if-exists

alter disk-store

修改或删除脱机磁盘存储中的区域。

修改区域的配置时，通常会使该区域脱机并使用新配置重新启动。 您可以使用alter disk-store命令更改磁盘存储中存储的区域的配置，以匹配您在重新启动时使用的配置。

可用性: Offline.

句法:

alter disk-store --name=value --region=value --disk-dirs=value(,value)*
    [--compressor(=value)] [--concurrency-level=value]
    [--enable-statistics=value] [--initial-capacity=value] [--load-factor=value]
    [--lru-algorithm=value] [--lru-action=value] [--lru-limit=value]
    [--off-heap(=value)] [--remove(=value)]

三个必需的选项--name，--region和--disk-dirs标识要更改的磁盘存储区和区域。 如果未指定其他选项，gfsh将显示当前配置而不进行任何更改。

Parameters, alter disk-store

示例命令:

alter disk-store --name=DiskStore1 --region=region1 --disk-dirs=/Disks/DiskStore1 --off-heap
alter disk-store --name=DiskStore1 --region=region1 --disk-dirs=/Disks/DiskStore1 --remove

alter region

改变区域的配置。

有关语法详细信息，请参阅在命令行选项中指定JSON。

可用性: Online. 必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

alter region --name=value [--groups=value(,value)*]
    [--entry-idle-time-expiration=value]
    [--entry-idle-time-expiration-action(=value)?]
    [--entry-time-to-live-expiration=value]
    [--entry-time-to-live-expiration-action(=value)?]
    [--entry-idle-time-custom-expiry=value] [--entry-time-to-live-custom-expiry=value]
    [--region-idle-time-expiration=value]
    [--region-idle-time-expiration-action(=value)?]
    [--region-time-to-live-expiration=value]
    [--region-time-to-live-expiration-action(=value)?]
    [--cache-listener=value(,value)*] [--cache-loader=value]
    [--cache-writer=value] [--async-event-queue-id=value(,value)*]
    [--gateway-sender-id=value(,value)*] [--enable-cloning(=value)?]
    [--eviction-max(=value)?]

Parameters, alter region

示例命令:

alter region --name=region1 --eviction-max=5000 [-group=all]

样本输出:

gfsh>alter region --name=customer --eviction-max=5000
Member  | Status
------- | ----------------------------------
server1 | Region "/customer" altered on "server1"

alter runtime

在成员或成员运行时更改所有成员或成员子集的配置属性。

有关这些配置属性的更多信息，请参阅cache.xml 和配置参数参考。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

alter runtime [--members=value(,value)*] [--groups=value(,value)*]
    [--archive-disk-space-limit=value]
    [--archive-file-size-limit=value] [--log-disk-space-limit=value]
    [--log-file-size-limit=value] [--log-level=value]
    [--statistic-archive-file=value] [--statistic-sample-rate=value]
    [--enable-statistics=value] [--copy-on-read(=value)?] [--lock-lease=value]
    [--lock-timeout=value] [--message-sync-interval=value] [--search-timeout=value]

Parameters, alter runtime

示例命令:

alter runtime --members=server1 --log-level=WARN --enable-statistics=true

样本输出:

gfsh>alter runtime --members=server1 --log-level=WARN --enable-statistics=true
Runtime configuration altered successfully for the following member(s)
192.0.2.0(server1:240)<v1>:64871

backup disk-store

将所有成员的持久数据备份到指定目录。

指定的目录必须存在于所有成员上，但它可以是每台计算机上的本地目录。 此命令可确保备份文件不会被并发操作损坏。 建议不要使用操作系统复制命令备份正在运行的系统。

您还可以使用此命令执行增量备份。 有关增量备份的详细信息，请参阅为系统恢复和操作管理创建备份。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

backup disk-store --dir=value [--baseline-dir=value]

Table 1. 备份磁盘存储参数

示例命令:

backup disk-store --dir=data/backups

backup disk-store --dir=data/backup/disk-store --baselineDir=data/backups/2012-09-24-17-08-50

样本输出:

gfsh>backup disk-store --dir=data/backups
The following disk stores were backed up successfully

Member  |                 UUID                 |              Directory               | Host
------- | ------------------------------------ | ------------------------------------ | ---------------
server2 | a6bb11f0-0baa-45c9-b23e-64876d02a586 | c:\PivotalGemFire70\Latest\server2\. | 192.0.2.0
server1 | 8dc365bd-c086-4af4-99d0-86b0b521aa04 | c:\PivotalGemFire70\Latest\server1\. | 192.0.2.0

change loglevel

更改指定成员的日志记录级别。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

change loglevel --loglevel=value [--members=value(,value)*] [--groups=value(,value)*]

Table 1. 更改Loglevel参数

示例命令:

gfsh>change loglevel --loglevel=DEBUG --members=server1

样本输出:

gfsh>change loglevel --loglevel=DEBUG --members=server1

Summary

                Member            | Changed log-level
--------------------------------- | -----------------
192.0.2.0(server1:3060)<v1>:24653 | true

clear defined indexes

清除所有已定义的索引。

索引定义本地存储在gfsh客户端上。 如果要创建一组新索引，或者如果一个或多个索引创建失败，则可能需要清除定义

另请参见define index。

可用性: Online or offline.

句法:

clear defined indexes

示例命令:

gfsh> clear defined indexes

样本输出:

gfsh>clear defined indexes
Index definitions successfully cleared

close

关闭持久客户CQ和持久客户。

• close durable-client

  试图关闭一个持久的客户端。 必须断开客户端才能使此命令起作用。

• close durable-cq

  关闭持久客户端注册的持久连续查询（CQ），并从订阅队列中排除为持久CQ保留的事件。

close durable-client

试图关闭一个持久的客户端。 必须断开客户端才能使此命令起作用。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

close durable-client --durable-client-id=value [--members=value(,value)*]
[--groups=value(,value)*]

Table 1. 关闭持久客户端参数

示例命令:

close durable-client --durable-client-id=client1

样本输出:

gfsh>close durable-client --durable-client-id=client1
Closed the durable client : "client1". on following members.
1.server4
2.server3

错误消息:

gfsh>close durable-cq --durable-cq-name=cq1 --durable-client-id=client1

Could not close the durable-cq : "cq1" for the durable-client-id : "client1" due to following reasons.

CacheClientProxy: Could not drain cq cq1 because client proxy id client1 is connected.
Occurred on members
1.server4
2.server3

No client found with client-id : client1
Occurred on members
1.server1

close durable-cq

关闭持久客户端注册的持久连续查询（CQ），并从订阅队列中排除为持久CQ保留的事件。

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

句法:

close durable-cq --durable-client-id=value --durable-cq-name=value 
[--members=value(,value)*] [--groups=value(,value)*]

Table 2. 关闭Durable-CQ参数

示例命令:

close durable-cq --durable-client-id=client1 --durable-cq-name=cq1

示例输出:

gfsh>close durable-cq --durable-cq-name=cq1 --durable-client-id=client1
Closed the durable cq : "cq1" for the durable client : "client1". on following members.
1.server4
2.server3

错误消息:

gfsh>close durable-client --durable-client-id=client1
Unable to close the durable client : "client1" due to following reasons.

Cannot close a running durable client : client1
Occurred on members
1.server4
2.server3

No client found with client-id : client1
Occurred on members
1.server1

compact

压缩在线和离线磁盘存储。

• compact disk-store

  使用该磁盘存储在所有成员上压缩磁盘存储。

• compact offline-disk-store

  压缩脱机磁盘存储。

compact disk-store

使用该磁盘存储在所有成员上压缩磁盘存储。

此命令使用每个成员为其磁盘存储配置的压缩阈值。 磁盘存储必须将allow-force-compaction属性设置为true。

有关详细信息，请参阅在磁盘存储日志文件上运行压缩。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

compact disk-store --name=value [--groups=value(,value)*]

Table 1. 压缩磁盘存储参数

示例命令:

compact disk-store --name=Disk1
compact disk-store --name=Disk1 --group=MemberGroup1,MemberGroup2

错误消息:

"Disk store \"{0}\" does not exist.";
 " for group(s) \"{0}\"";
"No members found in the specified group(s) \"{0}\".";
"Compaction was attempted but nothing to compact.";
"Error occurred while doing compaction. Reason: \"{0}\"";

compact offline-disk-store

压缩脱机磁盘存储。

如果磁盘存储很大，则可能需要使用-J=-XmxNNNm参数为进程分配额外的内存。

有关详细信息，请参阅在磁盘存储日志文件上运行压缩。

注意: 不要在增量备份的基线目录上执行脱机压缩。

可用性: Online or offline.

句法:

compact offline-disk-store --name=value --disk-dirs=value(,value)* 
[--max-oplog-size=value] [--J=value(,value)*]

Table 2. 压缩离线磁盘存储参数

示例命令:

compact offline-disk-store --name=Disk2 --disk-dirs=/Disks/Disk2
compact offline-disk-store --name=Disk2 --disk-dirs=/Disks/Disk2 --max-oplog-size=512 -J=-Xmx1024m

configure

为集群中的所有缓存配置Portable Data eXchange。

configure pdx

为集群中的所有缓存配置Geode的Portable Data eXchange。 此命令不会影响系统中正在运行的成员。 此命令将使用群集配置服务在定位器中保留pdx配置。

注意: 应在启动任何数据成员之前发出此命令。

可用性: Online.

句法:

configure pdx [--read-serialized=value] [--ignore-unread-fields=value]
    [--disk-store=value] [--auto-serializable-classes=value(,value)*]
    [--portable-auto-serializable-classes=value(,value)*

Table 1. Configure PDX Parameters

示例命令:

gfsh>configure pdx --read-serialized=true

示例输出:

gfsh>configure pdx --read-serialized=true
persistent = false
read-serialized = true
ignore-unread-fields = false

gfsh>configure pdx --disk-store=/home/username/server4/DEFAULT.drf
persistent = true
disk-store = /home/username/server4/DEFAULT.drf
read-serialized = false
ignore-unread-fields = false

错误消息:

"Failed to persist the configuration changes due to this command, Revert the command to maintain consistency.
Please use "status cluster-config-service" to determing whether Cluster configuration service is RUNNING."

connect

直接或通过定位器连接到JMX管理器。

如果您通过定位器进行连接，并且JMX管理器尚不存在，则定位器将启动一个。

gfsh作为发现客户端连接到定位器服务并询问JMX Manager的位置。 定位器知道何时没有当前配置为JMX管理器的成员，只需在其自身内启动JMX管理器服务。 gfsh作为JMX客户端连接到定位器的JMX RMI端口。

您还可以使用HTTP协议连接到远程定位器，如下面的第二个示例所示。

可用性: Offline. 如果您已连接，您将收到“已连接到：主机[端口]”的通知。

句法:

connect [--locator=value] [--jmx-manager=value] [--use-http(=value)?] [--url=value]
    [--user=value][--password=value] [--key-store=value] [--key-store-password=value]
    [--trust-store=value] [--trust-store-password=value] [--ciphers=value]
    [--protocols=value] [--security-properties-file=value] [--use-ssl(=value)?]
    [--skip-ssl-validation(=value)?]

Table 1. 连接参数

示例命令:

如果未指定定位器或JMX管理器，则gfsh将连接到默认端口上localhost上的定位器。

gfsh>connect

示例输出:

gfsh>connect
Connecting to Locator at [host=localhost, port=10334] ..
Connecting to Manager at [host=GemFireStymon, port=1099] ..
Successfully connected to: [host=GemFireStymon, port=1099]

通过HTTP连接到远程定位器的示例:

gfsh>connect --use-http=true --url="http://myLocatorHost.example.com:8080/gemfire/v1"
Successfully connected to: GemFire Manager's HTTP service @ 
http://myLocatorHost.example.com:8080/gemfire/v1

错误消息:

"Locator could not find a JMX Manager";
"jmx password must be specified.";
"Could not connect to : {0}. {1}";
"Could not find a GemFire jmx-manager service running at {0}.";
"Could not connect to GemFire Locator service at {0}."

create

创建异步事件队列，磁盘存储，网关接收器，网关发件人，索引和区域。

• create async-event-queue

  在网关发件人传递事件之前，为批处理事件创建异步事件队列。

• create defined indexes

  创建所有已定义的索引。

• create disk-store

  定义一个或多个磁盘存储池，可供区域和客户机订阅队列使用，以及网关发送方队列用于WAN分发。

• create gateway-receiver

  创建网关接收器。 每个成员只能有一个网关接收器，与网关发送器不同，您不需要为网关接收器指定标识符。

• create gateway-sender

  在群集的一个或多个成员上创建网关发件人。

• create index

  创建可在执行查询时使用的索引。

• create jndi-binding

  创建一个JNDI绑定，指定描述JDBC连接的资源属性。

• create lucene index

  创建具有给定路径和配置的区域。

• create region

  创建具有给定路径和配置的区域。

create async-event-queue

在网关发件人传递事件之前，为批处理事件创建异步事件队列。

请参阅配置多站点（WAN）事件队列。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

create async-event-queue --id=value --listener=value [--groups=value(,value)*]
    [--parallel(=value)?] [--enable-batch-conflation(=value)?] [--batch-size=value]
    [--batch-time-interval=value] [--persistent(=value)?] [--disk-store=value]
    [--disk-synchronous(=value)?] [--max-queue-memory=value]
    [--dispatcher-threads=value] [--order-policy=value]
    [--gateway-event-filter=value(,value)*]
    [--gateway-event-substitution-filter=value] 
    [--listener-param=value(,value)*]

Parameters, create async-event-queue:

示例命令:

create async-event-queue --id=myAEQ --listener=myApp.myListener

create defined indexes

创建所有已定义的索引。

另请参阅define index和clear defined indexes。

可用性: Online. 必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

create defined indexes [--members=value(,value)*] [--groups=value(,value)*]

参数，创建定义的索引:

示例命令:

create defined indexes

示例输出:

gfsh>create defined indexes
Indexes successfully created. Use list indexes to get details.
1. ubuntu(server1:17682)<v1>:27574

如果索引创建失败，您可能会在gfsh中收到类似于以下内容的错误消息:

gfsh>create defined indexes
Exception : org.apache.geode.cache.query.RegionNotFoundException , 
Message : Region ' /r3' not found: from  /r3Occurred on following members
1. india(s1:17866)<v1>:27809

create disk-store

定义一个或多个磁盘存储池，可供区域和客户机订阅队列使用，以及网关发送方队列用于WAN分发。

请参阅磁盘存储

可用性: Online. 必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

create disk-store --name=value --dir=value(,value)* [--allow-force-compaction(=value)?] 
[--auto-compact(=value)?] [--compaction-threshold=value] [--max-oplog-size=value]
[--queue-size=value] [--time-interval=value] [--write-buffer-size=value]
[--groups=value(,value)*]
[--disk-usage-warning-percentage=value] [--disk-usage-critical-percentage=value]

参数，创建磁盘存储:

示例命令:

create disk-store --name-store1 --dir=/data/ds1

示例输出:

gfsh>create disk-store --name-store1 --dir=/data/ds1
Member  | Result
------- | -------
server1 | Success

create gateway-receiver

创建网关接收器。 每个成员只能有一个网关接收器，与网关发送器不同，您不需要为网关接收器指定标识符。

除非指定了--groups或--members选项，否则创建将在所有服务器上进行。

如果网关接收器创建成功至少一个成员，则此gfsh命令退出，退出代码表示成功。

输出每个成员的网关接收器的表格格式状态，与创建的成功或失败无关。

请参阅网关接收器。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

create gateway-receiver [--groups=value(,value)*] [--members=value(,value)*] 
  [--manual-start=value] [--start-port=value] [--end-port=value] [--bind-address=value] 
  [--maximum-time-between-pings=value] [--socket-buffer-size=value]
  [--gateway-transport-filter=value(,value)*] [--hostname-for-senders=value]
  [--if-not-exists=(value)?]

参数，创建网关接收器:

示例命令:

gfsh>create gateway-receiver --members=server1

示例输出:

gfsh>create gateway-receiver --members=server1
Member  | Status
------- | ---------------------------------------------------------------------------
server1 | GatewayReceiver created on member "server1" and will listen on the port "0"

create gateway-sender

在群集的一个或多个成员上创建网关发件人。

请参阅网关发件人。

注意: 在承载网关发件人的每个Geode成员上，特定发件人id的网关发件人配置必须相同。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

create gateway-sender --id=value --remote-distributed-system-id=value 
   [--groups=value(,value)*] [--members=value(,value)*] [--parallel=value] 
   [--manual-start=value] [--socket-buffer-size=value] [--socket-read-timeout=value] 
   [--enable-batch-conflation=value] [--batch-size=value] [--batch-time-interval=value]
   [--enable-persistence=value] [--disk-store-name=value] [--disk-synchronous=value] 
   [--maximum-queue-memory=value] [--alert-threshold=value] [--dispatcher-threads=value] 
   [--order-policy=value][--gateway-event-filter=value(,value)*] 
   [--gateway-transport-filter=value(,value)*]

参数，创建网关发件人:

示例命令:

gfsh>create gateway-sender --remote-distributed-system-id="2" --id="sender2"

示例输出:

gfsh>create gateway-sender --remote-distributed-system-id="2" --id="sender2"
Member  | Status
------- | --------------------------------------------
server1 | GatewaySender "sender2" created on "server1"

create index

创建可在执行查询时使用的索引。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

请参阅使用索引。

句法:

create index --name=value --expression=value --region=value 
[--members=value(,value)*] [--type=value] [--groups=value(,value)*]

参数，创建索引:

示例命令:

create index --name=myKeyIndex --expression=region1.Id --region=region1 --type=key

示例输出:

gfsh>create index --name=myKeyIdex --expression=region1.Id --region=region1 --type=key
Index successfully created with following details
Name       : myKeyIdex
Expression : region1.Id
RegionPath : /region1
Members which contain the index
1. ubuntu(server1:17682)<v1>:27574

gfsh>create index --name=myIndex2 --expression=exp2 --region=/exampleRegion
Failed to create index "myIndex2" due to following reasons
Index "myIndex2" already exists.  Create failed due to duplicate name.
Occurred on following members
1. ubuntu(server1:17682)<v1>:27574

create jndi-binding

创建一个JNDI绑定，指定描述JDBC连接的资源属性。

可用性: Online. 必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

create jndi-binding --name=value --type=value --jdbc-driver-class=value
 --connection-url=value [--blocking-timeout-seconds=value]
 [--conn-pooled-datasource-class=value] [--idle-timeout-seconds=value]
 [--init-pool-size=value] [--login-timeout-seconds=value]
 [--managed-conn-factory-class=value] [--max-pool-size=value] [--password=value]
 [--transaction-type=value] [--username=value] [--xa-datasource-class=value]
 [--if-not-exists(=value)?] [--datasource-config-properties=value(,value)*]

参数，创建jndi绑定:

示例命令:

gfsh>create jndi-binding --name=jndi1 --type=SIMPLE \
  --jdbc-driver-class=org.apache.derby.jdbc.EmbeddedDriver \
  --connection-url="jdbc:derby:newDB;create=true"

create lucene index

创建Lucene索引。 有关Lucene索引创建的详细信息，请参阅Apache Lucene Integration。

有关Lucene相关的其他gfsh命令，请参阅describe lucene index, destroy lucene index, list lucene indexes 和 search lucene。

可用性: Online. 必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

create lucene index --name=value --region=value --field=value(,value)*
  [--analyzer=value(,value)*] [--serializer=value] [--group=value(,value)*]

参数，创建lucene索引:

示例命令:

gfsh>create lucene index --name=customerIndex --region=/Customer 
   --field=__REGION_VALUE_FIELD

gfsh>create lucene index --name=analyzerIndex --region=/Person 
     --field=name,email,address,revenue 
     --analyzer=DEFAULT,org.apache.lucene.analysis.core.KeywordAnalyzer,
                examples.MyCharacterAnalyzer,DEFAULT

示例输出:

gfsh>create lucene index --name=testIndex --region=testRegion
    --field=__REGION_VALUE_FIELD
               Member                  | Status
-------------------------------------- | ---------------------------------
192.168.1.23(server505:17200)<v1>:1025 | Successfully created lucene index

create region

创建具有给定路径和配置的区域。

在创建区域时，必须为初始配置指定--type或--template-region。 指定--key-constraint和--value-constraint会在查询和索引期间使对象类型信息可用。

请参阅区域数据存储和分发。

有关语法详细信息，请参阅在命令行选项中指定JSON。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

 create region --name=value [--type=value] [--template-region=value]
    [--groups=value(,value)*] [--if-not-exists(=value)?]
    [--key-constraint=value] [--value-constraint=value]
    [--enable-statistics=value] [--entry-idle-time-expiration=value]
    [--entry-idle-time-expiration-action=value]
    [--entry-time-to-live-expiration=value]
    [--entry-time-to-live-expiration-action=value]
    [--entry-idle-time-custom-expiry=value] [--entry-time-to-live-custom-expiry=value]
    [--region-idle-time-expiration=value]
    [--region-idle-time-expiration-action=value]
    [--region-time-to-live-expiration=value]
    [--region-time-to-live-expiration-action=value] [--disk-store=value]
    [--enable-synchronous-disk=value] [--enable-async-conflation=value]
    [--enable-subscription-conflation=value] [--cache-listener=value(,value)*]
    [--cache-loader=value] [--cache-writer=value]
    [--async-event-queue-id=value(,value)*]
    [--gateway-sender-id=value(,value)*] [--enable-concurrency-checks=value]
    [--enable-cloning=value] [--concurrency-level=value]
    [--colocated-with=value] [--local-max-memory=value]
    [--recovery-delay=value] [--redundant-copies=value]
    [--startup-recovery-delay=value] [--total-max-memory=value]
    [--total-num-buckets=value] [--compressor=value] [--off-heap(=value)]
    [--partition-resolver=value] [--eviction-entry-count=value]
    [--eviction-max-memory=value] [--eviction-action=value] [--eviction-object-sizer=value]

参数，创建区域:

示例命令:

create region --name=region1 --type=REPLICATE_PERSISTENT \
--cache-writer=org.apache.geode.examples.MyCacheWriter \
--group=Group1 --disk-store=DiskStore1

create region --name=region12 --template-region=/region1

create region --name=region2 --type=REPLICATE \
--cache-listener=org.apache.geode.examples.MyCacheListener1,\
org.apache.geode.examples.MyCacheListener2 \
--group=Group1,Group2

create region --name=region3 --type=PARTITION_PERSISTENT --redundant-copies=2 \
--total-max-memory=1000 --startup-recovery-delay=5 --total-num-buckets=100 \
--disk-store=DiskStore2 --cache-listener=org.apache.geode.examples.MyCacheListener3 \
--group=Group2 

create region --name=region4 --type=REPLICATE_PROXY \
--cache-listener=org.apache.geode.examples.MyCacheListener1 --group=Group1,Group2

create region --name=myRegion --type=REPLICATE --eviction-max-memory=100 \
--eviction-action=overflow-to-disk --eviction-object-sizer=my.company.geode.MySizer

create region --name=r1 --type=PARTITION \
--cache-loader=org.example.myLoader{'URL':'jdbc:cloudscape:rmi:MyData'}

示例输出:

gfsh>create region --name=myRegion --type=LOCAL
Member  | Status
------- | ---------------------------------------
server1 | Region "/myRegion" created on "server1"

debug

在gfsh中启用或禁用调试输出。

可用性: Online or offline.

句法:

debug --state=value

Table 1. 调试参数

示例命令:

debug --state=off
debug --state=on

示例输出:

gfsh>debug --state=on
Debug is on

define index

定义可在执行查询时使用的索引。 然后，您可以使用create defined indexes执行单个命令以一次创建多个索引。

可用性: Online or offline.

句法:

define index --name=value --expression=value --region=value [--type=value]

Table 1. 定义索引参数

示例命令:

gfsh> define index --name=myIndex1 --expression=exp1 --region=/exampleRegion 

gfsh> define index --name=myIndex2 --expression=”c.exp2” --region="/exampleRegion e, e.collection1 c" 

gfsh> define index --name=myIndex3 --expression=exp3 --region=/exampleRegion --type=hash 

//then to create the indexes, execute:

gfsh> create defined indexes

示例输出:

gfsh>define index --name=myIndex1 --expression=exp1 --region=/exampleRegion
Index successfully defined with following details
Name       : myIndex1
Expression : exp1
RegionPath : /exampleRegion

deploy

将JAR打包的应用程序部署到一个或多个成员。

只能指定--jars或--dir中的一个。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

deploy [--groups=value(,value)*] [--jars=value(,value)*] [--dir=value]

Table 1. 部署参数

示例命令:

deploy --jars=group1_functions.jar --groups=Group1

deploy --dir=libs/group1-libs --groups=Group2

示例输出:

gfsh> deploy --jars=group1_functions.jar --groups=Group1

 Member   |     Deployed JAR     |                Deployed JAR Location            
--------- | -------------------- | ---------------------------------------------------
datanode1 | group1_functions.jar | /usr/local/gemfire/deploy/GF#group1_functions.jar#1
datanode2 | group1_functions.jar | /usr/local/gemfire/deploy/GF#group1_functions.jar#1


gfsh> deploy --dir=libs/group1-libs --groups=Group2

Deploying files: group2_functions.jar, group2_dependencies.jar
Total file size is: 0.64MB

Continue?  (Y/n): Y

 Member   |      Deployed JAR       |             Deployed JAR Location            
--------- | ----------------------- | ---------------------------------------------
datanode3 | group2_functions.jar    | /usr/local/gemfire/deploy/GF#group2_functions.jar#1
datanode3 | group2_dependencies.jar | /usr/local/gemfire/deploy/GF#group2_dependencies.jar#1 
datanode4 | group2_functions.jar    | /usr/local/gemfire/deploy/GF#group2_functions.jar#1
datanode4 | group2_dependencies.jar | /usr/local/gemfire/deploy/GF#group2_dependencies.jar#1

describe

显示成员配置，shell连接，磁盘存储，成员或区域的详细信息。

• describe client

  显示指定客户端的详细信息。

• describe config

  显示成员的配置。

• describe connection

  显示连接信息详细信息

• describe disk-store

  显示有关成员磁盘存储的信息。

• describe jndi-binding

  显示有关JNDI绑定配置的信息。

• describe lucene index

  显示有关Lucene索引的信息。

• describe member

  显示具有给定名称/ID的成员的详细信息。

• describe offline-disk-store

  显示有关脱机成员磁盘存储的信息。

• describe region

  显示区域的属性和关键信息。

describe client

显示指定客户端的详细信息。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

describe client --clientID=value

参数，描述客户端:

示例命令:

describe client --clientID=192.0.2.0(4987:loner):58922:7b3398cf

示例输出:

gfsh>describe client --clientID=192.0.2.0(4987:loner):58922:7b3398cf
-------------------------------------------------------------------
Primary Servers                : 192.0.2.0(server1:5764)<v1>:15189
Secondary Servers              : 192.0.2.0(server2:5891)<v2>:39082
CPU                            : 0
Number of Cache Listner Calls  : 0
Number of Gets                 : 0
Number of Misses               : 0
Number of Puts                 : 0
Number of Threads              : 0
Process CPU Time (nanoseconds) : 0
Queue size                     : 1
UP Time (seconds)              : 67
Is Durable                     : No

describe config

显示成员的配置。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

describe config --member=value [--hide-defaults(=value)?]

参数，描述配置:

示例命令:

describe config --member=Member1;

示例输出:

gfsh>describe config --member=server1
Configuration of member : "server1"


JVM command line arguments
-----------------------------------
-Dgemfire.mcast-port=0
-Dgemfire.locators=localhost[10334]

GemFire properties defined using the API
................................................
log-file                                 : vf.gf.server.log
name                                     : server1

GemFire properties defined at the runtime
................................................
log-level                                 : finest
statistic-sampling-enabled                : true

Cache attributes
................................................
is-server        : true

Cache-server attributes
 . bind-address         : localhost

describe connection

显示连接信息详细信息

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

describe connection

示例命令:

describe connection

示例输出:

gfsh>describe connection
Connection Endpoints
--------------------
GemFireUser[1099]

describe disk-store

显示有关成员磁盘存储的信息。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

describe disk-store --member=value --name=value

参数，描述磁盘存储:

示例命令:

describe disk-store --member=server1 --name=DiskStore1

示例输出:

gfsh>describe disk-store --name=disk1 --member=server1
Disk Store ID                      : a531bc7b-5188-4510-85d7-de7de30c6671
Disk Store Name                    : disk1
Member ID                          : ubuntu(server1:7467)<v1>:35249
Member Name                        : server1
Allow Force Compaction             : No
Auto Compaction                    : Yes
Compaction Threshold               : 50
Max Oplog Size                     : 1024
Queue Size                         : 0
Time Interval                      : 1000
Write Buffer Size                  : 32768
Disk Usage Warning Percentage      : 90
Disk Usage Critical Percentage     : 99
PDX Serialization Meta-Data Stored : No


        Disk Directory          | Size
------------------------------- | ----------
/home/user/server1/DiskStore1 | 2147483647

describe jndi-binding

打印描述JDBC连接的配置信息。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

describe jndi-binding --name=value

参数，描述jndi绑定:

示例命令:

describe jndi-binding --name=jndi1

示例输出:

gfsh>describe jndi-binding --name=jndi1
    Property      | Value
----------------- | ------------------------------------
type              | SimpleDataSource
jndi-name         | jndi1
jdbc-driver-class | org.apache.derby.jdbc.EmbeddedDriver
user-name         |
connection-url    | jdbc:derby:newDB

describe lucene index

描述一个Lucene索引。

另请参阅create lucene index, destroy lucene index, list lucene indexes 和 search lucene.

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

describe lucene index --name=value --region=value

参数，描述lucene索引:

示例命令:

gfsh>describe lucene index --name=personIndex --region=/Person

示例输出:

gfsh>describe lucene index --name=personIndex --region=/Person
Index Name  | Region Path |                 Indexed Fields                 | Field Analyzer |   Status    | Query Executions | Updates | Commits | Documents
----------- | ----------- | ---------------------------------------------- | -------------- | ----------- | ---------------- | ------- | ------- | ---------
personIndex | /Person     | [name, email, address, streetAddress, revenue] | {}             | Initialized | 339              | 1008    | 962     | 1004

gfsh>describe lucene index --name=analyzerIndex --region=/Person
 Index Name   | Region Path |     Indexed Fields     |            Field Analyzer             |   Status    | Query Executions | Updates | Commits | Documents
------------- | ----------- | ---------------------- | ------------------------------------- | ----------- | ---------------- | ------- | ------- | ---------
analyzerIndex | /Person     | [address, name, email] | {address=MyCharacterAnalyzer, email.. | Initialized | 1695             | 1008    | 962     | 1004

describe member

显示具有给定名称/ID的成员的详细信息。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

describe member --name=value

参数，描述成员:

示例命令:

describe member --name=server1

示例输出:

gfsh>describe member --name=server1
Name        : server1
Id          : GemFireUser(server1:240)<v1>:64871
Host        : 192.0.2.0
Regions     : region4
region5
region3
region2
region1

PID         : 240
Groups      :
Used Heap   : 5M
Max Heap    : 123M
Working Dir : c:\PivotalGemFire70\Latest\server1
Log file    : C:\PivotalGemFire70\Latest\server1\vf.gf.server.log
Locators    : localhost[10334]

Server Bind        : localhost
Server Port        : 40404
Running            : true
Client Connections : 0

describe offline-disk-store

显示有关脱机成员磁盘存储的信息。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

describe offline-disk-store --name=value --disk-dirs=value(,value)* [--pdx=value] [--region=value]

参数，描述offline-disk-store:

示例命令:

describe offline-disk-store --name=DiskStore1\
 --disk-dirs=/home/username/gemfire/mydiskStore1Dir

describe offline-disk-store --name=DiskStore1 --disk-dirs=/DiskDir1  --pdx=true

示例输出:

gfsh>describe offline-disk-store --name=DiskStore1 --disk-dirs=/DiskDir1 --pdx=true
Regions in the disk store:
  /PdxTypes: -lru=none -concurrencyLevel=16 -initialCapacity=16 -loadFactor=0.75 -compressor=none -statisticsEnabled=false
  /Region1: -lru=none -concurrencyLevel=16 -initialCapacity=16 -loadFactor=0.75 -compressor=none -statisticsEnabled=false
PDX Types:
  com.app.data.PositionPdx: id=1
    long avg20DaysVol;
    String bondRating;
    double convRatio;
    String country;
    double delta;
    long industry;
    long issuer;
    double mktValue;
    double qty;
    String secId; // identity
    String secIdIndexed;
    String secLinks;
    double sharesOutstanding;
    String underlyer;
    long volatility;
    int pid;
    int portfolioId;
  com.app.data.StockPdx: id=2
    int ID; // identity
    String pkid;
    Object position1;
    Object position2;
    Object positions;
    Object collectionHolderMap;
    String type;
    String status;
    String[] names;
    String description;
    long createTime;
    Object[] position3;
    Object aDay;
    Date date;
PDX Enums:
  com.app.data.StockPdx$Day.Monday

describe region

显示区域的属性和关键信息。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

describe region --name=value

参数，描述区域:

示例命令:

describe region --name=region1

示例输出:

gfsh>describe region --name=Region1
..........................................................
Name : Region1
Data Policy : persistent replicate
Hosting Members : server-5
server-4
server-3
server-2

Non-Default Attributes Shared By Hosting Members 

Type   | Name            | Value
------ | --------------- | --------------------
Region | data-policy     | PERSISTENT_REPLICATE
       | disk-store-name | DiskStore1
       | size            | 0
       | scope           | distributed-ack

...........................................................
Name             : Region1
Data Policy      : empty
Accessor Members : server-1

Non-Default Attributes Shared By Accessor Members  

 Type  |    Name     | Value
------ | ----------- | ---------------
Region | data-policy | EMPTY
       | size        | 0
       | scope       | distributed-ack

destroy

删除或取消注册功能，删除索引，磁盘存储和区域。

• destroy async-event-queue

  销毁异步事件队列。

• destroy disk-store

  删除磁盘存储以及磁盘存储使用的磁盘上的所有文件。

• destroy function

  销毁或取消注册功能。

• destroy gateway-sender

  销毁网关发件人。

• destroy index

  销毁或删除指定的索引。

• destroy jndi-binding

  销毁指定的JNDI绑定。

• destroy lucene index

  销毁或删除指定的Lucene索引。

• destroy region

  销毁或删除某个地区。

destroy async-event-queue

销毁异步事件队列。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

destroy async-event-queue --id=value [--groups=value(,value)*] [--if-exists=value]

参数，销毁async-event-queue:

示例命令:

destroy async-event-queue --id=myAsyncEventQueue

destroy disk-store

删除磁盘存储以及磁盘存储使用的磁盘上的所有文件。 先前使用此磁盘存储的封闭区域的数据将丢失。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

destroy disk-store --name=value [--groups=value(,value)*] [--if-exists=value]

参数，销毁磁盘存储:

示例命令:

destroy disk-store --name=store1

示例输出:

gfsh>destroy disk-store --name=store1
Member  | Result
------- | -------
server1 | Success

destroy function

销毁或取消注册一个函数。

默认设置是从所有成员取消注册该函数。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

destroy function --id=value [--groups=value(,value)*] [--member=value]

参数，销毁函数:

示例命令:

(1) destroy function --id=InterestCalculations
(2) destroy function --id=InterestCalculations --member=server1
(3) destroy function --id=InterestCalculations --group=Group1

destroy gateway-sender

销毁区域不再使用的网关发件人。

默认设置是在所有成员上销毁网关发件人。

没有区域可以附加到要销毁的网关发送方。 如果仍然附加了某个区域，系统会发出类似于以下内容的错误消息：

ERROR: The GatewaySender ParallelGatewaySender{id=ln,remoteDsId=2,isRunning =false}
could not be destroyed as it is still used by region(s).

使用类似于以下命令的命令从区域中删除网关发件人：

gfsh>alter region --name=regionA --gateway-sender-id=""

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

destroy gateway-sender --id=value [--groups=value(,value)*]
  [--members=value(,value)*] [--if-exists=value]

参数，销毁网关发送者:

示例命令:

destroy gateway-sender --id=SiteASender

destroy index

销毁或删除指定的索引。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

destroy index [--name=value] [--region=value] [--members=value(,value)*]
[--groups=value(,value)*] [--if-exists=value]

注意: 您必须至少指定一个参数选项。 如果输入destroy index而没有任何参数，该命令将要求您指定至少一个选项。

参数，销毁索引:

示例命令:

destroy index --members=server2
destroy index --name=MyKeyIndex

destroy jndi-binding

销毁包含XA数据源配置的指定JNDI绑定。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

destroy jndi-binding --name=value [--if-exists=value]

参数，破坏jndi绑定:

示例命令:

destroy jndi-binding --name=jndi1

destroy lucene index

销毁或删除指定的Lucene索引。

参见 create lucene index, describe lucene index, list lucene indexes 和 search lucene.

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

destroy lucene index --region=value [--name=value]

参数，销毁lucene索引:

示例命令:

destroy lucene index --region=region1
destroy lucene index --region=region1 --name=MyKeyIndex

destroy region

销毁或删除某个地区。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

destroy region --name=value [--if-exists=value]

参数，销毁区域:

示例命令:

destroy region --name=region4
destroy region --name=/region1/subregion1

示例输出:

gfsh>destroy region --name=region1
"region1"  destroyed successfully.

disconnect

关闭所有活动连接。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

disconnect

示例命令:

disconnect

示例输出:

gfsh>disconnect
Disconnecting from: Locator1[1099]
Disconnected from : Locator1[1099]

错误消息:

Error occurred while disconnecting: {0}
Not connected!

echo

回显给定文本，其中可能包括系统和用户变量。

该命令还可以回显gfsh环境属性（使用 ’set variable’命令）如果变量名称 预先加上$ - 就像UNIX一样。

有关gfsh环境变量的列表，请参阅有用的gfsh Shell变量。

可用性: Online or offline.

句法:

echo [--string=value]

Table 1. 回显参数

示例命令:

echo --string="Hello World!"
echo --string="Hello World! This is ${SYS_USER}"
echo --string=${APP_FETCH_SIZE}

要查看shell中设置的所有变量：

echo --string=$*

示例输出:

gfsh>echo --string=${SYS_JAVA_VERSION}
Post substitution: echo --string=1.8.0_60
1.8.0_60

execute function

在成员或区域上执行函数。

执行函数

执行具有指定ID的函数。 默认情况下，该函数在所有成员上执行。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

execute function --id=value [--groups=value(,value)*]
[--members=value(,value)*] [--region=value] 
[--arguments=value(,value)*] [--result-collector=value] [--filter=value]

Table 1. 执行函数参数

示例命令:

execute function --id=InterestCalculations --region=/InterestRegion
execute function --id=InterestCalculations --members=server1
execute function --id=InterestCalculations --groups=Group1

exit

退出gfsh shell。 您也可以使用quit退出shell。

退出gfsh shell并返回OS shell。

可用性: Online or offline.

句法:

exit

示例命令:

exit

export

导出配置，数据，日志和堆栈跟踪。

• export cluster-configuration

  导出包含配置和操作集群所需的cache.xml文件，gemfire.properties文件和应用程序JAR文件的集群配置ZIP文件。

• export config

  导出成员或成员的配置属性。

• export data

  将用户数据从区域导出到文件。

• export logs

  将日志导出到给定目录。

• export offline-disk-store

  将区域数据从脱机磁盘存储导出到gemfire快照文件。

• export stack-traces

  导出一个或多个成员的堆栈跟踪。

export cluster-configuration

使用群集配置导出单个XML文件或ZIP文件，其中包含配置和操作群集所需的cache.xml文件，gemfire.properties文件和应用程序JAR文件。

如果既未指定文件名也未指定ZIP文件名，则群集配置将写入标准输出。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

参见 Overview of the Cluster Configuration Service.

句法:

export cluster-configuration [--group(=value)?] [--xml-file=value]
 [--zip-file-name=value]

导出群集配置参数:

示例命令:

gfsh>export cluster-configuration --zip-file-name=/group/shared-configs/devClusterConfig.zip
gfsh>export cluster-configuration --zip-file-name=my-configs/myClusterConfig.zip
gfsh>export cluster-configuration --zip-file-name=myClusterConfig.zip
gfsh>export cluster-configuration --xml-file=Cluster3Config.xml

示例输出:

gfsh>export cluster-configuration --zip-file-name=mySharedConfig.zip
Downloading cluster configuration : /home/username/gemfire/mySharedConfig.zip

export config

导出成员或成员的配置属性。

如果未指定任何参数，则将导出所有成员配置。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

export config [--members=value(,value)*] [--groups=value(,value)*]
[--dir=value]

导出配置参数:

示例命令:

export config
export config --members=member1

示例输出:

gfsh>export config --members=member1
Downloading Cache XML file: c:\PivotalGemFire\Latest\.\member1-cache.xml
Downloading properties file: c:\PivotalGemFire\Latest\.\member1-gf.properties

export data

将用户数据从一个区域导出到一个或多个文件。

可用性: 线上。 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

要将数据从任何区域（已复制或已分区）按顺序导出到单个文件，请使用--file选项:

export data --region=value --member=value --file=value

在此方案中，来自复制和分区区域的数据将按顺序导出到指定成员上的单个文件中。

对于分区区域，可以使用--parallel选项加快导出过程:

export data  --parallel --region=value --member=value --dir=value

在这种情况下，分区区域数据在所有托管节点上同时导出到这些相应节点的本地目录。

• 并行导出仅适用于分区区域。
• --file和--dir选项是互斥的; --file只能用于串行导出，--dir可用于串行和并行导出。

导出数据参数:

示例命令:

export data --region=region2 --file=region2_20121001.gfd --member=server2

样本输出:

 gfsh>export data --region=region2 --file=region2_20121001.gfd --member=server1
Data succesfully exported from region : region2 to file : C:\PivotalGemFire\
Latest\server1\region2_20121001.gfd on host : 192.0.2.0

export logs

将日志导出到给定目录。

将导出具有指定时间范围内日志的所有文件。 如果未指定时间范围，则将导出所有日志。

--dir参数指定将写入日志文件的本地目录。 仅在使用http连接导出日志时使用。 如果通过http执行，则zip存档将保存在用户客户端计算机上的指定目录中。 如果未指定，则将日志写入user.dir系统属性指定的位置。 当命令在JMX上执行时，日志将在连接的定位器的工作目录中保存为exportedlogs_xxx.zip。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

export logs [--dir=value] [--groups=value(,value)*] [--members=value(,value)*] 
[--log-level=value] [--only-log-level=value] [--merge-log=value] 
[--start-time=value] [--end-time=value] [logs-only(=value)?] 
[--stats-only(=value)?] [--file-size-limit(=value)?]

导出日志参数:

示例命令，显示输出:

gfsh>export logs --dir=data/logs
Logs exported to the connected member's file system: /my-locator/data/logs/exportedLogs_1489513007261.zip
gfsh>export logs --dir=data/logs --file-size-limit=1k
Estimated exported logs expanded file size = 95599, file-size-limit = 1024.
To disable exported logs file size check use option "--file-size-limit=0".

gfsh>export logs --dir=data/logs --file-size-limit=99k
Logs exported to the connected member's file system: /my-locator/data/logs/exportedLogs_1489513007261.zip

export offline-disk-store

将区域数据从脱机磁盘存储导出到gemfire快照文件。

可用性: Online or offline.

句法:

export offline-disk-store --name=value --disk-dirs=value(,value)* --dir=value

导出脱机磁盘存储参数:

示例命令:

 export offline-disk-store --name= DiskStore1 \
--disk-dirs=/home/username/gemfire/mydiskStore1Dir --dir=/home/username/gemfire/export

export stack-traces

导出一个或多个成员的堆栈跟踪。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

export stack-traces --file=value [--members=value(,value)*] [--groups=value(,value)*]

导出堆栈跟踪参数:

示例命令:

export stack-traces --file=stack.txt

示例输出:

gfsh>export stack-traces --file=stack.txt
stack-trace(s) exported to file: C:\PivotalGemFire\Latest\locator1\stack.txt
On host : GemFireStymon

gc

对一个或多个成员强制GC（垃圾收集）。

默认设置是在所有缓存成员上进行垃圾收集。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

gc [--groups=value(,value)*] [--member=value]

Table 1. GC 参数

示例命令:

gc --member=server1
gc --groups=Group1
gc

示例输出:

gfsh>gc
Sucessfully executed GC

get

显示区域中的条目。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

get --key=value --region=value [--key-class=value] [--value-class=value]

Table 1. Get 参数

示例命令:

get --key=('id':'133abg124') --region=region1

// Retrieving when key type is a wrapper(primitive)/String
get --key=('133abg124') --region=/region1/region12 --value-class=data.ProfileDetails

get --key=('100L') --region=/region1/region12 --value-class=data.ProfileDetails 
--key-class=java.lang.Long

示例输出:

gfsh>get --key=('123') --region=region1
Result      : true
Key Class   : java.lang.String
Key         : ('123')
Value Class : java.lang.String
Value       : ABC

help

显示所有可用命令的语法和用法信息。

在没有命令作为参数的情况下键入帮助会列出所有可用命令。

可用性: Online or offline.

句法:

help [command]

Examples Commands:

help
help rebalance

示例输出:

gfsh>help rebalance
NAME
        rebalance
IS AVAILABLE
        true
SYNOPSIS
        Rebalance partitioned regions. The default is for all partitioned region
s to be rebalanced.
SYNTAX
        rebalance [--include-region=value(,value)*] [--exclude-region=value(,val
ue)*] [--time-out=value] [--simulate(=value)?]
PARAMETERS
        include-region
                Partitioned regions to be included when rebalancing. Includes ta
ke precedence over excludes.
                Required:false
        exclude-region
                Partitioned regions to be excluded when rebalancing.
                Required:false
        time-out
                Time to wait (in seconds) before GFSH returns to a prompt while
rebalancing continues in the background. The default is to wait for rebalancing
to complete.
                Required:false
                Default if the parameter is not specified:-1
        simulate
                Whether to only simulate rebalancing. The --time-out parameter i
s not available when simulating.
                Required:false
                Default if no value for the parameter is given:true
                Default if the parameter is not specified:false

hint

显示有关主题的信息以及与主题关联的命令列表。

提供主题提示或列出所有可用主题（如果未指定主题）。

可用性: Online or offline.

句法:

hint [topic]

示例命令:

hint
hint Server

示例输出:

gfsh>hint
Hints are available for the following topics. Use "hint <topic-name>" for a specific
 hint.
Configuration
Data
Debug-Utility
Disk Store
Function Execution
GFSH
Help
JMX
Lifecycle
Locator
Management-Monitoring
Manager
Region
Server
Statistics

gfsh>hint server
A server is GemFire cluster member which holds a GemFire cache. Depending on the
 topology used it can refer to either a system that responds to client requests
or a system that is only a peer to other members.

describe member : Display information about a member, including name, id, groups
, regions, etc.
export logs     : Export the log files for a member or members.
list members    : Display all or a subset of members.
start server    : Start a GemFire Cache Server.
status server   : Display the status of a GemFire Cache Server.
stop server     : Stop a GemFire Cache Server..

history

显示或保存命令历史记录。

此历史记录可以保存到文件中，以后也可以用作脚本。

已成功执行的命令历史记录也记录在运行gfsh的用户的主目录中的.geode/.gfsh.history文件中。

可用性: Online or offline.

句法:

history [--file=<history text file>]

Table 1. History 参数

示例命令:

history
history --file=./mycommands.gfsh;

示例输出:

gfsh>history --file=./mycommands.gfsh
Wrote successfully to file ./mycommands.gfsh

import

您可以导入导出的群集配置以创建新群集或将数据导入区域。

• import cluster-configuration

  导入群集配置。

• import data

  将用户数据从文件导入区域。

import cluster-configuration

从ZIP文件或XML文件导入以前导出的群集配置。 在启动新群集时，此命令很有用。

• 在给定群集中，只有一个定位器需要执行导入。 该定位器与集群中所有其他连接的定位器共享导入的配置。
• 当服务器启动时，定位器与数据成员（服务器）共享导入的配置，或者最近启动了服务器，没有在其中定义区域，并且自启动以来没有给出任何其他配置更改。

要导入集群配置，请启动一个或多个定位器，然后运行gfsh``import cluster-configuration命令。

可用性: Online. 您必须在gfsh中连接到定位器才能使用此命令。

句法:

import cluster-configuration [--action=value] [--group(=value)?]
 [--xml-file=value] [--zip-file-name=value]

Import Cluster-Configuration 参数:

示例命令:

gfsh>import cluster-configuration --zip-file-name=/home/username/myClusterConfig.zip
gfsh>import cluster-configuration --xml-file=configs/Cluster3Config.xml

示例输出:

gfsh>import cluster-configuration --zip-file-name=/home/username/myClusterConfig.zip
Cluster configuration successfully imported

import data

将用户数据从一个或多个文件导入区域。

可用性: 线上。 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

如果数据按顺序导出到单个文件，请使用import命令的序列形式导入数据:

import data --region=value --file=value --member=value [--invoke-callbacks=value]

在此方案中，从指定成员上的单个文件顺序导入来自复制和分区区域的数据。

有关串行和并行数据导出之间差异的说明，请参阅导出数据。

如果数据是以并行格式从分区区域导出的，请使用--parallel选项导入数据:

import data --parallel --region=value --member=value --dir=value
  [--invoke-callbacks=value]

在这种情况下，分区区域数据在所有托管节点上从这些相应节点的本地目录同时导入。

• 并行导入仅适用于以并行模式导出的分区区域。
• --file和--dir选项是互斥的; --file只能用于串行导入，--dir可用于串行和并行导入。

导入数据参数:

示例命令:

import data --region=region2 --file=/mnt5/region2_20121001.gfd --member=server1

list

列出现有的Geode资源，例如已部署的应用程序，磁盘存储，功能，成员，服务器和区域。

• list async-event-queues

  显示所有成员的异步事件队列列表。

• list clients

  显示已连接客户端的列表。

• list deployed

  显示使用deploy命令部署到成员的JAR列表。

• list disk-stores

  列出Geode集群中的所有可用磁盘存储

• list durable-cqs

  列出与指定的持久客户端ID关联的持久客户端CQ。

• list functions

  显示已注册的函数列表。 默认设置是显示所有成员的功能。

• list gateways

  显示一个或多个成员的网关发件人和收件人。

• list indexes

  Display the list of indexes created for all members.

• list jndi-binding

  List all JNDI bindings, active and configured.

• list lucene indexes

  列出为所有成员创建的Lucene索引。

• list members

  显示全部或部分成员。

• list regions

  显示成员或成员的区域。 如果未指定参数，则列出群集中的所有区域。

list async-event-queues

显示所有成员的异步事件队列列表。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

list async-event-queues

示例命令:

list async-event-queues

list clients

显示已连接客户端的列表。

显示已连接客户端及其连接的服务器的列表。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

list clients

示例命令:

list clients

示例输出:

gfsh>list clients

ClientList

            Client Name / ID              | Server Name / ID
----------------------------------------- | -----------------------------------------------------
192.0.2.0(4987:loner):58922:7b3398cf | member=server2,port=53508;  member=server1,port=56806
192.0.2.0(5065:loner):39906:a6f598cf | member=server2,port=53508;  member=server1,port=56806

list deployed

显示使用deploy命令部署到成员的JAR列表。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

list deployed [--groups=value(,value)*]

参数，已部署列表:

示例命令:

list deployed
list deployed --groups=Group2

示例输出:

gfsh> list deployed  --groups=Group2

 Member   |     Deployed JAR     |                JAR Location
--------- | -------------------- | ---------------------------------------------------
datanode1 | group1_functions.jar | /usr/local/gemfire/deploy/vf.gf#group1_functions.jar#1
datanode2 | group1_functions.jar | /usr/local/gemfire/deploy/vf.gf#group1_functions.jar#1

错误消息:

No JAR Files Found

list disk-stores

列出Geode集群中的所有可用磁盘存储

该命令还使用磁盘存储列出已配置的磁盘目录以及任何区域，高速缓存服务器，网关，PDX序列化和异步事件队列，以便将信息溢出和/或保留到磁盘。 使用describe disk-store命令查看特定磁盘存储的详细信息。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

list disk-stores

示例命令:

list disk-stores

示例输出:

gfsh> list disk-stores

   Member Name   |                   Member Id                   | Disk Store Name |            Disk Store ID
  -------------- | --------------------------------------------- | --------------- | ------------------------------------
  consumerServer | 192.0.2.0(consumerServer:13825)<v5>:3545  | consumerData    | 4029af26-fd82-4997-bd6c-33382cdbb5e9
  consumerServer | 192.0.2.0(consumerServer:13825)<v5>:3545  | observerData    | 7e0316ad-963c-49b0-9b01-8f59b8d9e29e
  producerServer | 192.0.2.0(producerServer:13826)<v3>:53764 | producerData    | 4670e4eb-1c50-4465-b418-08ede3d5dbed

错误消息:

gfsh> list disk-stores
No Disk Stores Found

list durable-cqs

列出与指定的持久客户端ID关联的持久客户端CQ。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

list durable-cqs --durable-client-id=value
 [--members=value(,value)*] [--groups=value(,value)*]

参数, 列出 durable-cqs:

示例命令:

list durable-cqs --durable-client-id=client1

样本输出:

gfsh>list durable-cqs --durable-client-id=client1
member  | durable-cq-name
------- | ---------------
server3 | cq3
        | cq1
        | cq2
server4 | cq3
        | cq1

错误消息:

gfsh>list durable-cqs --durable-client-id=client1

Unable to list durable-cqs for durable-client-id : "client1" due to following reasons.

No client found with client-id : client1
Occurred on members
1.server4
2.server1
3.server3

list functions

显示已注册的函数列表。 默认设置是显示所有成员的函数。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

list functions [--matches=value] [--groups=value(,value)*]
[--members=value(,value)*]

参数，列表函数:

示例命令:

gfsh> list functions
gfsh> list functions --matches=reconcile.*

示例输出:

list functions

   Member   |          Function
  --------- | --------------------------
  camelot   | loadDataFromExternalSource
  camelot   | reconcileWeeklyExpenses
  excalibur | loadDataFromExternalSource
  excalibur | reconcileDailyExpenses


Example of 'list function' with a "matches" filter:

gfsh> list functions --matches=reconcile.*

   Member   |        Function
  --------- | -----------------------
  camelot   | reconcileWeeklyExpenses
  excalibur | reconcileDailyExpenses


Example of 'list functions' when no functions are found in Geode :

gfsh> list functions
No Functions Found.

list gateways

显示一个或多个成员的网关发件人和收件人。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

list gateways [--members=value(,value)*] [--groups=value(,value)*]

参数，列出网关:

示例命令:

list gateways

list indexes

显示为所有成员创建的索引列表。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

list indexes [--with-stats(=value)?]

参数，列表索引:

示例命令:

list indexes

list indexes --with-stats

示例输出:

gfsh>list indexes
Member Name    |                   Member ID                   | Region Path |   Name   | Type  | Indexed Expression | From Clause
-------------- | --------------------------------------------- | ----------- | -------- | ----- | ------------------ | -----------
consumerServer | 192.0.2.0(consumerServer:13873):6317      | /consumers  | cidIdx   | KEY   | id                 | /consumers
consumerServer | 192.0.2.0(consumerServer:13873):6317      | /consumers  | cnameIdx | RANGE | name               | /consumers
producerServer | 192.0.2.0(producerServer:13874):19198     | /producers  | pidIdx   | RANGE | id                 | /producers

Example of 'list indexes' with stats printed:

gfsh>list indexes --with-stats

Member Name  | Member ID | Region Path |   Name   | Type  | Indexed Expression | From Clause | Uses | Updates | Update Time | Keys | Values
------------ | --------- | ----------- | -------- | ----- | ------------------ | ----------- | ---- | ------- | ----------- | ---- | ------
cs...        | 192...    | /consumers  | cidIdx   | KEY   | id                 | /consumers  | 2512 | 0       | 0           | 5020 | 5020  
cs...        | 192...    | /consumers  | cnameIdx | RANGE | name               | /consumers  | 0    | 5020    | 421224000   | 0    | 5020
ps...        | 192...    | /producers  | pidIdx   | RANGE | id                 | /producers  | 0    | 5031    | 497872000   | 5031 | 5031

错误消息:

在Geode中找不到索引时的输出示例：

gfsh> list indexes
No Indexes Found

list jndi-binding

列出所有JNDI绑定，活动和配置。 活动绑定是绑定到服务器的JNDI上下文的绑定，也在群集配置中列出。 已配置的绑定是群集配置中列出的绑定，但可能在服务器上不活动。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

list jndi-binding

示例输出:

gfsh>list jndi-binding

Configured JNDI bindings: 

Group Name | JNDI Name | JDBC Driver Class
---------- | --------- | ------------------------------------
cluster    | jndi1     | org.apache.derby.jdbc.EmbeddedDriver

Active JNDI bindings found on each member: 

    Member      |        JNDI Name        | JDBC Driver Class
--------------- | ----------------------- | ----------------------------------------------------
land-gifted-gun | java:UserTransaction    | org.apache.geode.internal.jta.UserTransactionImpl
land-gifted-gun | java:TransactionManager | org.apache.geode.internal.jta.TransactionManagerImpl

list lucene indexes

显示为所有成员创建的Lucene索引列表。 可选的--with-stats限定符显示索引上的活动。

参见 create lucene index, describe lucene index, destroy lucene index and search lucene.

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

list lucene indexes [--with-stats(=value)]

参数，列出lucene索引:

示例命令:

list lucene indexes

示例输出:

gfsh>list lucene indexes --with-stats
Index Name | Region Path |     Indexed Fields     | Field Analy.. | Status  | Query Executions | Updates | Commits | Documents
---------- | ----------- | ---------------------- | ------------- | ------- | ---------------- | ------- | ------- | ---------
testIndex  | /testRegion | [__REGION_VALUE_FIELD] | {__REGION_V.. | Defined | NA               | NA      | NA      | NA

gfsh>list lucene indexes
 Index Name   | Region Path |                           Indexed Fields                           | Field Analy.. | Status
------------- | ----------- | ------------------------------------------------------------------ | ------------- | -----------
analyzerIndex | /Person     | [revenue, address, name, email]                                    | {revenue=St.. | Initialized
customerIndex | /Customer   | [symbol, revenue, SSN, name, email, address, __REGION_VALUE_FIELD] | {}            | Initialized
pageIndex     | /Page       | [id, title, content]                                               | {}            | Initialized
personIndex   | /Person     | [name, email, address, revenue]                                    | {}            | Initialized

list members

显示全部或部分成员。

在输出中，列出了成员协调员。 <vN>标识成员当前拥有的视图; N将为零或正整数。 <ec>表示哪些成员有资格成为会员协调员。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

list members [--group=value]

参数,列出成员:

示例命令:

list members
list members --group=Group1

示例输出:

gfsh>list members
  Name       | Id
------------ | -------------------------------------
Coordinator: | 192.0.2.0(locator1:216:locator)<ec><v6>:33368
locator1     | 192.0.2.0(locator1:216:locator)<ec><v6>:33368
server1      | 192.0.2.0(server1:888)<v7>:10839
server2      | 192.0.2.0(server2:3260)<v8>:16721

list regions

显示成员或成员的区域。 如果未指定参数，则列出群集中的所有区域。

句法:

list regions [--groups=value(,value)*] [--members=value(,value)*]

参数，列出区域:

示例命令:

list regions
list regions --groups=G1
list regions --members=member1

示例输出:

gfsh>list regions
List of regions
---------------
region1
region2

load-balance gateway-sender

使指定的网关发送方关闭其当前连接并以更平衡的方式重新连接到远程网关接收方。

使用此命令可以平衡网关发件人与接收者之间的连接。 例如，在远程站点添加新的网关接收器节点时，请执行此命令，以便新网关接收器可以从指定的网关发送器获取连接。 调用此命令可在所有网关接收器之间更均匀地重新分配发送方的连接。

注意: 此命令对ping连接没有影响。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

load-balance gateway-sender --id=value

Table 1. 负载平衡网关 - 发件人参数

示例命令:

load-balance gateway-sender --id=sender1-LN

示例输出:

load-balance gateway-sender --id=ny

                 Member             | Result | Message
  --------------------------------- | ------ |--------------------------------------------------------------------------
boglesbymac(ln-1:88651)<v2>:48277 | OK     | GatewaySender ny is rebalanced on member boglesbymac(ln-1:88651)<v2>:48277
boglesbymac(ln-4:88681)<v5>:42784 | OK     | GatewaySender ny is rebalanced on member boglesbymac(ln-4:88681)<v5>:42784
boglesbymac(ln-3:88672)<v4>:43675 | OK     | GatewaySender ny is rebalanced on member boglesbymac(ln-3:88672)<v4>:43675
boglesbymac(ln-2:88662)<v3>:12796 | OK     | GatewaySender ny is rebalanced on member boglesbymac(ln-2:88662)<v3>:12796

locate entry

在成员上找到区域条目。

找到条目

使用指定的键在成员上找到给定的条目。 使用分区区域时，此命令很有用。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

locate entry --key=value --region=value [--key-class=value] 
[--value-class=value] [--recursive=value]

Table 1. 找到条目参数

示例命令:

locate entry --key=('id':'133abg124') --region=/region1 
--key-class=data.ProfileKey --recursive=true;

示例输出:

gfsh>locate entry --key=('123abc') --region=region2
Result          : true
Key Class       : java.lang.String
Key             : ('123abc')
Locations Found : 2


MemberName | MemberId
---------- | -------------------------------------
server1    | GemFireStymon(server1:3692)<v1>:13487
server2    | GemFireStymon(server2:2340)<v2>:11613

netstat

通过“netstat”操作系统命令报告网络信息和统计信息。

报告给定成员的重要网络使用信息/统计信息。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

netstat [--members=value(,value)*] [--group=value] [--file=value] 
[--with-lsof(=value)?]

Table 1. Netstat 参数

示例命令:

netstat
netstat --members=server1
netstat --members=server1 --file=server1_netstat.txt

示例输出:

gfsh>netstat
####################################
Host: GemFireTest
OS: Windows XP 5.1 x86
Member(s):
 server2, locator1, server1
####################################

Active Connections

  Proto  Local Address          Foreign Address        State
  TCP    GemFireTest:epmap    GemFireTest:0        LISTENING
  TCP    GemFireTest:microsoft-ds  GemFireTest:0        LISTENING
  TCP    GemFireTest:1034     GemFireTest:0        LISTENING
  TCP    GemFireTest:1069     GemFireTest:0        LISTENING
  TCP    GemFireTest:1099     GemFireTest:0        LISTENING
  TCP    GemFireTest:1134     GemFireTest:0        LISTENING
  TCP    GemFireTest:3389     GemFireTest:0        LISTENING
  TCP    GemFireTest:8080     GemFireTest:0        LISTENING
  TCP    GemFireTest:8081     GemFireTest:0        LISTENING
  TCP    GemFireTest:10334    GemFireTest:0        LISTENING
  TCP    GemFireTest:40404    GemFireTest:0        LISTENING
  TCP    GemFireTest:40405    GemFireTest:0        LISTENING
  TCP    GemFireTest:1025     GemFireTest:0        LISTENING
  TCP    GemFireTest:5152     GemFireTest:0        LISTENING
  TCP    GemFireTest:netbios-ssn  GemFireTest:0        LISTENING
  TCP    GemFireTest:1035     GemFireTest:0        LISTENING
  TCP    GemFireTest:1035     GemFireTest:1081     ESTABLISHED
  TCP    GemFireTest:1035     GemFireTest:1086     ESTABLISHED
  TCP    GemFireTest:1035     GemFireTest:1147     ESTABLISHED
  TCP    GemFireTest:1035     GemFireTest:1156     ESTABLISHED
  TCP    GemFireTest:1046     GemFireTest:1099     ESTABLISHED
  TCP    GemFireTest:1049     osdc-proxy-vip.vmware.com:http  CLOSE_WA
  TCP    GemFireTest:1050     osdc-proxy-vip.vmware.com:3128  CLOSE_WA
  TCP    GemFireTest:1071     GemFireTest:0        LISTENING
  TCP    GemFireTest:1071     GemFireTest:1077     ESTABLISHED
  TCP    GemFireTest:1071     GemFireTest:1150     ESTABLISHED
  TCP    GemFireTest:1071     GemFireTest:1157     ESTABLISHED
  TCP    GemFireTest:1077     GemFireTest:1071     ESTABLISHED
  TCP    GemFireTest:1078     GemFireTest:24400    ESTABLISHED
  TCP    GemFireTest:1081     GemFireTest:1035     ESTABLISHED
  TCP    GemFireTest:1086     GemFireTest:1035     ESTABLISHED
  TCP    GemFireTest:1099     GemFireTest:1046     ESTABLISHED
  TCP    GemFireTest:1136     GemFireTest:0        LISTENING
  TCP    GemFireTest:1136     GemFireTest:1143     ESTABLISHED
  TCP    GemFireTest:1136     GemFireTest:1151     ESTABLISHED
  TCP    GemFireTest:1136     GemFireTest:1201     ESTABLISHED
  TCP    GemFireTest:1141     GemFireTest:4247     ESTABLISHED
  TCP    GemFireTest:1142     GemFireTest:48640    ESTABLISHED
  TCP    GemFireTest:1143     GemFireTest:1136     ESTABLISHED
  TCP    GemFireTest:1147     GemFireTest:1035     ESTABLISHED
  TCP    GemFireTest:1150     GemFireTest:1071     ESTABLISHED
  TCP    GemFireTest:1151     GemFireTest:1136     ESTABLISHED
  TCP    GemFireTest:1156     GemFireTest:1035     ESTABLISHED
  TCP    GemFireTest:1157     GemFireTest:1071     ESTABLISHED
  TCP    GemFireTest:1201     GemFireTest:1136     ESTABLISHED
  TCP    GemFireTest:1349     GemFireTest:10334    TIME_WAIT
  TCP    GemFireTest:1350     GemFireTest:10334    TIME_WAIT
  TCP    GemFireTest:1351     GemFireTest:10334    TIME_WAIT
  TCP    GemFireTest:1352     GemFireTest:10334    TIME_WAIT
  TCP    GemFireTest:1353     GemFireTest:10334    TIME_WAIT
  TCP    GemFireTest:1354     GemFireTest:10334    TIME_WAIT
  TCP    GemFireTest:4247     GemFireTest:0        LISTENING
  TCP    GemFireTest:4247     GemFireTest:1141     ESTABLISHED
  TCP    GemFireTest:24400    GemFireTest:0        LISTENING
  TCP    GemFireTest:24400    GemFireTest:1078     ESTABLISHED
  TCP    GemFireTest:48640    GemFireTest:0        LISTENING
  TCP    GemFireTest:48640    GemFireTest:1142     ESTABLISHED
  UDP    GemFireTest:microsoft-ds  *:*
  UDP    GemFireTest:isakmp   *:*
  UDP    GemFireTest:4500     *:*
  UDP    GemFireTest:ntp      *:*
  UDP    GemFireTest:1900     *:*
  UDP    GemFireTest:ntp      *:*
  UDP    GemFireTest:netbios-ns  *:*
  UDP    GemFireTest:netbios-dgm  *:*
  UDP    GemFireTest:1900     *:*
  UDP    GemFireTest:32270    *:*
  UDP    GemFireTest:42838    *:*
  UDP    GemFireTest:47727    *:*

pause gateway-sender

暂停网关发件人。

暂停成员或成员上的网关发件人。 有关暂停网关发件人的详细信息，请参阅暂停网关发件人。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

pause gateway-sender --id=value [--groups=value(,value)*] 
[--members=value(,value)*]

Table 1. 暂停 网关-发件人 参数

示例命令:

pause gateway-sender --id=sender1

pdx rename

在脱机磁盘存储中重命名PDX类型。

重命名的任何PDX类型都将在输出中列出。 如果未完成重命名或磁盘存储在线，则此命令将失败。

可用性: Offline.

句法:

pdx rename --old=value --new=value --disk-store=value --disk-dirs=value(,value)*

示例命令:

将以“com.gemstone”开头的所有包更改为“com.pivotal”：

gfsh>pdx rename --old=com.gemstone --new=com.pivotal --disk-store=ds1 --disk-dirs=/diskDir1

将名为“MyClassName”的类更改为“YourClassName”：

gfsh>pdx rename --old=MyClassName --new=YourClassName --disk-store=ds1 --disk-dirs=/diskDir1

将FQCN“com.target.app1.OldClass”更改为“com.target.app2.NewClass”：

gfsh>pdx rename --old=com.target.app1.OldClass --new=com.target.app2.NewClass --disk-store=ds1 --disk-dirs=/diskDir1

示例输出:

gfsh>pdx rename --old=PortfolioPdx --new=StockPdx --disk-store=DiskStore1 --disk-dirs=/DiskDir1
Successfully renamed pdx types:
  com.app.data.StockPdx: id=2
  com.app.data.StockPdx$Day.Monday

错误消息:

如果没有类型匹配，您可能会收到以下错误消息：

gfsh>pdx rename --old=gemstone --new=pivotal --disk-store=DiskStore1 --disk-dirs=/DiskDir1
Could not process command due to GemFire error. No Pdx types found to rename.

如果存储PDX类型的磁盘存储在线，您将收到以下错误消息：

gfsh>pdx rename --old=StockPdx --new=PortfolioPdx --disk-store=DiskStore1 --disk-dirs=/DiskDir1
Could not process command due to GemFire error. Error renaming pdx types :
GemFireCache[id = 484629896; isClosing = false; isShutDownAll = false;
closingGatewayHubsByShutdownAll = false; created = Wed Jan 07 10:29:45 PST 2015;
server = false; copyOnRead = false; lockLease = 120; lockTimeout = 60]: An open cache
already exists.

put

添加或更新区域中的条目。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

put --key=value --value=value --region=value [--key-class=value] 
[--value-class=value] [--if-not-exists(=value)]

示例命令:

put --key=('id':'133abg125') --value=('firstname':'James','lastname':'Gosling') 
--region=/region1 --key-class=data.ProfileKey --value-class=data.ProfileDetails

put --key=('133abg124') --value=('Hello World!!') --region=/region2

put --key=('100F') --value=('2146547689879658564')  --region=/region1/region12 
--key-class=java.lang.Float --value-class=java.lang.Long

示例输出:

gfsh>put --key=('123abc') --value=('Hello World!!') --region=region2
Result      : true
Key Class   : java.lang.String
Key         : ('123abc')
Value Class : java.lang.String
Old Value   : <NULL>

错误消息:

"Region name is either empty or Null";
"Key is either empty or Null";
"Value is either empty or Null";
"Region <{0}> not found in any of the members";
"Region <{0}> Not Found";
"Key is not present in the region";

query

对Geode区域运行查询。

如果在查询中未设置限制结果大小的限制，则为有用的gfsh Shell变量中定义的gfsh环境变量APP_FETCH_SIZE的默认限制。

使用单引号围绕OQL查询。

注意: 如果被查询的对象包含循环引用，则不应从gfsh执行此命令。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

query --query=value [--step-name=value] [--file=path/to/results/file]

Table 1. 查询参数

示例输出:

gfsh>query --query='SELECT * FROM /region2'

Result     : true
startCount : 0
endCount   : 20
Rows       : 1

Result
-----------------
('Hello World!!')

NEXT_STEP_NAME : END

rebalance

重新平衡分区区域。

默认情况下，所有分区区域都要重新平衡。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

rebalance [--include-region=value(,value)*] 
[--exclude-region=value(,value)*] [--time-out=value] [--simulate(=value)?]

Table 1. 重新平衡的参数

示例命令:

rebalance --include-region=/region3 --simulate=true

示例输出:

rebalance
1. server1  host1(3467):12435:12423
Row  Rebalanced Stats               | Value 
---  ----------------               | ----- 
1    TotalBucketCreateBytes         | 0 
2    TotalBucketCreateTime          | 0 
3    TotalBucketCreatesCompleted    | 0 
4    TotalBucketTransferBytes       | 0 
5    TotalBucketTransferTime        | 0 
6    TotalBucketTransfersCompleted  | 0 
7    TotalPrimaryTransferTime       | 0 
8    TotalPrimaryTransfersCompleted | 0 
9    TotalTime                      | 56

Rebalance complete on host1(3467):12435:12423.

remove

从区域中删除条目。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

remove --region=value [--key=value] [--all(=value)?] [--key-class=value]

示例命令:

gfsh>remove --region=/region1 --key=('id': '133abg134')
gfsh>remove --region=/region1 --key=('id': '133abg134') --key-class=data.ProfileKey 
gfsh>remove --region=/region1 --all=true

错误消息:

"Region name is either empty or Null"

"Key is either empty or Null"

"Value is either empty or Null"

"Region <{0}> not found in any of the members"

"Region <{0}> Not Found"

"Key is not present in the region"

"Option --all is not supported on partitioned region"

resume gateway-sender

恢复已暂停的所有网关发件人。

恢复成员或成员上的网关发件人。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

resume gateway-sender --id=value [--groups=value(,value)*] 
[--members=value(,value)*]

Table 1. 恢复网关发件人参数

示例命令:

resume gateway-sender --id=sender1-LN --groups=LN-Group1

revoke missing-disk-store

指示群集的成员停止等待磁盘存储可用。

仅在文件丢失时撤消磁盘存储，因为在启动撤销后它将不再可恢复。 使用show missing-disk-store命令获取缺少磁盘存储的描述。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

revoke missing-disk-store --id=value

Table 1. 撤消丢失磁盘存储参数

示例命令:

revoke missing-disk-store --id=60399215-532b-406f-b81f-9b5bd8d1b55a

示例输出:

gfsh>revoke missing-disk-store --id=60399215-532b-406f-b81f-9b5bd8d1b55a
Missing disk store successfully revoked

错误消息:

无法找到磁盘存储时revoke missing-disk-store的示例：

gfsh> revoke missing-disk-store --id=60399215-532b-406f-b81f

Unable to find missing disk store to revoke

run

执行一组GFSH命令。

Commands that normally prompt for additional input will instead use default values.

可用性: Online or offline.

注意: 文件中指定的某些命令需要在线状态。

句法:

run --file=value [--quiet(=value)?] [--continue-on-error(=value)?]

Table 1. Run 参数

示例命令:

run --file=create-regions.gfsh --quiet=true

(2) From command line:
prompt> /home/user1/gemfire70/bin/gfsh run ./create-regions.gfsh --quiet=true
prompt> /home/user1/gemfire70/bin/gfsh run ./create-regions.gfsh 
--continue-on-error=true

示例输出:

gfsh>run --file=create-regions.gfsh
1. Executing - create region --name=region4 --type=REPLICATE

Member  | Status
------- | --------------------------------------
server2 | Region "/region4" created on "server2"
server1 | Region "/region4" created on "server1"

2. Executing - create region --name=region1/subregion1 --type=LOCAL

Parent region for "region1/subregion1" doesn't exist.

search lucene

搜索Lucene索引

参见 create lucene index, describe lucene index, destroy lucene index 和 list lucene indexes.

可用性: Online.

句法:

search lucene --name=value --region=value --queryString=value --defaultField=value
    [--limit=value] [--keys-only=value]

参数, 搜索lucene:

示例命令:

gfsh> search lucene --name=testIndex --region=/testRegion --queryString=value1
   --defaultField=__REGION_VALUE_FIELD


gfsh> search lucene --name=indexOfStrings --region=/stringTestRegion 
      --queryString='__REGION_VALUE_FIELD:"my exact string"'
      --defaultField=__REGION_VALUE_FIELD

示例输出:

gfsh>search lucene --name=testIndex --region=/testRegion --queryString=value* 
   --defaultField=__REGION_VALUE_FIELD
key | value  | score
--- | ------ | -----
3   | value3 | 1
2   | value2 | 1
1   | value1 | 1
gfsh>search lucene --region=/Person --name=analyzerIndex 
   --defaultField=addr --queryString="97763"
 key   |                         value                                      | score
------ | ------------------------------------------------------------------ | --------
key763 | Person{name='Kris Cat', addr='7 Ash St, Portland_OR_97763', emai.. | 1.669657

set variable

在GFSH环境中设置变量。

设置命令可以使用的GFSH变量。

您可以使用echo命令查看变量的值。 例如，要查看所有环境变量及其当前值的列表，请使用以下命令：

gfsh>echo --string=$*

有关预设环境变量的说明，请参阅有用的gfsh Shell变量。

可用性: Online or offline.

句法:

set variable --name=value --value=value

Table 1. 设置变量的参数

示例命令:

set variable --name=APP_COLLECTION_LIMIT --value=10
set variable --name=FOO --value="foo"
set variable --name=BAR --value="bar"

示例输出:

gfsh>set variable --name=APP_COLLECTION_LIMIT --value=10
Value for variable APP_COLLECTION_LIMIT is now: 10.

gfsh>set variable --name=BAR --value="bar"
Value for variable BAR is now: "bar".

sh

执行操作系统命令。

执行操作系统（OS）命令。 使用＆立即返回gfsh提示符。

注意: 不支持将输出传递给另一个shell命令的命令。

句法:

sh command [--use-console(=value)?]

Table 1. Sh 参数

示例命令:

gfsh>sh ls -al
total 80
drwxrwxr-x. 10 username username  4096 Sep  3 15:10 .
drwxrwxr-x.  4 username username  4096 Sep  3 14:58 ..
drwx------.  2 username username  4096 Sep  3 15:09 bin
drwx------.  2 username username  4096 Sep  3 15:09 defaultConfigs
drwx------.  3 username username  4096 Sep  3 15:09 docs
drwx------.  2 username username  4096 Sep  3 15:09 dtd
-rwx------.  1 username username 31830 Sep  3 15:09 EULA.txt
drwx------.  2 username username  4096 Sep  3 15:09 lib
drwx------.  6 username username  4096 Sep  3 15:09 SampleCode
drwx------.  4 username username  4096 Sep  3 15:09 templates
drwx------.  5 username username  4096 Sep  3 15:09 tools

show

显示死锁，日志，指标和丢失的磁盘存储。

• show dead-locks

  显示群集中的所有死锁。

• show log

  显示成员的日志。

• show metrics

  显示或导出整个群集，成员或区域的度量标准。

• show missing-disk-stores

  显示群集中当前缺少的磁盘存储的摘要。

• show subscription-queue-size

  显示订阅队列中的事件数。

show dead-locks

显示群集中的所有死锁。

可用性: Online. 必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

show dead-locks --file=value

Table 1. 显示死锁参数

示例命令:

show dead-locks --file=deadlocks.txt

示例输出:

gfsh>show dead-locks --file=deadlocks.txt
No dead lock detected.

Please view the dependencies between the members in file : deadlocks.txt

show log

显示成员的日志。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

show log --member=value [--lines=value]

示例命令:

show log --member=locator1 --lines=5

示例输出:

gfsh>show log --member=locator1 --lines=5
SystemLog:
[info 2012/09/25 14:04:51.340 PDT locator1 <RMI TCP Connection(14)-192.0.2.0> tid=0x57] (tid=12 msgId=4) Parent region for "region1/subregion1" doesnt exi
st.

[info 2012/09/25 14:04:51.372 PDT locator1 <RMI TCP Connection(14)-192.0.2.0> tid=0x57] (tid=12 msgId=5) Error occurred while executing "create region --n
ame=region1/subregion1 --type=LOCAL".

[info 2012/09/25 15:14:34.314 PDT locator1 <RMI TCP Connection(159)-192.0.2.0> tid=0x68] (tid=13 msgId=6) Error occurred while executing "show log --membe
r=server1 --lines=5".

show metrics

显示或导出整个群集，成员或区域的度量标准。

如果未给出命令行参数，则会显示集群，缓存，磁盘库和查询类别下的度量标准。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

show metrics [--member=value] [--region=value] [--file=value]
[--port=value] [--categories=value(,value)*]

Table 3. 显示度量标准参数

示例命令:

// Metrics for the entire system
show metrics
// Metrics for a region:
show metrics --region=region1
// Metrics for a given member
show metrics --member=server1
// Metrics for a region on a member
show metrics --region=region1 --member=server1
//  Metrics for a member and the cacheserver it hosts
// NOTE: port option only work when used with --member option
show metrics --member=server1 --port=10334
// Export metrics for the entire system
show metrics --file=data/stats/system-stats.csv

示例输出:

gfsh>show metrics

Cluster-wide Metrics

  Type    |        Metric         | Value
--------- | --------------------- | -----
cluster   | totalHeapSize         | 123
cache     | totalRegionEntryCount | 0
          | totalRegionCount      | 0
          | totalMissCount        | 0
          | totalHitCount         | 0
diskstore | totalBytesOnDisk      | 0
          | diskReadsRate         | 0
          | diskWritesRate        | 0
          | flushTimeAvgLatency   | 0
          | totalBackupInProgress | 0
query     | queryRequestRate      | 0

show missing-disk-stores

显示群集中当前缺少的磁盘存储的摘要。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

show missing-disk-stores

示例命令:

show missing-disk-stores

示例输出:

gfsh> show missing-disk-stores

           Disk Store ID             |   Host    |               Directory
------------------------------------ | --------- | -------------------------------------
60399215-532b-406f-b81f-9b5bd8d1b55a | excalibur | /usr/local/gemfire/deploy/disk_store1

show subscription-queue-size

显示订阅队列中的事件数。

如果提供CQ名称，则它计算指定CQ的订阅队列中的事件数。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

show subscription-queue-size --durable-client-Id=value
 [--members=value(,value)*] [--groups=value(,value)*]

Table 4. 显示订阅 - 队列大小参数

示例命令:

show subscription-queue-size --durable-client-id=client1

示例输出:

gfsh>show subscription-queue-size --durable-client-Id=client1
member  | subcription-queue-size for durable-client : "client1".
------- | ------------------------------------------------------
server3 | 1
server4 | 0

错误消息:

gfsh>show subscription-queue-size --durable-client-Id=client1

No client found with client-id : client1
Occurred on members
1.server4
2.server1
3.server3

shutdown

停止所有成员。

要求所有具有缓存的成员关闭缓存并断开与系统的连接。 如果指定了--include-locators参数，则该命令将逐个关闭所有正在运行的定位符。 timeout参数允许您指定在超过时间后强制关闭系统。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

shutdown [--time-out=value] [--include-locators=value]

Table 1. 停止参数

示例命令:

shutdown
shutdown --time-out=15
shutdown --include-locators=true

示例输出:

gfsh>shutdown
"As a lot of data in memory will be lost, including possibly events in
queues, do you really want to shutdown the entire distributed system? (Y/n):"
Y
Shutdown is triggered

sleep

延迟gfsh命令执行。

以秒为单位延迟指定的时间 - 允许浮点值。

可用性: Online of offline.

句法:

sleep [--time=value]

Table 1. 延迟参数

示例命令:

sleep
sleep --time=60

示例输出:

gfsh>sleep --time=60

gfsh>

start

启动服务器，定位器，网关发送器和网关接收器以及监视工具。

• start gateway-receiver

  在给定成员或成员组上启动网关接收器。

• start gateway-sender

  在一个或多个成员上启动网关发件人。

• start jconsole

  在单独的进程中启动JDK JConsole监视应用程序。

• start jvisualvm

  在单独的进程中启动JDK的Java VisualVM监视应用程序。

• start locator

  启动定位器。

• start pulse

  在用户的默认系统浏览器中启动Geode Pulse监控仪表板工具，并将用户导航到登录页面（登录页面）。

• start server

  启动Geode缓存服务器进程。

start gateway-receiver

在给定成员或成员组上启动网关接收器。

请注意，每个成员只能有一个网关接收器，与网关发送器不同，您不需要为网关接收器指定标识符。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

start gateway-receiver [--groups=value(,value)*] [--members=value(,value)*]

参数，启动网关-接收器

示例命令:

start gateway-receiver
start gateway-receiver --members=member1

示例输出:

gfsh>start gateway-receiver
      Member                | Result | Message
--------------------------- | -------| -----------------------------------------------------------------------
pc13(2266)<v6>:56852        | OK     | GatewayReceiver is started on member pc13(2266)<v6>:56852
pc13(Manager:2242)<v5>:57631| Error  | GatewayReceiver is not available on member pc13(Manager:2242)<v5>:57631
pc13(2275)<v7>:47480        | OK     | GatewayReceiver is started on member pc13(2275)<v7>:47480
pc13(2293)<v8>:55472        | OK     | GatewayReceiver is started on member pc13(2293)<v8>:55472

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

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

start gateway-sender

在一个或多个成员上启动网关发件人。

有关如何配置网关发件人的信息，请参阅配置网关发件人。

注意: 默认情况下，网关发件人配置为自动启动。 手动重启会带来数据丢失的风险; 它不适用于生产系统。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

start gateway-sender --id=value [--groups=value(,value)*] [--members=value(,value)*]

参数，启动网关发件人

示例命令:

start gateway-sender --id=sender1-NY
start gateway-sender --id=sender1-NY --members=server1
start gateway-sender --id=sender1-NY --groups=MemberGroup1,MemberGroup2

示例输出:

gfsh>start gateway-sender --id=ln
 Member                       |  Result |                   Message
------------------------------| ------- | -------------------------------------------------------------------------
pc13(30614)<v6>:63670         | OK      | GatewaySender ln is started on member pc13(30614)<v6>:63670
pc13(30621)<v7>:36015         | OK      | GatewaySender ln is started on member pc13(30621)<v7>:36015
pc13(30633)<v8>:13633         | OK      | GatewaySender ln is started on member pc13(30633)<v8>:13633
pc13(Manager:30588)<v5>:42792 | Error   | GatewaySender ln is not available on member pc13(Manager:30588)<v5>:42792

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

start jconsole

在单独的进程中启动JDK JConsole监视应用程序。

JConsole会自动连接到正在运行的JMX Manager节点（如果有）。

请注意，您必须安装JDK（而不仅仅是JRE）并设置正确的PATH和JAVA_HOME环境变量。

有关将JConsole与Geode管理和监视系统一起使用的示例，请参阅通过JConsole浏览Geode MBean。

可用性: Online or offline.

句法:

start jconsole [--interval=<seconds>] [--notile] [--version]
[--J<jconsole JVM options>]

参数，启动jconsole

示例命令:

gfsh>start jconsole --interval=8 --notile;
Running JDK JConsole

gfsh>start jconsole --version;
JConsole version "1.8.0_31-b01-1"
Java(TM) SE Runtime Environment (build 1.8.0_31-b01-1-11)
Java HotSpot(TM) 64-Bit Server VM (build 20.6-b01-11, mixed mode)

示例输出:

gfsh>start jconsole
Running JDK JConsole

JConsole应用程序出现并自动连接到JMX Manager节点（如果有）：

错误消息:

An error occurred while launching JConsole = %1$s

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

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

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

start jvisualvm

在单独的进程中启动JDK的Java VisualVM监视应用程序。

可用性: Online or offline.

句法:

start jvisualvm [--J=value(,value)*]

参数，启动jvisualvm

示例命令:

start jvisualvm

示例输出:

start locator

启动定位器。

该命令创建一个以定位符命名的子目录和日志文件。 如果定位器检测到不存在其他JMX Manager，则定位器将自动启动嵌入式JMX Manager并将当前的gfsh会话连接到JMX Manager。

注意: 在启动gfsh之前必须设置JAVA_HOME才能使用此命令。

此外，如果gfsh尚未连接到JMX Manager，则gfsh控制台将自动连接到由新定位器启动的新嵌入式JMX Manager。

注意: 当在定位器启动期间指定--max-heap和--initial-heap时，Geode的资源管理器在内部指定其他GC参数。 如果您不希望资源管理器设置其他默认GC属性，请使用-Xms和-Xmx JVM选项。 有关详细信息，请参阅使用资源管理器控制堆使用。

可用性: Online or offline.

句法:

start locator --name=value [--bind-address=value] [--force(=value)]
 [--groups=value(,value)*] [--hostname-for-clients=value]
 [--locators=value] [--log-level=value] [--mcast-address=value] [--mcast-port=value] [--port=value] [--dir=value]
 [--properties-file=value] [--security-properties-file=value] [--initial-heap=value] [--max-heap=value]
 [--connect(=value)] [--enable-cluster-configuration(=value)] [--load-cluster-configuration-from-dir(=value)]
 [--cluster-config-dir=value] [--redirect-output(=value)]
 [--http-service-port=value] [--http-service-bind-address=value] 
 [--J=value(,value)*]

参数，启动定位器

示例命令:

start locator --name=locator1

start pulse

在用户的默认系统浏览器中启动Geode Pulse监控仪表板工具，并将用户导航到登录页面（登录页面）。

有关Geode Pulse的更多信息，请参阅Geode Pulse。

可用性: Online or offline.

句法:

start pulse [--url=value]

参数，启动pulse

示例命令:

start pulse
start pulse --url=http://gemfire.example.com:7070/pulse

示例输出: 有关Pulse的示例，请参阅Geode Pulse。

start server

启动Geode缓存服务器进程。

注意: 如果在服务器启动期间指定了--max-heap和--initial-heap，则会代表您指定其他GC参数。 如果您不希望设置其他默认GC属性，则使用-Xms和-Xmx JVM选项来设置这些参数。 有关详细信息，请参阅使用资源管理器控制堆使用。

可用性: Online or offline.

句法:

start server --name=value [--assign-buckets(=value)] [--bind-address=value]
    [--cache-xml-file=value] [--classpath=value] [--disable-default-server(=value)]
    [--disable-exit-when-out-of-memory(=value)] [--enable-time-statistics(=value)]
    [--force(=value)] [--include-system-classpath(=value)] [--properties-file=value]
    [--security-properties-file=value] [--groups=value(,value)*]
    [--locators=value] [--locator-wait-time=value] [--log-level=value]
    [--mcast-address=value] [--mcast-port=value] [--memcached-port=value]
    [--memcached-protocol=value] [--rebalance(=value)] [--server-bind-address=value]
    [--server-port=value] [--spring-xml-location=value]
    [--statistic-archive-file=value] [--dir=value] [--initial-heap=value]
    [--max-heap=value] [--use-cluster-configuration(=value)] [--J=value(,value)*]
    [--critical-heap-percentage=value] [--critical-off-heap-percentage=value]
    [--eviction-heap-percentage=value] [--eviction-off-heap-percentage=value]
    [--hostname-for-clients=value] [--max-connections=value]
    [--message-time-to-live=value] [--max-message-count=value] [--max-threads=value]
    [--socket-buffer-size=value] [--lock-memory=value] [--off-heap-memory-size=value]
    [--start-rest-api=value] [--redirect-output(=value)]
    [--http-service-port=value] [--http-service-bind-address=value]
    [--user=value] [--password=value]

参数，启动服务器

例子

gfsh>start server --name=server1
gfsh>start server --name=server2 --server-port=40405

status

检查群集配置服务和Geode成员进程的状态，包括定位器，网关接收器，网关发件人和服务器。

• status cluster-config-service

  显示集群配置服务的状态。

• status gateway-receiver

  显示指定网关接收器的状态。

• status gateway-sender

  显示指定网关发件人的状态。

• status locator

  显示指定定位器的状态。

• status server

  显示指定的Geode缓存服务器的状态。

status cluster-config-service

显示集群配置服务的状态。

显示enable-cluster-configuration设置为true的所有定位器上的集群配置服务的状态。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

status cluster-config-service

示例命令:

status cluster-config-service

示例输出:

gfsh>status cluster-config-service
Status of shared configuration on locators

  Name   | Status
-------- | -------
locator8 | RUNNING

status gateway-receiver

显示指定网关接收器的状态。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

status gateway-receiver [--groups=value(,value)*] [--members=value(,value)*]

Table 1. 状态网关 - 接收器参数

示例命令:

status gateway-receiver --groups=LN-Group1
status gateway-receiver --members=server1

示例输出:

gfsh>status gateway-receiver
Member               | Port  | Status
---------------------| ------| -------
pc13(8151)<v2>:26518 | 26837 | Running
pc13(8175)<v4>:53787 | 23753 | Running
pc13(8164)<v3>:24081 | 25457 | Running

Member                       | Error
-----------------------------| ---------------------------------------------------
pc13(Manager:8124)<v1>:52410 | GatewayReceiver is not available or already stopped
pc13(8130):8180              | GatewayReceiver is not available or already stopped


gfsh>status gateway-receiver --members=pc13(8151)<v2>:50130
Member               | Port  |  Status
-------------------- | ----- | --------
pc13(8151)<v2>:50130 | 28592 | Running

gfsh>status gateway-receiver --group=RG1
Member                 | Port  | Status
-----------------------| ------| -------
pc13(8151)<v2>:19450   | 27815 | Running
pc13(8175)<v4>:14139   | 27066 | Running
pc13(8164)<v3>:45150   | 29897 | Running

status gateway-sender

显示指定网关发件人的状态。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

status gateway-sender --id=value [--groups=value(,value)*]
[--members=value(,value)*]

Table 2. 状态网关 - 发件人参数

示例命令:

status gateway-receiver receiver1-LN --groups=LN-Group1;

示例输出:

gfsh>status gateway-sender --id=ln_Serial
Member                 |  Type  | Runtime Policy | Status
-----------------------| -------| -------------- | -----------
 pc13(8175)<v4>:21449  | Serial | Secondary      | Not Running
 pc13(8151)<v2>:40761  | Serial | Secondary      | Not Running
 pc13(8164)<v3>:33476  | Serial | Secondary      | Not Running

Member                         | Error
------------------------------ | ------------------------------
 pc13(8130):2365               | GatewaySender is not available
 pc13(Manager:8124)<v1>:43821  | GatewaySender is not available

gfsh>status gateway-sender --id=ln_Serial --members=pc13(8151)<v2>:7411
Member               |  Type  | Runtime Policy | Status
-------------------  | ------ | -------------- | -----------
 pc13(8151)<v2>:7411 | Serial | Secondary      | Not Running

gfsh>status gateway-sender --id=ln_Serial --members=pc13(8151)<v2>:7411
Member               |  Type  | Runtime Policy | Status
------------------- -| ------ | -------------- | -------
 pc13(8151)<v2>:7411 | Serial | Primary        | Running

gfsh>status gateway-sender --id=ln_Serial --groups=Serial_Sender
==>
Member                 |  Type  | Runtime Policy | Status
---------------------- | -------| -------------- | -----------
 pc13(8151)<v2>:44396  | Serial | Secondary      | Not Running
 pc13(8164)<v3>:29475  | Serial | Secondary      | Not Running
Member                 | Error
---------------------- | ------------------------------
 pc13(8186)<v5>:45840  | GatewaySender is not available

status locator

显示指定定位器的状态。

状态将是以下之一：

• started
• online
• offline
• not responding

可用性: Online or offline. 如果要在脱机时获取定位器的状态，请使用--dir选项。

句法:

status locator [--name=value] [--host=value] [--port=value] [--dir=value]

Table 3. 状态定位器参数

示例命令:

status locator
status locator --name=locator1

status server

显示指定的Geode缓存服务器的状态。

可用性: Online or offline. 如果要在脱机时获取服务器的状态，请使用--dir选项。

句法:

status server [--name=value] [--dir=value]

Table 4. 状态服务器参数

示例命令:

status server
status server --name=server1

stop

停止网关接收器，网关发送器，定位器和服务器。

• stop gateway-receiver

  停止一个或多个成员的网关接收器。

• stop gateway-sender

  停止指定成员或指定成员组成员上具有给定ID的网关发件人。

• stop locator

  停止定位器。

• stop server

  停止Geode缓存服务器。

stop gateway-receiver

停止一个或多个成员的网关接收器。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

stop gateway-receiver [--groups=value(,value)*] [--members=value(,value)*]

Table 1. 停止网关 - 接收器参数

示例命令:

stop gateway-receiver --members=receiver1-LN 
stop gateway-receiver --groups=LN-Group1

示例输出:

gfsh>stop gateway-receiver
      Member                | Result | Message
--------------------------- | -------| -----------------------------------------------------------------------
pc13(2266)<v6>:56852        | OK     | GatewayReceiver is stopped on member pc13(2266)<v6>:56852
pc13(Manager:2242)<v5>:57631| Error  | GatewayReceiver is not available on member pc13(Manager:2242)<v5>:57631
pc13(2275)<v7>:47480        | OK     | GatewayReceiver is stopped on member pc13(2275)<v7>:47480
pc13(2293)<v8>:55472        | OK     | GatewayReceiver is stopped on member pc13(2293)<v8>:55472

gfsh>stop gateway-receiver --members=pc13(2266)<v14>:36579
GatewayReceiver is stopped on member pc13(2266)<v14>:36579

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

stop gateway-sender

停止指定成员或指定成员组成员上具有给定ID的网关发件人。

警告: 在并行网关发件人上使用stop gateway-sender命令（或等效的GatewaySender.stop()API）要小心。 我们建议关闭整个成员，以确保将分区区域事件正确地故障转移到其他网关发件人成员，而不是在成员上停止单个并行网关发件人。 在单个并行网关上使用此命令发送方可能在事件丢失时发生。 有关详细信息，请参阅停止网关发件人。

可用性: Online. 您必须在gfsh中连接到JMX Manager成员才能使用此命令。

句法:

stop gateway-sender --id=value [--groups=value(,value)*] [--members=value(,value)*]

Table 2. 停止网关 - 发件人参数

示例命令:

stop gateway-sender --id=ln --members=server1

示例输出:

gfsh>stop gateway-sender --id=ln
Member                       | Result | Message
---------------------------- | ------ | ------------------------------------------------------------------------
pc13(5184)<v7>:41914         | OK     | GatewaySender ln is stopped on member pc13(5184)<v7>:41914
pc13(5192)<v8>:25704         | OK     | GatewaySender ln is stopped on member pc13(5192)<v8>:25704
pc13(5174)<v6>:53996         | OK     | GatewaySender ln is stopped on member pc13(5174)<v6>:53996
pc13(Manager:5148)<v5>:64040 | Error  | GatewaySender ln is not available on member pc13(Manager:5148)<v5>:64040

gfsh>stop gateway-sender --id=ln --members=pc13(5174)<v14>:17819
GatewaySender ln is stopped on member pc13(5174)<v14>:17819

gfsh>stop gateway-sender --id=ln --groups=SenderGroup1

Member                | Result | Message
--------------------- | ------ | -----------------------------------------------------------
pc13(5174)<v18>:63332 | OK     | GatewaySender ln is stopped on member pc13(5174)<v18>:63332
pc13(5184)<v19>:20055 | OK     | GatewaySender ln is stopped on member pc13(5184)<v19>:20055
pc13(5192)<v20>:14622 | OK     | GatewaySender ln is stopped on member pc13(5192)<v20>:14622

stop locator

停止定位器。

注意: 必须指定命令行选项之一--name或--dir以标识要停止的定位符。

可用性: Online or offline. 如果要在脱机时停止定位器，请使用--dir选项。

句法: