thalesgroup.ciphertrust.dpg_masking_format_save (1.0.0) — module

Manage masking formats for DPG

| "added in version" 1.0.0 of thalesgroup.ciphertrust"

Authors: Anurag Jain, Developer Advocate Thales Group

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 DPG Masking Format API

Refer https://thalesdocs.com/ctp/con/dpg/latest/admin/index.html for API documentation

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
    op_type: create
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Patch Access Policy"
  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
    op_type: patch

Inputs

    
name:
    description: Unique name for the masking format
    type: str

show:
    description: Flag to show/hide the starting/ending characters while revealing the
      data
    required: false
    type: bool

op_type:
    choices:
    - create
    - patch
    description: Operation to be performed
    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

mask_char:
    description: Character used for masking
    required: false
    type: str

ending_characters:
    description: Number of ending characters to be masked
    required: false
    type: int

masking_format_id:
    description:
    - Identifier of the userset to be patched
    type: str

starting_characters:
    description: Number of starting characters to be masked
    type: str