osnadmin channel

The osnadmin channel command allows administrators to perform channel-related operations on an orderer, such as joining a channel, listing the channels an orderer has joined, and removing a channel. The channel participation API must be enabled and the Admin endpoint must be configured in the orderer.yaml for each orderer.

*Note: For a network using a system channel, list (for all channels) and remove (for the system channel) are the only supported operations. Any other attempted operation will return an error.

Syntax

The osnadmin channel command has the following subcommands:

  • join

  • list

  • remove

osnadmin channel

  1. usage: osnadmin channel <command> [<args> ...]
  3. Channel actions
  5. Flags:
  6.       --help                     Show context-sensitive help (also try
  7.                                  --help-long and --help-man).
  8.   -o, --orderer-address=ORDERER-ADDRESS
  9.                                  Admin endpoint of the OSN
  10.       --ca-file=CA-FILE          Path to file containing PEM-encoded TLS CA
  11.                                  certificate(s) for the OSN
  12.       --client-cert=CLIENT-CERT  Path to file containing PEM-encoded X509 public
  13.                                  key to use for mutual TLS communication with
  14.                                  the OSN
  15.       --client-key=CLIENT-KEY    Path to file containing PEM-encoded private key
  16.                                  to use for mutual TLS communication with the
  17.                                  OSN
  18.       --no-status                Remove the HTTP status message from the command
  19.                                  output
  21. Subcommands:
  22.   channel join --channelID=CHANNELID --config-block=CONFIG-BLOCK
  23.     Join an Ordering Service Node (OSN) to a channel. If the channel does not
  24.     yet exist, it will be created.
  26.   channel list [<flags>]
  27.     List channel information for an Ordering Service Node (OSN). If the
  28.     channelID flag is set, more detailed information will be provided for that
  29.     channel.
  31.   channel remove --channelID=CHANNELID
  32.     Remove a channel from an Ordering Service Node (OSN).

osnadmin channel join

  1. usage: osnadmin channel join --channelID=CHANNELID --config-block=CONFIG-BLOCK
  3. Join an Ordering Service Node (OSN) to a channel. If the channel does not yet
  4. exist, it will be created.
  6. Flags:
  7.       --help                     Show context-sensitive help (also try
  8.                                  --help-long and --help-man).
  9.   -o, --orderer-address=ORDERER-ADDRESS
  10.                                  Admin endpoint of the OSN
  11.       --ca-file=CA-FILE          Path to file containing PEM-encoded TLS CA
  12.                                  certificate(s) for the OSN
  13.       --client-cert=CLIENT-CERT  Path to file containing PEM-encoded X509 public
  14.                                  key to use for mutual TLS communication with
  15.                                  the OSN
  16.       --client-key=CLIENT-KEY    Path to file containing PEM-encoded private key
  17.                                  to use for mutual TLS communication with the
  18.                                  OSN
  19.       --no-status                Remove the HTTP status message from the command
  20.                                  output
  21.   -c, --channelID=CHANNELID      Channel ID
  22.   -b, --config-block=CONFIG-BLOCK
  23.                                  Path to the file containing an up-to-date
  24.                                  config block for the channel

osnadmin channel list

  1. usage: osnadmin channel list [<flags>]
  3. List channel information for an Ordering Service Node (OSN). If the channelID
  4. flag is set, more detailed information will be provided for that channel.
  6. Flags:
  7.       --help                     Show context-sensitive help (also try
  8.                                  --help-long and --help-man).
  9.   -o, --orderer-address=ORDERER-ADDRESS
  10.                                  Admin endpoint of the OSN
  11.       --ca-file=CA-FILE          Path to file containing PEM-encoded TLS CA
  12.                                  certificate(s) for the OSN
  13.       --client-cert=CLIENT-CERT  Path to file containing PEM-encoded X509 public
  14.                                  key to use for mutual TLS communication with
  15.                                  the OSN
  16.       --client-key=CLIENT-KEY    Path to file containing PEM-encoded private key
  17.                                  to use for mutual TLS communication with the
  18.                                  OSN
  19.       --no-status                Remove the HTTP status message from the command
  20.                                  output
  21.   -c, --channelID=CHANNELID      Channel ID

osnadmin channel remove

  1. usage: osnadmin channel remove --channelID=CHANNELID
  3. Remove a channel from an Ordering Service Node (OSN).
  5. Flags:
  6.       --help                     Show context-sensitive help (also try
  7.                                  --help-long and --help-man).
  8.   -o, --orderer-address=ORDERER-ADDRESS
  9.                                  Admin endpoint of the OSN
  10.       --ca-file=CA-FILE          Path to file containing PEM-encoded TLS CA
  11.                                  certificate(s) for the OSN
  12.       --client-cert=CLIENT-CERT  Path to file containing PEM-encoded X509 public
  13.                                  key to use for mutual TLS communication with
  14.                                  the OSN
  15.       --client-key=CLIENT-KEY    Path to file containing PEM-encoded private key
  16.                                  to use for mutual TLS communication with the
  17.                                  OSN
  18.       --no-status                Remove the HTTP status message from the command
  19.                                  output
  20.   -c, --channelID=CHANNELID      Channel ID

Example Usage

osnadmin channel join examples

Here’s an example of the osnadmin channel join command.

  • Create and join a sample channel mychannel defined by the application channel genesis block contained in file mychannel-genesis-block.pb. Use the orderer admin endpoint at orderer.example.com:9443.

    2. osnadmin channel join -o orderer.example.com:9443 --ca-file $CA_FILE --client-cert $CLIENT_CERT --client-key $CLIENT_KEY --channelID mychannel --config-block mychannel-genesis-block.pb
    4. Status: 201
    5. {
    6.   "name": "mychannel",
    7.   "url": "/participation/v1/channels/mychannel",
    8.   "consensusRelation": "consenter",
    9.   "status": "active",
    10.   "height": 1
    11. }

    Status 201 and the channel details are returned indicating that the channel has been successfully created and joined.

osnadmin channel list example

Here are some examples of the osnadmin channel list command.

  • Listing all the channels that the orderer has joined. This includes the system channel (if one exists) and all of the application channels.

    1. osnadmin channel list -o orderer.example.com:9443 --ca-file $CA_FILE --client-cert $CLIENT_CERT --client-key $CLIENT_KEY
    3. Status: 200
    4. {
    5.   "systemChannel": null,
    6.   "channels": [
    7.       {
    8.           "name": "mychannel",
    9.           "url": "/participation/v1/channels/mychannel"
    10.       }
    11.   ]
    12. }

    Status 200 and the list of channels are returned.

  • Using the --channelID flag to list more details for mychannel.

    1. osnadmin channel list -o orderer.example.com:9443 --ca-file $CA_FILE --client-cert $CLIENT_CERT --client-key $CLIENT_KEY --channelID mychannel
    3. Status: 200
    4. {
    5.   "name": "mychannel",
    6.   "url": "/participation/v1/channels/mychannel",
    7.   "consensusRelation": "consenter",
    8.   "status": "active",
    9.   "height": 3
    10. }

    Status 200 and the details of the channels are returned.

osnadmin channel remove example

Here’s an example of the osnadmin channel remove command.

  • Removing channel mychannel from the orderer at orderer.example.com:9443.

    1. osnadmin channel remove -o orderer.example.com:9443 --ca-file $CA_FILE --client-cert $CLIENT_CERT --client-key $CLIENT_KEY --channelID mychannel
    3. Status: 204

    Status 204 is returned upon successful removal of a channel.

Creative Commons License
This work is licensed under a Creative Commons Attribution 4.0 International License.