thalesgroup.ciphertrust.dpg_masking_format_save module – Manage masking formats for DPG

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

New in thalesgroup.ciphertrust 1.0.0

Synopsis

Parameters

Parameter

Comments

ending_characters

integer

Number of ending characters to be masked

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

mask_char

string

Character used for masking

masking_format_id

string

Identifier of the Masking Format to be patched

name

string

Unique name for the masking format

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

show

boolean

Flag to show/hide the starting/ending characters while revealing the data

Choices:

  • false

  • true

starting_characters

integer

Number of starting characters to be masked

Examples

- name: "Create Masking Format"
  thalesgroup.ciphertrust.dpg_masking_format_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_MaskingFormat
    ending_characters: 2
    mask_char: X
    show: true
    starting_characters: 4

- name: "Patch Masking Format"
  thalesgroup.ciphertrust.dpg_masking_format_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
    masking_format_id: <MaskingFormatID>
    ending_characters: 4
    mask_char: O
    starting_characters: 2

- name: "Delete Masking Format ID"
  thalesgroup.ciphertrust.cm_resource_delete:
    key: <MaskingFormatID>
    resource_type: "masking-formats"
    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)