From e5e36d3c7b0fc0ad8f07807eec5106980e1ba694 Mon Sep 17 00:00:00 2001 From: jillr Date: Wed, 2 Sep 2020 16:39:46 +0000 Subject: [PATCH] Prepare 1.1.1 release 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. --- CHANGELOG.rst | 73 ++ changelogs/changelog.yaml | 102 +++ changelogs/fragments/.keep | 0 docs/ansible.posix.acl_module.rst | 313 +++++---- docs/ansible.posix.at_module.rst | 146 ++-- docs/ansible.posix.authorized_key_module.rst | 420 ++++++------ docs/ansible.posix.firewalld_module.rst | 318 +++++---- docs/ansible.posix.mount_module.rst | 258 ++++--- docs/ansible.posix.patch_module.rst | 227 ++++--- docs/ansible.posix.seboolean_module.rst | 106 ++- docs/ansible.posix.selinux_module.rst | 169 +++-- docs/ansible.posix.synchronize_module.rst | 664 +++++++++---------- docs/ansible.posix.sysctl_module.rst | 173 +++-- galaxy.yml | 2 +- 14 files changed, 1561 insertions(+), 1410 deletions(-) create mode 100644 CHANGELOG.rst create mode 100644 changelogs/changelog.yaml create mode 100644 changelogs/fragments/.keep diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..3f010d6 --- /dev/null +++ b/CHANGELOG.rst @@ -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. diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml new file mode 100644 index 0000000..2169838 --- /dev/null +++ b/changelogs/changelog.yaml @@ -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' diff --git a/changelogs/fragments/.keep b/changelogs/fragments/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/ansible.posix.acl_module.rst b/docs/ansible.posix.acl_module.rst index b5b0fe7..07fa743 100644 --- a/docs/ansible.posix.acl_module.rst +++ b/docs/ansible.posix.acl_module.rst @@ -31,217 +31,218 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
default
boolean -
- - - - - -
If the target is a directory, setting this to yes will make it the default ACL for entities created inside the directory.
-
Setting default to yes causes an error if the path is a file.
- + + + + + + +
If the target is a directory, setting this to yes will make it the default ACL for entities created inside the directory.
+
Setting default to yes causes an error if the path is a file.
+ - - + +
entity
- -
- - - - -
The actual user or group that the ACL applies to when matching entity types user or group are selected.
- + + + + + +
The actual user or group that the ACL applies to when matching entity types user or group are selected.
+ - - + +
entry
- -
- - - - -
DEPRECATED.
-
The ACL to set or remove.
-
This must always be quoted in the form of <etype>:<qualifier>:<perms>.
-
The qualifier may be empty for some types, but the type and perms are always required.
-
- can be used as placeholder when you do not care about permissions.
-
This is now superseded by entity, type and permissions fields.
- + + + + + +
DEPRECATED.
+
The ACL to set or remove.
+
This must always be quoted in the form of <etype>:<qualifier>:<perms>.
+
The qualifier may be empty for some types, but the type and perms are always required.
+
- can be used as placeholder when you do not care about permissions.
+
This is now superseded by entity, type and permissions fields.
+ - - + +
etype
- -
- - - - - -
The entity type of the ACL to apply, see setfacl documentation for more info.
- + + + + + + +
The entity type of the ACL to apply, see setfacl documentation for more info.
+ - - + +
follow
boolean -
- - - - - -
Whether to follow symlinks on the path if a symlink is encountered.
- + + + + + + +
Whether to follow symlinks on the path if a symlink is encountered.
+ - - + +
path
path - / required
- - - - -
The full path of the file or object.
-

aliases: name
- + / required + + + + + +
The full path of the file or object.
+

