thalesgroup.ciphertrust.connection_manager_luna_hsm module – Manage connections to the Luna Network HSM HA or non-HA

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

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 Luna Network HSM

Parameters

Parameter

Comments

connection_id

string

Unique ID of the connection to be updated

Default: "none"

description

string

Description about the connection

Default: "none"

hostname

string

Hostname/IP of the Luna Network HSM Server.

hsm_certificate

string

Luna Network HSM Server Certificate.

is_ha_enabled

boolean

Password associated with the Partition of the Luna Network HSM.

Choices:

  • false

  • true

label

string

Label of the Luna Network HSM STC Partition.

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

Unique connection name

Default: "none"

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

  • "add_partition"

  • "delete_partition"

  • "add_stc_partition"

  • "add_hsm_server"

  • "enable_stc"

  • "disable_stc"

partition_id

string

Unique ID of the Luna Network HSM partition to be updated or removed

partition_identity

string

Contents of Luna Network HSM STC Partition Identity(pid) file in base64 form.

partition_label

string

Label of the partition on the Luna Network HSM Server.

partitions

list / elements=dictionary

One partition for a Non HA connection or a list for an HA group.

hostname

string

Hostname/IP of the Luna Network HSM Server.

partition_label

string

Label of the partition on the Luna Network HSM Server.

serial_number

string

Serial number of the partition.

password

string

Password associated with the Partition of the Luna Network HSM.

Default: "none"

products

list / elements=string

Array of the CipherTrust products associated with the connection.

Default: ["none"]

serial_number

string

Serial number of the partition.

Examples

- name: "Create Luna Network HSM Connection"
  thalesgroup.ciphertrust.connection_manager_luna_hsm:
    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: luna-network-connection
    products:
      - cckm
    meta:
        color: blue
    is_ha_enabled: false
    password: pwd
    partitions:
      - hostname: sample-hostname
        partition_label: sample-label
        serial_number: serialNo.

Authors

  • Anurag Jain, Developer Advocate Thales Group