Download the PHP package ocolin/uisp-extended without Composer

On this page you can find all versions of the php package ocolin/uisp-extended. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of ocolin/uisp-extended

Informations about the package uisp-extended

UISP Extended

Ubiquiti's UISP platform provides a comprehensive API for managing network devices, but certain administrative tasks are not exposed through the API and must be performed directly on the device via SSH. ocolin/uisp-extended fills that gap by providing a clean PHP interface for SSH-based device management, designed to complement the ocolin/uisp package.

Experimental

This is currently experimental and has not been fully tested on every known device.

Requirements

Installation

Configuration

Arguments

When creating a Ubiquiti device class, there are a few parameters that you can use:

Name Type Default Description
ip string REQUIRED IP address of device
password string REQUIRED Password for login
username string admin Username for login
port integer 22 SSH port

Logging in

Upon instantiation, you will log into the device automatically. An error is thrown if the connection fails or authentication does not pass.

Example

Exceptions

Functions

Get Device Information

You can get information about the device such as the type name, model, family, and firmware.

Output Object

Name Type Description
name string Name of the device model
model string Model of device
family string Family of device model
firmware string Device firmware version

Example

Get MAC table

This provides a MAC/bridge table on the device. It outputs an array of MAC entry objects.

Object parameters

Name Type Description
mac string MAC address
interface string Interface address is on
isLocal boolean Is MAC address a local one?
agingTimer float Age of MAC address

Example:

Update password

This function allows you to update the password on a device. This function returns void, but will throw an error upon failure which will state where in the process it failed.

This will auto-detect the model of radio and execute the corresponding password update procedure automatically.

Example:

Exceptions

Update Wave Password

This function was created in the event of a user wants to specifically change password on a Wve device instead of relying on changePassword() which automatically detects the type of device.

The same errors will be thrown as changePassword().

Example

Update AirOS Password

This function was created in the event a user wants to specifically change the password on a non-Wave type of device.

The same errors will be thrown as changePassword().

Example

Reboot

While UISP has a reboot function, one was added here in case it needed to be used as standalone.

Example

All versions of uisp-extended with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
phpseclib/phpseclib Version ^3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ocolin/uisp-extended contains the following files

Loading the files please wait ...