yadro.tatlin_uni.tatlin_sp_user_group module – Configure SP user group

Note

This module is part of the yadro.tatlin_uni collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. 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 yadro.tatlin_uni.

To use it in a playbook, specify: yadro.tatlin_uni.tatlin_sp_user_group.

New in version 1.0.0: of yadro.tatlin_uni

Synopsis

  • Purpose of this module is to create/change user groups

  • This module supports check mode

Parameters

Parameter

Comments

comment

string

Additional information about group

connection

dictionary / required

connection describes Tatlin Storage Processor (SP) connection configuration.

Only session connection supported.

Authorization is executed automatically with corresponding endpoint. ‘auth/login’ by default.

Client receives x-auth-token and uses it for following requests.

base_url

string / required

Tatlin REST API entrypoint.

password

string

Tatlin user password.

timeout

integer

Tatlin REST API request timeout.

Default: 60

username

string

Tatlin username to login.

validate_certs

boolean

Responsible for SSL certificates validation.

If set to False certificates won’t validated.

Choices:

  • no

  • yes ← (default)

name

string / required

The name of the user group

parent_groups

list / elements=string

Groups that group name will belong to

state

string

present creates a new group if name does not exists. Otherwise change group parameters

absent deletes an existing group

Choices:

  • present ← (default)

  • absent

Examples

---
- name: Create TestGroup
  yadro.tatlin_uni.tatlin_sp_user_group:
    connection: "{{ connection }}"
    name: "TestGroup"
    parent_groups:
      - data
      - monitor
    comment: Testing group
    state: "present"

- name: Modify TestGroup
  yadro.tatlin_uni.tatlin_sp_user_group:
    connection: "{{ connection }}"
    name: "TestGroup"
    parent_groups:
      - admin
    comment: Testing admin group

- name: Delete TestGroup
  yadro.tatlin_uni.tatlin_sp_user_group:
    connection: "{{ connection }}"
    name: "TestGroup"
    state: "absent"

Return Values

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

Key

Description

error

string

Error details if raised

Returned: on error

msg

string

Operation status message

Returned: always

Authors

  • Sergey Kovalev (@kvlvs)