hyperledger.fabric_ansible_collection.certificate_authority_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 certificate authority.

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 certificate authority
  hyperledger.fabric_ansible_collection.certificate_authority_info:
    api_endpoint: https://console.example.org:32000
    api_authtype: basic
    api_key: xxxxxxxx
    api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    name: Org1 CA

Inputs

    
name:
    description:
    - The name of the certificate authority.
    required: true

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

api_secret:
    description:
    - The API secret for the 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 the Fabric operations
      console.
    type: int

api_authtype:
    description:
    - C(basic) - Authenticate to the 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 the Fabric operations console.
    required: true
    type: str

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

Outputs

certificate_authority:
  contains:
    api_url:
      description:
      - The URL for the API of the certificate authority.
      sample: https://org1ca-api.example.org:32000
      type: str
    ca_name:
      description:
      - The certificate authority name to use for enrollment requests.
      sample: ca
      type: str
    ca_url:
      description:
      - The URL for the API of the certificate authority.
      sample: https://org1ca-api.example.org:32000
      type: str
    location:
      description:
      - The location of the certificate authority.
      sample: ibmcloud
      type: str
    name:
      description:
      - The name of the certificate authority.
      sample: Org1 CA
      type: str
    operations_url:
      description:
      - The URL for the operations service of the certificate authority.
      sample: https://org1ca-operations.example.org:32000
      type: str
    pem:
      description:
      - The TLS certificate chain for the certificate authority.
      - The TLS certificate chain is returned as a base64 encoded PEM.
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: str
    tls_cert:
      description:
      - The TLS certificate chain for the certificate authority.
      - The TLS certificate chain is returned as a base64 encoded PEM.
      sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...
      type: str
    tlsca_name:
      description:
      - The certificate authority name to use for TLS enrollment requests.
      sample: tlsca
      type: str
  description:
  - The certificate authority.
  returned: if certificate authority exists
  type: dict
exists:
  description:
  - True if the certificate authority exists, false otherwise.
  returned: always
  type: boolean