Netbox 作为 Ansible 动态库存脚本使用教程

Netbox 作为 Ansible 动态库存脚本使用教程

1. 项目目录结构及介绍

netbox-as-ansible-inventory/
├── CHANGELOG.md
├── COPYING
├── MANIFEST.in
├── README.rst
├── VERSION
├── requirements.txt
├── setup.py
├── netbox/
│   ├── __init__.py
│   ├── inventory.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_inventory.py
│   └── ...
├── .coveragerc
├── .gitignore
└── .travis.yml

目录结构说明

• CHANGELOG.md: 项目变更日志文件。
• COPYING: 项目许可证文件。
• MANIFEST.in: 用于指定在打包时包含的文件。
• README.rst: 项目介绍和使用说明文件。
• VERSION: 项目版本号文件。
• requirements.txt: 项目依赖包列表。
• setup.py: 项目安装脚本。
• netbox/: 主要代码目录，包含动态库存脚本的核心逻辑。
  • init.py: 模块初始化文件。
  • inventory.py: 动态库存脚本的主要实现文件。
• tests/: 测试代码目录，包含项目的单元测试。
  • init.py: 测试模块初始化文件。
  • test_inventory.py: 针对 inventory.py 的单元测试文件。
• .coveragerc: 代码覆盖率配置文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。

2. 项目启动文件介绍

netbox/inventory.py

这是项目的核心启动文件，负责从 Netbox 获取数据并生成 Ansible 动态库存。该文件的主要功能包括：

• 动态获取 Netbox 数据: 通过 Netbox API 获取服务器信息。
• 生成 Ansible 库存: 将获取的数据转换为 Ansible 动态库存格式。
• 支持自定义分组和变量: 允许用户根据 Netbox 中的字段对服务器进行分组，并设置自定义变量。

使用方法

$ ansible-inventory -i netbox/inventory.py --list

该命令将调用 inventory.py 脚本，生成并列出所有主机的动态库存信息。

3. 项目配置文件介绍

netbox.yml

这是项目的配置文件，用于指定 Netbox API 的连接信息、分组规则和主机变量等。配置文件的默认路径为 netbox.yml，但可以通过环境变量 NETBOX_CONFIG_FILE 指定其他路径。

配置文件示例

netbox:
  url: "https://netbox.example.com"
  token: "your_netbox_api_token"

group_by:
  default:
    - platform
    - site
  custom:
    - custom_field_name

hosts_vars:
  ip:
    ansible_ssh_host: primary_ip
  general:
    ansible_user: admin
  custom:
    custom_field_name: custom_field_value

配置文件说明

• netbox: 包含 Netbox API 的 URL 和访问令牌。
• group_by: 定义服务器分组规则。
  • default: 使用 Netbox 默认字段进行分组。
  • custom: 使用自定义字段进行分组。
• hosts_vars: 定义主机变量。
  • ip: 使用 Netbox 中的 IP 字段作为变量。
  • general: 使用通用字段作为变量。
  • custom: 使用自定义字段作为变量。

通过配置文件，用户可以灵活地定义如何从 Netbox 获取数据并生成 Ansible 动态库存。