Difference between revisions of "Ansible modules"
Jump to navigation
Jump to search
↑ https://docs.ansible.com/ansible/latest/modules/modules_by_category.html
↑ https://docs.ansible.com/ansible/latest/modules/setup_module.html
↑ https://www.unixarena.com/2018/07/ansible-command-vs-shell-vs-raw-modules.html/
↑ https://docs.ansible.com/ansible/2.6/modules/docker_module.html
↑ https://docs.ansible.com/ansible/latest/modules/docker_compose_module.html
↑ https://medium.com/@tcij1013/ten-useful-ansible-modules-83fb6fb2d45e
| (28 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Ansible]] modules<ref>https://docs.ansible.com/ansible/latest/modules/modules_by_category.html</ref> add new capabilities to Ansible and is a core component of the software, as of September 2019 there are more than 2.800 modules available: <code>ansible-doc --list</code>. For example you can [[manage AWS infrastructure using Ansible]], execute commands with <code>shell</code> module or collect information using <code>setup</code><ref>https://docs.ansible.com/ansible/latest/modules/setup_module.html</ref> module. | + | [[Ansible]] modules<ref>https://docs.ansible.com/ansible/latest/modules/modules_by_category.html</ref> add new capabilities to Ansible and is a core component of the software, as of September 2019 there are more than 2.800 modules available: <code>[[ansible-doc --list]]</code>. For example you can [[manage AWS infrastructure using Ansible]], execute commands with <code>shell</code> module or collect information using <code>setup</code><ref>https://docs.ansible.com/ansible/latest/modules/setup_module.html</ref> module. |
* <code>ansible -m setup SERVER_NAME</code> will collect information from your system | * <code>ansible -m setup SERVER_NAME</code> will collect information from your system | ||
* <code>ansible -m setup SERVER_NAME -a 'filter=ansible_distribution'</code>. Collect just OS. | * <code>ansible -m setup SERVER_NAME -a 'filter=ansible_distribution'</code>. Collect just OS. | ||
| − | ==Modules== | + | == Modules == |
| − | * <code>apt_repository</code>: [[Ansible playbook: Add a | + | * <code>apt_repository</code>: [[Ansible playbook: Add a repository]] |
* <code>[[docker compose]]</code>: New in version 2.1 and was call docker_service before [[Ansible 2.8]] | * <code>[[docker compose]]</code>: New in version 2.1 and was call docker_service before [[Ansible 2.8]] | ||
| − | * <code>file</code>, for managing files and directories: https://docs.ansible.com/ansible/latest/modules/file_module.html | + | * <code>[[docker_container]]</code>: New in [[version 2.1]] |
| + | * <code>[[file]]</code>, for managing files and directories: https://docs.ansible.com/ansible/latest/modules/file_module.html | ||
* <code>ovirt_vm</code> ([[KVM]]) | * <code>ovirt_vm</code> ([[KVM]]) | ||
* Execution modules: | * Execution modules: | ||
| − | ** <code>command</code>, default for ad-hoc commands, bypasses the shell so won’t be impacted by local shell variables. | + | ** <code>[[command:]]</code>, default for ad-hoc commands, bypasses the shell so won’t be impacted by local shell variables. |
| − | ** <code>shell</code>, allow to use shell functionalities such as redirection. | + | ** <code>[[shell:]]</code>, allow to use shell functionalities such as redirection. |
| − | ** <code>raw</code>, do not require python on remote system<ref>https://www.unixarena.com/2018/07/ansible-command-vs-shell-vs-raw-modules.html/</ref> | + | ** <code>[[raw:]]</code>, do not require python on remote system<ref>https://www.unixarena.com/2018/07/ansible-command-vs-shell-vs-raw-modules.html/</ref> |
| − | |||
| + | * <code>[[gather_facts]]</code>, <code>[[lineinfile]]</code>, <code>[[package]]</code>, <code>[[user:]]</code>, <code>group</code>, <code>mount</code>, <code>git</code>, <code>[[docker]]</code><ref>https://docs.ansible.com/ansible/2.6/modules/docker_module.html</ref>, <code>[[docker_compose]]</code> <ref>https://docs.ansible.com/ansible/latest/modules/docker_compose_module.html</ref> and <code>mail</code> modules, <ref>https://medium.com/@tcij1013/ten-useful-ansible-modules-83fb6fb2d45e</ref> see all of them by category: https://docs.ansible.com/ansible/latest/modules/modules_by_category.html | ||
| − | == Examples of execution modules == | + | * <code>[[package:]]</code> |
| − | * <code>ansible -m raw DESTINATION_HOSTNAME -a uptime</code> | + | * <code>[[apt:]]</code> |
| − | * <code>ansible -m shell DESTINATION_HOSTNAME -a uptime</code> | + | * [[service:]] |
| − | * <code>ansible -m command DESTINATION_HOSTNAME -a uptime</code> | + | * [[Ansible module: archive]] |
| + | * <code>[[community.general.filesystem]]</code> | ||
| + | * <code>[[community.general.postgresql_db_module]]</code> | ||
| + | |||
| + | * [[copy]] | ||
| + | |||
| + | == [[Examples of Ansible execution modules]] == | ||
| + | * <code>[[ansible -m raw]] DESTINATION_HOSTNAME -a uptime</code> | ||
| + | * <code>[[ansible -m shell]] DESTINATION_HOSTNAME -a uptime</code> | ||
| + | * <code>[[ansible -m command]] DESTINATION_HOSTNAME -a uptime</code> (Do not support some characters as: "|") | ||
| + | |||
| + | == Related terms == | ||
| + | * [[Terraform modules]] | ||
| + | * [[Ansible plugins]] | ||
| + | * <code>[[ansible-galaxy collection install]]</code> | ||
| + | * <code>[[boto3 required for this module]]</code> | ||
| + | * <code>[[copy (Windows)]]</code> | ||
| + | * <code>[[amazon.aws]]</code> | ||
== See also == | == See also == | ||
| − | * {{Ansible}} | + | * {{Ansible modules}} |
| + | |||
| + | [[Category:Ansible]] | ||
Latest revision as of 13:39, 18 April 2023
Ansible modules[1] add new capabilities to Ansible and is a core component of the software, as of September 2019 there are more than 2.800 modules available: ansible-doc --list. For example you can manage AWS infrastructure using Ansible, execute commands with shell module or collect information using setup[2] module.
ansible -m setup SERVER_NAMEwill collect information from your systemansible -m setup SERVER_NAME -a 'filter=ansible_distribution'. Collect just OS.
Modules[edit]
apt_repository: Ansible playbook: Add a repositorydocker compose: New in version 2.1 and was call docker_service before Ansible 2.8docker_container: New in version 2.1file, for managing files and directories: https://docs.ansible.com/ansible/latest/modules/file_module.htmlovirt_vm(KVM)
- Execution modules:
gather_facts,lineinfile,package,[[user:]],group,mount,git,docker[4],docker_compose[5] andmailmodules, [6] see all of them by category: https://docs.ansible.com/ansible/latest/modules/modules_by_category.html
package:apt:- service:
- Ansible module: archive
community.general.filesystemcommunity.general.postgresql_db_module
Examples of Ansible execution modules[edit]
ansible -m raw DESTINATION_HOSTNAME -a uptimeansible -m shell DESTINATION_HOSTNAME -a uptimeansible -m command DESTINATION_HOSTNAME -a uptime(Do not support some characters as: "|")
Related terms[edit]
- Terraform modules
- Ansible plugins
ansible-galaxy collection installboto3 required for this modulecopy (Windows)amazon.aws
See also[edit]
- Ansible modules:
gather_facts, set_fact,ansible.builtin.file,lineinfile,stat,group,mount,git:,package:,command:,shell:,raw:,template:,register:,user:, Ansible playbooks examples,tasks:,lineinfile, blockinfile:,shell:,command:,raw:,ansible.builtin.file, service:, aws.ecs_taskdefinition, aws.asg, docker_container, kubernetes.core.k8s,community.,include_tasks
Advertising:
