README

routeros-api 是一个用于与 MikroTik 的 RouterOS API 交互的 PHP 客户端库。这个库允许开发者通过在他们的 PHP 应用程序中直接执行各种 RouterOS 命令来远程管理和监控 MikroTik 设备。

特性

• 连接管理：轻松通过 IP、用户名和密码连接到 MikroTik RouterOS。
• 命令执行：执行 RouterOS 命令并以结构化格式检索结果。
• 数据处理：自动将 RouterOS API 的响应解析为关联数组，以便轻松操作。
• 错误处理：全面的错误处理，以捕获和响应连接问题或无效命令。
• 可扩展性：该库设计为可扩展和定制，以满足您的特定需求。

用例

• 网络监控：从 MikroTik 设备获取并显示流量统计信息、接口状态和其他指标。
• 配置管理：远程更改配置、管理用户和在 MikroTik 路由器上更新固件。
• 自动化：自动化重复性任务，如备份计划、用户管理和网络诊断。

要求

• PHP 7.2+
• 启用了 API 的 MikroTik RouterOS

安装

您可以使用 Composer 将此库包含到项目中。

快速安装

要使用 Composer 快速安装此包，请运行以下命令

方法 1

composer require comitidn/routeros-api

如果方法 1 失败，请使用

方法 2

composer require comitidn/routeros-api:*@dev

手动安装

或者，您可以手动将此包添加到您的 composer.json 文件中

步骤 1：将包添加到您的 Composer 配置

将以下内容添加到您的 composer.json 文件中

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/comitidn/routeros-api.git"
        }
    ],
    "require": {
        "comitidn/routeros-api": "dev-main"
    }
}

步骤 2：安装包

运行以下命令以安装包

composer update

用法

以下是一个使用 routeros-api 库的基本示例

use RouterOSAPI\RouterOSAPI;

$api = new RouterOSAPI();
$api->connect('192.168.88.1', 'admin', 'password', 8728); // 8728 port default for API

// Example: Retrieve all interfaces
$api->write('/interface/print');
$interfaces = $api->read();

print_r($interfaces);

$api->disconnect();

高级用法

您可以将基本用法扩展到处理更复杂的任务，例如

• 获取特定数据：根据特定参数过滤结果。
• 配置设备：向路由器发送命令以更改配置。
• 错误处理：在 API 通信过程中捕获和处理错误。例如，过滤数据

$api->write('/interface/print', false);
$api->write('?name=ether1', true);
$ether1 = $api->read();

print_r($ether1);

贡献

欢迎贡献！如果您有建议或错误报告，请打开一个问题或提交一个拉取请求。

许可证

此项目采用 MIT 许可证。有关详细信息，请参阅 LICENSE 文件。