Skip to main content
Biamp Cornerstone

MPX 250 API Reference Guide

  1. Last updated
  2. Save as PDF

Overview

This article provides a comprehensive reference for the SSH API commands available on the EasyConnect MPX 250. The MPX 250 supports secure shell (SSH) connectivity, allowing system integrators and administrators to remotely configure, monitor, and manage the device via a command line interface and control systems.

By establishing an SSH session with the MPX 250, you can execute API commands to query system information, modify network parameters, manage configuration settings, and troubleshoot device behavior without needing a graphical user interface.

To connect to the MPX 250 command line interface, ensure you have:

  • An SSH client (such as PuTTY, Terminal, or control system).
  • The IP address of the MPX 250 (accessible via the local network).
  • Valid administrator credentials.

SSH command syntax and usage

The following sections detail the command syntax, descriptions, and expected input/output examples for all supported API commands.
 

Description Command Example

Help interface

Get information about commands and how to use the interface.

 

help

 system: Get complete system information
network: Get current network information
config: Get/set configuration settings
...
exit: Close the session

User information

Get/Set information about the logged in user.

user get

user set {"<KEY>":"<VALUE>",...}

> user get
{"username":"admin","role":"user"}

> user set {"password":"passw0rd"}
...<same as output from user>

System information

Get complete system information. Includes serial numbers, product and firmware version.

system

 {"sn":"10031225310002466","hwId":"O4E8408F63F942","product":"O-PC-4","firmwareversion":"1.3.1.0"}

Config management

Get and set the hub configuration. Default should be config values in text.

If no argument is supplied, help information is printed.

See more information about the specific settings in the Configuration Parameters below.

Note that currently the booleans are 0/1 values, and the strings are enums.

config get

config set {"<KEY>":"<VALUE>",...}

> config get
{"useadminpassword":false,"hdmiceccontrol":false,"useethernet":false,"wificredentials":true,...}

> config set {"useadminpassword":true,...}
...<same as output from get>

Network information

Get and set current network information.

get returns current status.

get {"config":true} returns current config (not status).

scan will find access points available to connect to over Wi-Fi.

If no argument is supplied, help information is printed.

network get
network get {"config":true}

network set {"interface":"Ethernet"}

network set {"interface":"Wifi","ssid":"<SSID>","password":"<PASSWORD>"}

network scan

> network get
{"status":"UP","interface":"Ethernet","ip":"192.168.196.133","subnet":"255.255.255.0","gw":"192.168.196.55","DNS1":"192.168.196.55","DNS2":"8.8.8.8","lease":3599}

> network get
{"status":"UP","interface":"WiFi","ssid":"OchnoNet","ip":"192.168.53.130","subnet":"255.255.255.0","gateway":"192.168.53.223","dns1":"192.168.53.223","dns2":"8.8.8.8","lease":0,"wifirssi":-55}

>network get {"config":true}
{"interface":"WiFi","ssid":"OchnoNet","dhcp":false,"dualdns":true,"ip":"192.168.53.130","subnet":"255.255.255.0","gateway":"192.168.53.223","dns1":"192.168.53.223","dns2":"8.8.8.8"}

> network set {"interface":"Ethernet"}
...<same as output from get>
> network set {"interface":"Wifi","ssid":"<SSID>","password":"<PASSWORD>"}
...<same as output from get>
> network set {"interface":"Wifi","ssid":"<SSID>","password":"<PASSWORD>","dhcp":false,"ip":"192.168.53.130","subnet":"255.255.255.0","gateway":"192.168.53.223","dns1":"192.168.53.223","dns2":"8.8.8.8"}
...<same as output from get>

> network scan
{"networks":[{"ssid":"NETWORK1","encryption":208,"rssi":-76,"channel":1},{"ssid":"NETWORK2","encryption":208,"rssi":-60,"channel":2},{"ssid":"NETOWORK3","encryption":208,"rssi":-73,"channel":3},...]}

Port state and actions

Get and set port information.

If no argument is supplied, help information is printed.

The port state shows active port (0 = no active port) and mode, also connected ports where in = port 1-4 (front) and out = port 5-8 (back).

port get

port set {"active":<PORT>,"mode":"UC"}

> port get
{"active":0,"mode":"BYOD","con_in":[1,0,0,0],"con_out":[1,0,0,0]}

> port set  {"active":1}
...<same as output from get>
> port set  {"mode":"UC"}
...<same as output from get>

 

Reboot

Reboot the hub. The connection will be closed.

soft executes a reboot of the cpu only

hard executes reboot but cuts power to the entire hub before restarting

reboot soft

reboot hard

  

Events subscription

Subscribe to hub events. The subscriptions will create printouts when an event occurs.

If no argument is supplied, help information is printed.

event list

event subscribe {"events":["<EVENT_NAME"]}

event unsubscribe {"events":["<EVENT_NAME"]}

> event list
{"events":["EVENT_US_PORT_CONNECTION","EVENT_SYSTEM_STATE_CHANGE","EVENT_POWER_INFO","EVENT_USB_PORT_CHANGE","EVENT_DISPLAY_PORT_CHANGE"],"subscriptions":[]}

> event subscribe {"events":["<EVENT_US_PORT_CONNECTION"]}
{"subscriptions":["EVENT_US_PORT_CONNECTION"]}

> event unsubscribe {"events":["<EVENT_US_PORT_CONNECTION"]}
{"subscriptions":[]}

 

Configuration Parameters 

This section details the configurable parameters and properties available via the API. These parameters allow administrators to customize system behavior, define switching policies, and manage external peripheral integration. Each entry includes the data type, accepted value ranges, and operational descriptions.

Name Type Range Description
adminalwaysoff Boolean  

