Command line interface
Naming and parameter conventions
Actions
Every command executes a so-called action describing the functionality of the command. The following table provides an overview of actions that may occur:
Table: CLI commands
Action | Function | Example |
---|---|---|
set | Set parameter values | eth vlan verify set 1 on |
show | Show parameter values. The action may accept one or more optional parameters | rstp port show |
help | Show a help string for specific (sub)command | rstp port help |
add | Adding a value to a set of values e.g. adding a port to a port map. | eth mactab mac add 00:11:22:33:44:55 1 |
rem | Removing a value from a set of values e.g. removing a port from a port map. | eth mactab mac rem 00:11:22:33:44:55 1 |
Not all commands implement all actions.
Command parameter conventions
Integer values
Integer values are currently only accepted with a base of 10 and may optionally contain a sign.
As an example, the following command sets the port membership of port 1 to VLAN 1024:
$ eth vlan port add 1 1024
Strings
Strings are started and ended with a "-character. As an example, the following command sets the value of config variable 0-1 to value "example"
$ cm set 0 1 "example"
Ports
Ports are entered as integer values starting with 0 up to max. port number + 1. Max. port number +1 represents the management port. A 5 port switch provides ports 0 – 3 (external ports) and port 4 as management port.
For example, the following commands set the default VLAN tag for port 1 to 1024 with prio 7:
$ eth vlan default set 1 1024 7
MAC addresses
MAC addresses are given in the format xx:xx:xx:xx:xx:xx where xx stands for a two char hex number. For example, the following command adds port 3 to MAC address 00:11:22:33:44:55
$ eth mactab mac add 00:11:22:33:44:55 3
IP addresses
IP addresses are given in the format xxx.xxx.xxx.xxx where xxx stands for a one- to three-digit decimal number. For example, the following command sets the IP address, netmask and gateway for the TCP/IP stack:
$ net ip set 192.168.1.133 255.255.255.0 0.0.0.0
Ethernet Interface
The eth command provides an interface to Ethernet interface including access to VLAN configuration, Ethernet statistics, ...
VLAN
The VLAN subgroup provides an interface for configuring the VLAN capabilities of the underlying switch.
Table: description of eth vlan mode in set
Command | eth vlan mode in set <port> <ptrover | replace | tag | disable> | |
---|---|---|
Description | Sets the input mode of the VLAN processing. | |
Parameter | <port> | The port as number starting from 0 for the first port |
<ptrover | replace | tag | disable> | The VLAN input processing mode to set:
|
Table: description of eth vlan mode in show
Command | eth vlan mode in show [port] | |
---|---|---|
Description | Shows the input of the given port or all ports if no port is given | |
Parameter | [port] | The optional port where the input mode shall be shown. |
Table: description of eth vlan mode out set
Command | eth vlan mode out set <port> <tagthr | domain | strip | disable> | |
---|---|---|
Description | Sets the output mode of the VLAN processing. | |
Parameter | <port> | The port as number starting from 0 for the first port |
<tagthr | domain | strip | disable> | The VLAN input processing mode to set:
|
Table: description of eth vlan mode out show
Command | eth vlan mode out show [port] | |
---|---|---|
Description | Shows the output processing mode of the given port or all ports if no port is given | |
Parameter | [port] | The optional port where the output mode shall be shown. |
Table: description of eth vlan port add
Command | eth vlan port add <port> <vlanid> | |
---|---|---|
Description | Adds a port as a member of the given VLAN id. | |
Parameter | <port> | The port as number starting from 0 for the first port |
<vlanid> | The VLAN id where the port shall become a member. |
Table: description of eth vlan port rem
Command | eth vlan port rem <port> <vlanid> | |
---|---|---|
Description | Removes a port as a member from the given VLAN id. | |
Parameter | <port> | The port as number starting from 0 for the first port |
<vlanid> | The VLAN id where the port shall be removed from. |
Table: description of eth vlan table show
Command | eth vlan table show |
---|---|
Description | Shows the entries of the VLAN table. |
Parameter | None |
Table: description of eth vlan default set
Command | eth vlan default set <port> <vlanid> <prio> | |
---|---|---|
Description | Sets the default VLAN id and priority for a port. | |
Parameter | <port> | The port as number starting from 0 for the first port |
<vlanid> | The default VLAN id for the port. | |
<prio> | The priority ranging from 0 – 7. |
Table: description of eth vlan default show
Command | eth vlan default show [port] | |
---|---|---|
Description | Shows the default VLAN settings of the given port or all ports if no port is given | |
Parameter | [port] | The optional port where the default VLAN settings shall be shown. |
Table: description of eth vlan verify set
Command | eth vlan verify set <port> <on | off> | |
---|---|---|
Description | Enables/disables the VLAN domain verification for the given port. | |
Parameter | <port> | The port as number starting from 0 for the first port |
<on | off> |
|
Table: description of eth vlan verity show
Command | eth vlan verify show [port] | |
---|---|---|
Description | Shows the VLAN verification settings of the given port or all ports if no port is given. | |
Parameter | [port] | The optional port where the VLAN verification settings shall be shown. |
Table: description of eth vlan discunknown set
Command | eth vlan discunknown set <port> <on | off> | |
---|---|---|
Description | Enabled/disables the discarding of frames with unknown VLAN ids. | |
Parameter | <port> | The port as number starting from 0 for the first port |
<on | off> |
|
Table: description of eth vlan discunknown show
Command | eth vlan discunknown show [port] | |
---|---|---|
Description | Shows the unknown VLAN discarding settings of the given port or all ports if no port is given | |
Parameter | [port] | The optional port where the VLAN discarding settings shall be shown. |
MAC table
The MAC table subgroup provides an interface to the MAC table settings and allows to access specific MAC table entries.
Table: description of eth mactab conf set
Command | eth mactab conf set <ageing | migration | discunknown | pervlan> <on | off> | |
---|---|---|
Description | Enabled/disables the given feature of the the MAC table. | |
Parameter | <learning | ageing | migration | discunknown | pervlan> | The feature setting to change:
|
<on | off> |
|
Table: description of eth mactab conf show
Command | eth mactab conf show |
---|---|
Description | Shows the state of the different MAC table configuration settings. |
Parameter | None |
Table: description ofeth mactab mac add
Command | eth mactab mac add <mac> <port> | |
---|---|---|
Description | Adds the given port to the port map of the given MAC address. If the MAC address is not yet in the table, it is added as a static MAC address. Both, unicast and multicast MAC addresses are accepted. | |
Parameter | <mac> | The MAC address where the port shall be added to. The address is given in the format xx:xx:xx:xx:xx:xx |
<port> | The port as number starting from 0 for the first port. |
Table: description of eth mactab mac rem
Command | eth mactab mac rem <mac> <port> | |
---|---|---|
Description | Removes the given port from the port map of the given MAC address. If the MAC address does not contain any more ports after command execution, it is removed from the MAC table. Both, unicast and multicast MAC addresses are accepted. | |
Parameter | <mac> | The MAC address where the port shall be removed from. The address is given in the format xx:xx:xx:xx:xx:xx |
<port> | The port as number starting from 0 for the first port. |
Table: description of eth mactab mac show
Command | eth mactab mac show <mac> | |
---|---|---|
Description | Shows the port map for the given MAC address. | |
Parameter | <mac> | The MAC address where the port map shall be shown. The address is given in the format xx:xx:xx:xx:xx:xx |
Table: description of eth mactab mac clear
Command | eth mactab mac clear <static | dynamic | all> | |
---|---|---|
Description | Deletes the MAC table. | |
Parameter | <static | dynamic | all> | The following part of the MAC table is cleared:
|
Denial of Service Prevention
This command group provides an interface to TX as well as broadcast and multicast rate limiting.
Table: description of eth dos txrate set
Command | eth dos txrate set <port> <limit> | |
---|---|---|
Description | Sets the maximum allowed TX rate in percent. | |
Parameter | <port> | The port as number starting from 0 for the first port. |
<limit> | The max. allowed TX rate in percent. |
Table: description of eth dos txrate show
Command | eth dos txrate show [port] | |
---|---|---|
Description | Sets the maximum allowed TX rate in percent for the given port. If no port is given, the TX rates for all ports are shown. | |
Parameter | [port] | The optional port as number starting from 0 for the first port where the TX rate shall be shown. |
Table: description of eth dos timebase set
Command | eth dos timebase set <timebase> | |
---|---|---|
Description | Sets the time frame for broadcast/multicast rate limiting in ms. A timebase of 0 disables the rate limiting. | |
Parameter | <timebase> | The time base in ms. |
Table: description of eth dos timebase show
Command | eth dos timebase show |
---|---|
Description | Shows the time frame for broadcast/multicast rate limiting in ms. A timebase of 0 means that rate limiting is disabled. |
Parameter | None |
Table: description of eth dos mlimit set
Command | eth dos mlimit set <limit> | |
---|---|---|
Description | Sets the rate limiting for multicast frames. The limit is interpreted as <limit> per <timebase>. The time base is set per eth dos timebase set command. | |
Parameter | <limit> | The limit in number of frames. |
Table: description of eth dos mlimit show
Command | eth dos mlimit show |
---|---|
Description | Shows the rate limiting for multicast frames. The limit is interpreted as <limit> per <timebase>. |
Parameter | None |
Table: description of eth dos blimit set
Command | eth dos blimit set <limit> | |
---|---|---|
Description | Sets the rate limiting for broadcast frames. The limit is interpreted as <limit> per <timebase>. The time base is set per eth dos timebase set command. | |
Parameter | <limit> | The limit in number of frames. |
Table: description of eth dos blimit show
Command | eth dos blimit show |
---|---|
Description | Shows the rate limiting for broadccast frames. The limit is interpreted as <limit> per <timebase>. |
Parameter | None |
Port settings
Table: description of eth port link show
Command | eth port link show [port] | |
Description | Shows the link state of the given port. If no port is given, link state of all ports is shown. | |
Parameter | [port] | The port as number starting from 0 for the first port |
Table: description of eth port adstate set
Command | eth port adstate set <port> <on|off> | |
Description | Sets the admin state of the given port. | |
Parameter | <port> | The port as number starting from 0 for the first port. |
<on|off> | Admin state of the port:
|
Table: description of eth port adstate show
Command | eth port adstate show [port] | |
Description | Shows the port admin state of the given port. If no port is given, port state of all ports is shown. | |
Parameter | [port] | The port as number starting from 0 for the first port |
Table: description of eth port speed show
Command | eth port speed show [port] | |
Description | Shows the port state of the given port. If no port is given, port state of all ports is shown. | |
Parameter | [port] | The port as number starting from 0 for the first port |
Table: description of eth port duplex show
Command | eth port duplex show [port] | |
Description | Shows the duplex mode of the given port. If no port is given, duplex mode of all ports is shown. | |
Parameter | [port] | The port as number starting from 0 for the first port |
Table: description of eth port mirror set
Command | eth port mirror set <port> <<portmap> | <mac>> <ida | insa | eda | inda | eport | inport> | |
Description | Sets mirror mode of port | |
Parameter | [port] | The port as number starting from 0 for the first port. |
| <<portmap> | <mac>> | Either port map or MAC address for mirrored ports. |
<eda | esa | inda | insa | eport | inport> | The port mirror mode.
|
Table: description of eth port mirror show
Command | eth port mirror show [port] | |
Description | Shows the mirror mode of the given port. If no port is given, mirror mode of all ports is shown. | |
Parameter | [port] | The port as number starting from 0 for the first port |
Table: description of eth port mdi state show
Command | eth port mdi state show [port] | |
Description | Shows the port MDI state of the given port. If no port is given, the state of all ports is shown. | |
Parameter | [port] | The port as number starting from 0 for the first port |
Table: description of eth port mdi state set
Command | eth port mdi state set <port> <default | uncrossed | crossed> | |
Description | Set the port MDI state of the given port. | |
Parameter | <port> | The port as number starting from 0 for the first port |
<default | uncrossed | crossed> | The MDI state:
|
Table: description of eth port mdi mode show
Command | eth port mdi mode show [port] | |
Description | Shows the port MDI mode of the given port. If no port is given, the mode of all ports is shown. | |
Parameter | [port] | The port as number starting from 0 for the first port |
Table: description of eth port mdi mode set
Command | eth port mdi mode set <port> <default | auto | manual> | |
Description | Set the port MDI mode of the given port. | |
Parameter | <port> | The port as number starting from 0 for the first port |
<default | auto | manual> | The MDI mode:
|
QoS Settings
Table: description of eth qos mode set
Command | eth qos mode set <port> <etype | mac | ip | vlan> <on | off> | |
Description | Enables/disable the different QoS priority resolution modes for the given port. All modes may be active. | |
Parameter | <port> | The port as number starting from 0 for the first port. |
<etype | mac | ip | vlan> | The priority type to use:
| |
<on | off> | Enables/disables the mode:
|
Table: description of eth qos mode show
Command | eth qos mode show [port] | |
Description | Shows the QoS priority resolution mode of the given port. If no port is given, the mode of all ports is shown. | |
Parameter | [port] | The port as number starting from 0 for the first port |
Table: description of eth qos defprio set
Command | eth qos defprio set <port> <defprio> | |
Description | Sets the default priority for a frame if none of the active QoS priority resolution modes for the given port provides a resolution. | |
Parameter | <port> | The port as number starting from 0 for the first port. |
<defprio> | The default priority. Valid ranges may differ depending on the underlying hardware. |
Table: description of eth qos defprio show
Command | eth qos defprio show [port] | |
Description | Shows the default priority of the given port. If no port is given, the priority of all ports is shown. | |
Parameter | [port] | The port as number starting from 0 for the first port |
Table: description of eth qos vlanprio set
Command | eth qos vlanprio set <port> <vlanprio> <mapping> | |
Description | Sets the VLAN priority for the given port. | |
Parameter | <port> | The port as number starting from 0 for the first port. |
<vlanprio> | The VLAN priority to map. | |
<mapping> | The priority to which the VLAN priority is mapped to. |
Table: description of eth qos vlanprio show
Command | eth qos vlanprio show [port] | |
Description | Shows the priority mapping of the given port. If no port is given, the mapping of all ports is shown. | |
Parameter | [port] | The port as number starting from 0 for the first port |
Config Manager
The cm command provides a CLI interface to the GOAL config manager. It allows the manipulation of existing variables and is able to show the current values of variables.
Table: description of cm set
Command | cm set <modid> <varid> <newval> | |
Description | Sets the value of an existing variable in the config manager. | |
Parameter | <modid> | The module id of the variable to set |
<varid> | The variable id of the variable to set | |
<newval> | The new value to set. Integer values are entered as is with an optional sign. String values begin and end with "-character. |
Table: description of cm show
Command | cm show [<modid> <varid>] | |
Description | Shows the variable identified by given module and variable id or all variables if no ids are given. | |
Parameter | <modid> | The module id of the variable to set |
<varid> | The variable id of the variable to set |
Network Interface
The network interface command group provides access to general network settings e.g. settings for the TCP/IP stack.
IP Settings
The ip sub command provides access to settings of the underlying TCP/IP stack.
Table: description of net ip set
Command | net ip set <ip> <netmask> <gateway> | |
Description | Sets the IP address, the netmask and the default gateway of the underlying TCP/IP stack. | |
Parameter | <ip> | The new IP address in the format xxx.xxx.xxx.xxx |
<netmask> | The new netmask in the format xxx.xxx.xxx.xxx | |
<gateway> | The new default gateway in the format xxx.xxx.xxx.xxx |
Table: description of net ip show
Command | net ip show |
Description | Shows the current IP settings of the underlying TCP/IP stack. |
Parameter | None |