Ansible动态主机清单脚本是输出合法JSON的可执行程序,需响应--list(输出主机组结构)和--host(输出单主机变量)参数,必须UTF-8编码且含_meta.hostvars;示例支持环境变量或AWS EC2自动发现。

Ansible 动态主机清单脚本本质是一个可执行程序(如 Python、Shell 脚本),它在运行时输出符合 Ansible 期望格式的 JSON,描述主机、主机组及其变量。关键不是“怎么写脚本”,而是“怎么输出合法的动态清单 JSON”。
理解动态清单的输入输出契约
Ansible 在调用你的脚本时,会传入两个参数:
- --list:要求脚本输出所有主机组和主机的结构化 JSON(最常用)
-
--host
:要求脚本输出指定主机的变量(仅当该主机需要独立变量时才需实现)
脚本必须可执行(chmod +x),且返回标准输出(stdout)为 UTF-8 编码的 JSON。不处理参数或输出非法 JSON 会导致 Ansible 报错 Invalid inventory format。
Python 示例:从环境变量读取主机列表
这是最轻量、易调试的入门方式。适用于 CI/CD 环境或临时测试:
#!/usr/bin/env python3
import json
import os
import sys
<p>def main():
if len(sys.argv) != 2:
print("Usage: %s --list or %s --host <hostname>" % (sys.argv[0], sys.argv[0]))
sys.exit(1)</hostname></p><pre class="brush:php;toolbar:false;">if sys.argv[1] == '--list':
# 从环境变量获取主机,用逗号分隔,例如:export MY_HOSTS="web1,web2,db1"
hosts = os.environ.get('MY_HOSTS', '').strip().split(',') if os.environ.get('MY_HOSTS') else []
hosts = [h.strip() for h in hosts if h.strip()]
inventory = {
"webservers": {
"hosts": [h for h in hosts if h.startswith('web')],
"vars": {"ansible_user": "ubuntu", "ansible_ssh_private_key_file": "~/.ssh/id_rsa"}
},
"dbservers": {
"hosts": [h for h in hosts if h.startswith('db')],
"vars": {"ansible_user": "postgres"}
},
"_meta": {
"hostvars": {}
}
}
# 为每台主机补充 _meta.hostvars(即使为空)
for host in hosts:
inventory["_meta"]["hostvars"][host] = {}
print(json.dumps(inventory, indent=2))
elif sys.argv[1].startswith('--host'):
hostname = sys.argv[1].split('--host')[1].strip()
# 返回该主机的变量(可选;若无特殊变量,返回空对象即可)
print(json.dumps({"ansible_user": "ubuntu"}, indent=2))
else:
sys.exit(1)
if name == 'main': main()
对接真实数据源:以 AWS EC2 为例
生产中常见需求是自动发现云主机。使用 boto3 是主流做法,但注意两点:
- 确保目标机器已安装
boto3和有效 AWS 凭据(~/.aws/credentials或 IAM 角色) - 务必在
_meta.hostvars中填入每台主机的连接信息(如ansible_host、ansible_user),否则 Ansible 不知道连哪、用谁登录
简化逻辑示意:
# 在 --list 分支中:
import boto3
ec2 = boto3.resource('ec2', region_name='us-east-1')
instances = ec2.instances.filter(Filters=[{'Name': 'tag:Environment', 'Values': ['prod']}])
<p>webservers = []
hostvars = {}
for i in instances:
if i.state['Name'] == 'running' and 'web' in [t['Value'] for t in i.tags or []]:
webservers.append(i.private_ip_address)
hostvars[i.private_ip_address] = {
"ansible_host": i.public_ip_address or i.private_ip_address,
"ansible_user": "ec2-user",
"ansible_ssh_private_key_file": "/path/to/key.pem"
}</p><p>inventory = {
"webservers": {"hosts": webservers},
"_meta": {"hostvars": hostvars}
}
</p>调试与验证技巧
别等跑 Playbook 才发现错误:
- 手动执行脚本:
./my_inventory.py --list | python3 -m json.tool(格式化并校验 JSON) - 检查是否可执行:
ls -l ./my_inventory.py,缺权限就chmod +x - 用 Ansible 自检:
ansible-inventory -i ./my_inventory.py --list --graph - 查主机变量:
ansible-inventory -i ./my_inventory.py --host web1
常见陷阱:忘记 _meta.hostvars、主机 IP 写成内网却没配 ansible_host、JSON 多了逗号、Python 字符串未 encode 为 UTF-8。











