Basic Interface Functions

1. Function Overview

Here we explain the basic interface functions of this product.

2. Definition of Terms Used

None

3. Function Details

3.1. Interface types

This product can handle the five interface types shown in the table below.

Interface types Interface ID Explanation

LAN port

port

This is a physical port of this product.
It can be classified into a fixed LAN port and a removable SFP port.
This interface is expressed as port followed by “stack ID” + “.” + “port number printed on the chassis.”

Specifying LAN port #1: port1.1

SFP+ port

SFP28 port

QSFP28 port

VLAN interface

vlan

This is a User-defined VLAN.
This interface is expressed as vlan followed by “VLAN ID”.
Specifying VLAN1: vlan1

Static logical interface

sa

This is the User-defined link aggregation.
Multiple LAN/SFP ports can be grouped together and used as one interface.
This interface is expressed as “sa” or “po,” followed by “logical link ID.”

Specifying the LACP logical interface for logical link ID #1: po1

LACP logical interface

po

3.2. Interface control

The interface on this product can be controlled as shown in the table below.

  • Interface control items

    Control items Commands Explanation

    Set description

    description

    Sets the description text for the applicable interface.

    Enable/disable

    shutdown

    Enables/disables the interface.

    Communication speed/communication mode

    speed-duplex

    Sets the communication speed and communication mode for the interface. (Select from the following values.)
    - Auto negotiation
    - 25Gbps / Full duplex
    - 10Gbps / Full duplex
    - 100Mbps / Full duplex

    Auto negotiation type

    negotiation

    Sets the communication type supported by auto negotiation for the interface. (Select from the following values.)
    - 10Gbps / Full duplex
    - 5Gbps / Full duplex
    - 2.5Gbps / Full duplex
    - 1Gbps / Full duplex
    - 100Mbps / Full duplex

    FEC

    fec

    Configures whether to use FEC (Forward Error Correction).

    MRU

    mru

    Sets the maximum frame size that can be received by the interface, within a range of 64–10,240 bytes.

    Cross/straight automatic detection
    (Auto MDI/MDI-X function)

    mdix

    Automatically detects the port type (MDI or MDI-X) of the connected port and the cable type (cross or straight). This function gives the ability to interconnect without dependency.

    Speed downshift

    -

    This function automatically reduces the communication speed and attempts to establish a link.
    This function is always enabled for LAN ports. (Cannot be disabled.)

    EEE

    eee

    Sets whether to use the energy saving technology for Ethernet (EEE: Energy Efficient Ethernet).
    This is standard for IEEE 802.3az.

Command control of the interface is performed as shown on the table below.

  • Interface control functionality chart

    Interface name Set description Enable/disable Communication speed/communication mode Auto negotiation type FEC MRU Cross/straight automatic detection EEE

    LAN port

    Yes

    Yes

    Yes

    Yes

    No

    Yes

    Yes

    Yes

    SFP+ port

    Yes

    Yes

    Yes

    No

    No

    Yes

    No

    No

    SFP28 port

    Yes

    Yes

    Yes

    No

    Yes (*1)

    Yes

    No

    No

    QSFP28 port

    Yes

    Yes

    Yes

    No

    Yes

    Yes

    No

    No

    VLAN interface

    Yes

    No

    No

    No

    No

    No

    No

    No

    Static logical interface

    Yes

    Yes

    No

    No

    No

    No

    No

    No

    LACP logical interface

    Yes

    Yes

    No

    No

    No

    No

    No

    No

  • Communication speed/communication mode compatibility table

    Communication speed/communication mode LAN port SFP+ port SFP28 port QSFP28 port

    Auto negotiation

    Yes

    Yes

    Yes

    Yes

    25Gbps / Full duplex

    No

    -

    Yes (*2)

    -

    10Gbps / Full duplex

    No

    Yes (*3)

    -

    -

    5Gbps / Full duplex

    No

    -

    -

    -

    2.5Gbps / Full duplex

    No

    -

    -

    -

    1Gbps / Full duplex

    No

    -

    -

    -

    100Mbps / Full duplex

    Yes

    -

    -

    -

