Octave Cloud IoT命令行界面(CLI)
ocsw的Python项目详细描述
ocsw cli-Octave Cloud IoT命令行工具
这不是的命令行接口(CLI)的正式实现 Octave Cloud REST API。在
ocsw调用Octave云基础设施api来提供 为各种服务实现的功能。这些是restapi 使用HTTPS请求和响应。在
API参考
这个包包括一个实现https://rest.octave.dev/中描述的api的客户机
要求
要安装和使用CLI,您必须具备:
- 在
Octave云基础设施帐户。在具有授予所需权限的策略的组中,在该帐户中创建的用户。此帐户用户可以是调用API的用户。在
在 - 在
系统使用基于令牌的身份验证。您可以通过登录Octave Cloud为您的用户获取API令牌,在主页的左下方,您将看到Master token选项。单击此处,弹出窗口将显示您的令牌以及您将与Octave Cloud api一起使用的用户。在
在
安装
照常:
pip install ocsw
环境变量
VARIABLE | Description |
---|---|
OCTAVE_CLOUD_API_URL | default: https://octave-api.sierrawireless.io/v5.0End point octave cloud |
OCTAVE_CLOUD_TOKEN | Master Token |
OCTAVE_CLOUD_USER | Your user id |
OCTAVE_CLOUD_COMPANY | Identifier of one of the company |
使用
^{pr2}$命令:蓝图
usage: ocsw-cli blueprint [-h] COMMAND ...
Manage blueprints
positional arguments:
COMMAND
ls display blueprint list
inspect display detailed information on one or more blueprints
diff differences between blueprint versions
optional arguments:
-h, --help show this help message and exit
命令:cloud
usage: ocsw-cli cloud [-h] COMMAND ...
Manage Cloud
positional arguments:
COMMAND
fetch download objects and refs from cloud
export download objects and refs from cloud
optional arguments:
-h, --help show this help message and exit
命令:cloud\u action
usage: ocsw-cli cloud_action [-h] COMMAND ...
Manage cloud actions
positional arguments:
COMMAND
inspect display detailed information on one or more cloud actions
ls list cloud action
diff differences in javascript between cloud action versions
optional arguments:
-h, --help show this help message and exit
命令:cloud_connector
usage: ocsw-cli cloud_connector [-h] COMMAND ...
Manage cloud connectors
positional arguments:
COMMAND
inspect display detailed information on one or more cloud connectors
ls list cloud connector
diff differences in javascript between cloud connector versions
optional arguments:
-h, --help show this help message and exit
指挥部:连队
usage: ocsw-cli company [-h] COMMAND ...
Manage companies
positional arguments:
COMMAND
ls display company list
inspect display detailed information on one or more companies
switch set company active
optional arguments:
-h, --help show this help message and exit
命令:device
usage: ocsw-cli device [-h] COMMAND ...
Manage devices
positional arguments:
COMMAND
actions list device edge actions
create creating device
inspect display detailed information on one or more devices
lc list devices configuration
li list devices identity
ls list devices connectivity
rm remove one or more devices
tags set device tags
events display recent events
changes display recent changes
optional arguments:
-h, --help show this help message and exit
命令:edge_action
usage: ocsw-cli edge_action [-h] COMMAND ...
Manage edge actions
positional arguments:
COMMAND
inspect display detailed information on one or more edge actions
ls list edge action
diff differences in javascript between edge action versions
optional arguments:
-h, --help show this help message and exit
命令:固件
usage: ocsw-cli firmware [-h] COMMAND ...
Manage firmware
positional arguments:
COMMAND
ls list of available firmware
note display notes on one or more firmware
optional arguments:
-h, --help show this help message and exit
命令:group
usage: ocsw-cli group [-h] COMMAND ...
Manage user groups
positional arguments:
COMMAND
ls display user group list
inspect display detailed information on one or more user groups
optional arguments:
-h, --help show this help message and exit
命令:stream
usage: ocsw-cli stream [-h] COMMAND ...
Manage streams
positional arguments:
COMMAND
ls display streams list
inspect display detailed information on one or more streams
events display stream events list
optional arguments:
-h, --help show this help message and exit
命令:user
usage: ocsw-cli user [-h] COMMAND ...
Manage users
positional arguments:
COMMAND
ls display user list
inspect display detailed information on one or more users
optional arguments:
-h, --help show this help message and exit
命令:标识
usage: ocsw-cli identity [-h]
Display detailed information about current user
optional arguments:
-h, --help show this help message and exit
命令:login
usage: ocsw-cli login [-h] [-t] [-u] [COMPANY]
Log in to a Octave Cloud
positional arguments:
COMPANY company name
optional arguments:
-h, --help show this help message and exit
-t , --token token
-u , --username username
命令:注销
usage: ocsw-cli logout [-h]
Log out from a Octave Cloud
optional arguments:
-h, --help show this help message and exit
命令:释放
usage: ocsw-cli release [-h]
Display Octave API Version Information
optional arguments:
-h, --help show this help message and exit
- 项目
标签: