Linux自动化运维（Shell与Ansible）（微课版） 课件 10-3-插件

Jinja2模板与插件任务3：插件目录/Contents010203插件简介查看插件帮助信息lookup插件01插件简介插件简介在Ansible中，插件是一种可扩展的机制，用于在Ansible执行过程中添加新的功能和行为。插件可以用来实现各种功能，例如操作系统管理、网络管理、云管理等。用户可以基于Ansible插件体系结构轻松地添加或删除插件，以满足不同的需求。Ansible内置了多种类型的插件，主要包括action插件、callback插件、filter插件、lookup插件、inventory插件、module插件、strategy插件等等。常见的插件类型如表所示。序号插件类型描述1action插件用于执行任务，例如复制文件、安装软件包、启动服务等。该插件通常是对Ansible模块的封装，可以通过调用模块来实现任务的执行2callback插件用于向用户提供反馈信息，例如任务的进度、执行结果等。该插件可以将输出格式化为不同的格式，并将其发送到不同的位置，例如终端、日志文件等3filter插件用于在模板中操作和转换数据，例如将JSON数据转换为YAML数据、提取URL的主机名、计算SHA1哈希等。该插件可以使用内置的Ansible过滤器，也可以使用标准的Jinja2过滤器4lookup插件用于在Playbook中查找数据，例如查找环境变量、获取远程主机的IP地址等。该插件可以将数据从不同的来源中提取出来，并将其传递给Playbook执行5inventory插件用于管理主机清单，例如使用INI文件、YAML文件、动态主机清单文件等。可以根据不同的需求选择不同的inventory插件6module插件用于定义Ansible模块，例如管理文件、用户、软件包等的模块。可以使用Python编写自定义的模块，并将其作为module插件添加到Ansible中。模块是插件的一个特殊实现，用于执行任务。虽然通常不使用“模块插件”这个术语，但模块是插件的一种特殊类型7strategy插件用于控制任务的执行策略，例如并发执行、串行执行、批量执行等。可以根据不同的场景选择不同的strategy插件。该插件通过处理任务和主机的调度来影响整个Playbook的执行流程02查看插件帮助信息查看插件帮助信息Ansible支持多种类型的插件，比如callback插件、connection插件、inventory插件、lookup插件、netconf插件、vars插件、filter插件等。在查看插件帮助信息之前，需要确定要查看的插件类型。使用以下命令可以查看当前Ansible版本中可用的所有插件列表。ansible-doc-t<plugin-type>-l使用以下命令可以查看可用的callback插件列表，-tcallback表示要查看的插件类型为callback插件，-l选项表示要列出所有可用的插件的名称。<plugin-type>表示要查看的插件类型，例如module、callback、inventory、vars、filter、connection、authentication、lookup等。ansible-doc-tcallback-l确定要查看的callback插件的名称后，可以使用以下命令查看其帮助信息。ansible-doc-tcallback<plugin-name>查看插件帮助信息其中，<pluginname>表示要查看的插件的名称。该命令将显示有关该插件的详细信息，包括用法示例、选项、参数和其他相关信息，以帮助用户理解如何使用该插件。使用以下命令查看jsoncallback插件的帮助信息。ansible-doc-tcallbackjson确定要查看的lookup插件的名称后，可以使用以下命令查看其帮助信息。使用以下命令可以查看可用的lookup插件列表，-tlookup表示要查看的插件类型为lookup插件，-l选项表示要列出所有可用的插件的名称。ansible-doc-tlookup-l其中，<pluginname>表示要查看的插件的名称。该命令将显示有关该插件的详细信息，包括用法示例、选项、参数和其他相关信息，以帮助用户理解如何使用该插件。ansible-doc-tlookup<plugin-name>使用以下命令查看filelookup插件的帮助信息。ansible-doc-tlookupfile03lookup插件lookup插件Ansible的lookup插件是一种扩展了Jinja2模板语言的插件，它可以使Ansible从外部来源（如文件、命令输出、API等）中获取数据。通过lookup插件，Ansible可以在运行时动态获取数据，从而实现更灵活的配置和自动化。lookup插件的基本语法与过滤器的非常相似。在调用lookup插件时，需要指定函数的名称、需要调用的lookup插件的名称以及插件需要的参数。lookup插件的基本语法如下。{{lookup('<plugin-name>','<parameter>')}}其中，<plugin-name>表示要使用的lookup插件的名称，而<parameter>则表示传递给插件的参数。某些lookup插件不需要参数，例如env插件可以用于获取环境变量，它不需要任何参数。lookup插件在Playbook中使用file插件从文件path/to/file.txt中读取数据，并将其分配给file_contents变量，然后使用debug模块输出变量的值，以验证数据已成功获取。catpath/to/file.txtThisislookuppluginfile----name:Exampleplaybookwithlookuppluginhosts:localhostbecome:truevars:file_contents:"{{lookup('file','path/to/file.txt')}}"tasks:-name:Displayfilecontentsdebug:var:file_contents在Playbook中使用file插件从本地文件中读取数据，并将其复制到远程主机上的/remote/path/to/file.txt文件中。-name:Copyfilecontentstoremotehostcopy:content:"{{lookup('file','path/to/file.txt')}}"dest:"/remote/path/to/file.txt"lookup插件在Playbook中使用template模块将从文件中获取的数据用于生成配置文件，在模板文件config_template.j2中可以引用变量file_contents，即从外部数据源获取的数据，生成的配置文件将位于/etc/myapp.conf文件中。-name:Generateconfigfilewithfilecontentstemplate:src:"config_template.j2"dest:"/etc/myapp.conf"vars:file_contents:"{{lookup('file','path/to/file.txt')}}"lookup插件lookup插件默认情况下返回单个值的字符串，如果需要将数据作为列表返回，则需要将wantlist参数设置为True。在Ansible2.5中，新增了一个名为query的Jinja2函数，无论返回的数据是单个值还是多个值，它始终都返回一个列表，无须设置wantlist参数，不再依赖于用户额外设置的参数来控制返回的数据结构类型。以下两种方式是等效的。lookup('dict',dict_variable,wantlist=True)query('dict',dict_variable)query函数则是在lookup插件的基础上做了一层封装，使用query函数调用lookup插件会隐式地将wantlist参数设置为True，因此无须设置wantlist参数。当使用Ansible的lookup插件从文件中读取数据时，如果要将返回的数据作为列表而不是字符串来处理，可以使用split方法将其分隔成一个列表。lookup插件catpath/to/filequery.txtitem1item2item3-name:Exampleplaybooktoreaddatafromfileaslisthosts:localhostvars:#Defineavariablethatcontainsthepathtothefiletoreadfile_path:"path/to/filequery.txt"tasks:-name:Readdatafromfileaslistdebug:var:data_listvars:#Usethelookupplugintoreadthefilecontentsa