Set to disable admin mode from being activated.
NOTE: This means the hub can no longer be accessed for
admin using Management Console or Workplace.
autoswitchconnect String ‘off’ | ‘on’ | ‘always’ Enables automatic video/USB switching when
connecting device.
on means the switching will happen only when nothing else is active.
always means the switching will always happen on a new connect.

autoswitchdisconnect

String

‘off’ | ‘on’ | ‘active’ | 'both'

Enables automatic video/USB switching when disconnecting device.
on means the switching will happen only when disconnecting the last device.
active means the switching will always happen when disconnecting from active port.

autoswitchports

Number

0-15 / 0b1111

Controls which ports that trigger automatic switching.
NOTE: This is a bit pattern where each bit controls a port.

buttondisabled

Number

0-15 / 0b1111

Disable buttons from use.

buttonemptydisabled

Boolean

 

Disables buttons from use when there is nothing connected to them.

buttonemptydisabled

Boolean

 

Disables buttons from use when there is nothing connected to them.

buttonoffdefaultport

Boolean

 

Enable to change to default port, instead of no port, when deactivating a port with a button.

chargingprotocols

String[]

['SPR', ‘EPR’, ‘PPS’, ‘LQC’]

Set what charging protocols that should be enabled.

defaultport

Number

0 = None
1-4 = USB-C 1-4

The initial port when booting system. This is also used by other settings: It is the port to change to when triggering auto switch disconnect, it may be the port a button moves to when deactivating a port. It is used in daisy-chain when a downstream hub tells the hub to activate a port.

disabledfpusb3

Boolean

 

Disable USB3 and video on ports that are not configured for Windows UC.

disableleds

Boolean

 

Disable all LEDs on the hub hardware.

enabledports

Boolean[]

[true, true, true, true]

Enable/disable specific upstream ports.

hdmiceccontrol

Boolean

 

Enables HDMI CEC toggle.

hdmipowerondelay

Number

0 = Always on
1-126 = ms x 100
127 = Always off

Time to keep in reset for the HDMI 5V.

hpdondelay

Number

0 = Always on
1-126 = ms x 100
127 = Always off

Time to keep in reset for the HPD.

inactivedisabled

Number

0-15 / 0b1111

Disable the port when it is inactive.

lockactive

Number

0 = off
1 = on

Lock active port so it's not possible to switch away.
This also works in daisy-chain, but all applicable hubs must be configured to use it.

mtrautoswitchreset

String

‘off’ | ‘on’ | ‘active’ | 'both'

Enables resetting UC mode memory when disconnecting devices.
This is only relevant in combination with mtrmodememory.

mtrbuttoncycle

Boolean

 

Enables device buttons to cycle between UC/BYOD mode on all buttons.

mtrdefaultmodeports

Number

0-15 / 0b1111

The default UC mode of individual ports, a set bit means UC mode

mtrdisableusb

Number

0 = all USB-A
1 = USB-A port 1
2 = USB-A port 1

Which USB to disable when in UC mode.
usemtr must be set to disable to use this UC configuration.

mtrkeepmodeinactive

Boolean

 

If UC mode should be kept even during no active port.

mtrlongpressdelay

Number

0 = Off
1-31 ms x 100

Enables long press to switch UC modes. Value is duration for trigger.

mtrmanualinherit

Boolean

 

Sets if a manual port change should inherit UC mode.

mtrmodememory

Boolean

 

If UC mode should be remembered after no active port.
When set, this overwrites mtrdefaultmodeports.
See setting mtrautoswitchreset for ways to reset memory.

mtronextension

Boolean

 

Sets if the UC is placed on the extension USB-C port.

mtrport

Number

0 = Off
1-6 = USB-C port 1-6

The port that has an UC connected.
usemtr must be set to port to use this UC configuration.

noportperipheraloff

 

 

Disable downstream ports with peripherals when no port is active.

powerbalancingmode

String

‘static’ | ‘firstprio’ | ‘fairshare’

Set the power distribution/balancing mode.
Sibling setting: usbpowerdistributionmode

powerstatic

Number[]

[0-31, 0-31, 0-31, 0-31]
Each value = W x 5
Sum W < Unit max W

Static power allocation per port. Sets the max allowed power per port.

sharenetwork

Boolean

 

Enables network sharing through the USB cable to the user laptop.

sharenetworkspeed

Boolean

 

Protocol for network sharing (false = USB2, true = USB3).
NOTE: Setting USB3 will force device on port 8 (USB-A 2) to only use USB2.

tysel7io

Boolean

 

Enable to allow Touch Controller IO on port 7 (USB-A 1).

tysel8io

Boolean

 

Enable to allow Touch Controller IO on port 8 (USB-A 2).

ufpdefaultrole

Number

0 = Sink
1 = Source

Default UFP port role for upstream ports. Only applicable if ufprole is set to DRP.

ufprole

Number

0 = Sink
1 = Source
2 = DRP

UFP port role for upstream ports.

usbpowerdistributionmode

Number

0 = Disabled
1 = First prio
2 = Fair share

Set the power distribution/balancing mode.
Sibling setting: powerbalancingmode

usbptondelay

Number

0 = Always on
1-126 = ms x 100
127 = Always off

Time to keep in reset for USB passthrough VBUS DET.

usbptusbcondelay

Number

0 = Always on
1-126 = ms x 100
127 = Always off

Time to keep in reset for VBUS of the USB-C passthrough ports.

usbptvbusondelay

Number

0 = Always on
1-126 = ms x 100
127 = Always off

Time to keep in reset for VBUS of the USB-A passthrough ports.

usemtr

String

 'off' | 'port' | 'disable Enables UC configuration, see other UC settings ("mtr...").

 

  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Article type
    Reference
    Stage
    Final
  2. Tags
    1. EasyConnect
    2. MPX 250