aliases: name
+ - - + +
permissions
- -
- - - - -
The permissions to apply/remove can be any combination of r, w and x (read, write and execute respectively)
- + + + + + +
The permissions to apply/remove can be any combination of r, w and x (read, write and execute respectively)
+ - - + +
recalculate_mask
- -
- - - - - -
Select if and when to recalculate the effective right masks of the files.
-
See setfacl documentation for more info.
-
Incompatible with state=query.
- + + + + + + +
Select if and when to recalculate the effective right masks of the files.
+
See setfacl documentation for more info.
+
Incompatible with state=query.
+ - - + +
recursive
boolean -
- - - - - -
Recursively sets the specified ACL.
-
Incompatible with state=query.
- + + + + + + +
Recursively sets the specified ACL.
+
Incompatible with state=query.
+ - - + +
state
- -
- - - - - -
Define whether the ACL should be present or not.
-
The query state gets the current ACL without changing it, for use in register operations.
- + + + + + + +
Define whether the ACL should be present or not.
+
The query state gets the current ACL without changing it, for use in register operations.
+ - - + +
use_nfsv4_acls
boolean -
- - - - - -
Use NFSv4 ACLs instead of POSIX ACLs.
- + + + + + + +
Use NFSv4 ACLs instead of POSIX ACLs.
+ - +
@@ -260,7 +261,6 @@ Examples .. code-block:: yaml+jinja - - name: Grant user Joe read access to a file ansible.posix.acl: path: /etc/foo.conf @@ -298,7 +298,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -311,24 +310,24 @@ Common return values are documented `here Returned Description - - + +
acl
list -
- + + success -
Current ACL on provided path (after changes, if any)
-
-
Sample:
-
['user::rwx', 'group::rwx', 'other::rwx']
- +
Current ACL on provided path (after changes, if any)
+
+
Sample:
+
['user::rwx', 'group::rwx', 'other::rwx']
+ - +

@@ -341,5 +340,3 @@ Authors - Brian Coca (@bcoca) - Jérémie Astori (@astorije) - - diff --git a/docs/ansible.posix.at_module.rst b/docs/ansible.posix.at_module.rst index 59cd9ed..3d2b41f 100644 --- a/docs/ansible.posix.at_module.rst +++ b/docs/ansible.posix.at_module.rst @@ -38,113 +38,115 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
command
string -
- - - - -
A command to be executed in the future.
- + + + + + +
A command to be executed in the future.
+ - - + +
count
integer - / required
- - - - -
The count of units in the future to execute the command or script file.
- + / required + + + + + +
The count of units in the future to execute the command or script file.
+ - - + +
script_file
string -
- - - - -
An existing script file to be executed in the future.
- + + + + + +
An existing script file to be executed in the future.
+ - - + +
state
string -
- - -
    Choices: -
  • absent
    • -
  • present ←
    • -
- - -
The state dictates if the command or script file should be evaluated as present(added) or absent(deleted).
- + + + +
    Choices: +
  • absent
    • +
  • present ←
    • +
+ + +
The state dictates if the command or script file should be evaluated as present(added) or absent(deleted).
+ - - + +
unique
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
If a matching job is present a new job will not be added.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
If a matching job is present a new job will not be added.
+ - - + +
units
string - / required
- - -
    Choices: -
  • minutes
    • -
  • hours
    • -
  • days
    • -
  • weeks
    • -
- - -
The type of units in the future to execute the command or script file.
- + / required + + + +
    Choices: +
  • minutes
    • +
  • hours
    • +
  • days
    • +
  • weeks
    • +
+ + +
The type of units in the future to execute the command or script file.
+ - +
@@ -155,7 +157,6 @@ Examples .. code-block:: yaml+jinja - - name: Schedule a command to execute in 20 minutes as root ansible.posix.at: command: ls -d / >/dev/null @@ -177,7 +178,6 @@ Examples - Status ------ @@ -186,5 +186,3 @@ Authors ~~~~~~~ - Richard Isaacson (@risaacson) - - diff --git a/docs/ansible.posix.authorized_key_module.rst b/docs/ansible.posix.authorized_key_module.rst index e004cc4..ceef3ef 100644 --- a/docs/ansible.posix.authorized_key_module.rst +++ b/docs/ansible.posix.authorized_key_module.rst @@ -31,191 +31,193 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
comment
string -
- - - - -
Change the comment on the public key.
-
Rewriting the comment is useful in cases such as fetching it from GitHub or GitLab.
-
If no comment is specified, the existing comment will be kept.
- + + + + + +
Change the comment on the public key.
+
Rewriting the comment is useful in cases such as fetching it from GitHub or GitLab.
+
If no comment is specified, the existing comment will be kept.
+ - - + +
exclusive
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Whether to remove all other non-specified keys from the authorized_keys file.
-
Multiple keys can be specified in a single key string value by separating them by newlines.
-
This option is not loop aware, so if you use with_ , it will be exclusive per iteration of the loop.
-
If you want multiple keys in the file you need to pass them all to key in a single batch as mentioned above.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Whether to remove all other non-specified keys from the authorized_keys file.
+
Multiple keys can be specified in a single key string value by separating them by newlines.
+
This option is not loop aware, so if you use with_ , it will be exclusive per iteration of the loop.
+
If you want multiple keys in the file you need to pass them all to key in a single batch as mentioned above.
+ - - + +
follow
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Follow path symlink instead of replacing it.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Follow path symlink instead of replacing it.
+ - - + +
key
string - / required
- - - - -
The SSH public key(s), as a string or (since Ansible 1.9) url (https://github.com/username.keys).
- + / required + + + + + +
The SSH public key(s), as a string or (since Ansible 1.9) url (https://github.com/username.keys).
+ - - + +
key_options
- -
- - - - -
A string of ssh key options to be prepended to the key in the authorized_keys file.
- + + + + + +
A string of ssh key options to be prepended to the key in the authorized_keys file.
+ - - + +
manage_dir
boolean -
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Whether this module should manage the directory of the authorized key file.
-
If set to yes, the module will create the directory, as well as set the owner and permissions of an existing directory.
-
Be sure to set manage_dir=no if you are using an alternate directory for authorized_keys, as set with path, since you could lock yourself out of SSH access.
-
See the example below.
- + + + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Whether this module should manage the directory of the authorized key file.
+
If set to yes, the module will create the directory, as well as set the owner and permissions of an existing directory.
+
Be sure to set manage_dir=no if you are using an alternate directory for authorized_keys, as set with path, since you could lock yourself out of SSH access.
+
See the example below.
+ - - + +
path
path -
- - - - -
Alternate path to the authorized_keys file.
-
When unset, this value defaults to ~/.ssh/authorized_keys.
- + + + + + +
Alternate path to the authorized_keys file.
+
When unset, this value defaults to ~/.ssh/authorized_keys.
+ - - + +
state
string -
- - -
    Choices: -
  • absent
    • -
  • present ←
    • -
- - -
Whether the given key (with the given key_options) should or should not be in the file.
- + + + +
    Choices: +
  • absent
    • +
  • present ←
    • +
+ + +
Whether the given key (with the given key_options) should or should not be in the file.
+ - - + +
user
string - / required
- - - - -
The username on the remote host whose authorized_keys file will be modified.
- + / required + + + + + +
The username on the remote host whose authorized_keys file will be modified.
+ - - + +
validate_certs
boolean -
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
This only applies if using a https url as the source of the keys.
-
If set to no, the SSL certificates will not be validated.
-
This should only set to no used on personally controlled sites using self-signed certificates as it avoids verifying the source site.
-
Prior to 2.1 the code worked as if this was set to yes.
- + + + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
This only applies if using a https url as the source of the keys.
+
If set to no, the SSL certificates will not be validated.
+
This should only set to no used on personally controlled sites using self-signed certificates as it avoids verifying the source site.
+
Prior to 2.1 the code worked as if this was set to yes.
+ - +
@@ -226,7 +228,6 @@ Examples .. code-block:: yaml+jinja - - name: Set authorized key taken from file ansible.posix.authorized_key: user: charlie @@ -285,7 +286,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -298,169 +298,169 @@ Common return values are documented `here Returned Description - - + +
exclusive
boolean -
- + + success -
If the key has been forced to be exclusive or not.
-
- +
If the key has been forced to be exclusive or not.
+
+ - - + +
key
string -
- + + success -
The key that the module was running against.
-
-
Sample:
-
https://github.com/user.keys
- +
The key that the module was running against.
+
+
Sample:
+
https://github.com/user.keys
+ - - + +
key_option
string -
- + + success -
Key options related to the key.
-
- +
Key options related to the key.
+
+ - - + +
keyfile
string -
- + + success -
Path for authorized key file.
-
-
Sample:
-
/home/user/.ssh/authorized_keys
- +
Path for authorized key file.
+
+
Sample:
+
/home/user/.ssh/authorized_keys
+ - - + +
manage_dir
boolean -
- + + success -
Whether this module managed the directory of the authorized key file.
-
-
Sample:
-
True
- +
Whether this module managed the directory of the authorized key file.
+
+
Sample:
+
True
+ - - + +
path
string -
- + + success -
Alternate path to the authorized_keys file
-
- +
Alternate path to the authorized_keys file
+
+ - - + +
state
string -
- + + success -
Whether the given key (with the given key_options) should or should not be in the file
-
-
Sample:
-
present
- +
Whether the given key (with the given key_options) should or should not be in the file
+
+
Sample:
+
present
+ - - + +
unique
boolean -
- + + success -
Whether the key is unique
-
- +
Whether the key is unique
+
+ - - + +
user
string -
- + + success -
The username on the remote host whose authorized_keys file will be modified
-
-
Sample:
-
user
- +
The username on the remote host whose authorized_keys file will be modified
+
+
Sample:
+
user
+ - - + +
validate_certs
boolean -
- + + success -
This only applies if using a https url as the source of the keys. If set to no, the SSL certificates will not be validated.
-
-
Sample:
-
True
- +
This only applies if using a https url as the source of the keys. If set to no, the SSL certificates will not be validated.
+
+
Sample:
+
True
+ - +

