1.0.2
This is a listing of all configurable keys for Tachyon Networks TNS-100 devices. API specs and examples can be found on Tachyon's API github page and additional usage tips can be found in the support site's API Guide article.
Management bridge MTU.
| Value type | int |
| Default | 9018 |
| Min value | 1280 |
| Max value | 9018 |
A short note/description for this interface.
| Value type | string |
| Default | |
| Min length | 0 |
| Max length | 32 |
Whether or not this interface is enabled.
| Value type | bool |
| Default | true |
The list of port isolation rules for this port.
| Value type | array of type: isolation_rule object |
| Min length | 0 |
| Max length | 5 |
Policy for this port isolation rule (block or allow). Setting allow for a port target is the same as removing the port isolation rule for that target.
| Value type | string |
| Allowed values | block, allow |
The port target (eth0, eth1, etc) for this isolation rule
| Value type | string |
| Allowed values | eth1, eth2, eth3, eth4, eth5 |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'access', excluding the mgmt VLAN.
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 1 |
Whether or not this port participates in the management VLAN (management VLAN Id is set under network.wan.management.vlan_id)
| Value type | bool |
| Default | true |
Policy type for the management VLAN (default for previous firmwares was trunk). This is used only when management is enabled on this port.
| Value type | string |
| Allowed values | trunk, access |
Policy type for the native VLAN 1, in the case when the mgmt vlan is not set to 1. Default was always 'trunk' in prev. firmwares.
| Value type | string |
| Allowed values | trunk, none |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'trunk', excluding the mgmt VLAN. If you don't wish to trunk VLAN 1, set native_vlan_policy to 'none'.
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 128 |
A short note/description for this interface.
| Value type | string |
| Default | |
| Min length | 0 |
| Max length | 32 |
Whether or not this interface is enabled.
| Value type | bool |
| Default | true |
The list of port isolation rules for this port.
| Value type | array of type: isolation_rule object |
| Min length | 0 |
| Max length | 5 |
Policy for this port isolation rule (block or allow). Setting allow for a port target is the same as removing the port isolation rule for that target.
| Value type | string |
| Allowed values | block, allow |
The port target (eth0, eth2, etc) for this isolation rule
| Value type | string |
| Allowed values | eth0, eth2, eth3, eth4, eth5 |
Whether or not to enable PoE out on this port.
| Value type | bool |
| Default | false |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'access', excluding the mgmt VLAN.
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 1 |
Whether or not this port participates in the management VLAN (management VLAN Id is set under network.wan.management.vlan_id)
| Value type | bool |
| Default | true |
Policy type for the management VLAN (default for previous firmwares was trunk). This is used only when management is enabled on this port.
| Value type | string |
| Allowed values | trunk, access |
Policy type for the native VLAN 1, in the case when the mgmt vlan is not set to 1. Default was always 'trunk' in prev. firmwares.
| Value type | string |
| Allowed values | trunk, none |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'trunk', excluding the mgmt VLAN. If you don't wish to trunk VLAN 1, set native_vlan_policy to 'none'.
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 128 |
A short note/description for this interface.
| Value type | string |
| Default | |
| Min length | 0 |
| Max length | 32 |
Whether or not this interface is enabled.
| Value type | bool |
| Default | true |
The list of port isolation rules for this port.
| Value type | array of type: isolation_rule object |
| Min length | 0 |
| Max length | 5 |
Policy for this port isolation rule (block or allow). Setting allow for a port target is the same as removing the port isolation rule for that target.
| Value type | string |
| Allowed values | block, allow |
The port target (eth1, eth3, etc) for this isolation rule
| Value type | string |
| Allowed values | eth0, eth1, eth3, eth4, eth5 |
Whether or not to enable PoE out on this port.
| Value type | bool |
| Default | false |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'access', excluding the mgmt VLAN.
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 1 |
Whether or not this port participates in the management VLAN (management VLAN Id is set under network.wan.management.vlan_id)
| Value type | bool |
| Default | true |
Policy type for the management VLAN (default for previous firmwares was trunk). This is used only when management is enabled on this port.
| Value type | string |
| Allowed values | trunk, access |
Policy type for the native VLAN 1, in the case when the mgmt vlan is not set to 1. Default was always 'trunk' in prev. firmwares.
| Value type | string |
| Allowed values | trunk, none |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'trunk', excluding the mgmt VLAN. If you don't wish to trunk VLAN 1, set native_vlan_policy to 'none'.
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 128 |
A short note/description for this interface.
| Value type | string |
| Default | |
| Min length | 0 |
| Max length | 32 |
Whether or not this interface is enabled.
| Value type | bool |
| Default | true |
The list of port isolation rules for this port.
| Value type | array of type: isolation_rule object |
| Min length | 0 |
| Max length | 5 |
Policy for this port isolation rule (block or allow). Setting allow for a port target is the same as removing the port isolation rule for that target.
| Value type | string |
| Allowed values | block, allow |
The port target (eth0, eth1, etc) for this isolation rule
| Value type | string |
| Allowed values | eth0, eth1, eth2, eth4, eth5 |
Whether or not to enable PoE out on this port.
| Value type | bool |
| Default | false |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'access', excluding the mgmt VLAN.
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 1 |
Whether or not this port participates in the management VLAN (management VLAN Id is set under network.wan.management.vlan_id)
| Value type | bool |
| Default | true |
Policy type for the management VLAN (default for previous firmwares was trunk). This is used only when management is enabled on this port.
| Value type | string |
| Allowed values | trunk, access |
Policy type for the native VLAN 1, in the case when the mgmt vlan is not set to 1. Default was always 'trunk' in prev. firmwares.
| Value type | string |
| Allowed values | trunk, none |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'trunk', excluding the mgmt VLAN. If you don't wish to trunk VLAN 1, set native_vlan_policy to 'none'.
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 128 |
A short note/description for this interface.
| Value type | string |
| Default | |
| Min length | 0 |
| Max length | 32 |
Whether or not this interface is enabled.
| Value type | bool |
| Default | true |
The list of port isolation rules for this port.
| Value type | array of type: isolation_rule object |
| Min length | 0 |
| Max length | 5 |
Policy for this port isolation rule (block or allow). Setting allow for a port target is the same as removing the port isolation rule for that target.
| Value type | string |
| Allowed values | block, allow |
The port target (eth0, eth1, etc) for this isolation rule
| Value type | string |
| Allowed values | eth0, eth1, eth2, eth3, eth5 |
Whether or not to enable PoE out on this port.
| Value type | bool |
| Default | false |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'access', excluding the mgmt VLAN..
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 1 |
Whether or not this port participates in the management VLAN (management VLAN Id is set under network.wan.management.vlan_id)
| Value type | bool |
| Default | true |
Policy type for the management VLAN (default for previous firmwares was trunk). This is used only when management is enabled on this port.
| Value type | string |
| Allowed values | trunk, access |
Policy type for the native VLAN 1, in the case when the mgmt vlan is not set to 1. Default was always 'trunk' in prev. firmwares.
| Value type | string |
| Allowed values | trunk, none |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'trunk', excluding the mgmt VLAN. If you don't wish to trunk VLAN 1, set native_vlan_policy to 'none'.
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 128 |
A short note/description for this interface.
| Value type | string |
| Default | |
| Min length | 0 |
| Max length | 32 |
Whether or not to enable 1G SFP support on this port. This change requires a reboot to take affect.
| Value type | bool |
| Default | false |
Whether or not this interface is enabled.
| Value type | bool |
| Default | true |
The list of port isolation rules for this port.
| Value type | array of type: isolation_rule object |
| Min length | 0 |
| Max length | 5 |
Policy for this port isolation rule (block or allow). Setting allow for a port target is the same as removing the port isolation rule for that target.
| Value type | string |
| Allowed values | block, allow |
The port target (eth0, eth1, etc) for this isolation rule
| Value type | string |
| Allowed values | eth0, eth1, eth2, eth3, eth4 |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'access', excluding the mgmt VLAN..
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 1 |
Whether or not this port participates in the management VLAN (management VLAN Id is set under network.wan.management.vlan_id)
| Value type | bool |
| Default | true |
Policy type for the management VLAN (default for previous firmwares was trunk). This is used only when management is enabled on this port.
| Value type | string |
| Allowed values | trunk, access |
Policy type for the native VLAN 1, in the case when the mgmt vlan is not set to 1. Default was always 'trunk' in prev. firmwares.
| Value type | string |
| Allowed values | trunk, none |
Array of VLAN IDs (2-4094) that this port has a policy type set to 'trunk', excluding the mgmt VLAN. If you don't wish to trunk VLAN 1, set native_vlan_policy to 'none'.
| Value type | array of type: vlan_id |
| Min length | 0 |
| Max length | 128 |
Whether or not STP is enabled.
| Value type | bool |
| Default | false |
Management network IP mode.
| Value type | string |
| Allowed values | static, dhcp |
| Default | dhcp |
Management network IPv4 DNS servers list, used when static ipv4 is enabled.
| Value type | array of type: ipv4addr |
| Min length | 0 |
| Max length | 2 |
Management network IPv4 enabled status; used as fallback when ip_mode is set to 'dhcp'.
| Value type | bool |
| Default | true |
Management network IPv4 gateway.
| Value type | ipv4addr |
Management network IPv4 address (used as a fallback when ip_mode is set to 'dhcp').
| Value type | ipv4addr |
| Default | 192.168.1.1 |
Management network IPv4 address prefix.
| Value type | int |
| Default | 24 |
| Min value | 1 |
| Max value | 32 |
Management network IPv6 DNS servers.
| Value type | array of type: ipv6addr |
| Min length | 0 |
| Max length | 2 |
Enable management network IPv6 addressing.
| Value type | bool |
| Default | false |
Management network IPv6 gateway. Empty strings are allowed when no gateway is specified.
| Value type | ipv6addr |
Enable management network IPv6 addressing.
| Value type | ipv6addr |
| Default | 2001::2 |
Management network IPv6 address prefix.
| Value type | int |
| Default | 64 |
| Min value | 1 |
| Max value | 128 |
This device's management VLAN ID. By default this is set to 1 (native VLAN).
| Value type | int |
| Default | 1 |
| Min value | 1 |
| Max value | 4094 |
Management bridge MTU.
| Value type | int |
| Default | 1500 |
| Min value | 1280 |
| Max value | 9018 |
A list of labels/names associated with the VLAN IDs on this device.
| Value type | array of type: vlan_label object |
| Min length | 0 |
| Max length | 128 |
The VLAN ID to which this label entry will apply.
| Value type | int |
| Min value | 1 |
| Max value | 4094 |
The VLAN label for this ID.
| Value type | string |
| Min length | 0 |
| Max length | 32 |
Enable broadcasting device info over CDP (Cisco Discovery Protocol).
| Value type | bool |
| Default | true |
Enable broadcasting device info over LLDP (Link Layer Discovery Protocol).
| Value type | bool |
| Default | true |
Enable broadcasting device info over MNDP (MikroTik Neighbor Discovery Protocol).
| Value type | bool |
| Default | true |
Enable device discovery general services.
| Value type | bool |
| Default | true |
Enable LLDP server in order to discover nearby devices. This is required for the discovery tool to function.
| Value type | bool |
| Default | true |
Web server HTTPS port.
| Value type | int |
| Default | 443 |
| Min value | 1 |
| Max value | 65535 |
Web server HTTP port.
| Value type | int |
| Default | 80 |
| Min value | 1 |
| Max value | 65535 |
Enable Network Time Protocol (NTP).
| Value type | bool |
| Default | true |
List NTP servers.
| Value type | array of type: hostname |
| Min length | 1 |
| Max length | 2 |
List of IPv4/6 address(es) to attempt to ping
| Value type | array of type: ipv4addr_or_ipv6addr |
| Min length | 1 |
| Max length | 2 |
Enable ping watchdog.
| Value type | bool |
| Default | false |
How many consecutive ping failures should trigger a device reboot
| Value type | int |
| Min value | 2 |
| Max value | 10 |
How often in seconds to attempt to ping specified address(es).
| Value type | int |
| Min value | 5 |
| Max value | 300 |
How long in seconds to wait before starting ping watchdog at bootup
| Value type | int |
| Default | 300 |
| Min value | 60 |
| Max value | 300 |
Enable remote syslog.
| Value type | bool |
| Default | false |
Remote syslog port.
| Value type | int |
| Min value | 1 |
| Max value | 65535 |
Remote syslog protocol.
| Value type | string |
| Allowed values | tcp, udp |
Remote syslog server.
| Value type | hostname |
SNMPv2 community string.
| Value type | string |
| Default | public |
| Min length | 1 |
| Max length | 100 |
Enable SNMPv2 (read-only).
| Value type | bool |
| Default | true |
Enable SNMPv3 (read-only).
| Value type | bool |
| Default | true |
SNMPv3 password.
| Value type | string |
| Min length | 8 |
| Max length | 32 |
SNMPv3 username.
| Value type | string |
| Min length | 1 |
| Max length | 100 |
SNMPv2 community string.
| Value type | string |
| Min length | 1 |
| Max length | 100 |
Enable SNMP traps.
| Value type | bool |
| Default | false |
SNMPv3 password.
| Value type | string |
| Min length | 8 |
| Max length | 32 |
SNMP protocol version.
| Value type | string |
| Allowed values | 2, 3 |
| Default | 2 |
SNMP traps server.
| Value type | hostname |
SNMPv3 username.
| Value type | string |
| Min length | 1 |
| Max length | 100 |
Web UI authentication method. Default value is 'local' to use the local user database.
| Value type | string |
| Allowed values | local, radius |
| Default | local |
The RADIUS AA port used when authenticating web UI users.
| Value type | int |
| Default | 1812 |
| Min value | 1 |
| Max value | 65535 |
The RADIUS AA serret used when authenticating web UI users.
| Value type | string |
| Min length | 1 |
| Max length | 64 |
The RADIUS AA server used when authenticating web UI users.
| Value type | hostname |
This device's description.
| Value type | string |
| Min length | 0 |
| Max length | 32 |
This device's location.
| Value type | string |
| Default | |
| Min length | 0 |
| Max length | 100 |
This device's name.
| Value type | string |
| Default | Tachyon Networks PtMP |
| Min length | 1 |
| Max length | 30 |
System hostname.
| Value type | hostname |
| Default | tachyon-networks |
Enable this device's physical reset button.
| Value type | bool |
| Default | true |
System timezone name. This follows standard time zone naming from http://timezonedb.com/. This applies to advanced timezones as well.
| Value type | timezone |
| Default | America/Los_Angeles |
Whether or not to enable advanced timezones with DST support.
| Value type | bool |
| Default | false |
System users.
| Value type | array of type: user object |
| Min length | 1 |
| Max length | 20 |
User's login name.
| Value type | string |
| Min length | 1 |
| Max length | 24 |
User's type.
| Value type | string |
| Allowed values | admin, read-only |
User's MD5 hashed password.
| Value type | string |
| Min length | 34 |
| Max length | 34 |
Whether this user is enabled or not.
| Value type | bool |