Skip to content

[pfsense_user] Add support for disabling users #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
opoplawski merged 4 commits into from
Nov 9, 2025
+18 −1
Merged

[pfsense_user] Add support for disabling users #208

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b188939
feat: Add support disabling users
JonatanLindstrom Oct 22, 2025
5784e4f
fix: Add trailing comma
JonatanLindstrom Oct 23, 2025
fac34e3
fix: Add a version_added attribute to docs
JonatanLindstrom Oct 23, 2025
5aaf475
fix: don't send self as a param
JonatanLindstrom Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion plugins/modules/pfsense_user.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
choices: [ "present", "absent" ]
type: str
descr:
description: Description of the user
description: Description of the user.
type: str
scope:
description: Scope of the user ('user' is a normal user, use 'system' for 'admin' user). Defaults to `user`.
Expand All @@ -55,6 +55,11 @@
authorizedkeys:
description: Authorized SSH Keys of the user. Can be base64 encoded.
type: str
disabled:
description: Disables the user, so that they cannot login.
default: false
type: bool
Comment thread
JonatanLindstrom marked this conversation as resolved.
version_added: 0.7.1
'''

EXAMPLES = r'''
Expand Down Expand Up @@ -92,6 +97,7 @@
groups=dict(type='list', elements='str'),
priv=dict(type='list', elements='str'),
authorizedkeys=dict(type='str'),
disabled=dict(type='bool', default=False),
)

USER_CREATE_DEFAULT = dict(
Expand Down Expand Up @@ -224,6 +230,8 @@ def _copy_and_update_target(self):
self.diff['after'] = self.pfsense.element_to_dict(self.target_elt)
if 'priv' in self.diff['after']:
self.diff['after']['priv'] = self._format_diff_priv(self.diff['after']['priv'])
if self._remove_deleted_disabled_param():
changed = True
if self._update_groups():
changed = True

Expand Down Expand Up @@ -273,6 +281,15 @@ def _update_groups(self):

return changed

def _remove_deleted_disabled_param(self):
""" Remove disabled param if user is re-enabled """
changed = False

if self.pfsense.remove_deleted_param_from_elt(self.target_elt, 'disabled', self.obj):
changed = True

return changed

##############################
# run
#
Expand Down