@@ -472,5 +472,3 @@ Authors ~~~~~~~ - Ansible Core Team - - diff --git a/docs/ansible.posix.firewalld_module.rst b/docs/ansible.posix.firewalld_module.rst index 7cd0195..49a4b69 100644 --- a/docs/ansible.posix.firewalld_module.rst +++ b/docs/ansible.posix.firewalld_module.rst @@ -36,247 +36,249 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
icmp_block
string -
- - - - -
The ICMP block you would like to add/remove to/from a zone in firewalld.
- + + + + + +
The ICMP block you would like to add/remove to/from a zone in firewalld.
+ - - + +
icmp_block_inversion
string -
- - - - -
Enable/Disable inversion of ICMP blocks for a zone in firewalld.
- + + + + + +
Enable/Disable inversion of ICMP blocks for a zone in firewalld.
+ - - + +
immediate
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Should this configuration be applied immediately, if set as permanent.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Should this configuration be applied immediately, if set as permanent.
+ - - + +
interface
string -
- - - - -
The interface you would like to add/remove to/from a zone in firewalld.
- + + + + + +
The interface you would like to add/remove to/from a zone in firewalld.
+ - - + +
masquerade
string -
- - - - -
The masquerade setting you would like to enable/disable to/from zones within firewalld.
- + + + + + +
The masquerade setting you would like to enable/disable to/from zones within firewalld.
+ - - + +
offline
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Whether to run this module even when firewalld is offline.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Whether to run this module even when firewalld is offline.
+ - - + +
permanent
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Should this configuration be in the running firewalld configuration or persist across reboots.
-
As of Ansible 2.3, permanent operations can operate on firewalld configs when it is not running (requires firewalld >= 3.0.9).
-
Note that if this is no, immediate is assumed yes.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Should this configuration be in the running firewalld configuration or persist across reboots.
+
As of Ansible 2.3, permanent operations can operate on firewalld configs when it is not running (requires firewalld >= 3.0.9).
+
Note that if this is no, immediate is assumed yes.
+ - - + +
port
string -
- - - - -
Name of a port or port range to add/remove to/from firewalld.
-
Must be in the form PORT/PROTOCOL or PORT-PORT/PROTOCOL for port ranges.
- + + + + + +
Name of a port or port range to add/remove to/from firewalld.
+
Must be in the form PORT/PROTOCOL or PORT-PORT/PROTOCOL for port ranges.
+ - - + +
rich_rule
string -
- - - - -
Rich rule to add/remove to/from firewalld.
- + + + + + +
Rich rule to add/remove to/from firewalld.
+ + - - + +
service
string -
- - - - -
Name of a service to add/remove to/from firewalld.
-
The service must be listed in output of firewall-cmd --get-services.
- + + + + + +
Name of a service to add/remove to/from firewalld.
+
The service must be listed in output of firewall-cmd --get-services.
+ - - + +
source
string -
- - - - -
The source/network you would like to add/remove to/from firewalld.
- + + + + + +
The source/network you would like to add/remove to/from firewalld.
+ - - + +
state
string - / required
- - -
    Choices: -
  • absent
    • -
  • disabled
    • -
  • enabled
    • -
  • present
    • -
