thalesgroup.ciphertrust.group_save module – Create or update groups on CipherTrust Manager

Note

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

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

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 groups management API

Parameters

Parameter

Comments

app_metadata

dictionary

A schema-less object, which can be used by applications to store information about the resource

client_metadata

dictionary

A schema-less object, which can be used by applications to store information about the resource such as client preferences

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

auth_domain_path

string / required

user’s domain path

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

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

  • true

name

string / required

name of the group

old_name

string

Group’s original name that needs to be patched.

Only required if the op_type is patch

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

user_metadata

dictionary

A schema-less object, which can be used by applications to store information about the resource such as end-user preferences

Examples

- name: "Create Group"
  thalesgroup.ciphertrust.group_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
        auth_domain_path:
    op_type: create
    name: "group_name"

- name: "Patch Group"
  thalesgroup.ciphertrust.group_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
        auth_domain_path:
    op_type: patch
    old_name: "group_name"
    name: "new_name"

Authors

  • Anurag Jain (@anugram)