arensb.truenas.group module – Manage groups

Note

This module is part of the arensb.truenas collection (version 1.11.4).

To install it, use: ansible-galaxy collection install arensb.truenas.

To use it in a playbook, specify: arensb.truenas.group.

New in arensb.truenas 0.1.0

Synopsis

  • Create, destroy, and manage groups on a TrueNAS host.

Parameters

Parameter

Comments

gid

integer

Optional GID to set for the group

name

string / required

Name of the group to manage.

non_unique

boolean

Allow a non-unique GID for the group.

If non_unique is true, a GID must be specified.

Choices:

  • false ← (default)

  • true

state

string

Whether the group should be present or not.

Choices:

  • "absent"

  • "present" ← (default)

Notes

Note

  • Supports check_mode

See Also

See also

ansible.builtin.group

The official documentation on the ansible.builtin.group module.

Examples

- name: Make sure group "mygroup" exists
  arensb.truenas.group:
    name: mygroup

- name: Make sure group "badgroup" is gone
  arensb.truenas.group:
    name: badgroup
    state: absent

Authors

  • Andrew Arensburger (@arensb)