hyperledger.fabric_ansible_collection.ordering_service_info (2.0.7) — module

Install collection

Install with ansible-galaxy collection install hyperledger.fabric_ansible_collection:==2.0.7

Add to requirements.yml

  collections:
    - name: hyperledger.fabric_ansible_collection
      version: 2.0.7

Description

Get information about a Hyperledger Fabric ordering service.

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 ordering service
  hyperledger.fabric_ansible_collection.ordering_service_info:
    api_endpoint: https://console.example.org:32000
    api_authtype: basic
    api_key: xxxxxxxx
    api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    name: Ordering Service

Inputs

    
name:
    description:
    - The name of the ordering service.

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

wait_timeout:
    default: 60
    description:
    - The timeout, in seconds, to wait until the ordering service is available.
    type: int

Outputs

exists:
  description:
  - True if the ordering service exists, false otherwise.
  type: boolean
ordering_service:
  contains:
    api_url:
      description:
      - The URL for the API of the ordering service node.
      sample: grpcs://orderingservice1-api.example.org:32000
      type: str
    client_tls_cert:
      description:
      - The client TLS certificate for the ordering service node.
      - The client TLS certificate is returned as a base64 encoded PEM.
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: str
    cluster_id:
      description:
      - The unique ID of the ordering service cluster.
      sample: abcdefgh
      type: str
    cluster_name:
      description:
      - The name of the ordering service cluster.
      sample: Ordering Service
      type: str
    consenter_proposal_fin:
      description:
      - True if the ordering service node has been added to the consenter set of the
        system channel, false otherwise. Ordering service nodes that have not been
        added to the consenter set of the system channel are not ready for use.
      sample: true
      type: boolean
    grpcwp_url:
      description:
      - The URL for the gRPC web proxy of the ordering service node.
      sample: https://orderingservice1-grpcwebproxy.example.org:32000
      type: str
    location:
      description:
      - The location of the ordering service node.
      sample: ibmcloud
      type: str
    msp_id:
      description:
      - The MSP ID of the ordering service node.
      sample: OrdererOrgMSP
      type: str
    name:
      description:
      - The name of the ordering service node.
      sample: Ordering Service_1
      type: str
    operations_url:
      description:
      - The URL for the operations service of the ordering service node.
      sample: https://orderingservice1-operations.example.org:32000
      type: str
    pem:
      description:
      - The TLS certificate chain for the ordering service node.
      - The TLS certificate chain is returned as a base64 encoded PEM.
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: str
    server_tls_cert:
      description:
      - The server TLS certificate for the ordering service node.
      - The server TLS certificate is returned as a base64 encoded PEM.
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: str
    system_channel_id:
      description:
      - The name of the system channel for the ordering service node.
      sample: testchainid
      type: str
    tls_ca_root_cert:
      description:
      - The TLS certificate chain for the ordering service node.
      - The TLS certificate chain is returned as a base64 encoded PEM.
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: str
    tls_cert:
      description:
      - The TLS certificate for the ordering service node.
      - The TLS certificate is returned as a base64 encoded PEM.
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: str
  description:
  - The ordering service, as a list of ordering service nodes.
  elements: dict
  returned: if ordering service exists
  type: list