Skip to content

pfsense_group

Frederic Bor edited this page Mar 4, 2020 · 5 revisions

pfsense_group

> PFSENSE_GROUP    (/home/fbor/ansible/lib/ansible/modules/network/pfsense/pfsense_group.py)

        Manage pfSense groups

  * This module is maintained by The Ansible Community
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)]
        type: list

- scope
        Scope of the group ('system' is 'Local')
        (Choices: system, remote)[Default: system]
        type: str

= state
        State in which to leave the group
        (Choices: present, absent)
        type: str


AUTHOR: Orion Poplawski (@opoplawski)
        METADATA:
          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


RETURN VALUES: