Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >=4.5.0 < 6.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'otherskins-ansible', '1.1.1'
Learn more about managing modules with a PuppetfileDocumentation
Puppet module: Ansible
Table of Contents
Module description
The ansible module installs and configures the Ansible across a range of operating systems and distributions.
Setup
Beginning with ansible
include '::ansible'
is enough to get you up and running. To pass in parameters specifying hosts entries use:
ansible::hosts { 'webservers':
entrys => [
'172.16.0.10',
'172.16.0.20',
]
}
Usage
To control all the parameters of the configuration file use the main ::ansible
class. See the common usages below for examples.
Install ansible
include '::ansible'
Install and specifying hosts
include '::ansible'
ansible::hosts { 'databases':
entrys => [
'172.16.0.30',
'172.16.0.40',
]
}
Change parameter in ansible.cfg
class { 'ansible':
roles_path => /srv/roles,
timeout => 30,
log_path => /var/log/ansible.log,
private_key_file => /etc/keys,
}
Reference
Defined Types
hosts
- Set hosts entries
Classes
Public classes
- ansible: Main class, includes all other classes.
Private classes
- ansible::install: Handles the packages.
- ansible::config: Handles the configuration file.
Parameters
The following parameters are available in the ::ansible
class:
gather_timeout
Optional.
Data type: Integer.
Description: Some hardware related facts are collected with a maximum timeout of 10 seconds. This option lets you increase or decrease that timeout to something more suitable for the environment.
Default value: undef
.
accelerate_timeout
Optional.
Data type: Integer.
Description: This setting controls the timeout for receiving data from a client. If no data is received during this time, the socket connection will be closed. A keepalive packet is sent back to the controller every 15 seconds, so this timeout should not be set lower than 15 (by default, the timeout is 30 seconds)
Default value: undef
.
accelerate_port
Optional.
Data type: Integer.
Description: This is the port to use for accelerated mode:
Default value: undef
.
command_timeout
Optional.
Data type: Integer.
Description: The command timeout value defines the amount of time to wait for a command or RPC call before timing out. The value for the command timeout must be less than the value of the persistent connection idle timeout (connect_timeout).
Default value: undef
.
connect_retry_timeout
Optional.
Data type: Integer.
Description: Configures the persistent connection retry timeout. This value configures the retry timeout that ansible-connection will wait to connect to the local domain socket. This value must be larger than the ssh timeout (timeout) and less than persistent connection idle timeout (connect_timeout). The default value is 15 seconds.
Default value: undef
.
connect_timeout
Optional.
Data type: Integer.
Description: Configures the persistent connection timeout value in seconds. This value is how long the persistent connection will remain idle before it is destroyed. If the connection doesn't receive a request before the timeout value expires, the connection is shutdown. The default value is 30 seconds.
Default value: undef
.
context
Optional.
Data type: Integer.
Description: Set how many context lines to show in diff
Default value: undef
.
forks
Optional.
Data type: Integer.
Description: This is the default number of parallel processes to spawn when communicating with remote hosts. Since Ansible 1.3, the fork number is automatically limited to the number of possible hosts at runtime, so this is really a limit of how much network and CPU load you think you can handle. Many users may set this to 50, some set it to 500 or more. If you have a large number of hosts, higher values will make actions across all of those hosts complete faster.
Default value: undef
.
poll_interval
Optional.
Data type: Integer.
Description: For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how often to check back on the status of those tasks when an explicit poll interval is not supplied. The default is a reasonably moderate 15 seconds which is a tradeoff between checking in frequently and providing a quick turnaround when something may have completed.
Default value: undef
.
remote_port
Optional.
Data type: Integer.
Description: This sets the default SSH port on all of your systems, for systems that didn’t specify an alternative value in inventory. The default is the standard 22.
Default value: undef
.
timeout
Optional.
Data type: Integer.
Description: This is the default SSH timeout to use on connection attempts.
Default value: undef
.
max_diff_size
Optional.
Data type: Integer.
Description: This controls the cutoff point (in bytes) on --diff for files set to 0 for unlimited (RAM may suffer!).
Default value: undef
.
nocows
Optional.
Data type: Integer.
Description: Por padrão, Ansible irá aproveitar o Cowsay se instalado para criar /usr/bin/ansible-playbook é mais excitante. Por quê? Acreditamos que o gerenciamento de sistemas deve ser uma experiência feliz. Se você não gosta das vacas, pode desativá-las definindo 'nocows' para 1.
Default value: undef
.
nocolor
Optional.
Data type: Integer.
Description: By default ansible will try to colorize output to give a better indication of failure and status information. If you dislike this behavior you can turn it off by setting ‘nocolor’ to 1.
Default value: undef
.
var_compression_level
Optional.
Data type: Integer.
Description: Controls the compression level of variables sent to worker processes. At the default of 0, no compression is used. This value must be an integer from 0 to 9.
Default value: undef
.
sudo_flags
Optional.
Data type: String.
Description: Additional flags to pass to sudo when engaging sudo support. The default is ‘-H -S -n’ which sets the HOME environment variable, prompts for passwords via STDIN, and avoids prompting the user for input of any kind. Note that ‘-n’ will conflict with using password-less sudo auth, such as pam_ssh_agent_auth. In some situations you may wish to add or remove flags, but in general most users will not need to change this setting.
Default value: undef
.
cow_selection
Optional.
Data type: String.
Description: Set which cowsay stencil you'd like to use by default. When set to 'random', a random stencil will be selected for each task. The selection will be filtered against the cow_whitelist
option below.
Default value: undef
.
cow_whitelist
Optional.
Data type: String.
Description: # when using the 'random' option for cowsay, stencils will be restricted to this list. it should be formatted as a comma-separated list with no spaces between names. NOTE: line continuations here are for formatting purposes only, as the INI parser in python does not support them.
Default value: undef
.
action_plugins
Optional.
Data type: String.
Description: Actions are pieces of code in ansible that enable things like module execution, templating, and so forth.
Default value: undef
.
cache_plugins
Optional.
Data type: String.
Description: Set plugin path directories here, separate with colons.
Default value: undef
.
callback_plugins
Optional.
Data type: String.
Description: Set plugin path directories here, separate with colons.
Default value: undef
.
diff_add
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
special_context_filesystems
Optional.
Data type: String.
Description: File systems that require special treatment when dealing with security context the default behaviour that copies the existing context or uses the user default needs to be changed to use the file system dependent context.
Default value: undef
.
changed
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
unreachable
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
debug
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
error
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
warn
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
verbose
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
highlight
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
deprecate
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
skip
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
connection_plugins
Optional.
Data type: String.
Description: Set plugin path directories here, separate with colons.
Default value: undef
.
lookup_plugins
Optional.
Data type: String.
Description: Set plugin path directories here, separate with colons.
Default value: undef
.
inventory_plugins
Optional.
Data type: String.
Description: Set plugin path directories here, separate with colons.
Default value: undef
.
vars_plugins
Optional.
Data type: String.
Description: Set plugin path directories here, separate with colons.
Default value: undef
.
filter_plugins
Optional.
Data type: String.
Description: Set plugin path directories here, separate with colons.
Default value: undef
.
diff_lines
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
diff_remove
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
test_plugins
Optional.
Data type: String.
Description: Set plugin path directories here, separate with colons.
Default value: undef
.
terminal_plugins
Optional.
Data type: String.
Description: Set plugin path directories here, separate with colons.
Default value: undef
.
strategy_plugins
Optional.
Data type: String.
Description: Set plugin path directories here, separate with colons.
Default value: undef
.
strategy
Optional.
Data type: String.
Description: # by default, ansible will use the 'linear' strategy but you may want to try another one
Default value: undef
.
ask_sudo_pass
Optional.
Data type: String.
Description: Similar to ask_pass, this controls whether an Ansible playbook should prompt for a sudo password by default when sudoing. The default behavior is also no.
Default value: undef
.
remote_user
Optional.
Data type: String.
Description: This is the default username ansible will connect as for /usr/bin/ansible-playbook. Note that /usr/bin/ansible will always default to the current user if this is not defined.
Default value: undef
.
ok
Optional.
Data type: String.
Description: Parameter to change output color.
Default value: undef
.
log_path
Optional.
Data type: String.
Description: If present and configured in ansible.cfg, Ansible will log information about executions at the designated location. Be sure the user running Ansible has permissions on the logfile.
Default value: undef
.
name_module
Optional.
Data type: String.
Description: This is the default module name (-m) value for /usr/bin/ansible. The default is the ‘command’ module. Remember the command module doesn’t support shell variables, pipes, or quotes, so you might wish to change it to ‘shell’.
Default value: undef
.
jinja2_extensions
Optional.
Data type: String.
Description: This is a developer-specific feature that allows enabling additional Jinja2 extensions.
Default value: undef
.
vault_password_file
Optional.
Data type: String.
Description: Configures the path to the Vault password file as an alternative to specifying --vault-password-file on the command line.
Default value: undef
.
module_utils
Optional.
Data type: String.
Description: The module_utils are python modules that Ansible is able to combine with Ansible modules when sending them to the remote machine. Having custom module_utils is useful for extracting common code when developing a set of site-specific modules. Ansible can look in multiple locations if you feed it a colon separated path, and it also will look for modules in the ./module_utils directory alongside a playbook.
Default value: undef
.
ansible_managed
Optional.
Data type: String.
Description: This string can be helpful to indicate that a file should not be directly edited because Ansible may overwrite the contents of the file.
Default value: undef
.
sudo_user
Optional.
Data type: String.
Description: This is the default user to sudo to if --sudo-user is not specified or ‘sudo_user’ is not specified in an Ansible playbook. The default is the most logical: ‘root’.
Default value: undef
.
inventory_ignore_extensions
Optional.
Data type: String.
Description: Coma-separated list of file extension patterns to ignore when Ansible inventory is a directory with multiple sources (static and dynamic).
Default value: undef
.
transfer_method
Optional.
Data type: String.
Description: Control the mechanism for transferring files (new). If set, this will override the scp_if_ssh option
Default value: undef
.
transport
Optional.
Data type: String.
Description: Some basic default values.
Default value: undef
.
gather_subset
Optional.
Data type: String.
Description: This only affects the gathering done by a play's gather_facts directive, by default gathering retrieves all facts subsets, all - gather all subsets, network - gather min and network facts, hardware - gather hardware facts (longest facts to retrieve), virtual - gather min and virtual facts, facter - import facts from facter, ohai - import facts from ohai, you can combine them using comma (ex: network,virtual), you can negate them using ! (ex: !hardware,!facter,!ohai), a minimal set of facts is always gathered.
Default value: undef
.
module_set_locale
Optional.
Data type: String.
Description: This boolean value controls whether or not Ansible will prepend locale-specific environment variables (as specified via the module_lang configuration option). If enabled, it results in the LANG, LC_MESSAGES, and LC_ALL being set when the module is executed on the given remote system. By default this is disabled.
Default value: undef
.
host_key_checking
Optional.
Data type: String.
Description: As described in Getting Started, host key checking is on by default in Ansible 1.3 and later. If you understand the implications and wish to disable it, you may do so here by setting the value to False.
Default value: undef
.
stdout_callback
Optional.
Data type: String.
Description: This setting allows you to override the default stdout callback for ansible-playbook.
Default value: undef
.
gathering
Optional.
Data type: String.
Description: The value ‘implicit’ is the default, which means that the fact cache will be ignored and facts will be gathered per play unless ‘gather_facts: False’ is set. The value ‘explicit’ is the inverse, facts will not be gathered unless directly requested in the play. The value ‘smart’ means each new host that has no facts discovered will be scanned, but if the same host is addressed in multiple plays it will not be contacted again in the playbook run. This option can be useful for those wishing to save fact gathering time. Both ‘smart’ and ‘explicit’ will use the fact cache.
Default value: undef
.
roles_path
Optional.
Data type: String.
Description: The roles path indicate additional directories beyond the ‘roles/’ subdirectory of a playbook project to search to find Ansible roles. For instance, if there was a source control repository of common roles and a different repository of playbooks, you might choose to establish a convention to checkout roles in /opt/mysite/roles like so.
Default value: undef
.
ask_pass
Optional.
Data type: String.
Description: Ask for privilege escalation password, the default is False.
Default value: undef
.
executable
Optional.
Data type: String.
Description: This is the location of the ssh binary. It defaults to ssh which will use the first ssh binary available in $PATH. This config can also be overridden with ansible_ssh_executable inventory variable.
Default value: undef
.
sudo_exe
Optional.
Data type: String.
Description: If using an alternative sudo implementation on remote machines, the path to sudo can be replaced here provided the sudo implementation is matching CLI flags with the standard sudo.
Default value: undef
.
control_path
Optional.
Data type: String.
Description: This is the location to save ControlPath sockets. This defaults to.
Default value: undef
.
retry_files_save_path
Optional.
Data type: String.
Description: The retry files save path is where Ansible will save .retry files when a playbook fails and retry_files_enabled is True (the default). The default location is adjacent to the play (~/ in versions older than 2.0) and can be changed to any writeable path.
Default value: undef
.
squash_actions
Optional.
Data type: String.
Description: Ansible can optimise actions that call modules that support list parameters when using with_ looping. Instead of calling the module once for each item, the module is called once with the full list.
Default value: undef
.
become_method
Optional.
Data type: String.
Description: Set the privilege escalation method. The default is sudo, other options are su, pbrun, pfexec, doas, ksu.
Default value: undef
.
remote_tmp
Optional.
Data type: String.
Description: Ansible works by transferring modules to your remote machines, running them, and then cleaning up after itself. In some cases, you may not wish to use the default location and would like to change the path. You can do so by altering this setting.
Default value: undef
.
control_path_dir
Optional.
Data type: String.
Description: This is the base directory of the ControlPath sockets. It is the %(directory)s part of the control_path option. This defaults to.
Default value: undef
.
ssh_args
Optional.
Data type: String.
Description: If set, this will pass a specific set of options to Ansible rather than Ansible’s usual defaults.
Default value: undef
.
module_compression
Optional.
Data type: String.
Description: Controls what compression method is used for new-style ansible modules when they are sent to the remote system. The compression types depend on having support compiled into both the controller's python and the client's python. The names should match with the python Zipfile compression types: ZIP_STORED (no compression. available everywhere), ZIP_DEFLATED (uses zlib, the default) These values may be set per host via the ansible_module_compression inventory variable
Default value: undef
.
local_tmp
Optional.
Data type: String.
Description: When Ansible gets ready to send a module to a remote machine it usually has to add a few things to the module: Some boilerplate code, the module’s parameters, and a few constants from the config file. This combination of things gets stored in a temporary file until ansible exits and cleans up after itself. The default location is a subdirectory of the user’s home directory. If you’d like to change that, you can do so by altering this setting.
Default value: undef
.
module_lang
Optional.
Data type: String.
Description: This is to set the default language to communicate between the module and the system. By default, the value is value LANG on the controller or, if unset, en_US.UTF-8 (it used to be C in previous versions).
Default value: undef
.
inventory
Optional.
Data type: String.
Description: Enable inventory plugins, default: 'host_list', 'script', 'yaml', 'ini'.
Default value: undef
.
hash_behaviour
Optional.
Data type: String.
Description: If inventory variables overlap, does the higher precedence one win or are hash values merged together? The default is 'replace' but this can also be set to 'merge'.
Default value: undef
.
library
Optional.
Data type: String.
Description: Some basic default values.
Default value: undef
.
private_key_file
Optional.
Data type: String.
Description: If set, always use this private key file for authentication, same as if passing --private-key to ansible or ansible-playbook
Default value: undef
.
callback_whitelist
Optional.
Data type: String.
Description: Enable callback plugins, they can output to stdout but cannot be 'stdout' type.
Default value: undef
.
become_user
Optional.
Data type: String.
Description: Ansible can use existing privilege escalation systems to allow a user to execute tasks as another. As of 1.9 ‘become’ supersedes the old sudo/su, while still being backwards compatible. Settings live under the [privilege_escalation] header.
Default value: undef
.
inventory_enabled
Optional.
Data type: String.
Description: Enable inventory plugins, default: 'host_list', 'script', 'yaml', 'ini'.
Default value: undef
.
fact_caching
Optional.
Data type: String.
Description: If set to a persistent type (not 'memory', for example 'redis') fact values from previous runs in Ansible will be stored. This may be useful when wanting to use, for example, IP information from one group of servers without having to talk to them in the same playbook run to get their current IP information.
Default value: undef
.
scp_if_ssh
Optional.
Data type: String.
Description: Control the mechanism for transferring files (old).
Default value: undef
.
display_skipped_hosts
Optional.
Data type: Boolean.
Description: By default, ansible-playbook will display "Skipping [host]" if it determines a task should not be run on a host. Set this to "False" if you don't want to see these "Skipping" messages. NOTE: the task header will still be shown regardless of whether or not the task is skipped.
Default value: undef
.
retry_files_enabled
Optional.
Data type: Boolean.
Description: Retry files. When a playbook fails by default a .retry file will be created in ~/. You can disable this feature by setting retry_files_enabled to False and you can change the location of the files by setting retry_files_save_path.
Default value: undef
.
command_warnings
Optional.
Data type: Boolean.
Description: Ansible can optionally warn when usage of the shell and command module appear to be simplified by using a default Ansible module instead. These warnings can be silenced by adjusting the following setting or adding warn=yes or warn=no to the end of the command line parameter string. This will for example suggest using the git module instead of shelling out to the git command.
Default value: undef
.
bin_ansible_callbacks
Optional.
Data type: Boolean.
Description: By default callbacks are not loaded for /bin/ansible, enable this if you want, for example, a notification or logging callback to also apply to /bin/ansible runs
Default value: undef
.
become
Optional.
Data type: Boolean.
Description: The equivalent of adding sudo: or su: to a play or task, set to true/yes to activate privilege escalation. The default behavior is no.
Default value: undef
.
allow_world_readable_tmpfiles
Optional.
Data type: Boolean.
Description: This makes the temporary files created on the machine to be world readable and will issue a warning instead of failing the task.
Default value: undef
.
system_warnings
Optional.
Data type: Boolean.
Description: Allows disabling of warnings related to potential issues on the system running ansible itself (not on the managed hosts).
Default value: undef
.
display_args_to_stdout
Optional.
Data type: Boolean.
Description: By default, ansible-playbook will print a header for each task that is run to stdout. These headers will contain the name: field from the task if you specified one. If you didn’t then ansible-playbook uses the task’s action to help you tell which task is presently running. Sometimes you run many of the same action and so you want more information about the task to differentiate it from others of the same action. If you set this variable to True in the config then ansible-playbook will also include the task’s arguments in the header.
Default value: undef
.
pipelining
Optional.
Data type: Boolean.
Description: Enabling pipelining reduces the number of SSH operations required to execute a module on the remote server, by executing many ansible modules without actual file transfer. This can result in a very significant performance improvement when enabled, however when using “sudo:” operations you must first disable ‘requiretty’ in /etc/sudoers on all managed hosts.
Default value: undef
.
sftp_batch_mode
Optional.
Data type: Boolean.
Description: If False, sftp will not use batch mode to transfer files. This may cause some types of file transfer failures impossible to catch however, and should only be disabled if your sftp version has problems with batch mode
Default value: undef
.
allow_unsafe_lookups
Optional.
Data type: Boolean.
Description: When enabled, this option allows lookups (via variables like {{lookup('foo')}} or when used as a loop with with_foo
) to return data that is not marked "unsafe". This means the data may contain jinja2 templating language which will be run through the templating engine. ENABLING THIS COULD BE A SECURITY RISK
Default value: undef
.
accelerate_multi_key
Optional.
Data type: Boolean.
Description: If set to yes, accelerate_multi_key will allow multiple private keys to be uploaded to it, though each user must have access to the system via SSH to add a new key. The default is "no".
Default value: undef
.
no_target_syslog
Optional.
Data type: Boolean.
Description: Prevents logging of tasks, but only on the targets, data is still logged on the master/controller.
Default value: undef
.
merge_multiple_cli_flags
Optional.
Data type: Boolean.
Description: This controls how ansible handles multiple --tags and --skip-tags arguments on the CLI. If this is True then multiple arguments are merged together. If it is False, then the last specified argument is used and the others are ignored. This option will be removed in 2.8.
Default value: undef
.
become_ask_pass
Optional.
Data type: Boolean.
Description: Ask for privilege escalation password, the default is False.
Default value: undef
.
pty
Optional.
Data type: Boolean.
Description: By default, Ansible requests a pseudo-terminal for commands executed under sudo. Uncomment this line to disable this behaviour.
Default value: undef
.
always
Optional.
Data type: Boolean.
Description: Always print diff when running ( same as always running with -D/--diff )
Default value: undef
.
record_host_keys
Optional.
Data type: Boolean.
Description: Uncomment this line to cause the paramiko connection plugin to not record new host keys encountered. Increases performance on new host additions. Setting works independently of the host key checking setting above.
Default value: undef
.
show_custom_stats
Optional.
Data type: Boolean.
Description: Controls showing custom stats at the end, off by default
Default value: undef
.
any_errors_fatal
Optional.
Data type: Boolean.
Description: Set default errors for all plays.
Default value: undef
.
host_key_auto_add
Optional.
Data type: Boolean.
Description: When using persistent connections with Paramiko, the connection runs in a background process. If the host doesn't already have a valid SSH key, by default Ansible will prompt to add the host key. This will cause connections running in background processes to fail. Uncomment this line to have Paramiko automatically add host keys.
Default value: undef
.
libvirt_lxc_noseclabel
Optional.
Data type: Boolean.
Description: Set this to yes to allow libvirt_lxc connections to work without SELinux.
Default value: undef
.
look_for_keys
Optional.
Data type: Boolean.
Description: Paramiko will default to looking for SSH keys initially when trying to authenticate to remote devices. This is a problem for some network devices that close the connection after a key failure. Uncomment this line to disable the Paramiko look for keys function
Default value: undef
.
task_includes_static
Optional.
Data type: Boolean.
Description: Determine whether includes in tasks and handlers are "static" by default. As of 2.0, includes are dynamic by default. Setting these values to True will make includes behave more like they did in the 1.x versions.
Default value: undef
.
handler_includes_static
Optional.
Data type: Boolean.
Description: Determine whether includes in tasks and handlers are "static" by default. As of 2.0, includes are dynamic by default. Setting these values to True will make includes behave more like they did in the 1.x versions.
Default value: undef
.
private_role_vars
Optional.
Data type: Boolean.
Description: By default, variables from roles will be visible in the global variable scope. To prevent this, the following option can be enabled, and only tasks and handlers within the role will see the variables there
Default value: undef
.
error_on_missing_handler
Optional.
Data type: Boolean.
Description: Controls if a missing handler for a notification event is an error or a warning.
Default value: undef
.
error_on_undefined_vars
Optional.
Data type: Boolean.
Description: By default (as of 1.3), Ansible will raise errors when attempting to dereference Jinja2 variables that are not set in templates or action lines. Uncomment this line to revert the behavior to pre-1.3.
Default value: undef
.
no_log
Optional.
Data type: Boolean.
Description: Prevents logging of task data, off by default.
Default value: undef
.
restrict_facts_namespace
Optional.
Data type: Boolean.
Description: This keeps facts from polluting the main namespace as variables. Setting to True keeps them under the ansible_facts namespace, the default is False.
Default value: undef
.
deprecation_warnings
Optional.
Data type: Boolean.
Description: Ansible may display deprecation warnings for language features that should no longer be used and will be removed in future versions.To disable these warnings, set the following value to False.
Default value: undef
.
network_group_modules
Optional.
Data type: Tuple.
Description: This family of modules use an alternative execution path optimized for network appliances only update this setting if you know how this works, otherwise it can break module execution.
Default value: undef
.
accelerate_connect_timeout
Optional.
Data type: Float.
Description: This setting controls the timeout for the socket connect call, and should be kept relatively low. The connection to the accelerate_port will be attempted 3 times before Ansible will fall back to ssh or paramiko (depending on your default connection setting) to try and start the accelerate daemon remotely. The default setting is 1.0 seconds.
Default value: undef
.
version
Data type: String.
Description: Version of the ansible instalation.
Default value: latest
.
confdir
Data type: String.
Description: Directory of configuration file.
Default value: /etc/ansible
.
package_name
Data type: String.
Description: The name of package.
Default value: ansible
.
group
Optional. Default user to ansible.
Data type: String.
Description: Default group of the user.
Default value: root
.
user
Data type: String.
Description: Default user to ansible.
Default value: root
.
Limitations
This module has been tested on [Centos 7.3, Ubuntu 16.04 and Debian 9].
Contributors
- Edgar Silva - edgarsilva948@gmail.com
- Vincius Xavier - viniciusxavierbove@gmail.com
Copyright
- Otherskins, Inc.
Dependencies
- puppetlabs-concat (>= 4.0.1)
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS