hyperledger.fabric_ansible_collection.peer_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 peer.

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 peer
  hyperledger.fabric_ansible_collection.peer_info:
    api_endpoint: https://console.example.org:32000
    api_authtype: basic
    api_key: xxxxxxxx
    api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    name: Org1 Peer

Inputs

    
name:
    description:
    - The name of the peer.
    required: true

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

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

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

Outputs

exists:
  description:
  - True if the peer exists, false otherwise.
  type: boolean
peer:
  contains:
    api_url:
      description:
      - The URL for the API of the peer.
      sample: grpcs://org1peer-api.example.org:32000
      type: str
    grpcwp_url:
      description:
      - The URL for the gRPC web proxy of the peer.
      sample: grpcs://org1peer-grpcwebproxy.example.org:32000
      type: str
    location:
      description:
      - The location of the peer.
      sample: ibmcloud
      type: str
    msp_id:
      description:
      - The MSP ID of the peer.
      sample: Org1MSP
      type: str
    name:
      description:
      - The name of the peer.
      sample: Org1 Peer
      type: str
    operations_url:
      description:
      - The URL for the operations service of the peer.
      sample: grpcs://org1peer-operations.example.org:32000
      type: str
    pem:
      description:
      - The TLS certificate chain for the peer.
      - The TLS certificate chain is returned as a base64 encoded PEM.
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: str
    tls_ca_root_cert:
      description:
      - The TLS certificate chain for the peer.
      - The TLS certificate chain is returned as a base64 encoded PEM.
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: str
    tls_cert:
      description:
      - The TLS certificate for the peer.
      - The TLS certificate is returned as a base64 encoded PEM.
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: str
  description: The peer.
  returned: if peer exists
  type: dict