thalesgroup.ciphertrust.cte_user_set (1.0.0) — module

Create and manage CTE user-sets

| "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

Create and edit CTE User set or add, edit, or remove a user to or from the user set

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Create CTE Userset"
  thalesgroup.ciphertrust.cte_user_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
    op_type: create
    name: UserSet1
    description: "Using Ansible"
    users:
      - uname: root1234
        uid: 1000
        gname: rootGroup
        gid: 1000
      - uname: test1234
        uid: 1234
        gname: testGroup
        gid: 1234
  register: userset
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Add user to UserSet"
  thalesgroup.ciphertrust.cte_user_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
    op_type: add_user
    id: "{{ userset['response']['id'] }}"
    users:
      - uname: root0001
        uid: 1001
        gname: rootGroup
        gid: 1000

Inputs

    
id:
    description: Identifier of the CTE CSI Storage Group to be patched
    type: str

gid:
    description: Group id of the user which shall be added in user-set
    type: int

uid:
    description: User id of the user which shall be added in user-set
    type: int

name:
    description: Name of the user set
    type: str

gname:
    description: Group name of the user which shall be added in user-set
    type: str

uname:
    description: Name of the user which shall be added in user-set
    type: str

users:
    description: List of users to be added to the user set
    type: list

op_type:
    choices:
    - create
    - patch
    - add_user
    - patch_user
    - delete_user
    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

os_domain:
    description: OS domain name in case of windows environment
    type: str

userIndex:
    description:
    - Identifier of the CTE User within UserSet to be patched or deleted
    type: str

description:
    description: Description of the user set
    type: str