hyperledger_labs.fabric_ansible_collection.chaincode_list_info (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

Get information on a chaincode definition on a Hyperledger Fabric channel

Usage examples

Scanned by Steampunk Spotter

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

- name: Show information on 'Org1 Peer' chaincodes
  hyperledger.fabric_ansible_collection.committed_chaincode:
    state: present
    api_endpoint: https://console.example.org:32000
    api_authtype: basic
    api_key: xxxxxxxx
    api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    peer: Org1 Peer
    identity: Org1 Admin.json
    msp_id: Org1MSP
    channel: mychannel

Inputs

    
hsm:
    description:
    - 'The PKCS #11 compliant HSM configuration to use for digital signatures.'
    - Only required if the identity specified in I(identity) was enrolled using an HSM.
    suboptions:
      label:
        description:
        - The HSM label that should be used for digital signatures.
        type: str
      pin:
        description:
        - The HSM pin that should be used for digital signatures.
        type: str
      pkcs11library:
        description:
        - 'The PKCS #11 library that should be used for digital signatures.'
        type: str
    type: dict

peer:
    description:
    - The peer to use to manage the committed chaincode definition.
    - You can pass a string, which is the display name of a peer registered with the Fabric
      operations console.
    - You can also pass a dict, which must match the result format of one of the M(peer_info)
      or M(peer) modules.
    required: true
    type: raw

msp_id:
    description:
    - The MSP ID to use for interacting with the peer.
    required: true
    type: str

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

channel:
    description:
    - The name of the channel.
    required: true
    type: str

identity:
    description:
    - The identity to use when interacting with the peer.
    - You can pass a string, which is the path to the JSON file where the enrolled identity
      is stored.
    - You can also pass a dict, which must match the result format of one of the M(enrolled_identity_info)
      or M(enrolled_identity) modules.
    required: true
    type: raw

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

Outputs

committed_chaincode:
  contains:
    committed_chaincodes:
      description:
      - List of committed chaincode definitions
      type: array
    installed_chaincodes:
      description:
      - list of installed chaincodes on the peer
      type: array
  description:
  - The committed chaincode definition.
  returned: when I(state) is C(present)
  type: dict