- - -
Enable or disable a setting.
-
For ports: Should this port accept (enabled) or reject (disabled) connections.
-
The states present and absent can only be used in zone level operations (i.e. when no other parameters but zone and state are set).
- + / required + + + +
    Choices: +
  • absent
    • +
  • disabled
    • +
  • enabled
    • +
  • present
    • +
+ + +
Enable or disable a setting.
+
For ports: Should this port accept (enabled) or reject (disabled) connections.
+
The states present and absent can only be used in zone level operations (i.e. when no other parameters but zone and state are set).
+ - - + +
timeout
integer -
- - - Default:
0
- - -
The amount of time the rule should be in effect for when non-permanent.
- + + + + Default:
0
+ + +
The amount of time the rule should be in effect for when non-permanent.
+ - - + +
zone
string -
- - - - -
The firewalld zone to add/remove to/from.
-
Note that the default zone can be configured per system but public is default from upstream.
-
Available choices can be extended based on per-system configs, listed here are "out of the box" defaults.
-
Possible values include block, dmz, drop, external, home, internal, public, trusted, work.
- + + + + + +
The firewalld zone to add/remove to/from.
+
Note that the default zone can be configured per system but public is default from upstream.
+
Available choices can be extended based on per-system configs, listed here are "out of the box" defaults.
+
Possible values include block, dmz, drop, external, home, internal, public, trusted, work.
+ - +
@@ -296,7 +298,6 @@ Examples .. code-block:: yaml+jinja - - name: permit traffic in default zone for https service ansible.posix.firewalld: service: https @@ -370,7 +371,6 @@ Examples - Status ------ @@ -379,5 +379,3 @@ Authors ~~~~~~~ - Adam Miller (@maxamillion) - - diff --git a/docs/ansible.posix.mount_module.rst b/docs/ansible.posix.mount_module.rst index 52344f9..d7b7535 100644 --- a/docs/ansible.posix.mount_module.rst +++ b/docs/ansible.posix.mount_module.rst @@ -31,193 +31,195 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
backup
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
+ - - + +
boot
boolean -
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Determines if the filesystem should be mounted on boot.
-
Only applies to Solaris systems.
- + + + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Determines if the filesystem should be mounted on boot.
+
Only applies to Solaris systems.
+ - - + +
dump
string -
- - - Default:
0
- - -
Dump (see fstab(5)).
-
Note that if set to null and state set to present, it will cease to work and duplicate entries will be made with subsequent runs.
-
Has no effect on Solaris systems.
- + + + + Default:
0
+ + +
Dump (see fstab(5)).
+
Note that if set to null and state set to present, it will cease to work and duplicate entries will be made with subsequent runs.
+
Has no effect on Solaris systems.
+ - - + +
fstab
string -
- - - - -
File to use instead of /etc/fstab.
-
You should not use this option unless you really know what you are doing.
-
This might be useful if you need to configure mountpoints in a chroot environment.
-
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.
-
This parameter defaults to /etc/fstab or /etc/vfstab on Solaris.
- + + + + + +
File to use instead of /etc/fstab.
+
You should not use this option unless you really know what you are doing.
+
This might be useful if you need to configure mountpoints in a chroot environment.
+
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.
+
This parameter defaults to /etc/fstab or /etc/vfstab on Solaris.
+ - - + +
fstype
string -
- - - - -
Filesystem type.
-
Required when state is present or mounted.
- + + + + + +
Filesystem type.
+
Required when state is present or mounted.
+ - - + +
opts
string -
- - - - -
Mount options (see fstab(5), or vfstab(4) on Solaris).
- + + + + + +
Mount options (see fstab(5), or vfstab(4) on Solaris).
+ - - + +
passno
string -
- - - Default:
0
- - -
Passno (see fstab(5)).
-
Note that if set to null and state set to present, it will cease to work and duplicate entries will be made with subsequent runs.
-
Deprecated on Solaris systems.
- + + + + Default:
0
+ + +
Passno (see fstab(5)).
+
Note that if set to null and state set to present, it will cease to work and duplicate entries will be made with subsequent runs.
+
Deprecated on Solaris systems.
+ - - + +
path
path - / required
- - - - -
Path to the mount point (e.g. /mnt/files).
-
Before Ansible 2.3 this option was only usable as dest, destfile and name.
-

