NVIDIA MLNX-OS User Manual
NVIDIA MLNX-OS User Manual
Breadcrumbs

Ethernet Interface Commands


interface ethernet


interface ethernet <slot>/<port>[/<subport>][-<slot>/<port>[/<subport>]]

Enters the Ethernet interface or Ethernet interface range configuration mode.

Syntax Description

<slot>/<port>

Ethernet port number

subport

Ethernet subport number to be used if a port is split

Default

N/A

Configuration Mode

config

History

3.1.0000


3.2.1100

Added range support

Example

Related Commands


Notes


boot-delay


boot-delay [<time>]
no boot-delay

Configures interface boot-delay timer.
The no form of the command returns boot-delay time to its default value.

Syntax Description

time

Boot delay time in seconds
Range: 0-600

Default

0 seconds

Configuration Mode

config interface ethernet
config interface port-channel
config interface mlag-port-channel

History

3.6.2002

Example

Related Commands

show interfaces ethernet

Notes

  • This command delays the interface from boot time of the interface

  • Configuration save and system reboot is required for the configuration to take effect

default interface ethernet


default interface ethernet <slot/port>

Resets a port to its default settings

Syntax Description

slot/port

Number of Ethernet interface in form of slot/port

Default

N/A

Configuration Mode

config

History

3.9.1000

Example

Related Commands

interfaces ethernet

Notes

If one of the following configurations exist on the port, the command will be blocked and an informative message will appear.

  1. Port is a BGP update source port (when the IP of the port is taken and used as a source IP for BGP routing updates and for TCP connection establishment with neighbor or peer-group).

  2. Port is a PIM update source port (when the IP of the port is taken and used as source IP in PIM communications).

  3. Port is an IP PIM rp-candidate.

  4. Port is an IP PIM bsr-candidate.

  5. Port is a member in LAG router port.

  6. Port is a member in LAG in NVE mode.

description


description <string>
no description

Configures an interface description.
The no form of the command returns the interface description to its default value.

Syntax Description

string

40 bytes

Default

""

Configuration Mode

config interface ethernet
config interface port-channel
config interface mlag-port-channel

History

3.1.0000


3.3.4500

Added MPO configuration mode

Example

Related Commands

show interfaces ethernet

Notes


fec-override


fec-override <fec-configuration> [force]
no fec-override <fec-configuration> [force]

Changes FEC configuration on a specific port or range of ports.
The no form of the command resets this parameter to its default value.

Syntax Description

fec-configuration

  • fc-fec – FireCode FEC

  • no-fec – does not use FEC

  • rs-fec – Reed Solomon FEC

force


Default

Auto-FEC selection

Configuration Mode

config interface ethernet

History

3.5.0000


3.6.2002

Added force option

3.7.1000

Updated Example

Example

Related Commands

show interfaces ethernet

Notes

Use this command with caution. There is no limitation in configuring non-standard FEC. It may cause the link to malfunction.

flowcontrol


flowcontrol {receive | send} {off | on} [force]

Enables or disables IEEE 802.3x link-level flow control per direction for the specified interface.

Syntax Description

receive | send

  • receive – ingresses direction

  • send – egresses direction

off | on

  • on – enables IEEE 802.3x link-level flow control for the specified interface on receive or send

  • off – disables IEEE 802.3x link-level flow control for the specified interface on receive or send

force

Forces configuration without the need to toggle the interface

Default

receive off; send off

Configuration Mode

config interface ethernet
config interface port-channel
config interface mlag-port-channel

History

3.1.0000


3.3.4500

Added MPO configuration mode

Example

Related Commands

show interfaces ethernet

Notes

To configure global pause please see section “Flowcontrol (Global pause)”.

ip address dhcp


ip address dhcp
no ip address dhcp

Enables DHCP on this Ethernet interface.

Syntax Description

N/A

Default

Disabled

Configuration Mode

config interface ethernet set as router interface
config interface port-channel set as router interface

History

3.4.2008

Example

Related Commands

show interfaces ethernet

Notes


load-interval


load-interval <time>
no load-interval

Sets the interface counter interval.
The no form of the command resets the interval to its default value.

Syntax Description

time

In seconds

