put https://cloud.synaccess.com/v1/conf/
Configuration
Configuration endpoint represents all network configuration, and other global configurations.
Configuration Object
{
"hostName": "SynLink",
"macAddr": "3A:D2:21:D3:82:45",
"webPort": 80,
"webSslPort": 443,
"telnetPort": 23,
"sshPort": 22,
"ipAssign": "static",
"globalRebootTime": 5,
"webEnabled": true,
"webSslEnabled": true,
"webRedirectHttp": false,
"customSslCertEnabled": false,
"telnetEnabled": true,
"sshEnabled": true,
"subnetMask": "255.255.255.0",
"gatewayIp": "192.168.1.1",
"staticIp": "192.168.1.100",
"primaryDns": "8.8.8.8",
"secondaryDns": "8.8.4.4",
"ntpEnabled": true,
"ntpHost": "pool.ntp.org",
"disableSshPassLogin": false,
"disableSshKeyLogin": false,
"usbFwupdateControlEnabled":false,
"sshIdleTimeout": 0,
"webIdleTimeout": 0,
"webMaxUsers": 0,
"deviceSequentialPowerUpDelay": 3,
"webApiPasswordEnabled": false,
"smtpServer": "",
"smtpPort": 0,
"smtpTlsEnabled": 0,
"smtpAuthRequired": 0,
"smtpUsername": "",
"syslogServerIp": "",
"enableRemoteUserLogging":false,
"enableRemoteEventLogging":false,
"smtpPassword": "",
"snmpv12Enabled": true,
"snmpv12ReadString": "public",
"snmpv12WriteString": "private",
"snmp3AuthPass": "examplepassword",
"snmp3PrivacyPass": "exampleprivacypass",
"snmp3TrapAuthProtocol": "SHA",
"snmp3TrapPrivacyProtocol": "AES",
"snmp3TrapSecurity": "authPriv",
"deviceName": "SynLink PDU",
"lcdOrientation": 90,
"lcdScreensaverTimeout": 60,
"lcdBacklightBrightness": 2,
"lcdScreensaverType": "power_info",
"lcdBackgroundColor": "black",
"lcdOutletControlEnabled": true,
"lcdNetworkControlEnabled": true,
"lcdRebootControlEnabled":false,
"lcdFlushControlEnabled":false,
"portAMode": "sensor",
"portAComBaud": 115200,
"portAModemBaud": 115200,
"usbComBaud": 115200,
"usbModemBaud":115200,
"usbFwupdateControlEnabled":false,
"daylightsavings": true,
"timezone": "GMT+8",
"customSslCertExists": false,
"customSslKeyExists": false
}
Device Settings
{
"deviceName": "Name for device not host name",
"globalRebootTime": 5
}
| Key | Type | Description |
|---|---|---|
| deviceName | string | Name for this PDU. Separate from hostname |
| globalRebootTime | number | Number of seconds the outlet is flipped before flipping back on a power cycle |
IP Settings
{
"macAddr": "80:1F:12:41:ED:28",
"ipAssign": "dhcp",
"staticIp": "192.168.1.100",
"subnetMask": "255.255.255.0",
"gatewayIp": "192.168.1.1",
"primaryDns": "8.8.8.8",
"secondaryDns": "8.8.4.4",
"hostName": "SP-3001CA-HA",
}
| Key | Type | Description |
|---|---|---|
| macAddr | string | Mac address string for network interface card |
| ipAssign | string | Either "dhcp" or "static" are valid strings. DHCP assignment will show IP through dhcpAssignedIp. Static IP is set with staticIp |
| staticIp | string | IP Address that the PDU will respond to if ipAssign is set to "static" |
| subnetMask | string | Subnet Mask that divides IP address into network address and host address |
| gatewayIp | string | IP Address of device on network which sends local network traffic to other networks |
| primaryDns | string | IP Address of Primary DNS Server |
| secondaryDns | string | IP Address of Secondary DNS Server |
| hostName | string | Label assigned to network connected device |
The following attributes only apply when "ip_assign" is set to dhcp and a DHCP address has been properly assigned.
{
"dhcpAssignedIp":"192.168.1.101",
"dhcpPrimaryDns":"8.8.8.8",
"dhcpSecondaryDns":"8.8.4.4",
"dhcpGatewayIp":"192.168.1.1",
"dhcpSubnetMask":"255.255.255.0",
}
| Key | Type | Description |
|---|---|---|
| dhcpAssignedIp | string | IP Address assigned by DHCP server. Only available is ipAssign is "dhcp" |
| dhcpPrimaryDns | string | Primary DNS assigned by DHCP server. Only available is ipAssign is "dhcp" |
| dhcpSecondaryDns | string | Secondary DNS by DHCP server. Only available is ipAssign is "dhcp" |
| dhcpGatewayIp | string | Gateway IP assigned by DHCP server. Only available is ipAssign is "dhcp" |
| dhcpSubnetMask | string | Subnet Mask assigned by DHCP server. Only available is ipAssign is "dhcp" |
Web Settings
{
"webEnabled": true,
"webPort": 80,
"webRedirectHttp": true,
"webSslEnabled": true,
"webSslPort": 443,
"webApiPasswordEnabled": false,
"customSslCertEnabled": false,
"customSslCertExists": false,
"customSslKeyExists": false
}
| Key | Type | Description |
|---|---|---|
| webEnabled | boolean | Turns on or off Webserver |
| webPort | number | Port to reach Webserver. Default port is 80 |
| webRedirectHttp | boolean | If true then any requests to http will be redirected to https |
| webSslEnabled | boolean | Enables web server on HTTPS. Uses webSslPort port |
| webSslPort | number | Port to reach HTTPS webserver. Default port is 443 |
| webApiPasswordEnabled | boolean | Enable or disable username-password access with every HTTP call. WARNING: Insecure |
| customSslCertEnabled | boolean | Set to true to use custom ssl cert and key instead of default. Requires customSslCertExists and customSslKeyExists to be true |
| customSslCertExists | boolean | true if user has successfully uploaded an SSL Certificate |
| customSslKeyExists | boolean | true if user has successfully uploaded an SSL Key |
SSH Settings
{
"sshEnabled": true,
"sshPort": 23,
"disableSshPassLogin": false,
"disableSshKeyLogin": false,
"sshIdleTimeout": 0,
}
| Key | Type | Description |
|---|---|---|
| sshEnabled | boolean | Turns on or off SSH Server |
| sshPort | number | Port to reach SSH Server. Default port is 22 |
| disableSshPassLogin | boolean | Disable or enable password based logins |
| disableSshKeyLogin | boolean | Disable or enable key based logins |
| sshIdleTimeout | number | Number of seconds before SSH server auto disconnects from idle connection |
Telnet Settings
{
"telnetEnabled": true,
"telnetPort": 23,
}
| Key | Type | Description |
|---|---|---|
| telnetEnabled | boolean | Turns on or off Telnet Server |
| telnetPort | number | Port to reach Telnet Server. Default port is 23 |
SNMP Settings
{
"snmpv12enabled": true,
"snmpv12ReadString": "example_read_string",
"snmpv12WriteString": "example_write_string",
"snmpv3Enable": true,
"snmpSysContact": "[email protected]",
"snmpSysName": "SP-3001CA-HA",
"snmpSysLocation": "Rack #4",
"snmp3AuthPass": "examplepassword",
"snmp3PrivacyPass": "exampleprivacypass",
"snmp3TrapAuthProtocol": "SHA",
"snmp3TrapPrivacyProtocol": "AES",
"snmp3TrapSecurity": "authPriv"
}
| Key | Type | Description |
|---|---|---|
| snmpv12enabled | boolean | Enable or disables SNMP v1/v2c agent. |
| snmpv12ReadString | string | Passphrase for reading from agent SNMP 1/v2c |
| snmpv12WriteString | string | Passphrase for writing to agent SNMP 1/v2c |
| snmpSysContact | string | Primary contact for PDU SNMP node |
| snmpSysName | string | Assigned name for PDU SNMP node |
| snmpSysLocation | string | Physical location for PDU SNMP node |
| snmp3AuthPass | string | Auth Pass for SNMPv3 Traps. Minimum 8 characters |
| snmp3PrivacyPass | string | Privacy Pass for SNMPv3 Traps. Minimum 8 characters |
| snmp3TrapAuthProtocol | string | Type of auth protocol options: "MD5" or "SHA" |
| snmp3TrapPrivacyProtocol | string | Type of privacy protocol options: "DES" or "AES" |
| snmp3TrapSecurity | string | Options: "authPriv", "authNoPriv", "noAuthNoPriv" |
SMTP Settings
{
"smtpServer": "smtp.gmail.com",
"smtpPort": 465,
"smtpTlsEnabled": true,
"smtpAuthRequired": true,
"smtpUsername": "example_username",
"smtpPassword": "example_password"
}
| Key | Type | Description |
|---|---|---|
| smtpServer | string | IP/Domain name for SMTP server |
| smtpPort | number | Port to reach SMTP Server |
| smtpTlsEnabled | boolean | Enable or disable TLS Authentication |
| smtpAuthRequired | boolean | Enable or disable passing authentication with SMTP messages. |
| smtpUsername | string | Username for SMTP authentication |
| smtpPassword | string | Password for SMTP authentication |
NTP & Time Settings
{
"ntpEnabled": true,
"ntpHost": "pool.ntp.org",
"daylightsavings": false,
"timeZone": "GMT+8"
}
| Key | Type | Description |
|---|---|---|
| ntpEnabled | boolean | Turns on or off NTP time synchronization. Requires network connection |
| ntpHost | string | NTP Host URL/IP to reference for time synchronization |
| daylightsavings | boolean | Enable or disable day light savings adjustment |
| timezone | string | Format: GMTXXX where XXX is between -12 to +12 for timezone offsets from GMT. Ex: GMT+8 for PST |
Remote Syslog Settings
{
"syslogServerIp": "",
"enableRemoteUserLogging":false,
"enableRemoteEventLogging":false,
}
| Key | Type | Description |
|---|---|---|
| syslogServerIp | string | Seting remote syslog server IP to send syslog messages |
| enableRemoteUserLogging | boolean | Enable or disable sending user activity logs to syslogServerIp |
| enableRemoteEventLogging | boolean | Enable or disable sending configured event triggers to syslogServerIp |
LCD Front Panel Settings
{
"lcdOrientation": 90,
"lcdScreensaverTimeout": 60,
"lcdBacklightBrightness": 2,
"lcdScreensaverType": "power_info",
"lcdBackgroundColor": "black",
"lcdOutletControlEnabled": true,
"lcdNetworkControlEnabled": true,
"lcdRebootControlEnabled":false,
"lcdFlushControlEnabled":false
}
| Key | Type | Description |
|---|---|---|
| lcdOutletControlEnabled | boolean | Allow controlling of outlet relays (if applicable) through front panel LCD |
| lcdNetworkControlEnabled | boolean | Allow changing of IP assignment/Address through front panel LCD |
| lcdRebootControlEnabled | boolean | Allows user to reboot the control module from the LCD interface (outlet states are unchanged) |
| lcdFlushControlEnabled | boolean | Allows user to flush logs and issue a graceful shutdown |
| lcdOrientation | number | Degrees to rotate screen. Options are 0, 90, 180, or 270 |
| lcdBacklightBrightness | string | Value between 0 and 7. 7 is brightest. |
| lcdScreensaverTimeout | number | Number of seconds before screensaver plays |
| lcdScreensaverType | string | Screensaver type. Options vary for each model. |
| lcdBackgroundColor | string | Options: black, navy, blue, teal, magenta, gray, maroon, purple, green, orange, navy, olive |
Port Settings
Port A can switch between Modem Mode, COM mode, and Sensor Mode. This port cannot be multiple modes at the same time.
COM mode will allow a serial connection to the SynLink Command Line Interface.
Sensor mode allows useage with sensor accessories.
Modem mode provides out of band access to a connected serial device, such as a modem. For example: connect a modem's serial port to the Port A serial port set to modem mode. Then from the SynLink CLI, use command "modem connect". You will now be able to use the modem's serial port.
{
"portAMode": "sensor",
"portAComBaud": 115200,
"portAModemBaud": 115200,
"usbComBaud": 115200,
"usbModemBaud":115200,
"usbFwupdateControlEnabled":false
}
| Key | Type | Description |
|---|---|---|
| portAMode | string | Options are: "sensor", "com", and "modem". COM will enable port for serial access. Modem will remote access to connected serial device. |
| portAModemBaud | number | Baud rate for RJ45 modem port for MODEM mode. Options are 1200, 2400, 4800, 9600, 19200, 38400, 57600 and 115200 |
| portAComBaud | number | Baud rate for RJ45 modem port for COM mode. Options are 1200, 2400, 4800, 9600, 19200, 38400, 57600 and 115200 |
| usbModemBaud | number | Baud rate for USB Port when a serial device is connected. Options are 1200, 2400, 4800, 9600, 19200, 38400, 57600 and 115200 |
| usbComBaud | number | Baud rate for USB-serial port labeled "COM". Options are 1200, 2400, 4800, 9600, 19200, 38400, 57600 and 115200 |
| usbFwupdateControlEnabled | boolean | Enable or Disable Power Sharing for Controller Power Redundancy |