thalesgroup.ciphertrust.dpg_user_set_save module – Create and manage DPG user sets

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

New in thalesgroup.ciphertrust 1.0.0

Synopsis

Parameters

Parameter

Comments

description

string

The description of user set

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

Unique name for the user set

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

user_set_id

string

Identifier of the user set to be patched

users

list / elements=string

List of users to be added in user set

Examples

- name: "Create User Set"
  thalesgroup.ciphertrust.dpg_user_set_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: AnsibleIntegrationTest_UserSet
    description: "Created via Ansible"
    users:
    - "AnsibleIntegrationTest_User1"
    - "AnsibleIntegrationTest_User2"

- name: "Patch User Set"
  thalesgroup.ciphertrust.dpg_user_set_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
    user_set_id: <UserSetID>
    users:
    - "AnsibleIntegrationTest_User1"
    - "AnsibleIntegrationTest_User2"
    - "AnsibleIntegrationTest_User3"

- name: "Delete UserSet ID"
  thalesgroup.ciphertrust.cm_resource_delete:
    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:
    key: <UserSetID>
    resource_type: "user-sets"

Authors

  • Anurag Jain (@anugram)