Ansible.Builtin

集合版本 2.19.0.dev0

描述

这些都是包含在 ansible-core 中的所有模块和插件。

作者

• Ansible, Inc.

• 问题跟踪器
• 代码库（源代码）

通信

• 论坛：Ansible 论坛.

• 矩阵房间 #users:ansible.im: 一般使用和支持问题.

• IRC 频道 #ansible (Libera 网络): 一般使用和支持问题.

插件索引

这些是 ansible.builtin 集合中的插件

模块

• add_host 模块 - 将主机（以及可选地组）添加到 ansible-playbook 内存中的清单

• apt 模块 - 管理 apt 包

• apt_key 模块 - 添加或删除 apt 密钥

• apt_repository 模块 - 添加和删除 APT 仓库

• assemble 模块 - 从片段组装配置文件

• assert 模块 - 断言给定的表达式为真

• async_status 模块 - 获取异步任务的状态

• blockinfile 模块 - 在标记行包围的文本块中插入、更新或删除

• command 模块 - 在目标上执行命令

• copy 模块 - 将文件复制到远程位置

• cron 模块 - 管理 cron.d 和 crontab 条目

• deb822_repository 模块 - 添加和删除 deb822 格式的仓库

• debconf 模块 - 配置 .deb 包

• debug 模块 - 在执行期间打印语句

• dnf 模块 - 使用 *dnf* 包管理器管理包

• dnf5 模块 - 使用 *dnf5* 包管理器管理包

• dpkg_selections 模块 - Dpkg 包选择选择

• expect 模块 - 执行命令并响应提示

• fail 模块 - 使用自定义消息失败

• fetch 模块 - 从远程节点获取文件

• file 模块 - 管理文件和文件属性

• find 模块 - 返回基于特定条件的文件列表

• gather_facts 模块 - 收集有关远程主机的信息

• get_url 模块 - 从 HTTP、HTTPS 或 FTP 下载文件到节点

• getent 模块 - unix getent 实用程序的包装器

• git 模块 - 从 git 检查点部署软件（或文件）

• group 模块 - 添加或删除组

• group_by 模块 - 基于信息创建 Ansible 组

• hostname 模块 - 管理主机名

• import_playbook 模块 - 导入剧本

• import_role 模块 - 将角色导入到剧本中

• import_tasks 模块 - 导入任务列表

• include_role 模块 - 加载并执行角色

• include_tasks 模块 - 动态包含任务列表

• include_vars 模块 - 从文件中加载变量，在任务中动态加载

• iptables 模块 - 修改 iptables 规则

• known_hosts 模块 - 从 known_hosts 文件中添加或删除主机

• lineinfile 模块 - 管理文本文件中的行

• meta 模块 - 执行 Ansible '操作'

• mount_facts 模块 - 检索挂载信息。

• package 模块 - 通用操作系统包管理器

• package_facts 模块 - 包信息作为信息

• pause 模块 - 暂停剧本执行

• ping 模块 - 尝试连接到主机，验证可用的 python，并在成功时返回 pong

• pip 模块 - 管理 Python 库依赖项

• raw 模块 - 执行低级和脏命令

• reboot 模块 - 重启机器

• replace 模块 - 使用反向引用的正则表达式替换文件中特定字符串的所有实例

• rpm_key 模块 - 从 rpm 数据库中添加或删除 gpg 密钥

• script 模块 - 在传输本地脚本后，在远程节点上运行本地脚本

• service 模块 - 管理服务

• service_facts 模块 - 将服务状态信息作为信息数据返回

• set_fact 模块 - 设置主机变量和信息。

• set_stats 模块 - 为当前 Ansible 运行定义和显示统计信息

• setup 模块 - 收集有关远程主机的信息

• shell 模块 - 在目标上执行 shell 命令

• slurp 模块 - 从远程节点吸取文件

• stat 模块 - 检索文件或文件系统状态

• subversion 模块 - 部署 Subversion 仓库

• systemd_service 模块 - 管理 systemd 单元

• sysvinit 模块 - 管理 SysV 服务。

• tempfile 模块 – 创建临时文件和目录

• template 模块 – 将文件模板化到目标主机

• unarchive 模块 – 解压缩存档文件（可以选择从本地机器复制）

• uri 模块 – 与 Web 服务交互

• user 模块 – 管理用户帐户

• validate_argument_spec 模块 – 验证角色参数规范。

• wait_for 模块 – 等待条件满足后继续执行

• wait_for_connection 模块 – 等待远程系统可访问/可用

• yum_repository 模块 – 添加或删除 YUM 存储库

Become 插件

• runas become – 以用户身份运行

• su become – 替换用户

• sudo become – 替换用户 DO

缓存插件

• jsonfile 缓存 – JSON 格式文件。

