Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 25A29200BA5 for ; Wed, 5 Oct 2016 02:09:48 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 2422F160AE8; Wed, 5 Oct 2016 00:09:48 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 193D6160ADC for ; Wed, 5 Oct 2016 02:09:46 +0200 (CEST) Received: (qmail 81556 invoked by uid 500); 5 Oct 2016 00:09:46 -0000 Mailing-List: contact commits-help@geode.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.incubator.apache.org Delivered-To: mailing list commits@geode.incubator.apache.org Received: (qmail 81547 invoked by uid 99); 5 Oct 2016 00:09:46 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 05 Oct 2016 00:09:46 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id E03CEC1E84 for ; Wed, 5 Oct 2016 00:09:45 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -5.969 X-Spam-Level: X-Spam-Status: No, score=-5.969 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, KAM_LOTSOFHASH=0.25, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-2.999] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id J7Eduhc381DP for ; Wed, 5 Oct 2016 00:09:44 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id 059BA5F4EC for ; Wed, 5 Oct 2016 00:09:43 +0000 (UTC) Received: (qmail 81334 invoked by uid 99); 5 Oct 2016 00:09:43 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 05 Oct 2016 00:09:43 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 658D7DFC55; Wed, 5 Oct 2016 00:09:43 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: dbarnes@apache.org To: commits@geode.incubator.apache.org Date: Wed, 05 Oct 2016 00:09:43 -0000 Message-Id: X-Mailer: ASF-Git Admin Mailer Subject: [01/51] [partial] incubator-geode git commit: GEODE-1964: native client documentation (note: contains references to images in the geode-docs directories) archived-at: Wed, 05 Oct 2016 00:09:48 -0000 Repository: incubator-geode Updated Branches: refs/heads/feature/GEODE-1964 [created] ff80a9315 http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb deleted file mode 100644 index a7e1e16..0000000 --- a/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb +++ /dev/null @@ -1,254 +0,0 @@ ---- -title: export ---- - - - -Export configurations, data, logs and stack-traces. - -- **[export cluster-configuration](../../../tools_modules/gfsh/command-pages/export.html#topic_mdv_jgz_ck)** - - 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. - -- **[export config](../../../tools_modules/gfsh/command-pages/export.html#topic_C7C69306F93743459E65D46537F4A1EE)** - - Export configuration properties for a member or members. - -- **[export data](../../../tools_modules/gfsh/command-pages/export.html#topic_263B70069BFC4A7185F86B3272011734)** - - Export user data from a region to a file. - -- **[export logs](../../../tools_modules/gfsh/command-pages/export.html#topic_B80978CC659244AE91E2B8CE56EBDFE3)** - - Export logs to a given directory. - -- **[export offline-disk-store](../../../tools_modules/gfsh/command-pages/export.html#topic_sjg_bvt_gq)** - - Export region data from an offline disk store into gemfire snapshot files. - -- **[export stack-traces](../../../tools_modules/gfsh/command-pages/export.html#topic_195D27B8B2B64A4E84CF2256636D54BD)** - - 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](../../../configuring/cluster_config/gfsh_persist.html#concept_r22_hyw_bl). - -**Syntax:** - -``` pre -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:** - -``` pre -gfsh>export cluster-configuration --zip-file-name=/home/username/gemfire80/myClusterConfig.zip -``` - -**Sample Output:** - -``` pre -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:** - -``` pre -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:** - -``` pre -export config -export config --member=member1 -``` - -**Sample Output:** - -``` pre -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:** - -``` pre -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:** - -``` pre -export data --region=region2 --file=region2_20121001.gfd --member=server2 - -``` - -**Sample Output:** - -``` pre - 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. - -**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command. - -**Syntax:** - -``` pre -export logs --dir=value [--group=value(,value)*] [--member=value] [--log --level=value] [--only-log-level=value] [--merge-log=value] [--start-time=value] -[--end-time=value] -``` - - - -| Name | Description | Default Value | -|--------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------| -| \\-\\-dir | *Required.* Directory to which log files will be written. |   | -| \\-\\-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: `none`, `error`, `info`, `config`, `fine`, `finer` and `finest`. | `info` | -| \\-\\-only-log-level | Whether to only include those entries that exactly match the \\-\\-log-level specified. | false | -| ‑‑merge‑log | Whether to merge logs after exporting to the target directory. | 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 | - -Table 4. Export Logs Parameters - -**Example Commands:** - -``` pre -export logs --dir=data/logs -``` - -**Sample Output:** - -``` pre -gfsh>export logs --dir=data/logs -Successfully exported to directory data/logs -``` - -## export offline-disk-store - -Export region data from an offline disk store into gemfire snapshot files. - -**Availability:** Online or offline. - -**Syntax:** - -``` pre -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:** - -``` pre - 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:** - -``` pre -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:** - -``` pre -export stack-traces --file=stack.txt -``` - -**Sample Output:** - -``` pre -gfsh>export stack-traces --file=stack.txt -stack-trace(s) exported to file: C:\PivotalGemFire70\Latest\locator1\stack.txt -On host : GemFireStymon -```