W3cubDocs

/Ansible

community.general.pam_limits – Modify Linux PAM limits

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.pam_limits.

Synopsis

  • The pam_limits module modifies PAM limits.
  • The default file is /etc/security/limits.conf.
  • For the full documentation, see man 5 limits.conf.

Parameters

Parameter Choices/Defaults Comments
backup
boolean
    Choices:
  • no ←
  • yes
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
comment
string
Default:
""
Comment associated with the limit.
dest
string
Default:
"/etc/security/limits.conf"
Modify the limits.conf path.
domain
string / required
A username, @groupname, wildcard, UID/GID range.
limit_item
string / required
    Choices:
  • core
  • data
  • fsize
  • memlock
  • nofile
  • rss
  • stack
  • cpu
  • nproc
  • as
  • maxlogins
  • maxsyslogins
  • priority
  • locks
  • sigpending
  • msgqueue
  • nice
  • rtprio
  • chroot
The limit to be set.
limit_type
string / required
    Choices:
  • hard
  • soft
  • -
Limit type, see man 5 limits.conf for an explanation.
use_max
boolean
    Choices:
  • no ←
  • yes
If set to yes, the maximal value will be used or conserved.
If the specified value is superior to the value in the file, file content is replaced with the new value, else content is not modified.
use_min
boolean
    Choices:
  • no ←
  • yes
If set to yes, the minimal value will be used or conserved.
If the specified value is inferior to the value in the file, file content is replaced with the new value, else content is not modified.
value
string / required
The value of the limit.
Value must either be unlimited, infinity or -1, all of which indicate no limit, or a limit of 0 or larger.
Value must be a number in the range -20 to 19 inclusive, if limit_item is set to nice or priority.
Refer to the man 5 limits.conf manual pages for more details.

Notes

Note

  • If dest file does not exist, it is created.

Examples

- name: Add or modify nofile soft limit for the user joe
  community.general.pam_limits:
    domain: joe
    limit_type: soft
    limit_item: nofile
    value: 64000

- name: Add or modify fsize hard limit for the user smith. Keep or set the maximal value
  community.general.pam_limits:
    domain: smith
    limit_type: hard
    limit_item: fsize
    value: 1000000
    use_max: yes

- name: Add or modify memlock, both soft and hard, limit for the user james with a comment
  community.general.pam_limits:
    domain: james
    limit_type: '-'
    limit_item: memlock
    value: unlimited
    comment: unlimited memory lock for james

- name: Add or modify hard nofile limits for wildcard domain
  community.general.pam_limits:
    domain: '*'
    limit_type: hard
    limit_item: nofile
    value: 39693561

Authors

  • Sebastien Rohaut (@usawa)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/pam_limits_module.html