thalesgroup.ciphertrust.cm_resource_delete (1.0.0) — module

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 delete resource APIs.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Delete Resource at CipherTrust Manager
- name: "Delete key on Ciphertrust Manager"
  thalesgroup.ciphertrust.cm_resource_delete:
    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
    key: "resource_id"
    resource_type: "keys"

Inputs

    
key:
    description:
    - This is a string type of option that can have either the name of the ID of the resource
      to be deleted
    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

resource_type:
    choices:
    - keys
    - protection-policies
    - access-policies
    - user-sets
    - interfaces
    - character-sets
    - users
    - dpg-policies
    - client-profiles
    - masking-formats
    description:
    - This is a string type of option that can hold the resource type.
    required: true
    type: str

Outputs

message:
  description: String with response
  returned: changed or success
  sample: successfully deleted
  type: string