Docs: Cleanup selinux_permissive module docs (#46351)

Update the selinux_permissive instructions and add a comment to the
provided example.

Signed-off-by: Major Hayden <major@redhat.com>
This commit is contained in:
Major Hayden 2018-10-03 12:04:25 -05:00 committed by Alicia Cozine
parent e283e7d5dd
commit 84eb92d13d

View file

@ -19,36 +19,37 @@ DOCUMENTATION = '''
module: selinux_permissive module: selinux_permissive
short_description: Change permissive domain in SELinux policy short_description: Change permissive domain in SELinux policy
description: description:
- Add and remove domain from the list of permissive domain. - Add and remove a domain from the list of permissive domains.
version_added: "2.0" version_added: "2.0"
options: options:
domain: domain:
description: description:
- "the domain that will be added or removed from the list of permissive domains" - The domain that will be added or removed from the list of permissive domains.
required: true required: true
permissive: permissive:
description: description:
- "indicate if the domain should or should not be set as permissive" - Indicate if the domain should or should not be set as permissive.
required: true required: true
type: bool type: bool
no_reload: no_reload:
description: description:
- "automatically reload the policy after a change" - Disable reloading of the SELinux policy after making change to a domain's permissive setting.
- "default is set to 'false' as that's what most people would want after changing one domain" - The default is C(no), which causes policy to be reloaded when a domain changes state.
- "Note that this doesn't work on older version of the library (example EL 6), the module will silently ignore it in this case" - Reloading the policy does not work on older versions of the C(policycoreutils-python) library, for example in EL 6."
type: bool type: bool
default: 'no' default: 'no'
store: store:
description: description:
- "name of the SELinux policy store to use" - "Name of the SELinux policy store to use."
notes: notes:
- Requires a version of SELinux recent enough ( ie EL 6 or newer ) - Requires a recent version of SELinux and C(policycoreutils-python) (EL 6 or newer).
requirements: [ policycoreutils-python ] requirements: [ policycoreutils-python ]
author: Michael Scherer (@mscherer) <misc@zarb.org> author: Michael Scherer (@mscherer) <misc@zarb.org>
''' '''
EXAMPLES = ''' EXAMPLES = '''
- selinux_permissive: - name: Change the httpd_t domain to permissive
selinux_permissive:
name: httpd_t name: httpd_t
permissive: true permissive: true
''' '''