hyperledger_labs.fabric_ansible_collection.channel_consenter (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 a consenter 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: Add consenter to channel
  hyperledger.fabric_ansible_collection.channel_consenters:
    state: present
    api_endpoint: https://console.example.org:32000
    api_authtype: basic
    api_key: xxxxxxxx
    api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    path: channel_config.bin
    ordering_service_node: Ordering Service_1

Scanned by Steampunk Spotter

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

- name: Remove consenter from channel
  hyperledger.fabric_ansible_collection.channel_consenters:
    state: absent
    api_endpoint: https://console.example.org:32000
    api_authtype: basic
    api_key: xxxxxxxx
    api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    path: channel_config.bin
    ordering_service_node: Ordering Service_1

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

state:
    choices:
    - absent
    - present
    default: present
    description:
    - C(absent) - A consenter matching the specified name will be removed from the channel.
    - C(present) - Asserts that an consenter matching the specified name and configuration
      exists in the channel. If no consenter matches the specified name, the consenter
      will be added to the channel. If an consenter matches the specified name but the
      configuration does not match, then the consenter in the channel will be updated.
    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_node:
    description:
    - The ordering service node to use as a consenter for this channel.
    - You can pass a string, which is the name of an ordering service node that is 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.
    type: raw