consortium_member – Manage a consortium member for a Hyperledger Fabric ordering service

Synopsis 

Add, update, and remove consortium members for a Hyperledger Fabric ordering service by using the IBM Blockchain Platform.

This module works with the IBM Blockchain Platform managed service running in IBM Cloud, or the IBM Blockchain Platform software running in a Red Hat OpenShift or Kubernetes cluster.

Parameters 

api_endpoint (required)
The URL for the IBM Blockchain Platform console.

Type: str

api_authtype (required)
ibmcloud - Authenticate to the IBM Blockchain Platform console using IBM Cloud authentication. You must provide a valid API key using api_key.

basic - Authenticate to the IBM Blockchain Platform console using basic authentication. You must provide both a valid API key using api_key and API secret using api_secret.

Type: str

api_key (required)
The API key for the IBM Blockchain Platform console.

Type: str

api_secret
The API secret for the IBM Blockchain Platform console.

Only required when api_authtype is basic.

Type: str

api_timeout
The timeout, in seconds, to use when interacting with the IBM Blockchain Platform console.

Type: int

Default value: 60

api_token_endpoint
The IBM Cloud IAM token endpoint to use when using IBM Cloud authentication.

Only required when api_authtype is ibmcloud, and you are using IBM internal staging servers for testing.

Type: str

Default value: https://iam.cloud.ibm.com/identity/token

state
absent - An organization matching the specified name will be removed from the consortium.

present - Asserts that an organization matching the specified name and configuration exists in the consortium. If no organization matches the specified name, the organization will be added to the consortium. If an organization matches the specified name but the configuration does not match, then the organization in the consortium will be updated.

Type: str

Default value: present

path (required)
Path to current the system channel configuration file.

This file can be fetched by using the ERROR while parsing: While parsing “M(channel_config)” at index 39: Module name “channel_config” is not a FQCN module.

This file will be updated in place. You will need to keep a copy of the original file for computing the configuration update.

Type: str

organization (required)
The organization to add, update, or remove from the consortium.

You can pass a string, which is the display name of an organization registered with the IBM Blockchain Platform console.

You can also pass a dictionary, which must match the result format of one of the ERROR while parsing: While parsing “M(organization_info)” at index 82: Module name “organization_info” is not a FQCN or ERROR while parsing: While parsing “M(organization[])” at index 106: Module name “organization[]” is not a FQCN modules.

Type: raw

policies
The set of policies for the consortium member. The keys are the policy names, and the values are the policies.

You can pass strings, which are paths to JSON files containing policies in the Hyperledger Fabric format (common.Policy).

You can also pass a dict, which must correspond to a parsed policy in the Hyperledger Fabric format (common.Policy).

Default policies are provided for the Admins, Writers, Readers, and Endorsement policies. You only need to provide policies if you want to override these default policies, or add additional policies.

Type: dict

Examples 

- name: Add the organization to the consortium
  ibm.blockchain_platform.consortium_member:
    state: present
    api_endpoint: https://ibp-console.example.org:32000
    api_authtype: basic
    api_key: xxxxxxxx
    api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    organization: Org1
    path: channel_config.bin

- name: Remove the organization from the consortium
  ibm.blockchain_platform.consortium_member:
    state: absent
    api_endpoint: https://ibp-console.example.org:32000
    api_authtype: basic
    api_key: xxxxxxxx
    api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    organization: Org1
    path: channel_config.bin