Download the PHP package imafaz/mikrolink without Composer
On this page you can find all versions of the php package imafaz/mikrolink. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download imafaz/mikrolink
More information about imafaz/mikrolink
Files in imafaz/mikrolink
Package mikrolink
Short Description lightweight library for manage mikrotik router os with api
License MIT
Homepage https://github.com/imafaz/MikroLink
Informations about the package mikrolink
Lightweight PHP Library for MikroTik API Management
MikroLink is a lightweight PHP library designed for interacting with MikroTik routers using their API. This library simplifies the process of managing and automating tasks on MikroTik devices programmatically.
- Requirements
- Installation
- Quick Start
- Usage
- Available Methods
- License
Requirements
To utilize this library effectively, ensure your environment meets the following requirements:
- PHP version 7.0 or higher
Installation
For seamless installation, use Composer:
Quick Start
Once the library is installed, include it in your PHP script:
Usage
Initialize the MikroLink object with debug mode, timeout, attempts, and delay settings:
Connect to a MikroTik router using its IP, username, password, port, and optional SSL mode:
Execute commands on the connected router:
disconnect router connection :
Available Methods
__construct
Description:
Initializes the MikroLink object with debugging and connection settings.
Signature:
Attributes:
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$timeout | Connection timeout (seconds) | int | No | 1 |
$attempts | Connection attempts | int | No | 3 |
$delay | Delay between attempts (sec) | int | No | 0 |
$logFile | log file name | string | No | mikrolink.log |
$printLog | print log | bool | No | false |
connect
Description:
Connects to a MikroTik router using the provided credentials and connection details.
Signature:
Attributes:
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$ip | Router IP address | string | Yes | N/A |
$username | Router login username | string | Yes | N/A |
$password | Router login password | string | Yes | N/A |
$port | Router API port | int | Yes | N/A |
$ssl | SSL mode toggle | bool | No | false |
exec
Description:
Executes a MikroTik API command with optional parameters.
Signature:
Attributes:
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$command | API command to execute | string | Yes | N/A |
$params | Additional command parameters | array | No | null |
disconnect
Description:
Terminates the connection with the MikroTik router.
Signature:
License
This library is licensed under the MIT License