Documentation

gitlab_group - Creates/updates/deletes Gitlab Groups

New in version 2.1.

Synopsis

  • When the group does not exist in Gitlab, it will be created.
  • When the group does exists and state=absent, the group will be deleted.

Requirements

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

  • pyapi-gitlab python module

Parameters

Parameter Choices/Defaults Comments
login_password
Gitlab password for login_user
login_token
Gitlab token for logging in.
login_user
Gitlab user name.
name
required
Name of the group you want to create.
path
The path of the group you want to create, this will be server_url/group_path
If not supplied, the group_name will be used.
server_url
required
Url of Gitlab server, with protocol (http or https).
state
    Choices:
  • present ←
  • absent
create or delete group.
Possible values are present and absent.
validate_certs Default:
yes
When using https if SSL certificate needs to be verified.

aliases: verify_ssl

Examples

- name: Delete Gitlab Group
  gitlab_group:
    server_url: http://gitlab.example.com
    validate_certs: False
    login_token: WnUzDsxjy8230-Dy_k
    name: my_first_group
    state: absent
  delegate_to: localhost

- name: Create Gitlab Group
  gitlab_group:
    server_url: https://gitlab.example.com
    validate_certs: True
    login_user: dj-wasabi
    login_password: MySecretPassword
    name: my_first_group
    path: my_first_group
    state: present
  delegate_to: localhost

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Werner Dijkerman (@dj-wasabi)

Hint

If you notice any issues in this documentation you can edit this document to improve it.