thalesgroup.ciphertrust.connection_manager_loki module – Manage Loki log forwarder 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_loki.

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 Loki

Parameters

Parameter

Comments

connection_id

string

Unique ID of the connection to be updated

Default: "none"

description

string

Description about the connection

Default: "none"

host

string

Host of the log-forwarder server

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

loki_params

dictionary

Loki connection specific params

ca_cert

string

CA certificate in PEM format

http_password

string

HTTP basic auth password

http_user

string

HTTP basic auth username

insecure_tls_skip_verify

string

In TLS mode, skip server certificate validation. This setting should only be used for testing

transport

string

Transport mode for sending data, supports “tls” and “tcp”. “tls” requires either a trusted CA cert or insecure TLS skip verify to be set to 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"

port

integer

Port of the log-forwarder server

products

list / elements=string

Array of the CipherTrust products associated with the connection.

Default: ["none"]

Examples

- name: "Create Loki Connection"
  thalesgroup.ciphertrust.connection_manager_loki:
    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: loki_conn
    products:
      - logger
    host: 127.0.0.1
    port: 5321

- name: "Update Loki Connection"
  thalesgroup.ciphertrust.connection_manager_loki:
    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