Relianoid 命令行界面 noid-cli 用户指南

查看类别

Relianoid 命令行界面 noid-cli 用户指南

5分钟简报

什么是 noid-cli #

noid-cli 是的缩写 RELIANOID 命令行界面。 该工具允许从命令行管理多个负载均衡器,或者自动化操作脚本中的负载均衡器动作。

noid-cli 是包装的 API (RELIANOID 它是一种应用程序编程接口 (Application Programming Interface),具有自动完成功能,可以更轻松地浏览负载平衡器模块及其对象。

可以与 RELIANOID EE 8.1 或更高版本的负载均衡器。

第一步 noid-cli #

安装 #

noid-cli 可在官方 RELIANOID APT 存储库,它可以安装在 RELIANOID 负载均衡器使用:

apt-get 更新 && apt-get 安装 noid-cli

此外,该软件包还适用于任何Debian,Ubuntu或任何基于 DEB 软件包以远程启动命令到您的负载均衡器。

用户资料 #

用户资料 包含有关将在何处执行命令的负载均衡器以及将要执行命令的用户的信息。 的 用户 功能仅适用于 RELIANOID 企业并在RBAC模块中进行管理,命令将根据用户的权限执行。 noid-cli 能够管理不同的配置文件。

设置 #

跑步前 noid-cli a API密钥 是必需的。可以从 RELIANOID Web GUI,在菜单中 系统>用户.

relianoid 配置 api 用户权限

一旦 noid-cli 已安装,可以通过执行启动 noid-cli 在外壳中。 如果是从负载均衡器执行的,它将以默认配置文件运行 本地 它管理本地负载均衡器,并且将请求ZAPI密钥。 在任何其他情况下,将启动配置助手。

relianoid noid-cli 命令行用户界面

如果必须修改配置文件设置或必须创建另一个配置文件,则 noid-cli 轮廓 对象应该被执行。

可以在 noid-cli 使用的调用时间 -p 如下所示。

root@noid-ee-01:~$ noid-cli -p my_profile

或将命令与 noid-cli 在交互模式下:

noid-cli:配置文件应用my_profile

它是如何使用的 #

noid-cli 有两种工作模式:

1. 推出时不带参数, noid-cli shell以交互方式执行。 此模式提供自动补全功能,一旦执行命令,它就不会退出以退出 noid-cli 外壳,类型 退出 或按 按Ctrl + D.

2. noid-cli 用参数调用。 这将执行命令,而无需输入 noid-cli 交互式外壳程序,并返回到系统控制台。

让我们看看下面可用的命令 RELIANOID 命令行界面。

命令 #

命令具有以下语法:

root@noid-ee-01:~$ noid-cli [ 选项 ] [ 目的 ] [行动] [ ID 列表 ] [ 参数 ]

举个例子:

root@noid-ee-01:~$ noid-cli -nc -p test-lb2 farms-services-backend set farm1 service1 0 -ip 1.1.1.1 -port 80 ^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^ ^^^ ^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^ 选项对象操作 ID 列表参数

在下面找到每个参数的描述。

选项:它们位于 noid-cli 调用。 完整的选项列表在帮助中有详细说明。
对象:选中的是一种负载均衡器对象。
行动:将被执行的动词。
ID列表:它们是引用对象的标识符。 这些ID与模块有关。
参数:它们是在对象中设置的参数。 通常,它们是在创建/添加或修改对象时所期望的。

所有这些参数均可通过JSON格式使用 -j (–json) 选项。

预期的命令参数可以按以下方式检索 输入。 有时,直到设置了先前的参数,参数才会展开。

noid-cli 具有自动补全功能,可以按两次 TAB 按钮。

可以使用以下命令检查更新后的帮助。

root@noid-ee-01:~$ noid-cli 帮助

输出数据 #

noid-cli 提示符将根据命令错误代码更改颜色。 所以输出将显示在 墨绿色 如果命令成功执行或 红色 命令执行期间是否有错误。 此外,配置文件名称将打印为 灰色 ,尤其是 noid-cli 无法连接到负载平衡器。 对于此类错误,查看配置文件配置和负载平衡器ZAPI密钥非常有用。

输出以彩色JSON格式打印,但是可以使用选项禁用它们 -NC (–无色)。 可能会显示一些信息消息,当以下消息被忽略时 noid-cli 在命令执行模式下启动(无交互) noid-cli).

错误消息通过 斯特德 输出。

命令示例 #

示例的完整列表可以在 ZAPI文档。 这里只是一些有用的例子:

获取系统信息

root@noid-ee-01:~$ noid-cli 系统获取

获取系统统计

root@noid-ee-01:~$ noid-cli 统计系统获取

列出农场概述

root@noid-ee-01:~$ noid-cli 农场列表

创建一个农场

root@noid-ee-01:~$ noid-cli farm create-profile http-farmname farm1-vip 10.0.0.241-vport 443

检索服务器场的配置

root@noid-ee-01:~$ noid-cli farm get farm1

修改服务器场

root@noid-ee-01:~$ noid-cli farm set farm1-listener https

重新启动服务器场

root@noid-ee-01:~$ noid-cli farm restart farm1

创建服务

root@noid-ee-01:~$ noid-cli farm-service add farm1 -id images

修改服务

root@noid-ee-01:~$ noid-cli farm-service set farm1 images -urlp /images

添加后端

root@noid-ee-01:~$ noid-cli farm-service-backend add farm1 images -ip 10.0.4.40 -port 443

修改后端

root@noid-ee-01:~$ noid-cli farm-service-backend set farm1 images 0 -priority 1

删除后端

root@noid-ee-01:~$ noid-cli farm-service-backend 删除 farm1 图片 0

在维护模式下取消后端

root@noid-ee-01:~$ noid-cli farm-service-backend 维护 farm1 图片 0

在维护模式下设置后端

root@noid-ee-01:~$ noid-cli farm-service-backend non_maintenance farm1 图像 0

请享用 noid-cli, RELIANOID 命令行界面!

📄 以 PDF 格式下载此文档 #

    电子邮件: *

    专利所有者 更好的文档