1 When an SFP/SFP+ module is connected to an SFP28 port, *FEC is disabled.
2 When an SFP+ module is connected to an SFP28 port, it operates *at 10 Gbps/full duplex, and when an SFP module is connected, it operates at 1 Gbps/full duplex.
3 When an SFP module is connected to an SFP+ port, it operates at *1 Gbps/full duplex.

3.3. LAN/SFP port defaults

The product LAN/SFP ports are in the following state given default settings.

  • All LAN/SFP ports function as access ports (ports that handle untagged frames), and belong to the default VLAN (VLAN #1).

  • The following functions are enabled for the default VLAN (VLAN #1) to which all LAN/SFP ports belong.

    • MSTP：Multiple Spanning Tree Protocol

    • IGMP Snooping

    • IPv4 address (192.168.100.240/24)

    • Access from a Telnet client

    • Access from a web client

3.4. Port mirroring

This product provides a port mirroring function, which copies the data traffic from a selected LAN/SFP port to another specified port.
The communication status can be analyzed by collecting the copied packets.
The product enables specifying up to one sniffer port.
The monitoring direction (send/receive, send only, or receive only) can be selected for monitored ports.
The mirror command can be used to set the port mirroring.
The port mirroring setting is disabled in default settings.

3.5. Frame counter

This product counts the number of frames transmitted/received for each LAN/SFP port. (This is called a “frame counter”.)
To reference the frame counter, use the show frame counter command.
The table below shows the display items for the frame counter and their maximum values.

  • Received frame counter display items

    Display item Explanation Maximum value

    Octets

    Number of octets received

    18,446,744,073,709,551,615

    Packets (*1)

    Number of received packets

    18,446,744,073,709,551,615

    Broadcast packets (*2)

    Number of broadcast packets received

    18,446,744,073,709,551,615

    Multicast packets (*2)

    Number of multicast packets received

    18,446,744,073,709,551,615

    Unicast packets (*2)

    Number of unicast packets received

    18,446,744,073,709,551,615

    Undersize packets (*2)

    Number of undersize packets received (packets smaller than 64 octets)

    18,446,744,073,709,551,615

    Oversize packets (*2)

    Number of oversize packets received (packets larger than 1,523 octets (*3))

    18,446,744,073,709,551,615

    Fragments (*2)

    Number of fragment packets received (packets smaller than 64 octets with abnormal CRC)

    18,446,744,073,709,551,615

    Jabbers (*2)

    Number of jabber packets received (packets larger than 1,523 octets with abnormal CRC (*3))

    18,446,744,073,709,551,615

    FCS errors (*2)

    Number of FCS error packets received

    18,446,744,073,709,551,615

    RX errors

    Number of reception errors

    18,446,744,073,709,551,615

    Drop packets (*4)

    Number of packets dropped from the reception buffer

    18,446,744,073,709,551,615

    (*1) : The packet value is the total of the (*2) packets.
    (*3): This will change, depending on the MRU that is set for the LAN/SFP port.
    (*4): This is shown only if tail drop is disabled.

  • Transmitted frame counter display items

    Display item Explanation Maximum value

    Octets

    Number of octets transmitted

    18,446,744,073,709,551,615

    Packets (*1)

    Number of packets transmitted

    18,446,744,073,709,551,615

    Broadcast packets (*2)

    Number of broadcast packets transmitted

    18,446,744,073,709,551,615

    Multicast packets (*2)

    Number of multicast packets transmitted

    18,446,744,073,709,551,615

    Unicast packets (*2)

    Number of unicast packets received

    18,446,744,073,709,551,615

    TX errors

    Number of transmission errors

    18,446,744,073,709,551,615

    Collisions

    Number of collision occurrences

    18,446,744,073,709,551,615

    Drop Packets(*3)

    Number of tail-dropped transmission packets

    18,446,744,073,709,551,615

    (*1) : The packet value is the total of the (*2) packets.
    (*3): This is shown only if tail drop is enabled.

  • Transmitted/received frame counter display items

    Display item Explanation Maximum value

    64 octet packets

    Number of packets with 64 octet length transmitted/received

    18,446,744,073,709,551,615

    65–127 octet packets

    Number of packets with 65–127 octet length transmitted/received

    18,446,744,073,709,551,615

    128–255 octet packets

    Number of packets with 128–255 octet length transmitted/received

    18,446,744,073,709,551,615

    256–511 octet packets

    Number of packets with 256–511 octet length transmitted/received

    18,446,744,073,709,551,615

    512–1,023 octet packets

    Number of packets with 512–1,023 octet length transmitted/received

    18,446,744,073,709,551,615

    1,024 to MAX octet packets

    Number of packets with 1,024–maximum octet length (*1) transmitted/received

    18,446,744,073,709,551,615

(*1): This will change, depending on the MRU that is set for the LAN/SFP port.

The frame counter can also be cleared by using the clear counters command.

When you execute the show interface command which shows the status of the LAN/SFP ports, information on the number of transmitted and received frames is shown, but this information is shown based on the frame counter information.
The number of frames transmitted/received that is displayed using the show interface command and how the frame counter is handled are shown below.

  • Number of frames transmitted/received that is displayed by the show interface command, and how the frame counter is handled

    Display item Information on the frame counter referred to

    input

    packets

    Received frame counter packets

    bytes

    Received frame counter octets

    multicast packets

    Received frame counter multicast packets

    drop packets(*1)

    Received frame counter drop packets

    output

    packets

    Transmitted frame counter packets

    bytes

    Transmitted frame counter octets

    multicast packets

    Transmitted frame counter multicast packets

    broadcast packets

    Transmitted frame counter broadcast packets

    drop packets(*1)

    Transmitted frame counter drop packets

    (*1): If tail drop is enabled this shows only the transmission information; if it is disabled this shows only the reception information.

3.6. SFP module optical receive level monitoring

This product provides the light-receiving level monitoring function for SFP/SFP+/SFP28/QSFP28 modules connected to the SFP+/SFP28/QSFP28 port.
If a fault occurs in an SFP/SFP+/SFP28/QSFP28 module’s optical receive level, this product’s port lamp indications change to a dedicated state, and a SYSLOG message is output.
When the optical receive level returns to the normal range, this product’s port lamp indications will recover, and a SYSLOG message is output.
The SYSLOG message is not output when the corresponding port is linked down.
The SFP/SFP+/SFP28/QSFP28 module’s optical receive level monitoring settings can be made using the sfp-monitor command.
By default, SFP module optical receive level monitoring is enabled.

3.7. Tx queue usage monitoring

If the transmit queue’s usage ratio becomes high (above 60%, above 100%), a SYSLOG message is output.
A SYSLOG message is also output when the transmit queue’s usage ratio returns to the normal range (below 50%).
The tx queue usage monitoring setting (for the entire system or individual LAN/SFP ports) can be set using the tx-queue-monitor command.
All tx queue usage monitoring settings are enabled in default settings.

4. ifIndex Assignment

ifIndex is an ID number linked to the interface and used by SNMP, DHCP, etc.
It is assigned as indicated in the table below.

Range of ifIndex Interface assignment Assignment rule Example

301 - 4394

VLAN interface

ifIndex = 300 + VLAN ID

301: vlan1
4394: vlan4094

4501 - 4596

Static logical interface

ifIndex = 4500 + static logical interface number

4501: sa1
4596: sa96

4601 - 4727

LACP logical interface

ifIndex = 4600 + LACP logical interface number

4601: po1
4727: po127

5001 - 6050

LAN/SFP port

ifIndex = 4000 + 1000 × stack ID + port number

5001: port1.1
6001: port2.1
6050: port2.50

5. Related Commands

Related commands are indicated below.
For details on the commands, refer to the Command Reference.

  • Basic interface functions: list of related commands

    Operations Operating commands

    Set description

    description

    Shutdown

    shutdown

    Set communication speed and communication mode

    speed-duplex

    Auto-negotiation type setting

    negotiation

    Forward error correction setting

    fec

    Set MRU

    mru

    Set cross/straight automatic detection

    mdix auto

    Set EEE

    eee

    Show EEE capabilities

    show eee capabilities

    Show EEE status information

    show eee status

    Set port mirroring

    mirror

    Show port-mirroring status

    show mirror

    Show interface status

    show interface

    Show simplified interface status

    show interface brief

    Show auto-negotiation information

    show interface negotiation

    Show frame counter

    show frame-counter

    Clear frame counters

    clear counters

    Show SFP/SFP+ status

    show ddm status

    Set SFP module optical receive level monitoring

    sfp-monitor rx-power

    Set tx queue usage monitoring setting (system)

    tx-queue-monitor usage-rate

    Set tx queue usage monitoring setting (LAN/SFP ports)

    tx-queue-monitor usage-rate

    Show the tx queue usage monitoring setting

    show tx-queue-monitor

    Resets interface

    interface reset

6. Examples of Command Execution

6.1. Basic LAN port settings

Some examples of basic LAN port settings are shown below.
For details on how to make the settings, refer to the Command Reference.

  • Set the description text for LAN port #1 (port1.1).

    Yamaha(config)#interface port1.1
Yamaha(config-if)#description Connected to rtx1200-router

  • Disable LAN port #1 (port1.1).

    Yamaha(config)#interface port1.1
Yamaha(config-if)#shutdown

  • Enable LAN port #1 (port1.1).

    Yamaha(config)#interface port1.1
Yamaha(config-if)#no shutdown

  • Set the communication speed and communication mode for LAN port #1 (port1.1) to 100Mbps/Full.

    Yamaha(config)#interface port1.1
Yamaha(config-if)#speed-duplex 100-full

6.2. Set port mirroring

In this example, we will set LAN port #1 to monitor the frames transmitted by LAN port #4 and the frames transmitted by LAN port #5.
The roles of the ports are shown below.

  • Sniffer port: LAN port #1 (port1.1)

  • Monitored port: LAN port #4 (port1.4), LAN port #5 (port1.5)

    1. Specifies the monitored port for LAN port #1 (port 1.1), which is a sniffer port.

      Yamaha(config)#interface port1.1
Yamaha(config-if)#mirror interface port1.4 direction both (1)
Yamaha(config-if)#mirror interface port1.5 direction transmit (2)
      1 Monitor transmitted and received frames
      2 Monitor transmitted frames

    2. Checks the port mirroring setting.

      Yamaha#show mirror
Sniffer Port   Monitored Port  Direction
=============  ==============  ==========
port1.1        port1.4         both
port1.1        port1.5         transmit

6.3. Show LAN/SFP port information

  • Confirm the status of LAN port #1 (port1.1).

    Yamaha#show interface port 1.1
Interface port1.1
  Link is UP
  Hardware is Ethernet
  HW addr: 00a0.deae.b89f
  Description: Connected to router
  ifIndex 5001, MRU 1522
  Speed-Duplex: auto(configured), 1000-full(current)
  Auto MDI/MDIX: on
  Vlan info :
    Switchport mode        : access
    Ingress filter         : enable
    Acceptable frame types : all
    Default Vlan           :    1
    Configured Vlans       :    1
  Interface counter:
    input  packets          : 0
           bytes            : 0
           multicast packets: 0
    output packets          : 0
           bytes            : 0
           multicast packets: 0
           broadcast packets: 0
           drop packets     : 0

7. Points of Caution

None

8. Related Documentation

None