模块简介

模块(也称为“任务插件”或“库插件”)是可从命令行或 playbook 任务中使用的独立代码单元。Ansible 通常在远程托管节点上执行每个模块,并收集返回值。在 Ansible 2.10 及更高版本中,大多数模块都托管在集合中。

您可以从命令行执行模块。

ansible webservers -m service -a "name=httpd state=started"
ansible webservers -m ping
ansible webservers -m command -a "/sbin/reboot -t now"

每个模块都支持参数。几乎所有模块都采用 key=value 参数,以空格分隔。某些模块不接受任何参数,而 command/shell 模块只需接受要运行的命令的字符串。

在 playbook 中,Ansible 模块的执行方式非常相似。

- name: reboot the servers
  command: /sbin/reboot -t now

另一种向模块传递参数的方法是使用 YAML 语法,也称为“复杂参数”。

- name: restart webserver
  service:
    name: httpd
    state: restarted

所有模块都返回 JSON 格式的数据。这意味着模块可以用任何编程语言编写。模块应该具有幂等性,并且在检测到当前状态与所需的最终状态匹配时,应避免进行任何更改。当在 Ansible playbook 中使用时,模块可以触发“更改事件”,形式为通知 处理程序 来运行其他任务。

您可以使用 ansible-doc 工具从命令行访问每个模块的文档。

ansible-doc yum

有关所有可用模块的列表,请参阅 集合文档,或在命令提示符下运行以下命令。

ansible-doc -l

另请参阅

特设命令简介

/usr/bin/ansible 中使用模块的示例

使用 playbook

/usr/bin/ansible-playbook 中使用模块的示例

您应该开发模块吗?

如何编写自己的模块

Python API

使用 Python API 的模块示例

沟通

有问题?需要帮助?想分享你的想法?请访问 Ansible 沟通指南

所有模块和插件的索引

所有可用的模块和插件