hyperledger_labs.fabric_ansible_collection.channel_consenters (2.0.0) — module

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 consenters 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

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set channel consenters from ordering service
  hyperledger.fabric_ansible_collection.channel_consenters:
    api_endpoint: https://console.example.org:32000
    api_authtype: basic
    api_key: xxxxxxxx
    api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    path: channel_config.bin
    ordering_service: Ordering Service

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set channel consenters from ordering service nodes
  hyperledger.fabric_ansible_collection.channel_consenters:
    api_endpoint: https://console.example.org:32000
    api_authtype: basic
    api_key: xxxxxxxx
    api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    path: channel_config.bin
    ordering_service_nodes:
      - Ordering Service_1
      - Ordering Service_2
      - Ordering Service_5

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

api_key:
    description:
    - The API key for the Fabric operations console.
    required: true
    type: str

api_secret:
    description:
    - The API secret for the Fabric operations console.
    - Only required when I(api_authtype) is C(basic).
    type: str

api_timeout:
    default: 60
    description:
    - The timeout, in seconds, to use when interacting with the Fabric operations console.
    type: int

api_authtype:
    description:
    - C(basic) - Authenticate to the Fabric operations console using basic authentication.
      You must provide both a valid API key using I(api_key) and API secret using I(api_secret).
    required: true
    type: str

api_endpoint:
    description:
    - The URL for the Fabric operations console.
    required: true
    type: str

ordering_service:
    description:
    - The ordering service to use as the consenters for this channel. All ordering service
      nodes in this ordering service will be used as the consenters for this channel.
    - You can pass a string, which is the cluster name of a ordering service registered
      with the Fabric operations console.
    - You can also pass a list, which must match the result format of one of the M(ordering_service_info)
      or M(ordering_service) modules.
    - Cannot be specified with I(ordering_service_nodes).
    type: raw

ordering_service_nodes:
    description:
    - The ordering service nodes to use as the consenters for this channel.
    - You can pass strings, which are the names of ordering service nodes that are registered
      with the Fabric operations console.
    - You can also pass a dict, which must match the result format of one of the M(ordering_service_node_info)
      or M(ordering_service_node) modules.
    - Cannot be specified with I(ordering_service).
    elements: raw
    type: list