thalesgroup.ciphertrust.cckm_az_certificate (1.0.0) — module

Install collection

Install with ansible-galaxy collection install thalesgroup.ciphertrust:==1.0.0

Add to requirements.yml

  collections:
    - name: thalesgroup.ciphertrust
      version: 1.0.0

Description

This is a Thales CipherTrust Manager module for working with the CipherTrust Manager APIs, more specifically with CCKM for Azure Certificates API

Usage examples

Scanned by Steampunk Spotter

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

- name: "Create Azure Certificate"
  thalesgroup.ciphertrust.cckm_az_certificate:
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
    op_type: create

Inputs

    
caid:
    description: ID or name of the certificate authority.
    type: str

tags:
    description: Application specific metadata in the form of key-value pair.
    type: dict

job_id:
    description: Sync Job ID to be updated
    type: str

op_type:
    choices:
    - create
    - update
    - certificate_op
    - create-sync-job
    - cancel-sync-job
    - import
    description: Operation to be performed
    required: true
    type: str

password:
    description: Password of the private key, if encrypted.
    type: str

cert_name:
    description: Name for the certificate on Azure. Certificate names can only contain
      alphanumeric characters and hyphens (-).
    type: str

key_vault:
    description: ID or name of the Azure vault where the certificate will be created.
    type: str

localNode:
    description:
    - this holds the connection parameters required to communicate with an instance of
      CipherTrust Manager (CM)
    - holds IP/FQDN of the server, username, password, and port
    required: true
    suboptions:
      password:
        description: admin password of CM
        required: true
        type: str
      server_ip:
        description: CM Server IP or FQDN
        required: true
        type: str
      server_port:
        default: 5432
        description: Port on which CM server is listening
        required: true
        type: int
      server_private_ip:
        description: internal or private IP of the CM Server, if different from the server_ip
        required: true
        type: str
      user:
        description: admin username of CM
        required: true
        type: str
      verify:
        default: false
        description: if SSL verification is required
        required: true
        type: bool
    type: dict

attributes:
    description: Secret attributes to be updated.
    type: dict

key_vaults:
    description: Name or ID of key vaults from which Azure secrets will be synchronized.
      synchronize_all and key_vaults are mutually exclusive. Specify either the synchronize_all
      or key_vaults.
    type: list

azure_param:
    description: Azure certificate parameters.
    type: dict

certificate_id:
    description: Azure Certificate ID to be acted upon
    type: str

private_key_pem:
    description: Private key in PEM format.
    type: str

synchronize_all:
    description: Set true to synchronize all certificates from all vaults. synchronize_all
      and key_vaults are mutually exclusive. Specify either the synchronize_all or key_vaults.
    type: bool

certificate_op_type:
    choices:
    - soft-delete
    - hard-delete
    - restore
    - recover
    description: Action to be performed on Certificate
    type: str

source_cert_identifier:
    description: ID of the certificate that will be imported into the Azure vault.
    type: str