thalesgroup.ciphertrust.dpg_character_set_save module – Create and manage DPG character-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_character_set_save.

New in thalesgroup.ciphertrust 1.0.0

Synopsis

Parameters

Parameter

Comments

char_set_id

string

Identifier of the Character Set to be patched

encoding

string

The description of Character 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 Character Set

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

range

list / elements=string

Allowed range of characters in HEX format

Examples

- name: "Create Character 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: DPGAlphaNum
    range:
    - "0030-0039"
    - "0041-005A"
    encoding: "UTF-8"

- name: "Patch Character Set"
  thalesgroup.ciphertrust.dpg_character_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
    char_set_id: <CharSetID>
    range:
    - "0030-0039"
    - "0041-005A"
    - "0061-007A"

- name: "Delete charset by ID"
  thalesgroup.ciphertrust.cm_resource_delete:
    key: <CharSetID>
    resource_type: "character-sets"
    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:

Authors

  • Anurag Jain (@anugram)