thalesgroup.ciphertrust.cte_resource_set module – Create and manage CTE resource-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.cte_resource_set.

New in thalesgroup.ciphertrust 1.0.0

Synopsis

  • Create and edit CTE resource set or add, edit, or remove a resource to or from the resource set

Parameters

Parameter

Comments

classification_tags

list / elements=dictionary

Classification set to be added to the resource set

attributes

list / elements=dictionary

List of attributes to be added to the tag

data_type

string

Data type of the attribute

name

string

Name of the attribute

operator

string

Operator to be applied to the attribute

Choices:

  • "eq"

  • "lt"

  • "ne"

  • "le"

  • "gt"

  • "ge"

value

string

Value of the attribute

description

string

Description of the classification tag

name

string

Name of the tag in the classification set

description

string

Description of the resource set

directory

string

directory path of the Resource which shall be associated with the resource-set

file

string

file name of the Resource which shall be associated with the resource-set

hdfs

boolean

Whether the specified path is a HDFS path

Choices:

  • false

  • true

id

string

Identifier of the CTE ResourceSet to be patched or deleted

include_subfolders

boolean

Flag to include subfolders in the Resource

Choices:

  • false

  • true

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

Name of the resource set

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

  • "add_resource"

  • "patch_resource"

  • "delete_resource"

resourceIndex

integer

Identifier of the CTE Resource within ResourceSet to be patched or deleted

resources

list / elements=dictionary

List of resources to be added to the resource set

directory

string

Directory of the resource to be added to the resource set

file

string

File name of the resource to be added to the resource set

hdfs

boolean

Whether the specified path is a HDFS path

Choices:

  • false

  • true

include_subfolders

boolean

Whether to include subfolders to the resource

Choices:

  • false

  • true

type

string

Type of the resource set i.e. Directory or Classification. Default value is Directory

Choices:

  • "Directory"

  • "Classification"

Examples

- name: "Create CTE ResourceSet"
  thalesgroup.ciphertrust.cte_resource_set:
    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: "RS-Ans-001"
    description: "Created via Ansible"
    type: Directory
    resources:
      - directory: "/"
        file: "*"
        include_subfolders: true
        hdfs: false
  register: resource_set

- name: "Add resource to a ResourceSet"
  thalesgroup.ciphertrust.cte_resource_set:
    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: add_resource
    id: "resourceSetID"
    resources:
      - directory: "/tmp"
        file: "*"
        include_subfolders: true
        hdfs: false

Authors

  • Anurag Jain (@anugram)