NetBox Python

NetBox的Python API客户端库。

注意：这是一个预发布版本，仍在开发中。

• Github仓库： https://github.com/netbox-community/netbox-python/

• 文档： https://netbox-community.github.io/netbox-python/

• 报告一个错误

• 请求一个功能

• 提问

关于

这是一个NetBox API的Python包装器。

入门

要安装，请运行pip install netbox-python。

或者，您可以克隆仓库并运行python setup.py install。

使用

完整的文档位于https://netbox-community.github.io/netbox-python/，但以下内容足以开始使用它。

开始之前，导入NetBox客户端并实例化它

from netbox_python import NetBoxClient, Result
nb = NetBoxClient(
    base_url="http://127.0.0.1:8000/", token="1dc6fa5bfcef8390dd83a261c36ed8f1551b2d6b"
)

NetBoxClient接受的第一个参数是NetBox URL。'token'参数来自NetBox。

现在，使用客户端您可以调用API，例如

# 1. List (paginated)
ret = nb.dcim.sites.list(limit=3)

# 2. Filtered List
ret = nb.dcim.sites.list(region_id="43")

# 3. All
ret = nb.dcim.sites.all()

# 4. Get
ret = nb.dcim.sites.get(24)

# 5. Create
ret = nb.dcim.sites.create(name="foo3", slug="foo3")

# 6. Bulk Create
data = [
    {"name": "foo4", "slug": "foo4"},
    {"name": "foo5", "slug": "foo5"},
    {"name": "foo6", "slug": "foo6"},
]
ret = nb.dcim.sites.create(data)

# 7. Update
ret = nb.dcim.sites.update(26, name="foo2-new", slug="foo2-new-slug")

# 8. Bulk Update
data = [
    {"id": 28, "name": "foo4-new", "slug": "foo4-new"},
    {"id": 29, "name": "foo5-new", "slug": "foo5-new"},
]
ret = nb.dcim.sites.update(data)

# 9. Delete
ret = nb.dcim.sites.delete(37)

# 10. Bulk Delete
data = [{"id": 25}, {"id": 27}]
ret = nb.dcim.sites.delete(data)

API上的方法对应于NetBox REST API，因此（'circuits', 'core', 'dcim', 'extras', 'ipam', 'plugins', 'tenancy', 'users', 'virtualization', 'wireless'）

circuits将包含'circuit_terminations', 'circuit_types'等。每个端点都有'list', 'get', 'create', 'update'和'delete'功能。

路线图

请参阅公开问题以获取功能建议（和已知问题）列表。

• 顶级功能请求（使用 👍 反应添加您的投票）
• 顶级错误（使用 👍 反应添加您的投票）
• 最新错误

支持

请联系以下位置之一的管理员

• GitHub 讨论区

贡献

首先，感谢您花时间贡献力量！贡献是使开源社区成为一个如此棒的学习、灵感和创作场所的原因。您做出的任何贡献都将惠及所有人，并受到 高度赞赏。

请阅读我们的贡献指南，感谢您的参与！

作者 & 贡献者

此存储库的原始设置由 Arthur Hanson 完成。

有关所有作者和贡献者的完整列表，请参阅贡献者页面。

许可证

本项目采用 Apache 软件许可证 2.0 许可。

有关更多信息，请参阅 LICENSE。