Ansible.Builtin
集合版本 2.19.0.dev0
描述
这些是 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 模块 – 导入剧本
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 模块 – 暂停剧本执行
ping 模块 – 尝试连接到主机，验证可用的 python 并在成功时返回
pongpip 模块 – 管理 Python 库依赖项
raw 模块 – 执行低级且不完善的命令
reboot 模块 – 重启机器
replace 模块 – 使用反向引用的正则表达式替换文件中特定字符串的所有实例
rpm_key 模块 – 从 rpm db 添加或删除 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 仓库
成为插件
runas become – 以用户身份运行
su become – 切换用户
sudo become – 使用 sudo 切换用户
缓存插件
jsonfile 缓存 – JSON 格式化文件。
memory 缓存 – RAM 支持，非持久化
回调插件
default callback – Ansible 默认屏幕输出
junit callback – 将 playbook 输出写入 JUnit 文件。
minimal callback – Ansible 最简屏幕输出
oneline callback – Ansible 单行屏幕输出
tree callback – 将主机事件保存到文件
连接插件
local connection – 在控制器上执行
paramiko_ssh connection – 通过 Python SSH (paramiko) 运行任务
psrp connection – 通过 Microsoft PowerShell 远程协议运行任务
ssh connection – 通过 SSH 客户端二进制文件连接
winrm connection – 通过 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 过滤器 – 从字符串获取
datetimeto_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 测试 – 列表是否包含此元素
directory 测试 – 路径是否解析为现有目录
exists 测试 – 路径是否存在，跟随符号链接
failed 测试 – 任务是否失败
falsy 测试 – Pythonic false
file 测试 – 路径是否解析为现有文件
finished 测试 – 异步任务是否完成
link 测试 – 路径是否引用现有符号链接
link_exists 测试 – 路径是否存在，不跟随
match 测试 – 字符串是否从开头匹配正则表达式
mount 测试 – 路径是否解析为挂载点
nan 测试 – 这是否不是一个数字 (NaN)
reachable 测试 – 任务是否因主机不可达而结束
regex 测试 – 字符串是否从开头匹配正则表达式
same_file 测试 – 比较两个路径以查看它们是否解析为同一文件系统对象
search 测试 – 字符串是否匹配正则表达式
skipped 测试 – 是否跳过了任务
started 测试 – 是否启动了异步任务
subset 测试 – 列表是否是另一个列表的子集
success 测试 – 检查任务是否成功
superset test – 判断一个列表是否是另一个列表的超集
timedout test – 判断任务是否超时
truthy test – Python 式的真值判断
unreachable test – 判断任务是否因为主机不可达而结束
uri test – 判断字符串是否为有效的 URI
url test – 判断字符串是否为有效的 URL
urn test – 判断字符串是否为有效的 URN
vault_encrypted test – 判断字符串是否为加密的 vault 字符串
vaulted_file test – 判断文件是否为加密的 vault 文件
version test – 比较版本字符串
变量插件
host_group_vars vars – 负责加载 group_vars 和 host_vars
另请参阅
此处托管文档的集合列表。