ansible.builtin.gitlab_group (v2.6.10) — module

Creates/updates/deletes Gitlab Groups

| "added in version" 2.1 of ansible.builtin"

Authors: Werner Dijkerman (@dj-wasabi)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.6.10

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
name:
    description:
    - Name of the group you want to create.
    required: true

path:
    description:
    - 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.

state:
    choices:
    - present
    - absent
    default: present
    description:
    - create or delete group.
    - Possible values are present and absent.

login_user:
    description:
    - Gitlab user name.

server_url:
    description:
    - Url of Gitlab server, with protocol (http or https).
    required: true

login_token:
    description:
    - Gitlab token for logging in.

login_password:
    description:
    - Gitlab password for login_user

validate_certs:
    aliases:
    - verify_ssl
    default: true
    description:
    - When using https if SSL certificate needs to be verified.