thalesgroup.ciphertrust.cm_resource_get_id_from_name module – Get CipherTrust Manager resource ID from resource name

Note

This module is part of the thalesgroup.ciphertrust collection (version 1.0.0).

To install it, use: ansible-galaxy collection install thalesgroup.ciphertrust.

To use it in a playbook, specify: thalesgroup.ciphertrust.cm_resource_get_id_from_name.

New in thalesgroup.ciphertrust 1.0.0

Synopsis

  • This is a Thales CipherTrust Manager module for working with the CipherTrust Manager APIs, more specifically List API with some filter.

Parameters

Parameter

Comments

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

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

Default: 5432

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 ← (default)

  • true

query_param

string / required

This is a string type of option that holds the query parameter type to be used to filter the list resources API response

Choices:

  • "name"

  • "username"

  • "email"

  • "status"

query_param_value

string / required

This is a string type of option that will hold the value of filter query parameter

resource_type

string / required

This is a string type of option that can hold the resource type.

Choices:

  • "keys"

  • "protection-policies"

  • "access-policies"

  • "user-sets"

  • "interfaces"

  • "character-sets"

  • "users"

  • "dpg-policies"

  • "client-profiles"

  • "masking-formats"

Examples

- name: "Get Key ID"
  thalesgroup.ciphertrust.cm_resource_get_id_from_name:
    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
    query_param: "name"
    query_param_value: "AnsibleKey"
    resource_type: "keys"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

id

string

String with the ID returned by the CipherTrust Manager

Returned: changed or success

Sample: "123456789"

Authors

  • Anurag Jain, Developer Advocate Thales Group