Mikrotik RouterOS API PHP 客户端使用教程

32 0 0

Mikrotik RouterOS API PHP 客户端使用教程

routeros-api-phpMikrotik RouterOS API PHP client for your applications项目地址:https://gitcode.com/gh_mirrors/ro/routeros-api-php

项目介绍

routeros-api-php 是一个用于与 Mikrotik RouterOS 进行交互的 PHP 客户端库。该项目旨在简化与 RouterOS 的 API 通信，支持 PHP 7 和 8，并遵循 PSR 标准。它能够自动检测 RouterOS 的版本，无论是 pre-6.43 还是 post-6.43 版本。

项目快速启动

安装

首先，通过 Composer 安装 routeros-api-php：

composer require evilfreelancer/routeros-api-php

基本使用

以下是一个简单的示例，展示如何连接到 RouterOS 并执行一个命令：




require_once 'vendor/autoload.php';


 


use RouterOSClient;


use RouterOSConfig;


use RouterOSExceptionsBadCredentialsException;


use RouterOSExceptionsClientException;


use RouterOSExceptionsConfigException;


use RouterOSExceptionsQueryException;


 


try {


    $config = new Config([


        'host' => '192.168.1.1',


        'user' => 'admin',


        'pass' => 'password',


        'port' => 8728,


    ]);


 


    $client = new Client($config);


 


    $query = new Query('/ip/address/print');


    $response = $client->query($query)->read();


 


    print_r($response);


} catch (BadCredentialsException $e) {


    echo 'Bad credentials: ' . $e->getMessage();


} catch (ClientException $e) {


    echo 'Client exception: ' . $e->getMessage();


} catch (ConfigException $e) {


    echo 'Config exception: ' . $e->getMessage();


} catch (QueryException $e) {


    echo 'Query exception: ' . $e->getMessage();


}

应用案例和最佳实践

案例一：动态更新路由器配置

假设你需要定期更新路由器的 DNS 服务器列表，可以使用以下代码：




$query = new Query('/ip/dns/set', [


    'servers' => '8.8.8.8,8.8.4.4'


]);


$client->query($query)->read();

最佳实践

错误处理：始终捕获并处理可能的异常，以确保应用程序的稳定性。配置管理：将配置信息（如主机地址、用户名和密码）存储在安全的位置，避免硬编码。性能优化：对于频繁的 API 调用，考虑使用连接池或保持长连接以减少开销。

典型生态项目

1. Laravel 集成

routeros-api-php 可以作为 Laravel 包使用，通过 Facade 提供更简洁的 API 调用方式：




$client = RouterOS::client([


    'host' => '192.168.1.1',


    'user' => 'admin',


    'pass' => 'password',


    'port' => 8728,


]);


 


$response = $client->query(new Query('/ip/address/print'))->read();


print_r($response);