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

Install Ansible via pip

Install with pip install ansible==2.7.7

Description

When the group does not exist in Gitlab, it will be created.

When the group does exist and state=absent, the group will be deleted.

As of Ansible version 2.7, this module make use of a different python module and thus some arguments are deprecated.

Requirements

• python-gitlab python module

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Delete Gitlab Group"
  local_action:
    gitlab_group:
        server_url: http://gitlab.dj-wasabi.local
        validate_certs: False
        login_token: WnUzDsxjy8230-Dy_k
        name: my_first_group
        state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Create Gitlab Group"
  local_action:
    gitlab_group:
        server_url: https://gitlab.dj-wasabi.local"
        validate_certs: True
        login_user: dj-wasabi
        login_password: "MySecretPassword"
        name: my_first_group
        path: my_first_group
        state: present

Inputs

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

path:
    default: null
    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.
    required: false

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

login_user:
    default: null
    description:
    - Gitlab user name.
    required: false

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

description:
    default: null
    description:
    - A description for the group.
    required: false
    version_added: '2.7'
    version_added_collection: ansible.builtin

login_token:
    default: null
    description:
    - Gitlab token for logging in.
    required: false

login_password:
    default: null
    description:
    - Gitlab password for login_user
    required: false

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