pyopnsense 0.4.0

安装

pyopnsense通过pypi提供，所以您只需要运行

pip install -U pyopnsense

以获取系统上的最新pyopnsense版本。如果您需要使用pyopnsense的开发版本，您可以将存储库克隆并使用以下命令本地安装

git clone https://github.com/mtreinish/pyopnsense && pip install -e pyopnsense

这将按可编辑模式安装pyopnsense到您的Python环境中进行开发。

用法

要使用pyopnsense，您需要一些信息，即API密钥和API密钥。这两个都可以通过OPNsense Web UI创建/找到，方法是在“系统->访问->用户”下导航到“API密钥”。

更多信息请参阅OPNsense文档：https://docs.opnsense.org/development/how-tos/api.html

一旦您有了API密钥和API密钥，您就可以使用pyopnsense与您的OPNsense安装进行交互。您可以通过向客户端类传递您的凭据来完成此操作。例如

from pyopnsense import diagnostics

api_key = 'XXXXXX'
api_secret = 'XXXXXXXXXXXXXXX'
opnsense_url = 'http://192.168.1.1/api'
timeout = 5

netinsight_client = diagnostics.NetworkInsightClient(
    api_key, api_secret, opnsense_url, timeout)

print(netinsight_client.get_interfaces())

这将打印一个将物理设备映射到其接口标签的字典。

可以使用相同的公式来访问您需要访问的每个API端点。库的基本结构设置为大致反映OPNsense API的端点树。每个客户端模块映射到基本端点，然后在那些模块中有客户端类来映射下一个级别。

您可以在以下位置的API参考文档中找到有关如何使用客户端的更多详细信息

http://pyopnsense.readthedocs.io/en/latest/api.html