/ home / hyperledger_labs / hyperledger_labs.fabric_ansible_collection / 2.0.0 / module / channel_parameters

hyperledger_labs.fabric_ansible_collection.channel_parameters (2.0.0) — module

Manage the parameters for a Hyperledger Fabric channel

Authors: Simon Stone (@sstone1)

preview | supported by community

Install collection

Install with ansible-galaxy collection install hyperledger_labs.fabric_ansible_collection:==2.0.0

Add to requirements.yml

  collections:
    - name: hyperledger_labs.fabric_ansible_collection
      version: 2.0.0

Description

Specify the parameters for a Hyperledger Fabric channel.

This module works with the IBM Support for Hyperledger Fabric software or the Hyperledger Fabric Open Source Stack running in a Red Hat OpenShift or Kubernetes cluster.

Usage examples

Scanned by Steampunk Spotter

- name: Set batch size channel parameters
  hyperledger.fabric_ansible_collection.channel_parameters:
    path: channel_config.bin
    batch_size:
      max_message_count: 10000
      absolute_max_bytes: 10485760
      preferred_max_bytes: 5242880

Scanned by Steampunk Spotter

- name: Set batch timeout channel parameter
  hyperledger.fabric_ansible_collection.channel_parameters:
    path: channel_config.bin
    batch_timeout: 500ms

Inputs

    
path:
    description:
    - Path to current the channel configuration file.
    - This file can be fetched by using the M(channel_config) module.
    - This file will be updated in place. You will need to keep a copy of the original
      file for computing the configuration update.
    required: true
    type: str

batch_size:
    description:
    - The batch size parameters for the channel.
    suboptions:
      absolute_max_bytes:
        description:
        - The total size of all the messages in a block for the channel must not exceed
          this value.
        type: int
      max_message_count:
        description:
        - The maximum number of messages that should be present in a block for the channel.
        type: int
      preferred_max_bytes:
        description:
        - The total size of all the messages in a block for the channel should not exceed
          this value.
        type: int
    type: dict

batch_timeout:
    description:
    - The maximum time to wait before cutting a new block for the channel.
    - Example values include I(500ms), I(5m), or I(24h).
    type: str