🧙‍♀️ Prophetess Netbox 插件

Prophetess 插件，用于将数据加载到 Netbox

🚀 安装

pip install prophetess-netbox

🔧 配置

NetboxLoader 包含多个必需和可选的配置选项。完整的配置说明如下

host: 'http://localhost:8000'
api_key: 123key
update_method: update
endpoint: dcim
model: sites
pk:
- slug
- cf_id: "{site}"
fk:
  region:
    endpoint: dcim
    model: regions
    pk:
    - cf_sf_id: "{region}"

加载器

主键

主键（PK），是一个字符串或字典（对象）列表，用于检查要加载的记录是否存在。当使用字典时，键用于与API进行查找，值是一个Python格式化字符串。这允许在映射解析的记录到Netbox假设的内容时具有灵活性。

例如，给定以下解析的记录：

{
  'slug': 'nb-slug',
  'region': 'custom-field-lookup',
  'name': 'test',
}

主键配置为：

- slug
- cf_region: '{region}'

结果查找将是： ?slug=nb-slug&cf_region=自定义字段查找

FK

FK（外键），允许将提取器中的字符串值映射到Netbox中的记录ID。它是一个记录键到查找配置映射的字典。记录可以在单个Netbox实例内的任何端点和模型之间进行链接。

给定以下记录：

{
  'slug': 'nb-slug',
  'region': 'region-slug',
  'name': 'test',
}

使用以下FK配置进行解析：

region:
  endpoint: dcim
  model: regions
  pk:
  - slug

如果假设存在一个slug为region-slug且记录ID为12的区域

{
  'slug': 'nb-slug',
  'region': 12,
  'name': 'test',
}

如果没有找到FK记录，则设置None。

配置

🧰 开发

请fork此项目并创建一个新的分支以提交任何更改。虽然不是必需的，但强烈建议首先创建一个问题来提出您希望进行的更改。请保持拉取请求针对一个更改/功能。

此项目使用tox + pytest进行单元测试和代码检查。使用以下命令验证您的更改是否破坏了现有功能

tox --cov-report term-missing
tox -e lint

🎉 特别感谢

❤️ Charles Butler
❤️ Erick Daniszewski