aliases: name
- + / required + + + + + +
Path to the mount point (e.g. /mnt/files).
+
Before Ansible 2.3 this option was only usable as dest, destfile and name.
+

aliases: name
+ - - + +
src
path -
- - - - -
Device (or NFS volume, or something else) to be mounted on path.
-
Required when state set to present or mounted.
- + + + + + +
Device (or NFS volume, or something else) to be mounted on path.
+
Required when state set to present or mounted.
+ - - + +
state
string - / required
- - -
    Choices: -
  • absent
    • -
  • mounted
    • -
  • present
    • -
  • unmounted
    • -
  • remounted
    • -
- - -
If mounted, the device will be actively mounted and appropriately configured in fstab. If the mount point is not present, the mount point will be created.
-
If unmounted, the device will be unmounted without changing fstab.
-
present only specifies that the device is to be configured in fstab and does not trigger or require a mount.
-
absent specifies that the device mount's entry will be removed from fstab and will also unmount the device and remove the mount point.
-
remounted 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 opts is set, the options will be applied to the remount, but will not change fstab. Additionally, if opts is set, and the remount command fails, the module will error to prevent unexpected mount changes. Try using mounted instead to work around this issue.
- + / required + + + +
    Choices: +
  • absent
    • +
  • mounted
    • +
  • present
    • +
  • unmounted
    • +
  • remounted
    • +
+ + +
If mounted, the device will be actively mounted and appropriately configured in fstab. If the mount point is not present, the mount point will be created.
+
If unmounted, the device will be unmounted without changing fstab.
+
present only specifies that the device is to be configured in fstab and does not trigger or require a mount.
+
absent specifies that the device mount's entry will be removed from fstab and will also unmount the device and remove the mount point.
+
remounted 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 opts is set, the options will be applied to the remount, but will not change fstab. Additionally, if opts is set, and the remount command fails, the module will error to prevent unexpected mount changes. Try using mounted instead to work around this issue.
+ - +
@@ -235,7 +237,6 @@ Examples .. code-block:: yaml+jinja - # Before 2.3, option 'name' was used instead of 'path' - name: Mount DVD read-only ansible.posix.mount: @@ -298,7 +299,6 @@ Examples - Status ------ @@ -308,5 +308,3 @@ Authors - Ansible Core Team - Seth Vidal (@skvidal) - - diff --git a/docs/ansible.posix.patch_module.rst b/docs/ansible.posix.patch_module.rst index 9289047..95d8e2e 100644 --- a/docs/ansible.posix.patch_module.rst +++ b/docs/ansible.posix.patch_module.rst @@ -31,172 +31,173 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
backup
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Passes --backup --version-control=numbered to patch, producing numbered backup copies.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Passes --backup --version-control=numbered to patch, producing numbered backup copies.
+ - - + +
basedir
path -
- - - - -
Path of a base directory in which the patch file will be applied.
-
May be omitted when dest option is specified, otherwise required.
- + + + + + +
Path of a base directory in which the patch file will be applied.
+
May be omitted when dest option is specified, otherwise required.
+ - - + +
binary
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Setting to yes will disable patch's heuristic for transforming CRLF line endings into LF.
-
Line endings of src and dest must match.
-
If set to no, patch will replace CRLF in src files on POSIX.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Setting to yes will disable patch's heuristic for transforming CRLF line endings into LF.
+
Line endings of src and dest must match.
+
If set to no, patch will replace CRLF in src files on POSIX.
+ - - + +
dest
path -
- - - - -
Path of the file on the remote machine to be patched.
-
The names of the files to be patched are usually taken from the patch file, but if there's just one file to be patched it can specified with this option.
-

aliases: originalfile
- + + + + + +
Path of the file on the remote machine to be patched.
+
The names of the files to be patched are usually taken from the patch file, but if there's just one file to be patched it can specified with this option.
+

