fabric-docs-i18n icon indicating copy to clipboard operation
fabric-docs-i18n copied to clipboard

[ja_JP] Commands Reference / peer channel

Open shimos opened this issue 2 years ago • 0 comments

Original HTML: https://hyperledger-fabric.readthedocs.io/en/release-2.5/commands/peerchannel.html Original Source: https://github.com/hyperledger/fabric/blob/e1e8e2e52aa4fc543360d245fe6554a0eaf81183/docs/source/commands/peerchannel.md

diff --git a/docs/source/commands/peerchannel.md b/docs/source/commands/peerchannel.md
index 497a37a5e..cefcacb73 100644
--- a/docs/source/commands/peerchannel.md
+++ b/docs/source/commands/peerchannel.md
@@ -1,3 +1,8 @@
+<!---
+ File generated by help_docs.sh. DO NOT EDIT.
+ Please make changes to preamble and postscript wrappers as appropriate.
+ --->
+
 # peer channel
 
 The `peer channel` command allows administrators to perform channel related
@@ -12,25 +17,29 @@ The `peer channel` command has the following subcommands:
   * fetch
   * getinfo
   * join
+  * joinbysnapshot
+  * joinbysnapshotstatus
   * list
   * signconfigtx
   * update
 
 ## peer channel
 ```
-Operate a channel: create|fetch|join|list|update|signconfigtx|getinfo.
+Operate a channel: create|fetch|join|joinbysnapshot|joinbysnapshotstatus|list|update|signconfigtx|getinfo.
 
 Usage:
   peer channel [command]
 
 Available Commands:
-  create       Create a channel
-  fetch        Fetch a block
-  getinfo      get blockchain information of a specified channel.
-  join         Joins the peer to a channel.
-  list         List of channels peer has joined.
-  signconfigtx Signs a configtx update.
-  update       Send a configtx update.
+  create               Create a channel
+  fetch                Fetch a block
+  getinfo              get blockchain information of a specified channel.
+  join                 Joins the peer to a channel.
+  joinbysnapshot       Joins the peer to a channel by the specified snapshot
+  joinbysnapshotstatus Query if joinbysnapshot is running for any channel
+  list                 List of channels peer has joined.
+  signconfigtx         Signs a configtx update.
+  update               Send a configtx update.
 
 Flags:
       --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
@@ -148,6 +157,53 @@ Global Flags:
 ```
 
 
+## peer channel joinbysnapshot
+```
+Joins the peer to a channel by the specified snapshot
+
+Usage:
+  peer channel joinbysnapshot [flags]
+
+Flags:
+  -h, --help                  help for joinbysnapshot
+      --snapshotpath string   Path to the snapshot directory
+
+Global Flags:
+      --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
+      --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
+      --clientauth                          Use mutual TLS when communicating with the orderer endpoint
+      --connTimeout duration                Timeout for client to connect (default 3s)
+      --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
+  -o, --orderer string                      Ordering service endpoint
+      --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
+      --tls                                 Use TLS when communicating with the orderer endpoint
+      --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint
+```
+
+
+## peer channel joinbysnapshotstatus
+```
+Query if joinbysnapshot is running for any channel
+
+Usage:
+  peer channel joinbysnapshotstatus [flags]
+
+Flags:
+  -h, --help   help for joinbysnapshotstatus
+
+Global Flags:
+      --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
+      --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
+      --clientauth                          Use mutual TLS when communicating with the orderer endpoint
+      --connTimeout duration                Timeout for client to connect (default 3s)
+      --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
+  -o, --orderer string                      Ordering service endpoint
+      --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
+      --tls                                 Use TLS when communicating with the orderer endpoint
+      --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint
+```
+
+
 ## peer channel list
 ```
 List of channels peer has joined.
@@ -358,6 +414,52 @@ Here's an example of the `peer channel join` command.
 
   You can see that the peer has successfully made a request to join the channel.
 
+### peer channel joinbysnapshot example
+
+Here's an example of the `peer channel joinbysnapshot` command.
+
+* Join a peer to the channel from a snapshot identified by the directory
+  `/snapshots/completed/testchannel/1000`. The snapshot was previously created on a different peer.
+
+  ```
+  peer channel joinbysnapshot --snapshotpath /snapshots/completed/testchannel/1000
+
+  2020-10-12 11:41:45.442 EDT [channelCmd] InitCmdFactory -> INFO 001 Endorser and orderer connections initialized
+  2020-10-12 11:41:45.444 EDT [channelCmd] executeJoin -> INFO 002 Successfully submitted proposal to join channel
+  2020-10-12 11:41:45.444 EDT [channelCmd] joinBySnapshot -> INFO 003 The joinbysnapshot operation is in progress. Use "peer channel joinbysnapshotstatus" to check the status.
+
+  ```
+
+  You can see that the peer has successfully made a request to join the channel from the specified snapshot.
+  When a `joinbysnapshot` operation is in progress, you cannot run another `peer channel join`
+  or `peer channel joinbysnapshot` simultaneously. To know whether or not a joinbysnapshot operation is in progress,
+  you can call the `peer channel joinbysnapshotstatus` command.
+
+
+### peer channel joinbysnapshotstatus example
+
+Here are some examples of the `peer channel joinbysnapshotstatus` command.
+
+* Query if joinbysnapshot is in progress for any channel. If yes,
+  it returns a message indicating a joinbysnapshot operation is in progress.
+
+  ```
+  peer channel joinbysnapshotstatus
+
+  2020-10-12 11:41:45.952 EDT [channelCmd] InitCmdFactory -> INFO 001 Endorser and orderer connections initialized
+  A joinbysnapshot operation is in progress for snapshot at /snapshots/completed/testchannel/1000
+  ```
+
+* If no `joinbysnapshot` operation is in progress, it returns a message indicating no joinbysnapshot operation is in progress.
+
+  ```
+  peer channel joinbysnapshotstatus
+
+  2020-10-12 11:41:47.922 EDT [channelCmd] InitCmdFactory -> INFO 001 Endorser and orderer connections initialized
+  No joinbysnapshot operation is in progress
+
+  ```
+
 ### peer channel list example
 
   Here's an example of the `peer channel list` command.

shimos avatar Sep 28 '23 00:09 shimos