Ansible.Builtin
集合版本 2.21.0.post0
描述
这些是包含在 ansible-core 中的所有模块和插件。
作者
Ansible, Inc.
交流
论坛: Ansible 论坛。
Matrix 聊天室
#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 模块 – 导入 playbook
import_role 模块 – 将角色导入到 play 中
import_tasks 模块 – 导入任务列表
include_role 模块 – 加载并执行角色
include_tasks 模块 – 动态包含任务列表
include_vars 模块 – 在任务中动态从文件加载变量
iptables 模块 – 修改 iptables 规则
known_hosts 模块 – 从
known_hosts文件中添加或删除主机lineinfile 模块 – 管理文本文件中的行
meta 模块 – 执行 Ansible “动作”
mount_facts 模块 – 检索挂载信息。
package 模块 – 通用操作系统软件包管理器
package_facts 模块 – 将软件包信息作为事实返回
pause 模块 – 暂停 playbook 执行
ping 模块 – 尝试连接主机，验证 python 可用性，成功时返回
pongpip 模块 – 管理 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 插件
Cache 插件
jsonfile 缓存 – JSON 格式文件。
memory 缓存 – 基于 RAM，非持久化
Callback 插件
default 回调 – 默认 Ansible 屏幕输出
junit 回调 – 将 playbook 输出写入 JUnit 文件。
minimal 回调 – 最小化 Ansible 屏幕输出
oneline 回调 – 单行 Ansible 屏幕输出
tree 回调 – 将主机事件保存到文件
Connection 插件
local 连接 – 在控制机上执行
psrp 连接 – 通过 Microsoft PowerShell 远程协议运行任务
ssh 连接 – 通过 SSH 客户端二进制文件连接
winrm 连接 – 通过 Microsoft WinRM 运行任务
Filter 插件
abs 过滤器 – 返回参数的绝对值。
attr 过滤器 – 获取对象的属性。
b64decode 过滤器 – 解码 Base64 字符串
b64encode 过滤器 – 将字符串编码为 Base64
basename 过滤器 – 获取路径的基名
batch 过滤器 – 对条目进行分批处理的过滤器。
bool 过滤器 – 将已知的真值/假值强制转换为布尔值
capitalize 过滤器 – 将值首字母大写。
center 过滤器 – 将值在给定宽度的字段中居中。
checksum 过滤器 – 输入数据的校验和
combinations 过滤器 – 列表元素的组合
combine 过滤器 – 合并两个字典
comment 过滤器 – 将字符串注释掉
commonpath 过滤器 – 获取公共路径
count 过滤器 – 返回容器中条目的数量。
d 过滤器 – 如果值未定义，则返回传入的默认值，否则返回变量的值。
default 过滤器 – 如果值未定义，则返回传入的默认值，否则返回变量的值。
dict2items 过滤器 – 将字典转换为带项的字典列表
dictsort 过滤器 – 对字典排序并产生结果。
difference 过滤器 – 一个列表相对于另一个列表的差集
dirname 过滤器 – 获取路径的目录名
e 过滤器 – 将字符串中的 ``&``, ``<``, ``>``, ``’``, 和 ``”`` 替换为 HTML 安全序列。
escape 过滤器 – 将字符串中的 ``&``, ``<``, ``>``, ``’``, 和 ``”`` 替换为 HTML 安全序列。
expanduser 过滤器 – 返回带有
~转换的路径。expandvars 过滤器 – 展开环境变量
extract 过滤器 – 基于索引或键提取值
fileglob 过滤器 – 将路径通配符展开为匹配的文件
filesizeformat 过滤器 – 将值格式化为“人类可读”的文件大小。
first 过滤器 – 返回序列中的第一项。
flatten 过滤器 – 扁平化列表中的列表
float 过滤器 – 将值转换为浮点数。
forceescape 过滤器 – 强制 HTML 转义。
format 过滤器 – 将给定的值应用到 `printf 风格`_ 的格式字符串中，如 ``string % values``。
from_json 过滤器 – 将 JSON 字符串转换为变量结构
from_yaml 过滤器 – 将 YAML 字符串转换为变量结构
from_yaml_all 过滤器 – 将一系列 YAML 文档转换为变量结构
groupby 过滤器 – 使用 Python 的 :func:`itertools` 根据属性对对象序列进行分组。
hash 过滤器 – 输入数据的哈希值
human_readable 过滤器 – 使字节/位变得人类可读
human_to_bytes 过滤器 – 从字符串获取字节
indent 过滤器 – 返回带有每行缩进 4 个空格的字符串副本。
int 过滤器 – 将值转换为整数。
intersect 过滤器 – 列表的交集
items 过滤器 – 返回映射的 ``(key, value)`` 项的迭代器。
items2dict 过滤器 – 将带项的字典列表合并为字典
join 过滤器 – 返回序列中字符串连接后的字符串。
last 过滤器 – 返回序列中的最后一项。
length 过滤器 – 返回容器中条目的数量。
list 过滤器 – 将值转换为列表。
log 过滤器 – (数学运算) 对数
lower 过滤器 – 将值转换为小写。
mandatory 过滤器 – 使变量的存在成为必需
map 过滤器 – 在对象序列上应用过滤器或查找属性。
max 过滤器 – 返回序列中的最大项。
md5 过滤器 – 输入数据的 MD5 哈希
min 过滤器 – 返回序列中的最小项。
normpath 过滤器 – 规范化路径名
password_hash 过滤器 – 将输入密码转换为 password_hash
path_join 过滤器 – 连接一个或多个路径组件
permutations 过滤器 – 列表元素的排列
pow 过滤器 – (数学运算) 幂运算
pprint 过滤器 – 美化打印变量。
product 过滤器 – 列表的笛卡尔积
quote 过滤器 – shell 引号
random 过滤器 – 随机数或列表项
realpath 过滤器 – 将路径转换为真实路径
regex_escape 过滤器 – 转义正则字符
regex_findall 过滤器 – 从字符串中提取所有正则匹配
regex_replace 过滤器 – 通过正则替换字符串
regex_search 过滤器 – 从字符串中提取正则匹配
reject 过滤器 – 通过对每个对象应用测试来过滤对象序列，拒绝测试成功的对象。
rejectattr 过滤器 – 通过对每个对象的指定属性应用测试来过滤对象序列，拒绝测试成功的对象。
rekey_on_member 过滤器 – 使用成员将字典列表重键为字典
relpath 过滤器 – 使路径变为相对路径
replace 过滤器 – 返回值副本，其中所有子字符串的出现都被新字符串替换。
reverse 过滤器 – 反转对象或返回一个以相反方式迭代它的迭代器。
root 过滤器 – (数学运算) 根运算
round 过滤器 – 将数字舍入到给定的精度。
safe 过滤器 – 将值标记为安全，意味着在启用自动转义的环境中，此变量不会被转义。
select 过滤器 – 通过对每个对象应用测试来过滤对象序列，仅选择测试成功的对象。
selectattr 过滤器 – 通过对每个对象的指定属性应用测试来过滤对象序列，仅选择测试成功的对象。
sha1 过滤器 – 输入数据的 SHA-1 哈希
shuffle 过滤器 – 随机打乱列表
slice 过滤器 – 切片迭代器并返回包含这些条目的列表的列表。
sort 过滤器 – 使用 Python 的 :func:`sorted` 排序可迭代对象。
split 过滤器 – 将字符串分割为列表
splitext 过滤器 – 将路径拆分为根和文件扩展名
strftime 过滤器 – 返回日期和/或时间
string 过滤器 – 如果对象尚不是字符串，则将其转换为字符串。
striptags 过滤器 – 去除 SGML/XML 标签并将相邻空白替换为一个空格。
subelements 过滤器 – 返回列表及其元素的积
sum 过滤器 – 返回数字序列的总和加上参数 ‘start’ 的值。
symmetric_difference 过滤器 – 两个列表中的不同项
ternary 过滤器 – 三元运算过滤器
title 过滤器 – 返回值的标题大小写版本。
to_datetime 过滤器 – 从字符串获取
datetimeto_json 过滤器 – 将变量转换为 JSON 字符串
to_nice_json 过滤器 – 将变量转换为“美观格式”的 JSON 字符串
to_nice_yaml 过滤器 – 将变量转换为 YAML 字符串
to_uuid 过滤器 – 命名空间 UUID 生成器
to_yaml 过滤器 – 将变量转换为 YAML 字符串
tojson 过滤器 – 将对象序列化为 JSON 字符串，并将其标记为 HTML 安全渲染。
trim 过滤器 – 去除前导和尾随字符，默认为空白。
truncate 过滤器 – 返回字符串的截断副本。
type_debug 过滤器 – 显示输入数据类型
union 过滤器 – 列表的并集
unique 过滤器 – 列表的唯一项集合
unvault 过滤器 – 打开 Ansible Vault
upper 过滤器 – 将值转换为大写。
urldecode 过滤器 – 解码百分号编码序列
urlencode 过滤器 – 使用 UTF-8 引用数据以用于 URL 路径或查询。
urlize 过滤器 – 将文本中的 URL 转换为可点击链接。
urlsplit 过滤器 – 从 URL 获取组件
vault 过滤器 – 对机密进行加密
win_basename 过滤器 – 获取 Windows 路径的基名
win_dirname 过滤器 – 获取 Windows 路径的目录
win_splitdrive 过滤器 – 按驱动器号拆分 Windows 路径
wordcount 过滤器 – 计算字符串中的单词数。
wordwrap 过滤器 – 将字符串换行到给定宽度。
xmlattr 过滤器 – 基于字典中的项创建 SGML/XML 属性字符串。
zip 过滤器 – 合并列表元素
zip_longest 过滤器 – 合并列表元素，使用填充符
Inventory 插件
advanced_host_list 清单 – 解析带有范围的“主机列表”
auto 清单 – 加载并执行 YAML 配置中指定的清单插件
constructed 清单 – 使用 Jinja2 基于现有清单构造变量和组。
generator 清单 – 使用 Jinja2 从模式构造主机和组
host_list 清单 – 解析“主机列表”字符串
ini 清单 – 使用 Ansible INI 文件作为清单源。
script 清单 – 执行返回 JSON 的清单脚本
toml 清单 – 使用特定的 TOML 文件作为清单源。
yaml 清单 – 使用特定的 YAML 文件作为清单源。
Lookup 插件
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)
Strategy 插件
debug strategy – 在交互式调试会话中执行任务。
free strategy – 执行任务而不等待所有主机
host_pinned strategy – 在每台主机上连续执行任务而不中断
linear strategy – 以线性方式执行任务
测试插件
abs 测试 – 路径是否是绝对路径
all 测试 – 列表中的所有条件是否为真
any 测试 – 列表中的任何条件是否为真
boolean 测试 – 如果对象是布尔值，则返回真。
callable 测试 – 返回对象是否可调用。
changed 测试 – 任务是否需要变更
contains 测试 – 列表是否包含此元素
defined 测试 – 如果变量已定义，则返回真。
directory 测试 – 路径是否解析为现有目录
divisibleby 测试 – 检查变量是否可被数字整除。
eq 测试 – 同 a == b。
equalto 测试 – 同 a == b。
escaped 测试 – 检查值是否已转义。
even 测试 – 如果变量是偶数，则返回真。
exists 测试 – 路径是否存在（跟踪符号链接）
failed 测试 – 任务是否失败
false 测试 – 如果对象是 False，则返回真。
falsy 测试 – Python 风格的假
file 测试 – 路径是否解析为现有文件
filter 测试 – 通过名称检查过滤器是否存在。
finished 测试 – 异步任务是否完成
float 测试 – 如果对象是浮点数，则返回真。
ge 测试 – 同 a >= b。
greaterthan 测试 – 同 a > b。
gt 测试 – 同 a > b。
in 测试 – 检查值是否在序列中。
integer 测试 – 如果对象是整数，则返回真。
iterable 测试 – 检查对象是否可迭代。
le 测试 – 同 a <= b。
lessthan 测试 – 同 a < b。
link 测试 – 路径是否引用现有的符号链接
link_exists 测试 – 路径是否存在（不跟踪）
lower 测试 – 如果变量是小写，则返回真。
lt 测试 – 同 a < b。
mapping 测试 – 如果对象是映射，则返回真。
match 测试 – 字符串是否从头开始匹配正则表达式
mount 测试 – 路径是否解析为挂载点
nan 测试 – 这是否不是一个数字 (NaN)
ne 测试 – 同 a != b。
none 测试 – 如果变量为 none，则返回真。
number 测试 – 如果变量是数字，则返回真。
odd 测试 – 如果变量是奇数，则返回真。
reachable 测试 – 任务未因主机不可达而结束
regex 测试 – 字符串是否从头开始匹配正则表达式
same_file 测试 – 比较两个路径看它们是否解析为同一个文件系统对象
sameas 测试 – 检查对象是否指向与另一个对象相同的内存地址。
search 测试 – 字符串是否匹配正则表达式
sequence 测试 – 如果变量是序列，则返回真。
skipped 测试 – 任务是否被跳过
started 测试 – 异步任务是否启动
string 测试 – 如果对象是字符串，则返回真。
subset 测试 – 列表是否是另一个列表的子集
success 测试 – 检查任务成功
superset 测试 – 列表是否是另一个列表的超集
test 测试 – 通过名称检查测试是否存在。
timedout 测试 – 任务是否超时
true 测试 – 如果对象是 True，则返回真。
truthy 测试 – Python 风格的真
undefined 测试 – 类似于 :func:`defined`，但方向相反。
unreachable 测试 – 任务是否因主机不可达而结束
upper 测试 – 如果变量是大写，则返回真。
uri 测试 – 字符串是否是有效的 URI
url 测试 – 字符串是否是有效的 URL
urn 测试 – 字符串是否是有效的 URN
vault_encrypted 测试 – 这是否是加密的 vault 字符串
vaulted_file 测试 – 此文件是否是加密的 vault
version 测试 – 比较版本字符串
Vars 插件
host_group_vars 变量插件 – 负责加载 group_vars 和 host_vars
另请参阅
此处托管了文档的 集合 列表。