Skip to content

pfsense_user

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

pfsensible.core.pfsense_user


        Manage pfSense users

ADDED IN: version 0.1.0 of pfsensible.core

OPTIONS (= is mandatory):

- authorizedkeys
        Contents of ~/.ssh/authorized_keys.  Can be base64 encoded.
        default: null
        type: str

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

- groups
        Groups of the user.
        default: null
        elements: str
        type: list

= name
        The name of the user.
        type: str

- password
        bcrypt encrypted password of the user.
        default: null
        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 user ('user' is a normal user, use 'system' for
        'admin' user).
        choices: [user, system]
        default: user
        type: str

- state
        State in which to leave the user.
        choices: [present, absent]
        default: present
        type: str

- uid
        UID of the user.
        Will use next available UID if not specified.
        default: null
        type: str


AUTHOR: Orion Poplawski (@opoplawski)

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

EXAMPLES:

- name: Add operator user
  pfsense_user:
    name: operator
    descr: Operator
    scope: user
    groups: [ 'Operators' ]
    priv: [ 'page-all', 'user-shell-access' ]

- name: Remove user
  pfsense_user:
    name: operator
    state: absent