• memory 缓存 – 基于内存，非持久性

回调插件

• default 回调 – Ansible 默认屏幕输出

• junit 回调 – 将剧本输出写入 JUnit 文件。

• minimal 回调 – Ansible 最小屏幕输出

• oneline 回调 – Ansible 单行屏幕输出

• tree 回调 – 将主机事件保存到文件

连接插件

• local 连接 – 在控制器上执行

• paramiko_ssh 连接 – 通过 Python SSH (paramiko) 运行任务

• psrp 连接 – 通过 Microsoft PowerShell 远程协议运行任务

• ssh 连接 – 通过 SSH 客户端二进制文件连接

• winrm 连接 – 通过 Microsoft 的 WinRM 运行任务

过滤器插件

• b64decode 过滤器 – 解码 Base64 字符串

• b64encode 过滤器 – 将字符串编码为 Base64

• basename 过滤器 – 获取路径的基名

• bool 过滤器 – 转换为布尔值

• checksum 过滤器 – 输入数据的校验和

• combinations 过滤器 – 从列表的元素中组合

• combine 过滤器 – 合并两个字典

• comment 过滤器 – 注释掉字符串

• commonpath 过滤器 – 获取公共路径

• dict2items 过滤器 – 将字典转换为项目化字典列表

• difference 过滤器 – 一个列表与另一个列表的差集

• dirname 过滤器 – 获取路径的目录名

• expanduser 过滤器 – 返回带有 ~ 转换的路径。

• expandvars 过滤器 – 展开环境变量

• extract 过滤器 – 根据索引或键提取值

• fileglob 过滤器 – 将路径 glob 展开为匹配的文件

• flatten 过滤器 – 展平列表中的列表

• from_json 过滤器 – 将 JSON 字符串转换为变量结构

• from_yaml 过滤器 – 将 YAML 字符串转换为变量结构

• from_yaml_all 过滤器 – 将一系列 YAML 文档转换为变量结构

• hash 过滤器 – 输入数据的哈希值

• human_readable 过滤器 – 使字节/位可读

• human_to_bytes 过滤器 – 从字符串中获取字节

• intersect 过滤器 – 列表的交集

• items2dict 过滤器 – 将项目化字典列表合并为字典

• log 过滤器 – （数学运算）的日志

• mandatory 过滤器 – 使变量的存在成为必需

• md5 过滤器 – 输入数据的 MD5 哈希值

• normpath 过滤器 – 规范化路径名

• password_hash 过滤器 – 将输入密码转换为 password_hash

• path_join 过滤器 – 连接一个或多个路径组件

• permutations 过滤器 – 从列表的元素中排列

• pow 过滤器 – （数学运算）的幂

• product 过滤器 – 列表的笛卡尔积

• quote 过滤器 – shell 引用

• random 过滤器 – 随机数或列表项

• realpath 过滤器 – 将路径转换为真实路径

• regex_escape 过滤器 – 转义正则表达式字符

• regex_findall 过滤器 – 从字符串中提取所有正则表达式匹配项

• regex_replace 过滤器 – 通过正则表达式替换字符串

• regex_search 过滤器 – 从字符串中提取正则表达式匹配项

• rekey_on_member 过滤器 – 使用成员将字典列表重新键入字典

• relpath 过滤器 – 使路径相对

• root 过滤器 – （数学运算）的根

• sha1 过滤器 – 输入数据的 SHA-1 哈希

• shuffle 过滤器 – 随机化列表

• split 过滤器 – 将字符串拆分为列表

• splitext 过滤器 – 将路径拆分为根和文件扩展名

• strftime 过滤器 – 日期格式化

• subelements 过滤器 – 返回列表及其元素的乘积

• symmetric_difference 过滤器 – 两个列表中不同的项目

• ternary 过滤器 – 三元运算过滤器

• to_datetime 过滤器 – 从字符串获取 datetime

• to_json 过滤器 – 将变量转换为 JSON 字符串

• to_nice_json 过滤器 – 将变量转换为“格式良好的”JSON 字符串

• to_nice_yaml 过滤器 – 将变量转换为 YAML 字符串

• to_uuid 过滤器 – 命名空间 UUID 生成器

• to_yaml 过滤器 – 将变量转换为 YAML 字符串

• type_debug 过滤器 – 显示输入数据类型

• union 过滤器 – 列表的并集

• unique 过滤器 – 列表中唯一项目的集合

• unvault 过滤器 – 打开 Ansible Vault

• urldecode 过滤器 – 解码百分比编码序列

• urlsplit 过滤器 – 从 URL 获取组件

• vault 过滤器 – 保管您的秘密

• win_basename 过滤器 – 获取 Windows 路径的基本名称

