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: 项目许可证文件，采用 GPL-3.0 许可证。
• MANIFEST.in: 用于打包的清单文件。
• README.rst: 项目说明文档。
• VERSION: 项目版本号。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。
• netbox/: 包含项目核心代码的目录。
  • __init__.py: 模块初始化文件。
  • inventory.py: 库存脚本核心文件。
• tests/: 包含项目测试代码的目录。
  • __init__.py: 测试模块初始化文件。
  • test_inventory.py: 库存脚本测试文件。
• .coveragerc: 代码覆盖率配置文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 netbox/inventory.py。这个文件是 Ansible 动态库存脚本的核心，负责从 Netbox 获取数据并生成 Ansible 所需的库存格式。

3. 项目的配置文件介绍

项目的配置文件可以通过以下几种方式指定：

1. 命令行参数：

   ansible-netbox-inventory -c CONFIG_FILE
   

   其中 CONFIG_FILE 是配置文件的路径。

2. 环境变量：

   export NETBOX_CONFIG_FILE=path/to/config.yml
   

   通过设置 NETBOX_CONFIG_FILE 环境变量来指定配置文件的路径。

配置文件的示例内容如下：

netbox:
  url: http://your-netbox-instance.com
  token: your-api-token
group_by:
  default:
    - platform
hosts_vars:
  ip:
    ansible_ssh_host: primary_ip

• netbox: 包含 Netbox 实例的 URL 和 API 令牌。
• group_by: 定义如何对服务器进行分组。
• hosts_vars: 定义如何将 Netbox 中的字段映射到 Ansible 变量。

通过以上配置，可以灵活地根据 Netbox 中的数据生成 Ansible 库存。