thalesgroup.ciphertrust.dpg_client_profile_save (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 DPG Client Profile API

Refer https://thalesdocs.com/ctp/con/dpg/latest/admin/index.html for API documentation

Usage examples

Scanned by Steampunk Spotter

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

- name: "Create DPG Client Profile"
  thalesgroup.ciphertrust.dpg_client_profile_save:
    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

Scanned by Steampunk Spotter

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

- name: "Patch DPG Client Profile"
  thalesgroup.ciphertrust.dpg_client_profile_save:
    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: patch

Inputs

    
name:
    description: Unique name for the client profile.
    type: str

ca_id:
    description: Local CA mapped with client profile
    required: false
    type: str

op_type:
    choices:
    - create
    - patch
    description: Operation to be performed
    required: true
    type: str

lifetime:
    description: Validity of registration token
    required: false
    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

policy_id:
    description: Policy mapped with client profile.
    required: false
    type: str

profile_id:
    description:
    - Identifier of the client profile to be patched
    type: str

max_clients:
    description: Number of clients that can register using a registration token
    required: false
    type: int

cert_duration:
    description: Duration for which client credentials are valid
    required: false
    type: int

configurations:
    description: Parameters required to initialize connector
    type: dict

csr_parameters:
    description: Client certificate parameters to be updated
    type: dict

nae_iface_port:
    description: Nae interface mapped with client profile
    required: false
    type: int

app_connector_type:
    choices:
    - DPG
    - CADP For Java
    description: App connector type for which the client profile is created
    type: str

heartbeat_threshold:
    description: The Threshold by which client's connectivity_status will be moved to
      Error if not heartbeat is received
    required: false
    type: int