hyperledger_labs.fabric_ansible_collection.organization_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 about a Hyperledger Fabric organization.

A Hyperledger Fabric organziation is also known as a Membership Services Provider (MSP).

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: Get the organization
  hyperledger.fabric_ansible_collection.organization_info:
    api_endpoint: https://console.example.org:32000
    api_authtype: basic
    api_key: xxxxxxxx
    api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    name: Org1

Inputs

    
name:
    description:
    - The name of the organization.

api_key:
    description:
    - The API key for the Fabric operations console.
    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).
    type: str

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

Outputs

exists:
  description:
  - True if the organization exists, false otherwise.
  type: boolean
organization:
  contains:
    admins:
      description:
      - The list of administrator certificates for this organization.
      - Administrator certificates must be supplied as base64 encoded PEM files.
      elements: str
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: list
    fabric_node_ous:
      contains:
        admin_ou_identifier:
          contains:
            certificate:
              description:
              - The root or intermediate certificate for this identity classification.
              - Root or intermediate certificates must be supplied as base64 encoded
                PEM files.
              sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
              type: str
            organizational_unit_identifier:
              description:
              - The organizational unit (OU) identifier for this identity classification.
              sample: admin
              type: str
          description:
          - Configuration specific to the admin identity classification.
          type: dict
        client_ou_identifier:
          contains:
            certificate:
              description:
              - The root or intermediate certificate for this identity classification.
              - Root or intermediate certificates must be supplied as base64 encoded
                PEM files.
              sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
              type: str
            organizational_unit_identifier:
              description:
              - The organizational unit (OU) identifier for this identity classification.
              sample: client
              type: str
          description:
          - Configuration specific to the client identity classification.
          type: dict
        enable:
          description:
          - True if identity classification is enabled for this organization, false
            otherwise.
          sample: true
          type: boolean
        orderer_ou_identifier:
          contains:
            certificate:
              description:
              - The root or intermediate certificate for this identity classification.
              - Root or intermediate certificates must be supplied as base64 encoded
                PEM files.
              sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
              type: str
            organizational_unit_identifier:
              description:
              - The organizational unit (OU) identifier for this identity classification.
              sample: orderer
              type: str
          description:
          - Configuration specific to the orderer identity classification.
          type: dict
        peer_ou_identifier:
          contains:
            certificate:
              description:
              - The root or intermediate certificate for this identity classification.
              - Root or intermediate certificates must be supplied as base64 encoded
                PEM files.
              sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
              type: str
            organizational_unit_identifier:
              description:
              - The organizational unit (OU) identifier for this identity classification.
              sample: peer
              type: str
          description:
          - Configuration specific to the peer identity classification.
          type: dict
      description:
      - Configuration specific to the identity classification.
      type: dict
    intermediate_certs:
      description:
      - The list of intermediate certificates for this organization.
      - Intermediate certificates must be supplied as base64 encoded PEM files.
      elements: str
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: list
    msp_id:
      description:
      - The MSP ID for the organization.
      sample: Org1MSP
      type: str
    name:
      description:
      - The name of the organization.
      sample: Org1
      type: str
    organizational_unit_identifiers:
      contains:
        certificate:
          description:
          - The root or intermediate certificate for this organizational unit identifier.
          - Root or intermediate certificates must be supplied as base64 encoded PEM
            files.
          sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
          type: str
        organizational_unit_identifier:
          description:
          - The organizational unit (OU) identifier.
          sample: acctdept
          type: str
      description:
      - The list of organizational unit identifiers for this organization.
      elements: dict
      type: list
    revocation_list:
      description:
      - The list of revoked certificates for this organization.
      - Revoked certificates must be supplied as base64 encoded PEM files.
      elements: str
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: list
    root_certs:
      description:
      - The list of root certificates for this organization.
      - Root certificates must be supplied as base64 encoded PEM files.
      elements: str
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: list
    tls_intermediate_certs:
      description:
      - The list of TLS root certificates for this organization.
      - TLS intermediate certificates must be supplied as base64 encoded PEM files.
      elements: str
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: list
    tls_root_certs:
      description:
      - The list of TLS root certificates for this organization.
      - TLS root certificates must be supplied as base64 encoded PEM files.
      elements: str
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: list
  description:
  - The organization.
  returned: if organization exists
  type: dict