CyberWatch Api工具。
cbw-api-toolbox的Python项目详细描述
Cyberwatch API工具箱
Cyberwatch实例API的简单接口。在
安装
先决条件
安装最新的软件包
要安装Cyberwatch API工具箱,只需将python 3与:
$ pip3 install cbw-api-toolbox
安装旧版本的软件包
版本1.X中的某些脚本可能无法在cbw-api-toolbox
的2.X版本中工作,要安装旧版本,只需执行以下操作:
测试安装
创建一个名为ping.py
的新文件并复制/粘贴此内容
# ping.pyimportosfromconfigparserimportConfigParserfromcbw_api_toolbox.cbw_apiimportCBWApiCONF=ConfigParser()CONF.read(os.path.join(os.path.abspath(os.path.dirname(__file__)),'..','api.conf'))CLIENT=CBWApi(CONF.get('cyberwatch','url'),CONF.get('cyberwatch','api_key'),CONF.get('cyberwatch','secret_key'))CLIENT.ping()
配置api.conf文件用您的凭证存档
请参阅Configuration部分
测试脚本
$ python3 ping.py
如果一切正常,OK
消息将出现
$ python3 ping.py INFO:root:OK
否则,将出现FAILED
消息
$ python3 ping.py
ERROR:root:FAILED
在这种情况下,请检查您的API_KEY
、SECRET_KEY
或{
配置
在项目的根目录创建一个api.conf
文件(请参见example_api.conf
)
api_key
:您的Cyberwatch用户api密钥api_key
:您的Cyberwatch用户密钥url
:您的Cyberwatch实例URL
示例
[cyberwatch] api_key = PyXpxrcJ7rQ... secret_key = +bUx37WnB0qt... url = https://myinstance.local
要查找API凭据,请执行以下操作:
- 在cyberwatch实例网页中单击您的个人资料页
- 单击“查看我的api密钥”按钮
使用
启动脚本示例
- 从examples directory中选择一个脚本并将其复制到您的计算机上
- 使用API凭据编辑脚本(请参见Configuration)
- 启动脚本
$ python3 your_example_script_file.py
API文档
请参阅完整的API文档here
图书馆文献
请参阅特定于库的文档here
- 项目
标签: