Posts

Showing posts with the label Ansible Collection ansible.builtin
Note This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name include_vars even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name. New in version 1.4: of ansible.builtin Synopsis Parameters Notes See Also Examples Return Values Synopsis Loads YAML/JSON variables dynamically from a file or directory, recursively, during task runtime. If loading a directory, the files are sorted alphabetically before being loaded. This module is also supported for Windows targets. To assign included variables to a different host than inventory_hostname , use delegate_to and set delegate_facts=yes . Note This module has a corresponding action plugin . Parameters Parameter Choices/Defaults Comments depth integer added in 2.2 o...
Note This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name assert even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name. New in version 1.5: of ansible.builtin Synopsis Parameters Notes See Also Examples Synopsis This module asserts that given expressions are true with an optional custom message. This module is also supported for Windows targets. Note This module has a corresponding action plugin . Parameters Parameter Choices/Defaults Comments fail_msg string added in 2.7 of ansible.builtin The customized message used for a failing assertion. This argument was called 'msg' before Ansible 2.7, now it is renamed to 'fail_msg' with alias 'msg'. aliases: msg quiet boolea...
Note This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name replace even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name. New in version 1.6: of ansible.builtin Synopsis Parameters Notes Examples Synopsis This module will replace all instances of a pattern within a file. It is up to the user to maintain idempotence by ensuring that the same pattern would never match any replacements made. Parameters Parameter Choices/Defaults Comments after string added in 2.4 of ansible.builtin If specified, only content after this match will be replaced/removed. Can be used in combination with before . Uses Python regular expressions; see http://docs.python.org/2/library/re.html. Uses DOTALL, which means the . specia...
Note This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name apt_key even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name. New in version 1.0: of ansible.builtin Synopsis Requirements Parameters Notes Examples Return Values Synopsis Add or remove an apt key, optionally downloading it. Requirements The below requirements are needed on the host that executes this module. gpg Parameters Parameter Choices/Defaults Comments data string The keyfile contents to add to the keyring. file path The path to a keyfile on the remote server to add to the keyring. id string The identifier of the key. Including this allows check mode to correctly report the changed state. If specifying a sub...
Note This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name include even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name. New in version 0.6: of ansible.builtin Synopsis Parameters Notes See Also Examples Synopsis Includes a file with a list of plays or tasks to be executed in the current playbook. Files with a list of plays can only be included at the top level. Lists of tasks can only be included where tasks normally run (in play). Before Ansible 2.0, all includes were ‘static’ and were executed when the play was compiled. Static includes are not subject to most directives. For example, loops or conditionals are applied instead to each inherited task. Since Ansible 2.0, task includes are dynamic and behave more like real...
Note This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name unarchive even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name. New in version 1.4: of ansible.builtin Synopsis Parameters Notes See Also Examples Return Values Synopsis The unarchive module unpacks an archive. It will not unpack a compressed file that does not contain an archive. By default, it will copy the source file from the local system to the target before unpacking. Set remote_src=yes to unpack an archive which already exists on the target. If checksum validation is desired, use ansible.builtin.get_url or ansible.builtin.uri instead to fetch the file and set remote_src=yes . For Windows targets, use the community.windows.win_unzip module instead. ...
Note This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name dnf even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name. New in version 1.9: of ansible.builtin Synopsis Requirements Parameters Notes Examples Synopsis Installs, upgrade, removes, and lists packages and groups with the dnf package manager. Requirements The below requirements are needed on the host that executes this module. python >= 2.6 python-dnf for the autoremove option you need dnf >= 2.0.1” Parameters Parameter Choices/Defaults Comments allow_downgrade boolean added in 2.7 of ansible.builtin Choices: no ← yes Specify if the named package and version is allowed to downgrade a maybe already installed higher version of th...