aliases: originalfile
+ - - + +
ignore_whitespace
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Setting to yes will ignore white space changes between patch and input..
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Setting to yes will ignore white space changes between patch and input..
+ - - + +
remote_src
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
If no, it will search for src at originating/controller machine, if yes it will go to the remote/target machine for the src.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
If no, it will search for src at originating/controller machine, if yes it will go to the remote/target machine for the src.
+ - - + +
src
path - / required
- - - - -
Path of the patch file as accepted by the GNU patch tool. If remote_src is 'no', the patch source file is looked up from the module's files directory.
-

aliases: patchfile
- + / required + + + + + +
Path of the patch file as accepted by the GNU patch tool. If remote_src is 'no', the patch source file is looked up from the module's files directory.
+

aliases: patchfile
+ - - + +
state
string -
- - -
    Choices: -
  • absent
    • -
  • present ←
    • -
- - -
Whether the patch should be applied or reverted.
- + + + +
    Choices: +
  • absent
    • +
  • present ←
    • +
+ + +
Whether the patch should be applied or reverted.
+ - - + +
strip
integer -
- - - Default:
0
- - -
Number that indicates the smallest prefix containing leading slashes that will be stripped from each file name found in the patch file.
-
For more information see the strip parameter of the GNU patch tool.
- + + + + Default:
0
+ + +
Number that indicates the smallest prefix containing leading slashes that will be stripped from each file name found in the patch file.
+
For more information see the strip parameter of the GNU patch tool.
+ - +
@@ -213,7 +214,6 @@ Examples .. code-block:: yaml+jinja - - name: Apply patch to one file ansible.posix.patch: src: /tmp/index.html.patch @@ -234,7 +234,6 @@ Examples - Status ------ @@ -244,5 +243,3 @@ Authors - Jakub Jirutka (@jirutka) - Luis Alberto Perez Lazaro (@luisperlaz) - - diff --git a/docs/ansible.posix.seboolean_module.rst b/docs/ansible.posix.seboolean_module.rst index 70f9eb1..31ab10e 100644 --- a/docs/ansible.posix.seboolean_module.rst +++ b/docs/ansible.posix.seboolean_module.rst @@ -38,81 +38,83 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
ignore_selinux_state
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Useful for scenarios (chrooted environment) that you can't get the real SELinux state.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Useful for scenarios (chrooted environment) that you can't get the real SELinux state.
+ - - + +
name
- - / required
- - - - -
Name of the boolean to configure.
- + / required + + + + + +
Name of the boolean to configure.
+ - - + +
persistent
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Set to yes if the boolean setting should survive a reboot.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Set to yes if the boolean setting should survive a reboot.
+ - - + +
state
boolean - / required
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Desired boolean value
- + / required + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Desired boolean value
+ - +
@@ -129,7 +131,6 @@ Examples .. code-block:: yaml+jinja - - name: Set httpd_can_network_connect flag on and keep it persistent across reboots ansible.posix.seboolean: name: httpd_can_network_connect @@ -139,7 +140,6 @@ Examples - Status ------ @@ -148,5 +148,3 @@ Authors ~~~~~~~ - Stephen Fromm (@sfromm) - - diff --git a/docs/ansible.posix.selinux_module.rst b/docs/ansible.posix.selinux_module.rst index 70012e8..aec26e9 100644 --- a/docs/ansible.posix.selinux_module.rst +++ b/docs/ansible.posix.selinux_module.rst @@ -39,61 +39,62 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
configfile
- -
- - - Default:
"/etc/selinux/config"
- - -
The path to the SELinux configuration file, if non-standard.
-

aliases: conf, file
- + + + + Default:
"/etc/selinux/config"
+ + +
The path to the SELinux configuration file, if non-standard.
+

aliases: conf, file
+ - - + +
policy
- -
- - - - -
The name of the SELinux policy to use (e.g. targeted) will be required if state is not disabled.
- + + + + + +
The name of the SELinux policy to use (e.g. targeted) will be required if state is not disabled.
+ - - + +
state
- - / required
- - -
    Choices: -
  • disabled
    • -
  • enforcing
    • -
  • permissive
    • -
- - -
The SELinux mode.
- + / required + + + +
    Choices: +
  • disabled
    • +
  • enforcing
    • +
  • permissive
    • +