Default

300 seconds

Configuration Mode

config interface ethernet
config interface port-channel
config interface mlag-port-channel

History

3.3.0000


3.3.4500

Added MPO configuration mode

Example

Related Commands

show interfaces ethernet

Notes

This interval is used for the ingress rate and egress rate counters

module-type


module-type <type> [force]
no module-type <type> [force]


Splits the interface into two, four, or eight separate interfaces and specifies the module type intended to be used (QSFP or QSFP-DD).

The no form of the command resets the interface to its default configuration (non-split)

Syntax Description

type

  • qsfp-split-2 – port is split into 2 ports using QSFP module, each can run at up to 50GbE

  • qsfp-split-4 – port is split into 4 ports using QSFP module, each can run at up to 25GbE

  • qsfp-dd-split-2 – port is split into 2 ports using QSFP-DD module, each can run at up to 200GbE.

  • qsfp-dd-split-4 – port is split into 4 ports using QSFP-DD module, each can run at up to 100GbE.

  • qsfp-dd-split-8 – port is split into 8 ports using QSFP-DD module, each can run at up to 50GbE.

force

Force the split operation without asking for user confirmation.

Default

non-split

Configuration Mode

config interface ethernet

History

3.1.1400


3.5.0000

Added note

3.6.3640

Added note

3.6.4006

Added note

3.9.0900

  • Added QSFP-DD split types

  • Removed “module-type qsfp” command

3.10.3100

Added split to 8 for PAM4-based, Spectrum-3 systems.

Example

Related Commands

show interfaces ethernet

Notes

  • Port cannot be split when storm-control is configured on port

  • Force command don't remove storm-control configuration. Error output:
    % Storm control configuration must be removed from interface Eth1/2

  • After a split port is created or deleted, the forwarding mode for each split port is set according to the global configuration

  • The affected interfaces should be disabled prior to the operation

  • In order to unsplit the interface, use the “no” command.

  • The following speeds are supported on the different Ethernet interface types and depend on the system types and plugged module:

    • qsfp-dd-split-2: 1GbE, 10GbE, 25GbE, 40GbE, 50GbE, 100GbE, 200GbE,

    • qsfp-dd-split-4: 1GbE, 10GbE, 25GbE, 50GbE, 100GbE

    • qsfp-dd-split-8: 1GbE, 10GbE, 25GbE, 50GbE

  • When using split-to-4 and split-to-8, only odd ports can be split. In case split is used, the following even port will be unmapped (e.g., splitting port 1/17 to 4 or to 8 will unmap port 1/18).(s(.split 1/17 to 8 will unmap 1/18)(split 1/17 to 8 will unmap 1/18)plit 1(split 1/17 to 8 will unmap 1/18)(split 1/17 to 8 will unmap 1/18)/17 to 8 will unmap 1/18)

mtu 


mtu <frame-size>

Configures the Maximum Transmission Unit (MTU) frame size for the interface.

Syntax Description

frame-size

Range: 1500-9216 bytes

Default

9216 bytes

Configuration Mode

config interface ethernet
config interface port-channel
config interface mlag-port-channel

History

3.1.0000


3.3.4500

Added MPO configuration mode

3.9.2000

Updated default MTU size and added note

Example

Related Commands

show interfaces ethernet

Notes

Switches that perform upgrade to version 3.9.2000, existing interfaces will stay with MTU 1500 (or any other value that was configured). Newly created interfaces (created by split/unsplit operation) will be created with MTU 9216 (the new default). The configured and displayed MTU represents the L3 MTU (being used in IP interfaces). The L2 MTU (being used in physical interfaces) is automatically configured as L3 MTU + 22 Bytes.

recirculation


recirculation [force]
no recirculation

Sets the recirculation port.
The no form of the command unsets the recirculation port.

Syntax Description

N/A

Default

Disabled

Configuration Mode

config interface ethernet

History

3.9.0300

3.9.1000

Added note

Example

Related Commands

what-just-happened buffer enable

Notes

This command reduces by 1 the number of monitor sessions that can be configured. It will fail if the maximum number of monitor sessions are already configured.

no recirculation port interface ethernet


no recirculation port interface ethernet <port_num>

