Documentation

gitlab_group - Creates/updates/deletes Gitlab Groups

New in version 2.1.

Synopsis

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

Options

parameter required default choices comments
login_password
no
Gitlab password for login_user
login_token
no
Gitlab token for logging in.
login_user
no
Gitlab user name.
name
yes
Name of the group you want to create.
path
no
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
yes
Url of Gitlab server, with protocol (http or https).
state
no present
  • present
  • absent
create or delete group.
Possible values are present and absent.
validate_certs
no True
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.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.