carroarmato0/ansible.posix
1
0
Fork 0
mirror of https://github.com/ansible-collections/ansible.posix.git synced 2026-01-11 23:25:28 +01:00
Code Issues Projects Releases Packages Wiki Activity

Prepare 1.1.1 release

Browse source 
Run add_docs.py
Run antsibull-changelog; backfill for prior releases
Bump release in galaxy.yml
Add .keep to changelogs/fragments so directory is not deleted if
`keep_fragments` is ever set to False.
This commit is contained in:
jillr 2020-09-02 16:39:46 +00:00
parent f68cec59e7
commit e5e36d3c7b
14 changed files with 1561 additions and 1410 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
CHANGELOG.rst Normal file
View file

@ -0,0 +1,73 @@
===========================
ansible.posix Release Notes
===========================
.. contents:: Topics
v1.1.1
======
Bugfixes
--------
- Fix synchronize to work with renamed docker and buildah connection plugins.
v1.1.0
======
Minor Changes
-------------
- firewalld - add firewalld module to ansible.posix collection
v1.0.0
======
Major Changes
-------------
- Bootstrap Collection (https://github.com/ansible-collections/ansible.posix/pull/1).
Minor Changes
-------------
- CI should use devel (https://github.com/ansible-collections/ansible.posix/pull/6).
- Enable tests for at, patch and synchronize modules (https://github.com/ansible-collections/ansible.posix/pull/5).
- Enabled tags in galaxy.yml (https://github.com/ansible-collections/ansible.posix/issues/18).
- Migrate hacking/cgroup_perf_recap_graph.py to this collection, since the cgroup_perf_recap callback lives here.
- Remove license key from galaxy.yml.
- Remove sanity jobs from shippable (https://github.com/ansible-collections/ansible.posix/pull/43).
- Removed ANSIBLE_METADATA from all the modules.
- Revert "Enable at, patch and synchronize tests (https://github.com/ansible-collections/ansible.posix/pull/5)".
- Update EXAMPLES section in modules to use FQCN.
- Update README.md (https://github.com/ansible-collections/ansible.posix/pull/4/).
Bugfixes
--------
- Allow unsetting existing environment vars via environment by specifying a null value (https://github.com/ansible/ansible/pull/68236).
- Mount - Handle remount with new options (https://github.com/ansible/ansible/issues/59460).
- Profile_tasks - result was a odict_items which is not subscriptable, so the slicing was failing (https://github.com/ansible/ansible/issues/59059).
- Revert "mount - Check if src exists before mounted (ansible/ansible#61752)".
- Typecast results before use in profile_tasks callback (https://github.com/ansible/ansible/issues/69563).
- authorized_keys - Added FIDO2 security keys (https://github.com/ansible-collections/ansible.posix/issues/17).
- authorized_keys - fix inconsistent return value for check mode (https://github.com/ansible-collections/ansible.posix/issues/37)
- json callback - Fix host result to task references in the resultant JSON output for non-lockstep strategy plugins such as free (https://github.com/ansible/ansible/issues/65931)
- mount - fix issues with ismount module_util pathing for Ansible 2.9 (fixes https://github.com/ansible-collections/ansible.posix/issues/21)
- patch - fix FQCN usage for action plugin (https://github.com/ansible-collections/ansible.posix/issues/11)
- selinux - add missing configuration keys for /etc/selinux/config (https://github.com/ansible-collections/ansible.posix/issues/23)
- synchronize - fix FQCN usage for action plugin (https://github.com/ansible-collections/ansible.posix/issues/11)
New Modules
-----------
- acl - Set and retrieve file ACL information.
- at - Schedule the execution of a command or script file via the at command
- authorized_key - Adds or removes an SSH authorized key
- mount - Control active and configured mount points
- patch - Apply patch files using the GNU patch tool
- seboolean - Toggles SELinux booleans
- selinux - Change policy and state of SELinux
- synchronize - A wrapper around rsync to make common tasks in your playbooks quick and easy
- sysctl - Manage entries in sysctl.conf.

102
changelogs/changelog.yaml Normal file
View file

@ -0,0 +1,102 @@
ancestor: null
releases:
1.0.0:
changes:
bugfixes:
- Allow unsetting existing environment vars via environment by specifying a
null value (https://github.com/ansible/ansible/pull/68236).
- Mount - Handle remount with new options (https://github.com/ansible/ansible/issues/59460).
- Profile_tasks - result was a odict_items which is not subscriptable, so the
slicing was failing (https://github.com/ansible/ansible/issues/59059).
- Revert "mount - Check if src exists before mounted (ansible/ansible#61752)".
- Typecast results before use in profile_tasks callback (https://github.com/ansible/ansible/issues/69563).
- authorized_keys - Added FIDO2 security keys (https://github.com/ansible-collections/ansible.posix/issues/17).
- authorized_keys - fix inconsistent return value for check mode (https://github.com/ansible-collections/ansible.posix/issues/37)
- json callback - Fix host result to task references in the resultant JSON output
for non-lockstep strategy plugins such as free (https://github.com/ansible/ansible/issues/65931)
- mount - fix issues with ismount module_util pathing for Ansible 2.9 (fixes
https://github.com/ansible-collections/ansible.posix/issues/21)
- patch - fix FQCN usage for action plugin (https://github.com/ansible-collections/ansible.posix/issues/11)
- selinux - add missing configuration keys for /etc/selinux/config (https://github.com/ansible-collections/ansible.posix/issues/23)
- synchronize - fix FQCN usage for action plugin (https://github.com/ansible-collections/ansible.posix/issues/11)
major_changes:
- Bootstrap Collection (https://github.com/ansible-collections/ansible.posix/pull/1).
minor_changes:
- CI should use devel (https://github.com/ansible-collections/ansible.posix/pull/6).
- Enable tests for at, patch and synchronize modules (https://github.com/ansible-collections/ansible.posix/pull/5).
- Enabled tags in galaxy.yml (https://github.com/ansible-collections/ansible.posix/issues/18).
- Migrate hacking/cgroup_perf_recap_graph.py to this collection, since the cgroup_perf_recap
callback lives here.
- Remove license key from galaxy.yml.
- Remove sanity jobs from shippable (https://github.com/ansible-collections/ansible.posix/pull/43).
- Removed ANSIBLE_METADATA from all the modules.
- Revert "Enable at, patch and synchronize tests (https://github.com/ansible-collections/ansible.posix/pull/5)".
- Update EXAMPLES section in modules to use FQCN.
- Update README.md (https://github.com/ansible-collections/ansible.posix/pull/4/).
fragments:
- 11-action-plugins-use-fqcn.yml
- 12_migrate_cgroup_perf_recap_graph.yml
- 14_mount_option.yml
- 15_profile_tasks.yml
- 17_authorized_keys.yml
- 19_enable_tags.yml
- 21-mount-module_util-routing-issue.yml
- 23-selinux-doesnt-create-missing-config-keys.yml
- 25_ansible_metadata.yml
- 26_profile_tasks_doc.yml
- 27_update_examples.yml
- 33_mount.yml
- 35_disable_tests.yml
- 37-authorized_keys-inconsistent-check-mode-values.yml
- 39_remove_license.yml
- 43_remove_shippable.yml
- 4_update_readme.yml
- 5_enable_tests.yml
- 65931-json-callback-non-lockstep-output.yml
- 6_test_devel.yml
- 7_env.yml
- initial_commit.yaml
modules:
- description: Set and retrieve file ACL information.
name: acl
namespace: ''
- description: Schedule the execution of a command or script file via the at command
name: at
namespace: ''
- description: Adds or removes an SSH authorized key
name: authorized_key
namespace: ''
- description: Control active and configured mount points
name: mount
namespace: ''
- description: Apply patch files using the GNU patch tool
name: patch
namespace: ''
- description: Toggles SELinux booleans
name: seboolean
namespace: ''
- description: Change policy and state of SELinux
name: selinux
namespace: ''
- description: A wrapper around rsync to make common tasks in your playbooks quick
and easy
name: synchronize
namespace: ''
- description: Manage entries in sysctl.conf.
name: sysctl
namespace: ''
release_date: '2020-06-19'
1.1.0:
changes:
minor_changes:
- firewalld - add firewalld module to ansible.posix collection
fragments:
- firewalld_migration.yml
release_date: '2020-07-15'
1.1.1:
changes:
bugfixes:
- Fix synchronize to work with renamed docker and buildah connection plugins.
fragments:
- 74_synchronize_docker.yml
release_date: '2020-09-02'

0
changelogs/fragments/.keep Normal file
View file

313
docs/ansible.posix.acl_module.rst
View file

@ -31,217 +31,218 @@ Parameters
<tr> <tr>
<th colspan="1">Parameter</th> <th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th> <th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th> <th width="100%">Comments</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>default</b> <b>default</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>If the target is a directory, setting this to <code>yes</code> will make it the default ACL for entities created inside the directory.</div> <div>If the target is a directory, setting this to <code>yes</code> will make it the default ACL for entities created inside the directory.</div>
<div>Setting <code>default</code> to <code>yes</code> causes an error if the path is a file.</div> <div>Setting <code>default</code> to <code>yes</code> causes an error if the path is a file.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>entity</b> <b>entity</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>The actual user or group that the ACL applies to when matching entity types user or group are selected.</div> <div>The actual user or group that the ACL applies to when matching entity types user or group are selected.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>entry</b> <b>entry</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>DEPRECATED.</div> <div>DEPRECATED.</div>
<div>The ACL to set or remove.</div> <div>The ACL to set or remove.</div>
<div>This must always be quoted in the form of <code>&lt;etype&gt;:&lt;qualifier&gt;:&lt;perms&gt;</code>.</div> <div>This must always be quoted in the form of <code>&lt;etype&gt;:&lt;qualifier&gt;:&lt;perms&gt;</code>.</div>
<div>The qualifier may be empty for some types, but the type and perms are always required.</div> <div>The qualifier may be empty for some types, but the type and perms are always required.</div>
<div><code>-</code> can be used as placeholder when you do not care about permissions.</div> <div><code>-</code> can be used as placeholder when you do not care about permissions.</div>
<div>This is now superseded by entity, type and permissions fields.</div> <div>This is now superseded by entity, type and permissions fields.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>etype</b> <b>etype</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>group</li> <li>group</li>
<li>mask</li> <li>mask</li>
<li>other</li> <li>other</li>
<li>user</li> <li>user</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>The entity type of the ACL to apply, see <code>setfacl</code> documentation for more info.</div> <div>The entity type of the ACL to apply, see <code>setfacl</code> documentation for more info.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>follow</b> <b>follow</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Whether to follow symlinks on the path if a symlink is encountered.</div> <div>Whether to follow symlinks on the path if a symlink is encountered.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>path</b> <b>path</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">path</span> <span style="color: purple">path</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
</td> <td>
<td> </td>
<div>The full path of the file or object.</div> <td>
<div style="font-size: small; color: darkgreen"><br/>aliases: name</div> <div>The full path of the file or object.</div>
</td> <div style="font-size: small; color: darkgreen"><br/>aliases: name</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>permissions</b> <b>permissions</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>The permissions to apply/remove can be any combination of <code>r</code>, <code>w</code> and <code>x</code> (read, write and execute respectively)</div> <div>The permissions to apply/remove can be any combination of <code>r</code>, <code>w</code> and <code>x</code> (read, write and execute respectively)</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>recalculate_mask</b> <b>recalculate_mask</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>default</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>default</b>&nbsp;&larr;</div></li>
<li>mask</li> <li>mask</li>
<li>no_mask</li> <li>no_mask</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Select if and when to recalculate the effective right masks of the files.</div> <div>Select if and when to recalculate the effective right masks of the files.</div>
<div>See <code>setfacl</code> documentation for more info.</div> <div>See <code>setfacl</code> documentation for more info.</div>
<div>Incompatible with <code>state=query</code>.</div> <div>Incompatible with <code>state=query</code>.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>recursive</b> <b>recursive</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Recursively sets the specified ACL.</div> <div>Recursively sets the specified ACL.</div>
<div>Incompatible with <code>state=query</code>.</div> <div>Incompatible with <code>state=query</code>.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>state</b> <b>state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>absent</li> <li>absent</li>
<li>present</li> <li>present</li>
<li><div style="color: blue"><b>query</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>query</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Define whether the ACL should be present or not.</div> <div>Define whether the ACL should be present or not.</div>
<div>The <code>query</code> state gets the current ACL without changing it, for use in <code>register</code> operations.</div> <div>The <code>query</code> state gets the current ACL without changing it, for use in <code>register</code> operations.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>use_nfsv4_acls</b> <b>use_nfsv4_acls</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Use NFSv4 ACLs instead of POSIX ACLs.</div> <div>Use NFSv4 ACLs instead of POSIX ACLs.</div>
</td> </td>
</tr> </tr>
</table> </table>
<br/> <br/>
@ -260,7 +261,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
- name: Grant user Joe read access to a file - name: Grant user Joe read access to a file
ansible.posix.acl: ansible.posix.acl:
path: /etc/foo.conf path: /etc/foo.conf
@ -298,7 +298,6 @@ Examples
Return Values Return Values
------------- -------------
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
@ -311,24 +310,24 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
<th>Returned</th> <th>Returned</th>
<th width="100%">Description</th> <th width="100%">Description</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>acl</b> <b>acl</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">list</span> <span style="color: purple">list</span>
</div> </div>
</td> </td>
<td>success</td> <td>success</td>
<td> <td>
<div>Current ACL on provided path (after changes, if any)</div> <div>Current ACL on provided path (after changes, if any)</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[&#x27;user::rwx&#x27;, &#x27;group::rwx&#x27;, &#x27;other::rwx&#x27;]</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[&#x27;user::rwx&#x27;, &#x27;group::rwx&#x27;, &#x27;other::rwx&#x27;]</div>
</td> </td>
</tr> </tr>
</table> </table>
<br/><br/> <br/><br/>
@ -341,5 +340,3 @@ Authors
- Brian Coca (@bcoca) - Brian Coca (@bcoca)
- Jérémie Astori (@astorije) - Jérémie Astori (@astorije)

146
docs/ansible.posix.at_module.rst
View file

@ -38,113 +38,115 @@ Parameters
<tr> <tr>
<th colspan="1">Parameter</th> <th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th> <th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th> <th width="100%">Comments</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>command</b> <b>command</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>A command to be executed in the future.</div> <div>A command to be executed in the future.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>count</b> <b>count</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">integer</span> <span style="color: purple">integer</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
</td> <td>
<td> </td>
<div>The count of units in the future to execute the command or script file.</div> <td>
</td> <div>The count of units in the future to execute the command or script file.</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>script_file</b> <b>script_file</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>An existing script file to be executed in the future.</div> <div>An existing script file to be executed in the future.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>state</b> <b>state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>absent</li> <li>absent</li>
<li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>The state dictates if the command or script file should be evaluated as present(added) or absent(deleted).</div> <div>The state dictates if the command or script file should be evaluated as present(added) or absent(deleted).</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>unique</b> <b>unique</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>If a matching job is present a new job will not be added.</div> <div>If a matching job is present a new job will not be added.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>units</b> <b>units</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <td>
<li>minutes</li> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>hours</li> <li>minutes</li>
<li>days</li> <li>hours</li>
<li>weeks</li> <li>days</li>
</ul> <li>weeks</li>
</td> </ul>
<td> </td>
<div>The type of units in the future to execute the command or script file.</div> <td>
</td> <div>The type of units in the future to execute the command or script file.</div>
</td>
</tr> </tr>
</table> </table>
<br/> <br/>
@ -155,7 +157,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
- name: Schedule a command to execute in 20 minutes as root - name: Schedule a command to execute in 20 minutes as root
ansible.posix.at: ansible.posix.at:
command: ls -d / >/dev/null command: ls -d / >/dev/null
@ -177,7 +178,6 @@ Examples
Status Status
------ ------
@ -186,5 +186,3 @@ Authors
~~~~~~~ ~~~~~~~
- Richard Isaacson (@risaacson) - Richard Isaacson (@risaacson)

420
docs/ansible.posix.authorized_key_module.rst
View file

@ -31,191 +31,193 @@ Parameters
<tr> <tr>
<th colspan="1">Parameter</th> <th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th> <th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th> <th width="100%">Comments</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>comment</b> <b>comment</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Change the comment on the public key.</div> <div>Change the comment on the public key.</div>
<div>Rewriting the comment is useful in cases such as fetching it from GitHub or GitLab.</div> <div>Rewriting the comment is useful in cases such as fetching it from GitHub or GitLab.</div>
<div>If no comment is specified, the existing comment will be kept.</div> <div>If no comment is specified, the existing comment will be kept.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>exclusive</b> <b>exclusive</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Whether to remove all other non-specified keys from the authorized_keys file.</div> <div>Whether to remove all other non-specified keys from the authorized_keys file.</div>
<div>Multiple keys can be specified in a single <code>key</code> string value by separating them by newlines.</div> <div>Multiple keys can be specified in a single <code>key</code> string value by separating them by newlines.</div>
<div>This option is not loop aware, so if you use <code>with_</code> , it will be exclusive per iteration of the loop.</div> <div>This option is not loop aware, so if you use <code>with_</code> , it will be exclusive per iteration of the loop.</div>
<div>If you want multiple keys in the file you need to pass them all to <code>key</code> in a single batch as mentioned above.</div> <div>If you want multiple keys in the file you need to pass them all to <code>key</code> in a single batch as mentioned above.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>follow</b> <b>follow</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Follow path symlink instead of replacing it.</div> <div>Follow path symlink instead of replacing it.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>key</b> <b>key</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
</td> <td>
<td> </td>
<div>The SSH public key(s), as a string or (since Ansible 1.9) url (https://github.com/username.keys).</div> <td>
</td> <div>The SSH public key(s), as a string or (since Ansible 1.9) url (https://github.com/username.keys).</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>key_options</b> <b>key_options</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>A string of ssh key options to be prepended to the key in the authorized_keys file.</div> <div>A string of ssh key options to be prepended to the key in the authorized_keys file.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>manage_dir</b> <b>manage_dir</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Whether this module should manage the directory of the authorized key file.</div> <div>Whether this module should manage the directory of the authorized key file.</div>
<div>If set to <code>yes</code>, the module will create the directory, as well as set the owner and permissions of an existing directory.</div> <div>If set to <code>yes</code>, the module will create the directory, as well as set the owner and permissions of an existing directory.</div>
<div>Be sure to set <code>manage_dir=no</code> if you are using an alternate directory for authorized_keys, as set with <code>path</code>, since you could lock yourself out of SSH access.</div> <div>Be sure to set <code>manage_dir=no</code> if you are using an alternate directory for authorized_keys, as set with <code>path</code>, since you could lock yourself out of SSH access.</div>
<div>See the example below.</div> <div>See the example below.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>path</b> <b>path</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">path</span> <span style="color: purple">path</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Alternate path to the authorized_keys file.</div> <div>Alternate path to the authorized_keys file.</div>
<div>When unset, this value defaults to <em>~/.ssh/authorized_keys</em>.</div> <div>When unset, this value defaults to <em>~/.ssh/authorized_keys</em>.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>state</b> <b>state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>absent</li> <li>absent</li>
<li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Whether the given key (with the given key_options) should or should not be in the file.</div> <div>Whether the given key (with the given key_options) should or should not be in the file.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>user</b> <b>user</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
</td> <td>
<td> </td>
<div>The username on the remote host whose authorized_keys file will be modified.</div> <td>
</td> <div>The username on the remote host whose authorized_keys file will be modified.</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>validate_certs</b> <b>validate_certs</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>This only applies if using a https url as the source of the keys.</div> <div>This only applies if using a https url as the source of the keys.</div>
<div>If set to <code>no</code>, the SSL certificates will not be validated.</div> <div>If set to <code>no</code>, the SSL certificates will not be validated.</div>
<div>This should only set to <code>no</code> used on personally controlled sites using self-signed certificates as it avoids verifying the source site.</div> <div>This should only set to <code>no</code> used on personally controlled sites using self-signed certificates as it avoids verifying the source site.</div>
<div>Prior to 2.1 the code worked as if this was set to <code>yes</code>.</div> <div>Prior to 2.1 the code worked as if this was set to <code>yes</code>.</div>
</td> </td>
</tr> </tr>
</table> </table>
<br/> <br/>
@ -226,7 +228,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
- name: Set authorized key taken from file - name: Set authorized key taken from file
ansible.posix.authorized_key: ansible.posix.authorized_key:
user: charlie user: charlie
@ -285,7 +286,6 @@ Examples
Return Values Return Values
------------- -------------
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
@ -298,169 +298,169 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
<th>Returned</th> <th>Returned</th>
<th width="100%">Description</th> <th width="100%">Description</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>exclusive</b> <b>exclusive</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td>success</td> <td>success</td>
<td> <td>
<div>If the key has been forced to be exclusive or not.</div> <div>If the key has been forced to be exclusive or not.</div>
<br/> <br/>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>key</b> <b>key</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td>success</td> <td>success</td>
<td> <td>
<div>The key that the module was running against.</div> <div>The key that the module was running against.</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">https://github.com/user.keys</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">https://github.com/user.keys</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>key_option</b> <b>key_option</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td>success</td> <td>success</td>
<td> <td>
<div>Key options related to the key.</div> <div>Key options related to the key.</div>
<br/> <br/>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>keyfile</b> <b>keyfile</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td>success</td> <td>success</td>
<td> <td>
<div>Path for authorized key file.</div> <div>Path for authorized key file.</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">/home/user/.ssh/authorized_keys</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">/home/user/.ssh/authorized_keys</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>manage_dir</b> <b>manage_dir</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td>success</td> <td>success</td>
<td> <td>
<div>Whether this module managed the directory of the authorized key file.</div> <div>Whether this module managed the directory of the authorized key file.</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">True</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">True</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>path</b> <b>path</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td>success</td> <td>success</td>
<td> <td>
<div>Alternate path to the authorized_keys file</div> <div>Alternate path to the authorized_keys file</div>
<br/> <br/>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>state</b> <b>state</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td>success</td> <td>success</td>
<td> <td>
<div>Whether the given key (with the given key_options) should or should not be in the file</div> <div>Whether the given key (with the given key_options) should or should not be in the file</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">present</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">present</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>unique</b> <b>unique</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td>success</td> <td>success</td>
<td> <td>
<div>Whether the key is unique</div> <div>Whether the key is unique</div>
<br/> <br/>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>user</b> <b>user</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td>success</td> <td>success</td>
<td> <td>
<div>The username on the remote host whose authorized_keys file will be modified</div> <div>The username on the remote host whose authorized_keys file will be modified</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">user</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">user</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>validate_certs</b> <b>validate_certs</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td>success</td> <td>success</td>
<td> <td>
<div>This only applies if using a https url as the source of the keys. If set to <code>no</code>, the SSL certificates will not be validated.</div> <div>This only applies if using a https url as the source of the keys. If set to <code>no</code>, the SSL certificates will not be validated.</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">True</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">True</div>
</td> </td>
</tr> </tr>
</table> </table>
<br/><br/> <br/><br/>
@ -472,5 +472,3 @@ Authors
~~~~~~~ ~~~~~~~
- Ansible Core Team - Ansible Core Team

318
docs/ansible.posix.firewalld_module.rst
View file

@ -36,247 +36,249 @@ Parameters
<tr> <tr>
<th colspan="1">Parameter</th> <th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th> <th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th> <th width="100%">Comments</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>icmp_block</b> <b>icmp_block</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>The ICMP block you would like to add/remove to/from a zone in firewalld.</div> <div>The ICMP block you would like to add/remove to/from a zone in firewalld.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>icmp_block_inversion</b> <b>icmp_block_inversion</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Enable/Disable inversion of ICMP blocks for a zone in firewalld.</div> <div>Enable/Disable inversion of ICMP blocks for a zone in firewalld.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>immediate</b> <b>immediate</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Should this configuration be applied immediately, if set as permanent.</div> <div>Should this configuration be applied immediately, if set as permanent.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>interface</b> <b>interface</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>The interface you would like to add/remove to/from a zone in firewalld.</div> <div>The interface you would like to add/remove to/from a zone in firewalld.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>masquerade</b> <b>masquerade</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>The masquerade setting you would like to enable/disable to/from zones within firewalld.</div> <div>The masquerade setting you would like to enable/disable to/from zones within firewalld.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>offline</b> <b>offline</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Whether to run this module even when firewalld is offline.</div> <div>Whether to run this module even when firewalld is offline.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>permanent</b> <b>permanent</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Should this configuration be in the running firewalld configuration or persist across reboots.</div> <div>Should this configuration be in the running firewalld configuration or persist across reboots.</div>
<div>As of Ansible 2.3, permanent operations can operate on firewalld configs when it is not running (requires firewalld &gt;= 3.0.9).</div> <div>As of Ansible 2.3, permanent operations can operate on firewalld configs when it is not running (requires firewalld &gt;= 3.0.9).</div>
<div>Note that if this is <code>no</code>, immediate is assumed <code>yes</code>.</div> <div>Note that if this is <code>no</code>, immediate is assumed <code>yes</code>.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>port</b> <b>port</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Name of a port or port range to add/remove to/from firewalld.</div> <div>Name of a port or port range to add/remove to/from firewalld.</div>
<div>Must be in the form PORT/PROTOCOL or PORT-PORT/PROTOCOL for port ranges.</div> <div>Must be in the form PORT/PROTOCOL or PORT-PORT/PROTOCOL for port ranges.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>rich_rule</b> <b>rich_rule</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Rich rule to add/remove to/from firewalld.</div> <div>Rich rule to add/remove to/from firewalld.</div>
</td> <div>See <a href='https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html'>Syntax for firewalld rich language rules</a>.</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>service</b> <b>service</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Name of a service to add/remove to/from firewalld.</div> <div>Name of a service to add/remove to/from firewalld.</div>
<div>The service must be listed in output of firewall-cmd --get-services.</div> <div>The service must be listed in output of firewall-cmd --get-services.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>source</b> <b>source</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>The source/network you would like to add/remove to/from firewalld.</div> <div>The source/network you would like to add/remove to/from firewalld.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>state</b> <b>state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <td>
<li>absent</li> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>disabled</li> <li>absent</li>
<li>enabled</li> <li>disabled</li>
<li>present</li> <li>enabled</li>
</ul> <li>present</li>
</td> </ul>
<td> </td>
<div>Enable or disable a setting.</div> <td>
<div>For ports: Should this port accept (enabled) or reject (disabled) connections.</div> <div>Enable or disable a setting.</div>
<div>The states <code>present</code> and <code>absent</code> can only be used in zone level operations (i.e. when no other parameters but zone and state are set).</div> <div>For ports: Should this port accept (enabled) or reject (disabled) connections.</div>
</td> <div>The states <code>present</code> and <code>absent</code> can only be used in zone level operations (i.e. when no other parameters but zone and state are set).</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>timeout</b> <b>timeout</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">integer</span> <span style="color: purple">integer</span>
</div> </div>
</td> </td>
<td> <td>
<b>Default:</b><br/><div style="color: blue">0</div> <b>Default:</b><br/><div style="color: blue">0</div>
</td> </td>
<td> <td>
<div>The amount of time the rule should be in effect for when non-permanent.</div> <div>The amount of time the rule should be in effect for when non-permanent.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>zone</b> <b>zone</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>The firewalld zone to add/remove to/from.</div> <div>The firewalld zone to add/remove to/from.</div>
<div>Note that the default zone can be configured per system but <code>public</code> is default from upstream.</div> <div>Note that the default zone can be configured per system but <code>public</code> is default from upstream.</div>
<div>Available choices can be extended based on per-system configs, listed here are &quot;out of the box&quot; defaults.</div> <div>Available choices can be extended based on per-system configs, listed here are &quot;out of the box&quot; defaults.</div>
<div>Possible values include <code>block</code>, <code>dmz</code>, <code>drop</code>, <code>external</code>, <code>home</code>, <code>internal</code>, <code>public</code>, <code>trusted</code>, <code>work</code>.</div> <div>Possible values include <code>block</code>, <code>dmz</code>, <code>drop</code>, <code>external</code>, <code>home</code>, <code>internal</code>, <code>public</code>, <code>trusted</code>, <code>work</code>.</div>
</td> </td>
</tr> </tr>
</table> </table>
<br/> <br/>
@ -296,7 +298,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
- name: permit traffic in default zone for https service - name: permit traffic in default zone for https service
ansible.posix.firewalld: ansible.posix.firewalld:
service: https service: https
@ -370,7 +371,6 @@ Examples
Status Status
------ ------
@ -379,5 +379,3 @@ Authors
~~~~~~~ ~~~~~~~
- Adam Miller (@maxamillion) - Adam Miller (@maxamillion)

258
docs/ansible.posix.mount_module.rst
View file

@ -31,193 +31,195 @@ Parameters
<tr> <tr>
<th colspan="1">Parameter</th> <th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th> <th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th> <th width="100%">Comments</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>backup</b> <b>backup</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.</div> <div>Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>boot</b> <b>boot</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Determines if the filesystem should be mounted on boot.</div> <div>Determines if the filesystem should be mounted on boot.</div>
<div>Only applies to Solaris systems.</div> <div>Only applies to Solaris systems.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>dump</b> <b>dump</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
<b>Default:</b><br/><div style="color: blue">0</div> <b>Default:</b><br/><div style="color: blue">0</div>
</td> </td>
<td> <td>
<div>Dump (see fstab(5)).</div> <div>Dump (see fstab(5)).</div>
<div>Note that if set to <code>null</code> and <em>state</em> set to <code>present</code>, it will cease to work and duplicate entries will be made with subsequent runs.</div> <div>Note that if set to <code>null</code> and <em>state</em> set to <code>present</code>, it will cease to work and duplicate entries will be made with subsequent runs.</div>
<div>Has no effect on Solaris systems.</div> <div>Has no effect on Solaris systems.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>fstab</b> <b>fstab</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>File to use instead of <code>/etc/fstab</code>.</div> <div>File to use instead of <code>/etc/fstab</code>.</div>
<div>You should not use this option unless you really know what you are doing.</div> <div>You should not use this option unless you really know what you are doing.</div>
<div>This might be useful if you need to configure mountpoints in a chroot environment.</div> <div>This might be useful if you need to configure mountpoints in a chroot environment.</div>
<div>OpenBSD does not allow specifying alternate fstab files with mount so do not use this on OpenBSD with any state that operates on the live filesystem.</div> <div>OpenBSD does not allow specifying alternate fstab files with mount so do not use this on OpenBSD with any state that operates on the live filesystem.</div>
<div>This parameter defaults to /etc/fstab or /etc/vfstab on Solaris.</div> <div>This parameter defaults to /etc/fstab or /etc/vfstab on Solaris.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>fstype</b> <b>fstype</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Filesystem type.</div> <div>Filesystem type.</div>
<div>Required when <em>state</em> is <code>present</code> or <code>mounted</code>.</div> <div>Required when <em>state</em> is <code>present</code> or <code>mounted</code>.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>opts</b> <b>opts</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Mount options (see fstab(5), or vfstab(4) on Solaris).</div> <div>Mount options (see fstab(5), or vfstab(4) on Solaris).</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>passno</b> <b>passno</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
<b>Default:</b><br/><div style="color: blue">0</div> <b>Default:</b><br/><div style="color: blue">0</div>
</td> </td>
<td> <td>
<div>Passno (see fstab(5)).</div> <div>Passno (see fstab(5)).</div>
<div>Note that if set to <code>null</code> and <em>state</em> set to <code>present</code>, it will cease to work and duplicate entries will be made with subsequent runs.</div> <div>Note that if set to <code>null</code> and <em>state</em> set to <code>present</code>, it will cease to work and duplicate entries will be made with subsequent runs.</div>
<div>Deprecated on Solaris systems.</div> <div>Deprecated on Solaris systems.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>path</b> <b>path</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">path</span> <span style="color: purple">path</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
</td> <td>
<td> </td>
<div>Path to the mount point (e.g. <code>/mnt/files</code>).</div> <td>
<div>Before Ansible 2.3 this option was only usable as <em>dest</em>, <em>destfile</em> and <em>name</em>.</div> <div>Path to the mount point (e.g. <code>/mnt/files</code>).</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: name</div> <div>Before Ansible 2.3 this option was only usable as <em>dest</em>, <em>destfile</em> and <em>name</em>.</div>
</td> <div style="font-size: small; color: darkgreen"><br/>aliases: name</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>src</b> <b>src</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">path</span> <span style="color: purple">path</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Device (or NFS volume, or something else) to be mounted on <em>path</em>.</div> <div>Device (or NFS volume, or something else) to be mounted on <em>path</em>.</div>
<div>Required when <em>state</em> set to <code>present</code> or <code>mounted</code>.</div> <div>Required when <em>state</em> set to <code>present</code> or <code>mounted</code>.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>state</b> <b>state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <td>
<li>absent</li> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>mounted</li> <li>absent</li>
<li>present</li> <li>mounted</li>
<li>unmounted</li> <li>present</li>
<li>remounted</li> <li>unmounted</li>
</ul> <li>remounted</li>
</td> </ul>
<td> </td>
<div>If <code>mounted</code>, the device will be actively mounted and appropriately configured in <em>fstab</em>. If the mount point is not present, the mount point will be created.</div> <td>
<div>If <code>unmounted</code>, the device will be unmounted without changing <em>fstab</em>.</div> <div>If <code>mounted</code>, the device will be actively mounted and appropriately configured in <em>fstab</em>. If the mount point is not present, the mount point will be created.</div>
<div><code>present</code> only specifies that the device is to be configured in <em>fstab</em> and does not trigger or require a mount.</div> <div>If <code>unmounted</code>, the device will be unmounted without changing <em>fstab</em>.</div>
<div><code>absent</code> specifies that the device mount&#x27;s entry will be removed from <em>fstab</em> and will also unmount the device and remove the mount point.</div> <div><code>present</code> only specifies that the device is to be configured in <em>fstab</em> and does not trigger or require a mount.</div>
<div><code>remounted</code> specifies that the device will be remounted for when you want to force a refresh on the mount itself (added in 2.9). This will always return changed=true. If <em>opts</em> is set, the options will be applied to the remount, but will not change <em>fstab</em>. Additionally, if <em>opts</em> is set, and the remount command fails, the module will error to prevent unexpected mount changes. Try using <code>mounted</code> instead to work around this issue.</div> <div><code>absent</code> specifies that the device mount&#x27;s entry will be removed from <em>fstab</em> and will also unmount the device and remove the mount point.</div>
</td> <div><code>remounted</code> specifies that the device will be remounted for when you want to force a refresh on the mount itself (added in 2.9). This will always return changed=true. If <em>opts</em> is set, the options will be applied to the remount, but will not change <em>fstab</em>. Additionally, if <em>opts</em> is set, and the remount command fails, the module will error to prevent unexpected mount changes. Try using <code>mounted</code> instead to work around this issue.</div>
</td>
</tr> </tr>
</table> </table>
<br/> <br/>
@ -235,7 +237,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
# Before 2.3, option 'name' was used instead of 'path' # Before 2.3, option 'name' was used instead of 'path'
- name: Mount DVD read-only - name: Mount DVD read-only
ansible.posix.mount: ansible.posix.mount:
@ -298,7 +299,6 @@ Examples
Status Status
------ ------
@ -308,5 +308,3 @@ Authors
- Ansible Core Team - Ansible Core Team
- Seth Vidal (@skvidal) - Seth Vidal (@skvidal)

227
docs/ansible.posix.patch_module.rst
View file

@ -31,172 +31,173 @@ Parameters
<tr> <tr>
<th colspan="1">Parameter</th> <th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th> <th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th> <th width="100%">Comments</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>backup</b> <b>backup</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Passes <code>--backup --version-control=numbered</code> to patch, producing numbered backup copies.</div> <div>Passes <code>--backup --version-control=numbered</code> to patch, producing numbered backup copies.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>basedir</b> <b>basedir</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">path</span> <span style="color: purple">path</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Path of a base directory in which the patch file will be applied.</div> <div>Path of a base directory in which the patch file will be applied.</div>
<div>May be omitted when <code>dest</code> option is specified, otherwise required.</div> <div>May be omitted when <code>dest</code> option is specified, otherwise required.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>binary</b> <b>binary</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Setting to <code>yes</code> will disable patch&#x27;s heuristic for transforming CRLF line endings into LF.</div> <div>Setting to <code>yes</code> will disable patch&#x27;s heuristic for transforming CRLF line endings into LF.</div>
<div>Line endings of src and dest must match.</div> <div>Line endings of src and dest must match.</div>
<div>If set to <code>no</code>, <code>patch</code> will replace CRLF in <code>src</code> files on POSIX.</div> <div>If set to <code>no</code>, <code>patch</code> will replace CRLF in <code>src</code> files on POSIX.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>dest</b> <b>dest</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">path</span> <span style="color: purple">path</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Path of the file on the remote machine to be patched.</div> <div>Path of the file on the remote machine to be patched.</div>
<div>The names of the files to be patched are usually taken from the patch file, but if there&#x27;s just one file to be patched it can specified with this option.</div> <div>The names of the files to be patched are usually taken from the patch file, but if there&#x27;s just one file to be patched it can specified with this option.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: originalfile</div> <div style="font-size: small; color: darkgreen"><br/>aliases: originalfile</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>ignore_whitespace</b> <b>ignore_whitespace</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Setting to <code>yes</code> will ignore white space changes between patch and input..</div> <div>Setting to <code>yes</code> will ignore white space changes between patch and input..</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>remote_src</b> <b>remote_src</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>If <code>no</code>, it will search for src at originating/controller machine, if <code>yes</code> it will go to the remote/target machine for the <code>src</code>.</div> <div>If <code>no</code>, it will search for src at originating/controller machine, if <code>yes</code> it will go to the remote/target machine for the <code>src</code>.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>src</b> <b>src</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">path</span> <span style="color: purple">path</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
</td> <td>
<td> </td>
<div>Path of the patch file as accepted by the GNU patch tool. If <code>remote_src</code> is &#x27;no&#x27;, the patch source file is looked up from the module&#x27;s <em>files</em> directory.</div> <td>
<div style="font-size: small; color: darkgreen"><br/>aliases: patchfile</div> <div>Path of the patch file as accepted by the GNU patch tool. If <code>remote_src</code> is &#x27;no&#x27;, the patch source file is looked up from the module&#x27;s <em>files</em> directory.</div>
</td> <div style="font-size: small; color: darkgreen"><br/>aliases: patchfile</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>state</b> <b>state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>absent</li> <li>absent</li>
<li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Whether the patch should be applied or reverted.</div> <div>Whether the patch should be applied or reverted.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>strip</b> <b>strip</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">integer</span> <span style="color: purple">integer</span>
</div> </div>
</td> </td>
<td> <td>
<b>Default:</b><br/><div style="color: blue">0</div> <b>Default:</b><br/><div style="color: blue">0</div>
</td> </td>
<td> <td>
<div>Number that indicates the smallest prefix containing leading slashes that will be stripped from each file name found in the patch file.</div> <div>Number that indicates the smallest prefix containing leading slashes that will be stripped from each file name found in the patch file.</div>
<div>For more information see the strip parameter of the GNU patch tool.</div> <div>For more information see the strip parameter of the GNU patch tool.</div>
</td> </td>
</tr> </tr>
</table> </table>
<br/> <br/>
@ -213,7 +214,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
- name: Apply patch to one file - name: Apply patch to one file
ansible.posix.patch: ansible.posix.patch:
src: /tmp/index.html.patch src: /tmp/index.html.patch
@ -234,7 +234,6 @@ Examples
Status Status
------ ------
@ -244,5 +243,3 @@ Authors
- Jakub Jirutka (@jirutka) - Jakub Jirutka (@jirutka)
- Luis Alberto Perez Lazaro (@luisperlaz) - Luis Alberto Perez Lazaro (@luisperlaz)

106
docs/ansible.posix.seboolean_module.rst
View file

@ -38,81 +38,83 @@ Parameters
<tr> <tr>
<th colspan="1">Parameter</th> <th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th> <th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th> <th width="100%">Comments</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>ignore_selinux_state</b> <b>ignore_selinux_state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Useful for scenarios (chrooted environment) that you can&#x27;t get the real SELinux state.</div> <div>Useful for scenarios (chrooted environment) that you can&#x27;t get the real SELinux state.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>name</b> <b>name</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
</td> <td>
<td> </td>
<div>Name of the boolean to configure.</div> <td>
</td> <div>Name of the boolean to configure.</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>persistent</b> <b>persistent</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Set to <code>yes</code> if the boolean setting should survive a reboot.</div> <div>Set to <code>yes</code> if the boolean setting should survive a reboot.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>state</b> <b>state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <td>
<li>no</li> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>yes</li> <li>no</li>
</ul> <li>yes</li>
</td> </ul>
<td> </td>
<div>Desired boolean value</div> <td>
</td> <div>Desired boolean value</div>
</td>
</tr> </tr>
</table> </table>
<br/> <br/>
@ -129,7 +131,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
- name: Set httpd_can_network_connect flag on and keep it persistent across reboots - name: Set httpd_can_network_connect flag on and keep it persistent across reboots
ansible.posix.seboolean: ansible.posix.seboolean:
name: httpd_can_network_connect name: httpd_can_network_connect
@ -139,7 +140,6 @@ Examples
Status Status
------ ------
@ -148,5 +148,3 @@ Authors
~~~~~~~ ~~~~~~~
- Stephen Fromm (@sfromm) - Stephen Fromm (@sfromm)

169
docs/ansible.posix.selinux_module.rst
View file

@ -39,61 +39,62 @@ Parameters
<tr> <tr>
<th colspan="1">Parameter</th> <th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th> <th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th> <th width="100%">Comments</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>configfile</b> <b>configfile</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
<b>Default:</b><br/><div style="color: blue">"/etc/selinux/config"</div> <b>Default:</b><br/><div style="color: blue">"/etc/selinux/config"</div>
</td> </td>
<td> <td>
<div>The path to the SELinux configuration file, if non-standard.</div> <div>The path to the SELinux configuration file, if non-standard.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: conf, file</div> <div style="font-size: small; color: darkgreen"><br/>aliases: conf, file</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>policy</b> <b>policy</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>The name of the SELinux policy to use (e.g. <code>targeted</code>) will be required if state is not <code>disabled</code>.</div> <div>The name of the SELinux policy to use (e.g. <code>targeted</code>) will be required if state is not <code>disabled</code>.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>state</b> <b>state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <td>
<li>disabled</li> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>enforcing</li> <li>disabled</li>
<li>permissive</li> <li>enforcing</li>
</ul> <li>permissive</li>
</td> </ul>
<td> </td>
<div>The SELinux mode.</div> <td>
</td> <div>The SELinux mode.</div>
</td>
</tr> </tr>
</table> </table>
<br/> <br/>
@ -104,7 +105,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
- name: Enable SELinux - name: Enable SELinux
ansible.posix.selinux: ansible.posix.selinux:
policy: targeted policy: targeted
@ -121,7 +121,6 @@ Examples
Return Values Return Values
------------- -------------
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
@ -134,92 +133,92 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
<th>Returned</th> <th>Returned</th>
<th width="100%">Description</th> <th width="100%">Description</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>configfile</b> <b>configfile</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td>always</td> <td>always</td>
<td> <td>
<div>Path to SELinux configuration file.</div> <div>Path to SELinux configuration file.</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">/etc/selinux/config</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">/etc/selinux/config</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>msg</b> <b>msg</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td>always</td> <td>always</td>
<td> <td>
<div>Messages that describe changes that were made.</div> <div>Messages that describe changes that were made.</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">Config SELinux state changed from &#x27;disabled&#x27; to &#x27;permissive&#x27;</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">Config SELinux state changed from &#x27;disabled&#x27; to &#x27;permissive&#x27;</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>policy</b> <b>policy</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td>always</td> <td>always</td>
<td> <td>
<div>Name of the SELinux policy.</div> <div>Name of the SELinux policy.</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">targeted</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">targeted</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>reboot_required</b> <b>reboot_required</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td>always</td> <td>always</td>
<td> <td>
<div>Whether or not an reboot is required for the changes to take effect.</div> <div>Whether or not an reboot is required for the changes to take effect.</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">True</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">True</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div> <div class="ansibleOptionAnchor" id="return-"></div>
<b>state</b> <b>state</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td>always</td> <td>always</td>
<td> <td>
<div>SELinux mode.</div> <div>SELinux mode.</div>
<br/> <br/>
<div style="font-size: smaller"><b>Sample:</b></div> <div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">enforcing</div> <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">enforcing</div>
</td> </td>
</tr> </tr>
</table> </table>
<br/><br/> <br/><br/>
@ -231,5 +230,3 @@ Authors
~~~~~~~ ~~~~~~~
- Derek Carter (@goozbach) <goozbach@friocorte.com> - Derek Carter (@goozbach) <goozbach@friocorte.com>

664
docs/ansible.posix.synchronize_module.rst
View file

@ -34,492 +34,494 @@ Parameters
<tr> <tr>
<th colspan="1">Parameter</th> <th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th> <th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th> <th width="100%">Comments</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>archive</b> <b>archive</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags and -D.</div> <div>Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags and -D.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>checksum</b> <b>checksum</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Skip based on checksum, rather than mod-time &amp; size; Note that that &quot;archive&quot; option is still enabled by default - the &quot;checksum&quot; option will not disable it.</div> <div>Skip based on checksum, rather than mod-time &amp; size; Note that that &quot;archive&quot; option is still enabled by default - the &quot;checksum&quot; option will not disable it.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>compress</b> <b>compress</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Compress file data during the transfer.</div> <div>Compress file data during the transfer.</div>
<div>In most cases, leave this enabled unless it causes problems.</div> <div>In most cases, leave this enabled unless it causes problems.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>copy_links</b> <b>copy_links</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Copy symlinks as the item that they point to (the referent) is copied, rather than the symlink.</div> <div>Copy symlinks as the item that they point to (the referent) is copied, rather than the symlink.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>delete</b> <b>delete</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Delete files in <code>dest</code> that don&#x27;t exist (after transfer, not before) in the <code>src</code> path.</div> <div>Delete files in <code>dest</code> that don&#x27;t exist (after transfer, not before) in the <code>src</code> path.</div>
<div>This option requires <code>recursive=yes</code>.</div> <div>This option requires <code>recursive=yes</code>.</div>
<div>This option ignores excluded files and behaves like the rsync opt --delete-excluded.</div> <div>This option ignores excluded files and behaves like the rsync opt --delete-excluded.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>dest</b> <b>dest</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
</td> <td>
<td> </td>
<div>Path on the destination host that will be synchronized from the source.</div> <td>
<div>The path can be absolute or relative.</div> <div>Path on the destination host that will be synchronized from the source.</div>
</td> <div>The path can be absolute or relative.</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>dest_port</b> <b>dest_port</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">integer</span> <span style="color: purple">integer</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Port number for ssh on the destination host.</div> <div>Port number for ssh on the destination host.</div>
<div>Prior to Ansible 2.0, the ansible_ssh_port inventory var took precedence over this value.</div> <div>Prior to Ansible 2.0, the ansible_ssh_port inventory var took precedence over this value.</div>
<div>This parameter defaults to the value of <code>ansible_ssh_port</code> or <code>ansible_port</code>, the <code>remote_port</code> config setting or the value from ssh client configuration if none of the former have been set.</div> <div>This parameter defaults to the value of <code>ansible_ssh_port</code> or <code>ansible_port</code>, the <code>remote_port</code> config setting or the value from ssh client configuration if none of the former have been set.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>dirs</b> <b>dirs</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Transfer directories without recursing.</div> <div>Transfer directories without recursing.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>existing_only</b> <b>existing_only</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Skip creating new files on receiver.</div> <div>Skip creating new files on receiver.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>group</b> <b>group</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Preserve group.</div> <div>Preserve group.</div>
<div>This parameter defaults to the value of the archive option.</div> <div>This parameter defaults to the value of the archive option.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>link_dest</b> <b>link_dest</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">list</span> <span style="color: purple">list</span>
</div> </div>
</td> </td>
<td> <td>
<b>Default:</b><br/><div style="color: blue">null</div> <b>Default:</b><br/><div style="color: blue">null</div>
</td> </td>
<td> <td>
<div>Add a destination to hard link against during the rsync.</div> <div>Add a destination to hard link against during the rsync.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>links</b> <b>links</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Copy symlinks as symlinks.</div> <div>Copy symlinks as symlinks.</div>
<div>This parameter defaults to the value of the archive option.</div> <div>This parameter defaults to the value of the archive option.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>mode</b> <b>mode</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>pull</li> <li>pull</li>
<li><div style="color: blue"><b>push</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>push</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Specify the direction of the synchronization.</div> <div>Specify the direction of the synchronization.</div>
<div>In push mode the localhost or delegate is the source.</div> <div>In push mode the localhost or delegate is the source.</div>
<div>In pull mode the remote host in context is the source.</div> <div>In pull mode the remote host in context is the source.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>owner</b> <b>owner</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Preserve owner (super user only).</div> <div>Preserve owner (super user only).</div>
<div>This parameter defaults to the value of the archive option.</div> <div>This parameter defaults to the value of the archive option.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>partial</b> <b>partial</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Tells rsync to keep the partial file which should make a subsequent transfer of the rest of the file much faster.</div> <div>Tells rsync to keep the partial file which should make a subsequent transfer of the rest of the file much faster.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>perms</b> <b>perms</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Preserve permissions.</div> <div>Preserve permissions.</div>
<div>This parameter defaults to the value of the archive option.</div> <div>This parameter defaults to the value of the archive option.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>private_key</b> <b>private_key</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">path</span> <span style="color: purple">path</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Specify the private key to use for SSH-based rsync connections (e.g. <code>~/.ssh/id_rsa</code>).</div> <div>Specify the private key to use for SSH-based rsync connections (e.g. <code>~/.ssh/id_rsa</code>).</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>recursive</b> <b>recursive</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Recurse into directories.</div> <div>Recurse into directories.</div>
<div>This parameter defaults to the value of the archive option.</div> <div>This parameter defaults to the value of the archive option.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>rsync_opts</b> <b>rsync_opts</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">list</span> <span style="color: purple">list</span>
</div> </div>
</td> </td>
<td> <td>
<b>Default:</b><br/><div style="color: blue">null</div> <b>Default:</b><br/><div style="color: blue">null</div>
</td> </td>
<td> <td>
<div>Specify additional rsync options by passing in an array.</div> <div>Specify additional rsync options by passing in an array.</div>
<div>Note that an empty string in <code>rsync_opts</code> will end up transfer the current working directory.</div> <div>Note that an empty string in <code>rsync_opts</code> will end up transfer the current working directory.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>rsync_path</b> <b>rsync_path</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Specify the rsync command to run on the remote host. See <code>--rsync-path</code> on the rsync man page.</div> <div>Specify the rsync command to run on the remote host. See <code>--rsync-path</code> on the rsync man page.</div>
<div>To specify the rsync command to run on the local host, you need to set this your task var <code>ansible_rsync_path</code>.</div> <div>To specify the rsync command to run on the local host, you need to set this your task var <code>ansible_rsync_path</code>.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>rsync_timeout</b> <b>rsync_timeout</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">integer</span> <span style="color: purple">integer</span>
</div> </div>
</td> </td>
<td> <td>
<b>Default:</b><br/><div style="color: blue">0</div> <b>Default:</b><br/><div style="color: blue">0</div>
</td> </td>
<td> <td>
<div>Specify a <code>--timeout</code> for the rsync command in seconds.</div> <div>Specify a <code>--timeout</code> for the rsync command in seconds.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>set_remote_user</b> <b>set_remote_user</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Put user@ for the remote paths.</div> <div>Put user@ for the remote paths.</div>
<div>If you have a custom ssh config to define the remote user for a host that does not match the inventory user, you should set this parameter to <code>no</code>.</div> <div>If you have a custom ssh config to define the remote user for a host that does not match the inventory user, you should set this parameter to <code>no</code>.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>src</b> <b>src</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">string</span> <span style="color: purple">string</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
</td> <td>
<td> </td>
<div>Path on the source host that will be synchronized to the destination.</div> <td>
<div>The path can be absolute or relative.</div> <div>Path on the source host that will be synchronized to the destination.</div>
</td> <div>The path can be absolute or relative.</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>times</b> <b>times</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Preserve modification times.</div> <div>Preserve modification times.</div>
<div>This parameter defaults to the value of the archive option.</div> <div>This parameter defaults to the value of the archive option.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>use_ssh_args</b> <b>use_ssh_args</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Use the ssh_args specified in ansible.cfg.</div> <div>Use the ssh_args specified in ansible.cfg.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>verify_host</b> <b>verify_host</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Verify destination host key.</div> <div>Verify destination host key.</div>
</td> </td>
</tr> </tr>
</table> </table>
<br/> <br/>
@ -560,7 +562,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
- name: Synchronization of src on the control machine to dest on the remote hosts - name: Synchronization of src on the control machine to dest on the remote hosts
ansible.posix.synchronize: ansible.posix.synchronize:
src: some/relative/path src: some/relative/path
@ -689,7 +690,6 @@ Examples
Status Status
------ ------
@ -698,5 +698,3 @@ Authors
~~~~~~~ ~~~~~~~
- Timothy Appnel (@tima) - Timothy Appnel (@tima)

173
docs/ansible.posix.sysctl_module.rst
View file

@ -31,133 +31,134 @@ Parameters
<tr> <tr>
<th colspan="1">Parameter</th> <th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th> <th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th> <th width="100%">Comments</th>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>ignoreerrors</b> <b>ignoreerrors</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Use this option to ignore errors about unknown keys.</div> <div>Use this option to ignore errors about unknown keys.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>name</b> <b>name</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
/ <span style="color: red">required</span> </div> / <span style="color: red">required</span>
</td> </div>
<td> </td>
</td> <td>
<td> </td>
<div>The dot-separated path (aka <em>key</em>) specifying the sysctl variable.</div> <td>
<div style="font-size: small; color: darkgreen"><br/>aliases: key</div> <div>The dot-separated path (aka <em>key</em>) specifying the sysctl variable.</div>
</td> <div style="font-size: small; color: darkgreen"><br/>aliases: key</div>
</td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>reload</b> <b>reload</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li> <li>no</li>
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
</ul> </ul>
</td> </td>
<td> <td>
<div>If <code>yes</code>, performs a <em>/sbin/sysctl -p</em> if the <code>sysctl_file</code> is updated. If <code>no</code>, does not reload <em>sysctl</em> even if the <code>sysctl_file</code> is updated.</div> <div>If <code>yes</code>, performs a <em>/sbin/sysctl -p</em> if the <code>sysctl_file</code> is updated. If <code>no</code>, does not reload <em>sysctl</em> even if the <code>sysctl_file</code> is updated.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>state</b> <b>state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li>
<li>absent</li> <li>absent</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Whether the entry should be present or absent in the sysctl file.</div> <div>Whether the entry should be present or absent in the sysctl file.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>sysctl_file</b> <b>sysctl_file</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
<b>Default:</b><br/><div style="color: blue">"/etc/sysctl.conf"</div> <b>Default:</b><br/><div style="color: blue">"/etc/sysctl.conf"</div>
</td> </td>
<td> <td>
<div>Specifies the absolute path to <code>sysctl.conf</code>, if not <code>/etc/sysctl.conf</code>.</div> <div>Specifies the absolute path to <code>sysctl.conf</code>, if not <code>/etc/sysctl.conf</code>.</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>sysctl_set</b> <b>sysctl_set</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">boolean</span> <span style="color: purple">boolean</span>
</div> </div>
</td> </td>
<td> <td>
<ul style="margin: 0; padding: 0"><b>Choices:</b> <ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li> <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li> <li>yes</li>
</ul> </ul>
</td> </td>
<td> <td>
<div>Verify token value with the sysctl command and set with -w if necessary</div> <div>Verify token value with the sysctl command and set with -w if necessary</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="1"> <td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div> <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>value</b> <b>value</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small"> <div style="font-size: small">
<span style="color: purple">-</span> <span style="color: purple">-</span>
</div> </div>
</td> </td>
<td> <td>
</td> </td>
<td> <td>
<div>Desired value of the sysctl key.</div> <div>Desired value of the sysctl key.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: val</div> <div style="font-size: small; color: darkgreen"><br/>aliases: val</div>
</td> </td>
</tr> </tr>
</table> </table>
<br/> <br/>
@ -168,7 +169,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
# Set vm.swappiness to 5 in /etc/sysctl.conf # Set vm.swappiness to 5 in /etc/sysctl.conf
- ansible.posix.sysctl: - ansible.posix.sysctl:
name: vm.swappiness name: vm.swappiness
@ -205,7 +205,6 @@ Examples
Status Status
------ ------
@ -214,5 +213,3 @@ Authors
~~~~~~~ ~~~~~~~
- David CHANIAL (@davixx) <david.chanial@gmail.com> - David CHANIAL (@davixx) <david.chanial@gmail.com>

2
galaxy.yml
View file

@ -1,6 +1,6 @@
namespace: ansible namespace: ansible
name: posix name: posix
version: 1.1.0 version: 1.1.1
readme: README.md readme: README.md
authors: authors:
- Ansible (github.com/ansible) - Ansible (github.com/ansible)