Disables the recirculation port.

Syntax Description

port_num 

Port number

Default

N/A

Configuration Mode

config

History

3.9.0300

Example

Related Commands

recirculation
show recirculation port

Notes


shutdown


shutdown
no shutdown

Disables the interface.
The no form of the command enables the interface.

Syntax Description

N/A

Default

Interface is enabled

Configuration Mode

config interface ethernet
config interface port-channel
config interface mlag-port-channel

History

3.1.0000


3.3.4500

Added MPO configuration mode

Example

Related Commands

show interfaces ethernet

Notes


speed


speed {<value> [no-autoneg | speed_value [... speed_value]] | <auto>} [force]
no speed

Sets the speed of the interface.
The no form of the command sets the speed of the interface to its default value.

Syntax Description

value

The following speeds are available:

  • 1G or 1000—1GbE

  • 10G or 10000—10GbE

  • 25G or 25000—25GbE

  • 40G or 40000—40GbE

  • 50G or 50000—50GbE (This speed refers to the speed 50Gx2. See below)

  • 50Gx1—Port runs at 50Gbps using 1 lane for transmitting (50G PAM4: 1 lane * 50 Gbps)

  • 50Gx2—Port runs at 50Gbps using 2 lanes for transmitting (50G NRZ:  2 lane * 25 Gbps)

  • 50GxAuto—Port runs at 50Gbps with auto-select lane count

  • 56G or 56000—56GbE

  • 100G or 100000—100GbE (This speed refers to the speed 100Gx4. See below)

  • 100Gx2—Port runs at 100Gbps using 2 lanes for transmitting (100G PAM4: 2 lanes * 50 Gbps)

  • 100Gx4—Port runs at 100Gbps using 4 lanes for transmitting (100G NRZ:  4 lanes * 25 Gpbs)

  • 100GxAuto—Port runs at 100Gbps with auto-select lane count

  • 200G or 200000—200GbE (This speed refers to the speed 200Gx4. See below)

  • 200Gx4—Port runs at 200Gbps using 4 lanes for transmitting (200G PAM4: 4 lanes * 50 Gbps)

  • 400G or 400000—400GbE (This speed refers to the speed 400Gx8. See below)

  • 400Gx8 – Port runs at 400Gbps using 8 lanes for transmitting (400G PAM4: 8 lanes * 50 Gbps)

auto—auto-negotiates link speed (not supported on MPO or LAG interfaces)

no-autoneg

Disallows auto negotiation link speed on the interface (not supported on MPO or LAG interfaces)

force

Forces speed change configuration

Default

Depends on the port module type (see the “Notes” section below)

Configuration Mode

config interface ethernet
config interface port-channel
config interface mlag-port-channel

History

3.1.0000


3.5.0000

Added 25GbE, 50GbE, and 100GbE speeds and updated notes

3.6.6000

Added no-autoneg parameter

3.9.0600

Removed no-autoneg parameter

3.9.1000

Updated notesAdded speed with lane configuration

3.9.2000

Added no-autoneg parameter

Example

Related Commands

show interfaces ethernet

Notes

  • The default speed of an interface depends on its speed capabilities.

  • It is not possible to set the speed on a LAG or MPO interface

  • Not all interfaces support all speed options

  • It is not possible to set “auto” speed along with specific speeds

  • A port with more than one speed advertised or a port configured to “auto” speed cannot be added to LAG

  • To change the speed of a LAG interface:

    1. Remove Ethernet ports from LAG.

    2. Shutdown ports.

    3. Reconfigure port speed.

    4. Re-enable ports.

    5. Re-add ports to LAG interface.

  • Speed configuration with lane count affects the Spectrum-2 and Spectrum-3 systems only.

clear counters


clear counters

Clears the interface counters.

Syntax Description

N/A

Default

N/A

Configuration Mode

config interface ethernet
config interface port-channel
config interface mlag-port-channel

History

3.1.0000


3.3.4500

Added MPO configuration mode

Example

Related Commands

show interfaces ethernet

Notes

This command also clears NVE counters


show interfaces counters


show interfaces <type> <id> counters

Displays the extended counters for the interface.

Syntax Description

id

