gitlab_user – Creates/updates/deletes Gitlab Users
gitlab_user – Creates/updates/deletes Gitlab Users
New in version 2.1.
Synopsis
- When the user does not exist in Gitlab, it will be created.
- When the user does exists and state=absent, the user will be deleted.
- When changes are made to user, the user will be updated.
Requirements
The below requirements are needed on the host that executes this module.
- pyapi-gitlab python module
- administrator rights on the Gitlab server
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
access_level - |
The access level to the group. One of the following can be used. guest reporter developer master owner | |
confirm boolean added in 2.4 |
|
Require confirmation. |
- / required |
The email that belongs to the user. | |
group - |
Add user as an member to this group. | |
login_password - |
Gitlab password for login_user | |
login_token - |
Gitlab token for logging in. | |
login_user - |
Gitlab user name. | |
name - / required |
Name of the user you want to create | |
password - / required |
The password of the user. GitLab server enforces minimum password length to 8, set this value with 8 or more characters. | |
server_url - / required |
Url of Gitlab server, with protocol (http or https). | |
sshkey_file - |
The ssh key itself. | |
sshkey_name - |
The name of the sshkey | |
state - |
|
create or delete group. Possible values are present and absent. |
username - / required |
The username of the user. | |
validate_certs boolean |
|
When using https if SSL certificate needs to be verified.
|
Examples
- name: Delete Gitlab User
gitlab_user:
server_url: http://gitlab.example.com
validate_certs: False
login_token: WnUzDsxjy8230-Dy_k
username: myusername
state: absent
delegate_to: localhost
- name: Create Gitlab User
gitlab_user:
server_url: https://gitlab.dj-wasabi.local
validate_certs: True
login_user: dj-wasabi
login_password: MySecretPassword
name: My Name
username: myusername
password: mysecretpassword
email: [email protected]
sshkey_name: MySSH
sshkey_file: ssh-rsa AAAAB3NzaC1yc...
state: present
delegate_to: localhost
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Werner Dijkerman (@dj-wasabi)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/gitlab_user_module.html