Skip to content

pfsense_group

Orion Poplawski edited this page Jan 13, 2023 · 5 revisions

pfsensible.core.pfsense_group


        Manage pfSense groups

ADDED IN: version 0.1.0 of pfsensible.core

OPTIONS (= is mandatory):

- descr
        Description of the group
        default: null
        type: str

- gid
        GID of the group.
        Will use next available GID if not specified.
        default: null
        type: str

= name
        The name of the group
        type: str

- priv
        A list of privileges to assign.
        Allowed values include page-all, user-shell-access.
        default: null
        elements: str
        type: list

- scope
        Scope of the group
        choices: [local, remote, system]
        default: local
        type: str

= state
        State in which to leave the group
        choices: [present, absent]
        type: str


AUTHOR: Orion Poplawski (@opoplawski)

METADATA:
  metadata_version: '1.1'
  status:
  - preview
  supported_by: community

EXAMPLES:

- name: Add adservers group
  pfsense_group:
    name: Domain Admins
    descr: Remote Admins
    scope: remote
    priv: [ 'page-all', 'user-shell-access' ]
    state: present

- name: Remove group
  pfsense_group:
    name: Domain Admins
    state: absent