Interface number: <slot>/<port> or <slot>/<port>-<slot>/<port>

Default

N/A

Configuration Mode

Any command mode

History

3.1.0000


3.6.1002

Added “error packets” counter to Tx

3.6.4006

Added extended output for storm-control

3.6.5000

Added hoq discard packets counter

3.9.0500

Removed Priority option

3.9.1000

Added ability to use a range of ports and added "ECN marked packets" counter

3.8.1300

Added note

Example

. . .

Related Commands


Notes

  • NVIDIA-Spectrum-based systems display queue depth for TC0-TC7

  • As of version 3.9.1000, the "id" attribute is optional. If nothing is selected, information for all ports will be displayed

  • Discard Packets counter refers to discards due to insufficient buffer in both RX and
    TX

show interfaces counters discard


show interfaces <type> <id> counters discard

Displays discarded counters of the interface.

Syntax Description

id

Interface number: <slot>/<port> or <slot>/<port>-<slot>/<port>

Default

N/A

Configuration Mode

Any command mode

History

3.6.6102

3.9.1000

Made "id" attribute optional

Example

Related Commands


Notes

  • Discard Packets counter refers to discards due to insufficient buffer in both RX and TX.

  • The "id" attribute is optional. If nothing is selected, information for all ports will be displayed

show interfaces ethernet


show interfaces ethernet <inf> [cable-length | capabilities | congestion-control | counters | description | link-diagnostics | pfc-wd | signal-degrade | status | switchport | transceiver]

Displays the configuration and status for the interface.

Syntax Description

inf

Interface number: <slot>/<port> or <slot>/<port>-<slot>/<port>

cable-length

Display cable-length of specific interfaces

capabilities

Display specific interfaces capabilities information

congestion-control

Display specific interface congestion control information

counters

Display specific interfaces counters

description

Display specific interfaces description information

link-diagnostics

Display interfaces link diagnostics information

pfc-wd

Display pfc-wd information

signal-degrade

Display interfaces signal degrade information

status

Display specific interfaces status information

switchport

Display specific interface VLAN-membership information

transceiver

Display detailed cable info for this port

Default

N/A

Configuration Mode

Any command mode

History

3.1.0000


3.6.1002

Added “error packets” counter to Tx, “Last change in operational status”, and “Isolation group” to output

3.6.2002

Added “boot delay” parameters to output

3.6.3640

Added support for “forwarding mode”

3.6.4110

Updated Example with “Forwarding mode”

3.6.5000

Added telemetry to output

3.6.6000

Added output line for “auto-negotiation”

3.6.8008

Updated example

3.6.8100

Updated example

3.7.1100

Updated example and notes

3.9.1000

Added ability to use a range of ports and updated example

Example

Related Commands


Notes

  • If a high power transceiver (e.g. LR4) is inserted to a port that does not support it, the link does not go up, and the following warning message is displayed: “Warning: High power transceiver is not supported” when running the command “show interfaces ethernet” is run. For more information, please refer to “High Power Transceivers”.

  • “Operational Fec” appears as N/A while port is DOWN, and as no-fec/fc-fec/rs-fec while port is UP

  • As of version 3.9.1000, the "inf" attribute is optional. If nothing is selected, information for all ports will be displayed

  • The speed with lane count information refers to the Spectrum-2 and Spectrum-3 systems only.

show interfaces ethernet counters tc


show interfaces ethernet [<slot/port> | <slot/port>-<slot/port>] counters tc <priority> 

Displays traffic class counters for the specified interface and priority.

Syntax Description

slot/port

Number of Ethernet interface in form of slot/port

priority

Valid priority values: 0-7 or all

Default

N/A

Configuration Mode

Any command mode

History

3.6.3004

3.9.1000

Added ability to use a range of ports

Example

Related Commands


Notes

As of version 3.9.1000, the "slot/port" attribute is optional. If nothing is selected, information for all ports will be displayed

show interfaces ethernet counters pg


show interfaces ethernet [<slot/port> | <slot/port>-<slot/port>] counters pg <priority> 

Displays priority group counters for the specified interface and priority.

Syntax Description

slot/port

Number of Ethernet interface in form of slot/port

priority