+ + +
The SELinux mode.
+ - +
@@ -104,7 +105,6 @@ Examples .. code-block:: yaml+jinja - - name: Enable SELinux ansible.posix.selinux: policy: targeted @@ -121,7 +121,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -134,92 +133,92 @@ Common return values are documented `here Returned Description - - + +
configfile
string -
- + + always -
Path to SELinux configuration file.
-
-
Sample:
-
/etc/selinux/config
- +
Path to SELinux configuration file.
+
+
Sample:
+
/etc/selinux/config
+ - - + +
msg
string -
- + + always -
Messages that describe changes that were made.
-
-
Sample:
-
Config SELinux state changed from 'disabled' to 'permissive'
- +
Messages that describe changes that were made.
+
+
Sample:
+
Config SELinux state changed from 'disabled' to 'permissive'
+ - - + +
policy
string -
- + + always -
Name of the SELinux policy.
-
-
Sample:
-
targeted
- +
Name of the SELinux policy.
+
+
Sample:
+
targeted
+ - - + +
reboot_required
boolean -
- + + always -
Whether or not an reboot is required for the changes to take effect.
-
-
Sample:
-
True
- +
Whether or not an reboot is required for the changes to take effect.
+
+
Sample:
+
True
+ - - + +
state
string -
- + + always -
SELinux mode.
-
-
Sample:
-
enforcing
- +
SELinux mode.
+
+
Sample:
+
enforcing
+ - +

@@ -231,5 +230,3 @@ Authors ~~~~~~~ - Derek Carter (@goozbach) - - diff --git a/docs/ansible.posix.synchronize_module.rst b/docs/ansible.posix.synchronize_module.rst index 41c395f..efd892b 100644 --- a/docs/ansible.posix.synchronize_module.rst +++ b/docs/ansible.posix.synchronize_module.rst @@ -34,492 +34,494 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
archive
boolean -
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags and -D.
- + + + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags and -D.
+ - - + +
checksum
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Skip based on checksum, rather than mod-time & size; Note that that "archive" option is still enabled by default - the "checksum" option will not disable it.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Skip based on checksum, rather than mod-time & size; Note that that "archive" option is still enabled by default - the "checksum" option will not disable it.
+ - - + +
compress
boolean -
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Compress file data during the transfer.
-
In most cases, leave this enabled unless it causes problems.
- + + + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Compress file data during the transfer.
+
In most cases, leave this enabled unless it causes problems.
+ - - + +
copy_links
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Copy symlinks as the item that they point to (the referent) is copied, rather than the symlink.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Copy symlinks as the item that they point to (the referent) is copied, rather than the symlink.
+ - - + +
delete
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Delete files in dest that don't exist (after transfer, not before) in the src path.
-
This option requires recursive=yes.
-
This option ignores excluded files and behaves like the rsync opt --delete-excluded.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Delete files in dest that don't exist (after transfer, not before) in the src path.
+
This option requires recursive=yes.
+
This option ignores excluded files and behaves like the rsync opt --delete-excluded.
+ - - + +
dest
string - / required
- - - - -
Path on the destination host that will be synchronized from the source.
-
The path can be absolute or relative.
- + / required + + + + + +
Path on the destination host that will be synchronized from the source.
+
The path can be absolute or relative.
+ - - + +
dest_port
integer -
- - - - -
Port number for ssh on the destination host.
-
Prior to Ansible 2.0, the ansible_ssh_port inventory var took precedence over this value.
-
This parameter defaults to the value of ansible_ssh_port or ansible_port, the remote_port config setting or the value from ssh client configuration if none of the former have been set.
- + + + + + +
Port number for ssh on the destination host.
+
Prior to Ansible 2.0, the ansible_ssh_port inventory var took precedence over this value.
+
This parameter defaults to the value of ansible_ssh_port or ansible_port, the remote_port config setting or the value from ssh client configuration if none of the former have been set.
+ - - + +
dirs
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Transfer directories without recursing.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Transfer directories without recursing.
+ - - + +
existing_only
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Skip creating new files on receiver.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Skip creating new files on receiver.
+ - - + +
group
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Preserve group.
-
This parameter defaults to the value of the archive option.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Preserve group.
+
This parameter defaults to the value of the archive option.
+ - - + +
link_dest
list -
- - - Default:
null
- - -
Add a destination to hard link against during the rsync.
- + + + + Default:
null
+ + +
Add a destination to hard link against during the rsync.
+ - - + +
links
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Copy symlinks as symlinks.
-
This parameter defaults to the value of the archive option.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Copy symlinks as symlinks.
+
This parameter defaults to the value of the archive option.
+ - - + +
mode
string -
- - -
    Choices: -
  • pull
    • -
  • push ←
    • -
- - -
Specify the direction of the synchronization.
-
In push mode the localhost or delegate is the source.
-
In pull mode the remote host in context is the source.
- + + + +
    Choices: +
  • pull
    • +
  • push ←
    • +
+ + +
Specify the direction of the synchronization.
+
In push mode the localhost or delegate is the source.
+
In pull mode the remote host in context is the source.
+ - - + +
owner
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Preserve owner (super user only).
-
This parameter defaults to the value of the archive option.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Preserve owner (super user only).
+
This parameter defaults to the value of the archive option.
+ - - + +
partial
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Tells rsync to keep the partial file which should make a subsequent transfer of the rest of the file much faster.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Tells rsync to keep the partial file which should make a subsequent transfer of the rest of the file much faster.
+ - - + +
perms
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Preserve permissions.
-
This parameter defaults to the value of the archive option.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Preserve permissions.
+
This parameter defaults to the value of the archive option.
+ - - + +
private_key
path -
- - - - -
Specify the private key to use for SSH-based rsync connections (e.g. ~/.ssh/id_rsa).
- + + + + + +
Specify the private key to use for SSH-based rsync connections (e.g. ~/.ssh/id_rsa).
+ - - + +
recursive
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Recurse into directories.
-
This parameter defaults to the value of the archive option.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Recurse into directories.
+
This parameter defaults to the value of the archive option.
+ - - + +
rsync_opts
list -
- - - Default:
null
- - -
Specify additional rsync options by passing in an array.
-
Note that an empty string in rsync_opts will end up transfer the current working directory.
- + + + + Default:
null
+ + +
Specify additional rsync options by passing in an array.
+
Note that an empty string in rsync_opts will end up transfer the current working directory.
+ - - + +
rsync_path
string -
- - - - -
Specify the rsync command to run on the remote host. See --rsync-path on the rsync man page.
-
To specify the rsync command to run on the local host, you need to set this your task var ansible_rsync_path.
- + + + + + +
Specify the rsync command to run on the remote host. See --rsync-path on the rsync man page.
+
To specify the rsync command to run on the local host, you need to set this your task var ansible_rsync_path.
+ - - + +
rsync_timeout
integer -
- - - Default:
0
- - -
Specify a --timeout for the rsync command in seconds.
- + + + + Default:
0
+ + +
Specify a --timeout for the rsync command in seconds.
+ - - + +
set_remote_user
boolean -
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Put user@ for the remote paths.
-
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 no.
- + + + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Put user@ for the remote paths.
+
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 no.
+ - - + +
src
string - / required
- - - - -
Path on the source host that will be synchronized to the destination.
-
The path can be absolute or relative.
- + / required + + + + + +
Path on the source host that will be synchronized to the destination.
+
The path can be absolute or relative.
+ - - + +
times
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Preserve modification times.
-
This parameter defaults to the value of the archive option.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Preserve modification times.
+
This parameter defaults to the value of the archive option.
+ - - + +
use_ssh_args
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Use the ssh_args specified in ansible.cfg.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Use the ssh_args specified in ansible.cfg.
+ - - + +
verify_host
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Verify destination host key.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Verify destination host key.
+ - +
@@ -560,7 +562,6 @@ Examples .. code-block:: yaml+jinja - - name: Synchronization of src on the control machine to dest on the remote hosts ansible.posix.synchronize: src: some/relative/path @@ -689,7 +690,6 @@ Examples - Status ------ @@ -698,5 +698,3 @@ Authors ~~~~~~~ - Timothy Appnel (@tima) - - diff --git a/docs/ansible.posix.sysctl_module.rst b/docs/ansible.posix.sysctl_module.rst index 0691896..1d7b34b 100644 --- a/docs/ansible.posix.sysctl_module.rst +++ b/docs/ansible.posix.sysctl_module.rst @@ -31,133 +31,134 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
ignoreerrors
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Use this option to ignore errors about unknown keys.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Use this option to ignore errors about unknown keys.
+ - - + +
name
- - / required
- - - - -
The dot-separated path (aka key) specifying the sysctl variable.
-

aliases: key
- + / required + + + + + +
The dot-separated path (aka key) specifying the sysctl variable.
+

aliases: key
+ - - + +
reload
boolean -
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
If yes, performs a /sbin/sysctl -p if the sysctl_file is updated. If no, does not reload sysctl even if the sysctl_file is updated.
- + + + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
If yes, performs a /sbin/sysctl -p if the sysctl_file is updated. If no, does not reload sysctl even if the sysctl_file is updated.
+ - - + +
state
- -
- - -
    Choices: -
  • present ←
    • -
  • absent
    • -
- - -
Whether the entry should be present or absent in the sysctl file.
- + + + +
    Choices: +
  • present ←
    • +
  • absent
    • +
+ + +
Whether the entry should be present or absent in the sysctl file.
+ - - + +
sysctl_file
- -
- - - Default:
"/etc/sysctl.conf"
- - -
Specifies the absolute path to sysctl.conf, if not /etc/sysctl.conf.
- + + + + Default:
"/etc/sysctl.conf"
+ + +
Specifies the absolute path to sysctl.conf, if not /etc/sysctl.conf.
+ - - + +
sysctl_set
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Verify token value with the sysctl command and set with -w if necessary
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Verify token value with the sysctl command and set with -w if necessary
+ - - + +
value
- -
- - - - -
Desired value of the sysctl key.
-

aliases: val
- + + + + + +
Desired value of the sysctl key.
+

aliases: val
+ - +
@@ -168,7 +169,6 @@ Examples .. code-block:: yaml+jinja - # Set vm.swappiness to 5 in /etc/sysctl.conf - ansible.posix.sysctl: name: vm.swappiness @@ -205,7 +205,6 @@ Examples - Status ------ @@ -214,5 +213,3 @@ Authors ~~~~~~~ - David CHANIAL (@davixx) - - diff --git a/galaxy.yml b/galaxy.yml index ff3db68..01777f2 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: ansible name: posix -version: 1.1.0 +version: 1.1.1 readme: README.md authors: - Ansible (github.com/ansible)