thalesgroup.ciphertrust.group_add_remove_object module – Add or remove user or client from group

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

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 operation API

Parameters

Parameter

Comments

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

name

string / required

name of the group to be updated

object_id

string / required

CM ID of the object (user or client) to be added to the group

object_type

string / required

Type of object to be added to or removed from a group

Choices:

  • "user"

  • "client"

op_type

string / required

Operation to be performed

add to add a user or client to a group

remove to remove a user or client from a group

Choices:

  • "add"

  • "remove"

Examples

- name: "Add User to a Group"
  thalesgroup.ciphertrust.group_add_remove_object:
    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: add
    object_type: user
    object_id: user_id_on_CM
    name: "group_name"

- name: "Add Client to a Group"
  thalesgroup.ciphertrust.group_add_remove_object:
    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: add
    object_type: client
    object_id: client_id_on_CM
    name: "group_name"

- name: "Remove User from a Group"
  thalesgroup.ciphertrust.group_add_remove_object:
    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: remove
    object_type: user
    object_id: user_id_on_CM
    name: "group_name"

- name: "Remove Client from a Group"
  thalesgroup.ciphertrust.group_add_remove_object:
    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: remove
    object_type: client
    object_id: client_id_on_CM
    name: "group_name"

Authors

  • Anurag Jain, Developer Advocate Thales Group