hyperledger_labs.fabric_ansible_collection.channel_acl (2.0.0) — module

Manage an ACL 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

Add, update, and remove ACLs 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

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Add the ACL to the channel
  hyperledger.fabric_ansible_collection.channel_acl:
    state: present
    name: lscc/ChaincodeExists
    policy: /Channel/Application/Admins
    path: channel_config.bin
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove the ACL from the channel
  hyperledger.fabric_ansible_collection.channel_acl:
    state: absent
    name: lscc/ChaincodeExists
    path: channel_config.bin

Inputs

    
name:
    description:
    - The name of the ACL to add, update, or remove from the channel.
    required: true
    type: str

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) - An ACL matching the specified name will be removed from the channel.
    - C(present) - Asserts that an ACL matching the specified name and policy exists in
      the channel. If no ACL matches the specified name, the ACL will be added to the
      channel. If an ACL matches the specified name but the policy does not match, then
      the ACL in the channel will be updated.
    type: str

policy:
    description:
    - The name of the policy used by the ACL.
    required: true
    type: str