export
Export configurations, data, logs and stack-traces.
-
Exports a cluster configuration zip file that contains the
cache.xmlfiles,gemfire.propertiesfiles, and application jar files needed to configure and operate a Geode distributed system. -
Export configuration properties for a member or members.
-
Export user data from a region to a file.
-
Export logs to a given directory.
-
Export region data from an offline disk store into gemfire snapshot files.
-
Export the stack trace for a member or members.
export cluster-configuration
Exports a cluster configuration zip file that contains the cache.xml files, gemfire.properties files, and application jar files needed to configure and operate a Geode distributed system.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
See Overview of the Cluster Configuration Service.
Syntax:
export cluster-configuration --zip-file-name=value [--dir=value]
| Name | Description | Default Value |
|---|---|---|
| \-\-zip-file-name | Required. File name of the zip file to contain the exported cluster configuration. | |
| \-\-dir | Directory where the cluster configuration zip files is saved. | Locator directory |
Table 1. Export Cluster-Configuration Parameters
Example Commands:
gfsh>export cluster-configuration --zip-file-name=/home/username/gemfire80/myClusterConfig.zip
Sample Output:
gfsh>export cluster-configuration --zip-file-name=mySharedConfig.zip
Downloading cluster configuration : /home/username/gemfire80/myClusterConfig.zip
export config
Export configuration properties for a member or members.
If you do not specify any parameters, all member configuration will be exported.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
export config [--member=value(,value)*] [--group=value(,value)*]
[--dir=value]
| Name | Description |
|---|---|
| \-\-member | Name/Id of the member(s) whose configuration will be exported. |
| \-\-group | Group(s) of members whose configuration will be exported. |
| \-\-dir | Directory to which the exported configuration files will be written. |
Table 2. Export Config Parameters
Example Commands:
export config
export config --member=member1
Sample Output:
gfsh>export config --member=member1
Downloading Cache XML file: c:\PivotalGemFire70\Latest\.\member1-cache.xml
Downloading properties file: c:\PivotalGemFire70\Latest\.\member1-gf.properties
export data
Export user data from a region to a file.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
export data --region=value --file=value --member=value
| Name | Description |
|---|---|
| \-\-region | Required. Region from which data is to be exported. |
| \-\-file | Required. File to which the exported data is to be written. The file must have an extension of .gfd. |
| ‑‑member | Required. Name/Id of a member that hosts the region. The data will be exported to the specified file on the host where the member is running. |
Table 3. Export Data Parameters
Example Commands:
export data --region=region2 --file=region2_20121001.gfd --member=server2
Sample Output:
gfsh>export data --region=region2 --file=region2_20121001.gfd --member=server1
Data succesfully exported from region : region2 to file : C:\PivotalGemFire70\
Latest\server1\region2_20121001.gfd on host : 192.0.2.0
export logs
Export logs to a given directory.
All files that have logs in the specified time range will be exported. If no time range is specified, all logs will be exported.
The --dir parameter specifies a local directory to which log files will be written. This is used only when you are exporting logs using an http connection. If executed over http, the zip archive will be saved in the specified directory on the user's client machine. If not specified, logs are written to the location specified by the user.dir system property. When the command is executed over JMX, logs will be saved as exportedlogs_xxx.zip in the connected locator's working directory.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
export logs [--dir=value] [--group=value(,value)*] [--member=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)?]
| Name | Description | Default Value |
|---|---|---|
| \-\-dir | Local directory to which log files will be written when logs are exported using an http connection. Ignored when the command is executed over JMX. | |
| \-\-group | Group of members whose log files will be exported. | |
| ‑‑member | Name/ID of the member whose log files will be exported. | |
| \-\-log-level | Minimum level of log entries to export. Valid values are: OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, and ALL. |
INFO |
| \-\-only-log-level | Whether to only include only entries that exactly match the \-\-log-level specified. | false |
| ‑‑merge‑log | Whether to merge logs after exporting to the target directory (deprecated). | false |
| \-\-start-time | Log entries that occurred after this time will be exported. Format: yyyy/MM/dd/HH/mm/ss/SSS/z OR yyyy/MM/dd | no limit |
| \-\-end-time | Log entries that occurred before this time will be exported. Format: yyyy/MM/dd/HH/mm/ss/SSS/z OR yyyy/MM/dd | no limit |
| \-\-logs-only | Whether to export only logs (not statistics) | If parameter not specified: false. If parameter specified without a value: true |
| \-\-stats-only | Whether to export only statistics (not logs) | If parameter not specified: false. If parameter specified without a value: true |
| \-\-file-size-limit | Limits total unzipped size of the exported files. Specify 0 (zero) for no limit. Value is in megabytes by default or [k,m,g,t] may be specified. | If parameter not specified: 100m. If parameter specified without a value: 0 |
Table 4. Export Logs Parameters
Example commands, showing output:
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
Export region data from an offline disk store into gemfire snapshot files.
Availability: Online or offline.
Syntax:
export offline-disk-store --name=value --disk-dirs=value(,value)* --dir=value
| Name | Description |
|---|---|
| \-\-name | Required. Name of the disk store to be exported. |
| \-\-disk-dirs | Directories which contain the disk store files. |
| \-\-dir | Directory to export the snapshot files to. |
Table 5. Export Offline-Disk-Store Parameters
Example Commands:
export offline-disk-store --name= DiskStore1 \
--disk-dirs=/home/username/gemfire/mydiskStore1Dir --dir=/home/username/gemfire/export
export stack-traces
Export the stack trace for a member or members.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
export stack-traces --file=value [--member=value] [--group=value]
| Name | Description |
|---|---|
| \-\-file | Required. Filename to which the stack-traces will be written. |
| \-\-member | Name or ID of the member whose log files will be exported. |
| \-\-group | Group of members whose log files will be exported. |
Table 6. Export Stack-Traces Parameters
Example Commands:
export stack-traces --file=stack.txt
Sample Output:
gfsh>export stack-traces --file=stack.txt
stack-trace(s) exported to file: C:\PivotalGemFire70\Latest\locator1\stack.txt
On host : GemFireStymon