API Reference

settings

settings command returns a list of commands to change PDU settings

SynLink> settings
-------------
Settings Menu
-------------

Usage: settings [command]

Commands:
  firmware    Print options/info for firmware configurations
  ports       Print options for controller front panel ports
  display     Print options for front panel lcd display

settings firmware status

Return firmware information for PDU in human readable format.

SynLink> settings firmware status

-----------------------
SynLink Firmware Status
-----------------------
Controller Serial number    | 1360604425
Controller Hardware Version | 1.17.0
Controller Firmware Version | 1.3.0
Enclosure Serial Number     | 9826498
Subsystem Serial Numbers    | 16777225, 16777226
Subsystem Hardware Versions | 1.0.0,1.0.0
Subsystem Firmware Versions | 1.1.0,1.1.0

settings firmware factory_reset

Issue factory reset from command line interface and proper permissions.

SynLink> settings firmware factory_reset
Are you sure you want to factory reset? You will lose all your configurations (y/n)> y
Please type "reset" and Enter to issue factory reset> reset

Issuing factory reset. 
Controller module will restart. Your outlets will not change states.

settings firmware reboot

Restart SynLink Controller Module and any running services/processes. Your outlets will not change states. If your outlets are on, they will stay on. If your outlets are off, they will stay off.

SynLink> settings firmware reboot
Are you sure you want to reboot your Controller Module? Any active connections to SynLink services will be terminated (y/n)>y

Restarting SynLink Module now. You may lose connection.

settings ports status

SynLink> settings ports status
----------------
Port Information
----------------

Current Mode for Port A: Sensor

Port A COM mode baud rate: 115200 (not active)
Port A MODEM mode baud rate: 115200 (not active)

USB COM port baud rate: 115200
USB MODEM port baud rate: 115200

-----------------
Port Descriptions
-----------------
RJ45 Port labeled "A" can be configured to do one of three separate functions.

Port A can act as a sensor port and connected sensor accessories will properly pair.
Port A can act as a modem port and provide out of band access to a serial device, such as a modem.
Port A can act as a com port and  allows access to this SynLink Command Line Interface with a connected host.

USB Port labeled "COM" provides serial access to the SynLink Command Line Interface
USB Port labeled "USB" can provide outlet of band access to a connected serial device, such as a modem.

settings ports set

See options to configure ports on front panel of SynLink controller.

RJ45 Port labeled "A" can be configured to do one of three separate functions.

Port A can act as a sensor port and connected sensor accessories will properly pair. Port A can act as a modem port and provide out of band access to a serial device, such as a modem. Port A can act as a com port and allows access to this SynLink Command Line Interface with a connected host.

USB Port labeled "COM" provides serial access to the SynLink Command Line Interface

USB Port labeled "USB" can provide outlet of band access to a connected serial device, such as a modem.

SynLink> settings ports set
-------------------
Port Configurations
-------------------

Usage:

  settings ports set [key] [value] 


Key                 | Values           | Desc           
------------------------------------------------------------------------------------
port_a_mode         | sensor,com,modem | change functionality of RJ45 port labeled: A
port_a_com_baud     | BAUD_RATE        | baud rate when port A is set to mode: com
port_a_modem_baud   | BAUD_RATE        | baud rate when port A is set to mode: modem
usb_com_port_baud   | BAUD_RATE        | baud rate for USB port labeled: COM
usb_modem_port_baud | BAUD_RATE        | baud rate for USB port labeled: USB

Valid Baud rates: 115200, 57600, 38400, 19200, 9600, 4800, 2400, 1200

settings display status

SynLink> settings display status

-------------------
Display Information
-------------------

Picture Settings
----------------
Orientation: Landscape
Brightness: 100%
Theme: Black

Screensaver Settings
--------------------
Screensaver Type: Power info
Screensaver Timeout: 60 seconds

Display Permissions
-------------------
Control Outlets with LCD display: Enabled
Change Network Settings with LCD Display: Enabled
Reboot Control Module with LCD Display: Disabled
Flush logs with LCD Display: Disabled

settings display set

SynLink> settings display set
----------------------
Display Configurations
----------------------

Usage:

  settings display set [key] [value] 


Key                 | Values          | Desc           
-----------------------------------------------------------------------------------
orientation         | 0,90,180,270    | Degrees of rotation to rotate
brightness          | 0,1,2,3,4,5,6,7 | 7 is brightest.
color_theme         | COLOR           | changes background color of display
screensaver         | off,power       | have screensaver show power info or nothing
screensaver_timeout | SECONDS         | max timeout 3600 seconds.
enable_outlet_ctrl  | ON,OFF          | ON will allow outlet switching from lcd
enable_network_ctrl | ON,OFF          | ON will allow network configuration from lcd
enable_lcd_reboot   | ON,OFF          | ON will allow reboot via lcd screen
enable_lcd_flush    | ON,OFF          | ON will allow flush system logs from lcd screen

Valid colors: black, blue, gray, green, magenta, maroon, navy, olive, orange, teal, purple