pfsense_user - opoplawski/ansible-pfsense GitHub Wiki

> PFSENSE_USER    (/home/fbor/ansible/lib/ansible/modules/network/pfsense/pfsense_user.py)

  Manage pfSense users

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


RETURN VALUES: