thalesgroup.ciphertrust.connection_manager_sap_data_custodian module – Manage SAP Data Custodian connections

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.connection_manager_sap_data_custodian.

New in thalesgroup.ciphertrust 1.0.0

Synopsis

  • This is a Thales CipherTrust Manager module for working with the CipherTrust Manager APIs, more specifically with Connection Manager API for SAP Data Custodian

Parameters

Parameter

Comments

api_endpoint

string

KMS API endpoint of the SAP Data Custodian. Provide HTTP URL with the API version in it. Only v2 version of KMS API is supported.

Default: "none"

connection_id

string

Unique ID of the connection to be updated

Default: "none"

description

string

Description about the connection

Default: "none"

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

meta

dictionary

Optional end-user or service data stored with the connection

name

string / required

Unique connection name

Default: "none"

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

products

list / elements=string

Array of the CipherTrust products associated with the connection.

Default: ["none"]

technical_user_credentials

dictionary

Technical User Credentials for SAP Data Custodian connection

api_key

string

API key of the technical user

secret

string

Secret/Password of the technical user

user_credentials

dictionary

Standard User Credentials for SAP Data Custodian connection

secret

string

Secret/Password of the user

tenant

string

Tenant of the user

user

string

Username

Examples

- name: "Create SAP Data Custodian Connection"
  thalesgroup.ciphertrust.connection_manager_sap_data_custodian:
    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
    api_endpoint: "https://demo-kms-endpoint/kms/v2"
    name: "SAP Data Custodian"
    products:
      - cckm
    user_credentials:
      secret: secret
      tenant: tenant
      username: username

- name: "Update SAP Data Custodian Connection"
  thalesgroup.ciphertrust.connection_manager_sap_data_custodian:
    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