thalesgroup.ciphertrust.dpg_client_profile_save module – Manage DPG client profile

Note

This module is part of the thalesgroup.ciphertrust collection (version 1.0.0).

To install it, use: ansible-galaxy collection install thalesgroup.ciphertrust.

To use it in a playbook, specify: thalesgroup.ciphertrust.dpg_client_profile_save.

New in thalesgroup.ciphertrust 1.0.0

Synopsis

Parameters

Parameter

Comments

app_connector_type

string

App connector type for which the client profile is created

Choices:

  • "DPG"

  • "CADP For Java"

ca_id

string

Local CA mapped with client profile

cert_duration

integer

Duration for which client credentials are valid

configurations

dictionary

Parameters required to initialize connector

csr_parameters

dictionary

Client certificate parameters to be updated

heartbeat_threshold

integer

The Threshold by which client’s connectivity_status will be moved to Error if not heartbeat is received

lifetime

string

Validity of registration token

localNode

dictionary / required

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

password

string / required

admin password of CM

server_ip

string / required

CM Server IP or FQDN

server_port

integer / required

Port on which CM server is listening

Default: 5432

server_private_ip

string / required

internal or private IP of the CM Server, if different from the server_ip

user

string / required

admin username of CM

verify

boolean / required

if SSL verification is required

Choices:

  • false ← (default)

  • true

max_clients

integer

Number of clients that can register using a registration token

nae_iface_port

integer

Nae interface mapped with client profile

name

string

Unique name for the client profile.

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

policy_id

string

Policy mapped with client profile.

profile_id

string

Identifier of the client profile to be patched

Examples

- 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

- 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

Authors

  • Anurag Jain, Developer Advocate Thales Group