Valid priority values: 0-7 or all

Default

N/A

Configuration Mode

Any command mode

History

3.6.3004

3.9.1000

Added ability to use a range of ports

Example

Related Commands


Notes

As of version 3.9.1000, the "slot/port" attribute is optional. If nothing is selected, information for all ports will be displayed

show interfaces ethernet description


show interfaces ethernet [<inf>] description

Displays the admin status and protocol status for the specified interface.

Syntax Description

inf

Interface number: <slot>/<port>

Default

N/A

Configuration Mode

Any command mode

History

3.1.0000


3.4.1100

Updated example

3.8.2000

Updated example

3.9.1000

Updated example

Example

Related Commands


Notes

The speed with lane count information refers to the Spectrum-2 and Spectrum-3 systems only.

show interfaces ethernet rates


show interfaces ethernet rates [<transfer-rate-unit>]

Displays the current transfer rate of the interface.

Syntax Description

transfer-rate-unit

  • bytes – displays interface transfer rates in B/s dynamically (while converting to K/M/G if needed)

  • KB – displays interface transfer rate in Kb/s

  • MB – displays interface transfer rate in Mb/s

  • GB – displays interface transfer rate in Gb/s

  • bits – displays interface transfer rates in b/s dynamically (while converting to K/M/G if needed)

  • Kb – displays interface transfer rate in Kb/s

  • Mb – displays interface transfer rate in Mb/s

  • Gb – displays interface transfer rate in Gb/s

  • If no parameter is entered, transfer rate is displayed in bits

Default

N/A

Configuration Mode

Any command mode

History

3.6.2002


3.7.0000

Added new rates to “transfer-rate-unit”

Example

Related Commands


Notes


show recirculation port


show recirculation port

Shows recirculation port status and information.

Syntax Description

N/A

Default

N/A

Configuration Mode

Any command mode

History

3.9.0300

Example

Related Commands

recirculation

Notes


show interfaces ethernet status


show interfaces ethernet [<inf>] status

Displays the status, speed and negotiation mode of the specified interface.

Syntax Description

inf

Interface number: <slot>/<port>

Default

N/A

Configuration Mode

Any command mode

History

3.1.0000


3.4.1100

Updated example

3.9.1000

Updated example

Example

Related Commands


Notes

The speed with lane count information refers to the Spectrum-2 and Spectrum-3 systems only.

show interfaces ethernet transceiver


show interfaces ethernet [<inf>] transceiver

Displays transceiver information.

Syntax Description

inf

Interface number: <slot>/<port>

Default

N/A

Configuration Mode

Any command mode

History

3.1.0000

Example

Related Commands

Notes

  • For a full list of the supported cables and transceivers, please refer to the LinkX™ Cables and Transceivers webpage

  • If a high power transceiver (e.g. LR4) is used, it will be indicated in the field “cable/module type”

show interfaces ethernet transceiver brief


show interfaces ethernet [<inf>] transceiver brief

Display brief transceiver information.

Syntax Description

inf

Interface number: <slot>/<port>

Default

N/A

Configuration Mode

Any command mode

History

3.6.6102

Example

Related Commands


Notes

  • For a full list of the supported cables and transceivers, please refer to the LinkX™ Cables and Transceivers webpage

  • If a high power transceiver (e.g. LR4) is used, it will be indicated in the field “cable/module type”

show interfaces ethernet transceiver counters 


show interfaces ethernet [<inf>] transceiver counters

 Displays PHY counters related to operational FEC mode and actual number of lanes in the current port.

Syntax Description

inf

Interface number: <slot>/<port>

Default

N/A

Configuration Mode

Any command mode

History

3.6.1002

3.10.3000

Updated command description, notes, and example

Example

Related Commands


