Resolves #1312, Improve pam_limits documentation

Adds comment parameter and improve examples.
This commit is contained in:
Guillaume Grossetie 2015-12-01 14:22:25 +01:00 committed by GUILLAUME GROSSETIE
parent 3c4f954f0f
commit 32658b9d3b

View file

@ -78,14 +78,22 @@ options:
- Modify the limits.conf path. - Modify the limits.conf path.
required: false required: false
default: "/etc/security/limits.conf" default: "/etc/security/limits.conf"
comment:
description:
- Comment associated with the limit.
required: false
default: ''
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Add or modify limits for the user joe # Add or modify nofile soft limit for the user joe
- pam_limits: domain=joe limit_type=soft limit_item=nofile value=64000 - pam_limits: domain=joe limit_type=soft limit_item=nofile value=64000
# Add or modify limits for the user joe. Keep or set the maximal value # Add or modify fsize hard limit for the user smith. Keep or set the maximal value.
- pam_limits: domain=joe limit_type=soft limit_item=nofile value=1000000 - pam_limits: domain=smith limit_type=hard limit_item=fsize value=1000000 use_max=yes
# Add or modify memlock, both soft and hard, limit for the user james with a comment.
- pam_limits: domain=james limit_type=- limit_item=memlock value=unlimited comment="unlimited memory lock for james"
''' '''
def main(): def main():