thalesgroup.ciphertrust.group_add_remove_object (1.0.0) — module

Install collection

Install with ansible-galaxy collection install thalesgroup.ciphertrust:==1.0.0

Add to requirements.yml

  collections:
    - name: thalesgroup.ciphertrust
      version: 1.0.0

Description

This is a Thales CipherTrust Manager module for working with the CipherTrust Manager APIs, more specifically with groups operation API

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Inputs

    
name:
    default: null
    description: name of the group to be updated
    required: true
    type: str

op_type:
    choices:
    - add
    - remove
    description:
    - Operation to be performed
    - add to add a user or client to a group
    - remove to remove a user or client from a group
    required: true
    type: str

localNode:
    description:
    - 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
    required: true
    suboptions:
      password:
        description: admin password of CM
        required: true
        type: str
      server_ip:
        description: CM Server IP or FQDN
        required: true
        type: str
      server_port:
        default: 5432
        description: Port on which CM server is listening
        required: true
        type: int
      server_private_ip:
        description: internal or private IP of the CM Server, if different from the server_ip
        required: true
        type: str
      user:
        description: admin username of CM
        required: true
        type: str
      verify:
        default: false
        description: if SSL verification is required
        required: true
        type: bool
    type: dict

object_id:
    default: null
    description: CM ID of the object (user or client) to be added to the group
    required: true
    type: str

object_type:
    choices:
    - user
    - client
    description:
    - Type of object to be added to or removed from a group
    required: true
    type: str