Notes

  • The counter “phy received bits” provides information on the total amount of traffic received and can be used to estimate the ratio of error traffic

  • The counter “phy symbol errors” provides information on the error traffic that was not corrected because the FEC algorithm could not do it or because FEC was not active on this interface

  • The counter “phy corrected bits” provides the number of corrected bits by the active FEC mode (RS/FC)

  • The counter "Time since last clear" provides the time passed since the last counters clear event in msec

  • The counter "Edpl/bip errors lane*" provides the NO FEC corrected counter value on appropriate lane

  • The counter "FC corrected blocks lane*" provides the FC FEC corrected counter value on appropriate lane

  • The counter "RS corrected symbols lane*" provides the RS FEC corrected counter value on appropriate lane

  • The counter "raw_ber_magnitude" provides the BER magnitude value for total number of errors. Used for BER calculation - Raw_BER = raw_ber_coef * 10^(-raw_ber_magnitude)

  • The counter "raw_ber_coef" provides the BER coefficient value for total number of errors

  • The counter "effective_ber_magnitude" provides the BER magnitude value for effective number of errors. Used for BER calculation - Effective_BER = effective_ber_coef * 10^(-effective_ber_magnitude)

  • The counter "effective_ber_coef" provides the BER coefficient value for effective number of errors

show interfaces ethernet transceiver diagnostics


show interfaces ethernet [<inf>] transceiver diagnostics

Displays cable channel monitoring and diagnostics info for this interface. Tx and Rx power are reported in mW and dBm units.

Syntax Description

inf

Interface number: <slot>/<port>

Default

N/A

Configuration Mode

Any command mode

History

3.6.2002


3.6.4006

Updated Example to report Tx and Rx power in mW and dBm units

3.6.6000

Updated Example

Example

Related Commands


Notes

This example is for a QSFP transceiver

show interfaces ethernet transceiver raw


show interfaces ethernet [<inf>] transceiver raw

Displays cable info for this interface.

Syntax Description

inf

Interface number: <slot>/<port>

Default

N/A

Configuration Mode

Any command mode

History

3.6.1002

Example

Related Commands


Notes


show interfaces status


show interfaces status 

Displays the configuration and status for the interface.

Syntax Description

N/A

Default

N/A

Configuration Mode

Any command mode

History

3.6.4006

3.9.0300

Updated example—added MTU column

3.9.1000

Updated example

Example

Related Commands


Note

  • If a high power transceiver (e.g. LR4) is inserted to a port that does not support it, the link does not go up, and the following warning message is displayed: “Warning: High power transceiver is not supported” when running the command “show interfaces ethernet” is run. For more information, please refer to “High Power Transceivers”.

  • The speed with lane count information refers to the Spectrum-2 and Spectrum-3 systems only.

disable interface ethernet traffic-class congestion-control


disable interface ethernet <inf> traffic-class <tc> congestion-control

interface ethernet <inf> disable traffic-class <tc> congestion-control

Disables RED/ECN marking for traffic-class queue on ethernet port.

Syntax Description

inf

Interface number: <slot>/<port>

tc

Traffic class. Range 0-7

Default

N/A

Configuration Mode

config

History

3.8.2000

Role

admin

Example

Related Commands

show interfaces ethernet 1/1 congestion-control

Notes

The “no interface ethernet <inf> traffic-class <tc> congestion-control” command returns configuration on the port to its default value.

disable interface port-channel traffic-class congestion-control


disable interface port-channel <inf> traffic-class <tc> congestion-control

Disables RED/ECN marking for traffic-class queue on LAG port.

Syntax Description

inf

Interface number.
Range: 1-4096

tc

Traffic class.
Range 0-7

Default

N/A

Configuration Mode

config

History

3.8.2000

Role

admin

Example

Related Commands

show interfaces port-channel congestion-control

Notes

The “no interface port-channel <inf> traffic-class <tc> congestion-control” command returns configuration on the port to its default value.

disable interface mlag-port-channel traffic-class congestion-control


disable interface mlag-port-channel <inf> traffic-class <tc> congestion-control
interface mlag-port-channel <inf> disable traffic-class <tc> congestion-control

Disables RED/ECN marking for traffic-class queue on MLAG port.

Syntax Description

inf

Interface number.
Range: 1-1000

tc

Traffic class.
Range 0-7

Default

N/A

Configuration Mode

config

History

3.8.2000

Role

admin

Example

Related Commands

show interfaces mlag-port-channel 1/1 congestion-control

Notes

The “no interface mlag-port-channel <inf> traffic-class <tc> congestion-control” command returns configuration on the port to a default value.

Last updated: