yadro.tatlin_uni.tatlin_sp_user module – Configure SP user

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.

New in version 1.0.0: of yadro.tatlin_uni

Synopsis

• Purpose of this module is to create/change local user’s attributes

• This module supports check mode

Parameters

Parameter	Comments
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)
enabled boolean	Indication of whether a user is enabled true if the user is enabled, the user can log in false if the user is disabled, the user cannot log in If new user is created and enabled not passed, true is a default value Choices: no yes
groups list / elements=string	The groups of the user that restrict user permissions. Required when creating a new user
name string / required	The name of the user
password string	The password of the user. Required when creating a new user.
state string	present creates a new user if name does not exists. Otherwise change user parameters absent deletes an existing user Choices: present ← (default) absent

Examples

---
- name: Create TestUser
  yadro.tatlin_uni.tatlin_sp_user:
    connection: "{{ connection }}"
    name: "TestUser"
    password: "TestPassword"
    groups:
      - data
      - monitor
    enabled: true
    state: "present"

- name: Modify TestUser
  yadro.tatlin_uni.tatlin_sp_user:
    connection: "{{ connection }}"
    name: "TestUser"
    enabled: false
    groups:
      monitor

- name: Delete TestUser
  yadro.tatlin_uni.tatlin_sp_user:
    connection: "{{ connection }}"
    name: "TestUser"
    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)

Collection links

Issue Tracker Repository (Sources)