• win_dirname 过滤器 – 获取 Windows 路径的目录

• win_splitdrive 过滤器 – 按驱动器号拆分 Windows 路径

• zip 过滤器 – 组合列表元素

• zip_longest 过滤器 – 组合列表元素，带填充

库存插件

• advanced_host_list 库存 – 解析带范围的“主机列表”

• auto 库存 – 加载并执行 YAML 配置中指定的库存插件

• constructed 库存 – 使用 Jinja2 基于现有库存构建变量和组。

• generator 库存 – 使用 Jinja2 从模式构建主机和组

• host_list 库存 – 解析“主机列表”字符串

• ini 库存 – 使用 Ansible INI 文件作为库存来源。

• script 库存 – 执行返回 JSON 的库存脚本

• toml 库存 – 使用特定 TOML 文件作为库存来源。

• yaml 库存 – 使用特定 YAML 文件作为库存来源。

查找插件

• config 查找 – 显示“解析的”Ansible 选项值。

• csvfile 查找 – 从 TSV 或 CSV 文件读取数据

• dict 查找 – 返回字典中的键/值对项目

• env 查找 – 读取环境变量的值

• file 查找 – 读取文件内容

• fileglob 查找 – 列出与模式匹配的文件

• first_found 查找 – 返回从列表中找到的第一个文件

• indexed_items 查找 – 重新编写列表以返回“索引项目”

• ini 查找 – 从 ini 文件读取数据

• inventory_hostnames 查找 – 与主机模式匹配的库存主机列表

• items 查找 – 项目列表

• lines 查找 – 从命令读取行

• list 查找 – 只返回它所提供的。

• nested 查找 – 使用其他列表的嵌套元素组成一个列表

• password 查找 – 检索或生成一个随机密码，存储在文件中

• pipe 查找 – 读取命令的输出

• random_choice 查找 – 从列表中返回随机元素

• sequence 查找 – 基于数字序列生成一个列表

• subelements 查找 – 遍历字典列表中的嵌套键

• template 查找 – 使用 Jinja2 渲染后检索文件内容

• together 查找 – 将列表合并为同步列表

• unvault 查找 – 读取保管的文件内容

• url 查找 – 返回来自 URL 的内容

• varnames 查找 – 查找匹配的变量名称

• vars 查找 – 查找变量的模板化值

Shell 插件

• cmd shell – Windows 命令提示符

• powershell shell – Windows PowerShell

• sh shell – POSIX shell (/bin/sh)

策略插件

• debug 策略 – 在交互式调试会话中执行任务。

• free 策略 – 在不等待所有主机的情况下执行任务

• host_pinned 策略 – 在每个主机上执行任务，不会中断

• linear 策略 – 以线性方式执行任务

测试插件

• abs 测试 – 路径是否绝对

• all 测试 – 列表中的所有条件是否为真

• any 测试 – 列表中的任何条件是否为真

• changed 测试 – 任务是否需要更改

• contains 测试 – 列表中是否包含该元素

• 目录测试 – 路径是否解析为现有目录

• 存在测试 – 路径是否存在，遵循符号链接

• 失败测试 – 任务是否失败

• falsy 测试 – Python 风格的假值

• 文件测试 – 路径是否解析为现有文件

• 完成测试 – 异步任务是否已完成

• 链接测试 – 路径是否引用现有符号链接

• link_exists 测试 – 路径是否存在，不跟随链接

• 匹配测试 – 字符串是否从开头匹配正则表达式

• 挂载测试 – 路径是否解析为挂载点

• nan 测试 – 是否不是数字（NaN）

• 可达测试 – 任务未因主机不可达而结束

• 正则表达式测试 – 字符串是否从开头匹配正则表达式

• same_file 测试 – 比较两个路径以查看它们是否解析为同一个文件系统对象

• 搜索测试 – 字符串是否匹配正则表达式

• 跳过测试 – 任务是否被跳过

• 启动测试 – 异步任务是否已启动

• 子集测试 – 列表是否为另一个列表的子集

• 成功测试 – 检查任务是否成功

• 超集测试 – 列表是否为另一个列表的超集

• 超时测试 – 任务是否超时

• truthy 测试 – Python 风格的真值

• 不可达测试 – 任务是否因主机不可达而结束

• uri 测试 – 字符串是否为有效的 URI

• url 测试 – 字符串是否为有效的 URL

• urn 测试 – 字符串是否为有效的 URN

• vault_encrypted 测试 – 这是否是一个加密的 vault 字符串

• vaulted_file 测试 – 该文件是否是一个加密的 vault

• 版本测试 – 比较版本字符串

变量插件

• host_group_vars 变量 – 负责加载 group_vars 和 host_vars

另请参见

包含在此处托管文档的 集合 列表。