Improve the formatting and content for the sysctl module's description.
This commit is contained in:
parent
a130a8e614
commit
36a8312de6
1 changed files with 15 additions and 12 deletions
|
@ -22,45 +22,48 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: sysctl
|
module: sysctl
|
||||||
short_description: Permit to handle sysctl.conf entries
|
short_description: Manage entries in sysctl.conf.
|
||||||
description:
|
description:
|
||||||
- This module manipulates sysctl entries and performs a I(/sbin/sysctl -p) after changing them.
|
- This module manipulates sysctl entries and optionally performs a C(/sbin/sysctl -p) after changing them.
|
||||||
version_added: "1.0"
|
version_added: "1.0"
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- this is the short path, decimal separated, to the sysctl entry
|
- The dot-separated path (aka I(key)) specifying the sysctl variable.
|
||||||
required: true
|
required: true
|
||||||
default: null
|
default: null
|
||||||
aliases: [ 'key' ]
|
aliases: [ 'key' ]
|
||||||
value:
|
value:
|
||||||
description:
|
description:
|
||||||
- set the sysctl value to this entry
|
- Desired value of the sysctl key.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: [ 'val' ]
|
aliases: [ 'val' ]
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- whether the entry should be present or absent
|
- Whether the entry should be present or absent.
|
||||||
choices: [ "present", "absent" ]
|
choices: [ "present", "absent" ]
|
||||||
default: present
|
default: present
|
||||||
checks:
|
checks:
|
||||||
description:
|
description:
|
||||||
- if C(checks)=I(none) no smart/facultative checks will be made
|
- If C(none), no smart/facultative checks will be made. If
|
||||||
- if C(checks)=I(before) some checks performed before any update (ie. does the sysctl key is writable ?)
|
C(before), some checks are performed before any update (i.e. is
|
||||||
- if C(checks)=I(after) some checks performed after an update (ie. does kernel give back the set value ?)
|
the sysctl key writable?). If C(after), some checks are performed
|
||||||
- if C(checks)=I(both) all the smart checks I(before and after) are performed
|
after an update (i.e. does kernel return the set value?). If
|
||||||
|
C(both), all of the smart checks (C(before) and C(after)) are
|
||||||
|
performed.
|
||||||
choices: [ "none", "before", "after", "both" ]
|
choices: [ "none", "before", "after", "both" ]
|
||||||
default: both
|
default: both
|
||||||
reload:
|
reload:
|
||||||
description:
|
description:
|
||||||
- if C(reload=yes), performs a I(/sbin/sysctl -p) if the C(sysctl_file) is updated
|
- If C(yes), performs a I(/sbin/sysctl -p) if the C(sysctl_file) is
|
||||||
- if C(reload=no), does not reload I(sysctl) even if the C(sysctl_file) is updated
|
updated. If C(no), does not reload I(sysctl) even if the
|
||||||
|
C(sysctl_file) is updated.
|
||||||
choices: [ "yes", "no" ]
|
choices: [ "yes", "no" ]
|
||||||
default: "yes"
|
default: "yes"
|
||||||
sysctl_file:
|
sysctl_file:
|
||||||
description:
|
description:
|
||||||
- specifies the absolute path to C(sysctl.conf), if not /etc/sysctl.conf
|
- Specifies the absolute path to C(sysctl.conf), if not C(/etc/sysctl.conf).
|
||||||
required: false
|
required: false
|
||||||
default: /etc/sysctl.conf
|
default: /etc/sysctl.conf
|
||||||
notes: []
|
notes: []
|
||||||
|
|
Loading…
Reference in a new issue