W3cubDocs

/Ansible 2.11

community.general.gitlab_group_members – Manage group members on GitLab Server

Note

This plugin is part of the community.general collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.gitlab_group_members.

New in version 1.2.0: of community.general

Synopsis

  • This module allows to add and remove members to/from a group, or change a member’s access level in a group on GitLab.

Requirements

The below requirements are needed on the host that executes this module.

  • python-gitlab python module <= 1.15.0
  • administrator rights on the GitLab server

Parameters

Parameter Choices/Defaults Comments
access_level
string
    Choices:
  • guest
  • reporter
  • developer
  • maintainer
  • owner
The access level for the user.
Required if state=present, user state is set to present.
api_password
string
The password to use for authentication against the API
api_token
string / required
A personal access token to authenticate with the GitLab API.
api_url
string
The resolvable endpoint for the API
api_username
string
The username to use for authentication against the API
gitlab_group
string / required
The name of the GitLab group the member is added to/removed from.
gitlab_user
string / required
The username of the member to add to/remove from the GitLab group.
state
string
    Choices:
  • present ←
  • absent
State of the member in the group.
On present, it adds a user to a GitLab group.
On absent, it removes a user from a GitLab group.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether or not to validate SSL certs when supplying a https endpoint.

Notes

Note

  • Supports check_mode.

Examples

- name: Add a user to a GitLab Group
  community.general.gitlab_group_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    gitlab_group: groupname
    gitlab_user: username
    access_level: developer
    state: present

- name: Remove a user from a GitLab Group
  community.general.gitlab_group_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    gitlab_group: groupname
    gitlab_user: username
    state: absent

Authors

  • Zainab Alsaffar (@zanssa)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/gitlab_group_members_module.html