set port oam link-monitor

Use this command to configure OAM link monitor functionality for the specified port.

Syntax

set port oam port-string link-monitor {frame | frame-period | frame-seconds | symbol-period} {threshold threshold | window window | action {[syslog] [disable-interface] [notify]}

Parameters

port-string Specifies the port(s) to enable or disable. For a detailed description of possible port-string values, refer to Port String Syntax Used in the CLI in the S-, K-, and 7100 Series Configuration Guide.
frame Configure OAM monitoring of frame events for a port.
frame-period Configure OAM monitoring of frame-period events for a port.
frame-seconds Configure OAM monitoring of frame-second events for a port.
symbol-period Configure OAM symbol-period event for a port.
threshold threshold Specifies the number of errors threshold for the specified OAM link monitor function. See the Usage section of this command for default and range threshold values for each link-monitor function.
window window Specifies the window value for:
  • The errored frame event and the errored frame-seconds summary events in seconds.
  • The errored frame-period event, in number of frames
  • The errored-symbol-period event in number of symbols

See the Usage section of this command for default and range window values for each link-monitor function.

syslog Specifies that a syslog message will be generated upon detecting a link monitor event.
disable-interface Specifies that the port will be operationally disabled upon detecting a link monitor event.
notify Specifies that a link notification event is triggered upon detecting a link monitor event.

Defaults

None.

Mode

All command modes.

Usage

This command configures the link-monitoring process on the specified port. Should the number of errors exceed the value specified in the threshold parameter for the configured window parameter, the link-monitoring process will take one or more specified actions.

Note

Note

If the threshold value is zero (0), then an Event Notification OAM PDU is sent at the end of every window, regardless of whether the threshold is exceeded or not for that window. This can be used as an asynchronous notification to the peer OAM entity of the statistics related to this threshold crossing alarm.

The frame option monitors frame errors occurring during a period of time. The default threshold is 1 errored-frame. Valid threshold values are 0 - 4294967295 errored-frames. The default window is a 1 second interval. Valid window values are 1 - 60 seconds.

The frame-period option monitors frame errors that occur during the reception of a given number of frames. The default threshold is 1 errored-frame. Valid threshold values are 0 - 4294967295 errored-frames. The default window is equivalent to the maximum number of minimum sized frames that may be transmitted over the link during a one second interval, and the upper bound is the maximum number of minimum sized frames that may be transmitted over the link during a one minute interval. Therefore, the maximum frame-period window value can be set to 60 times the default window value.

The frame-period option defines its window value (number of frames) based upon the line rate of the port being configured. As such, the value may not be determined until the port has achieved a valid link state. The possible frame-period window default and range values, based upon link speed are displayed in Frame-Period Window Values.

Click to expand in new window

Frame-Period Window Values

Port Line Rate Default Window Value Window Value Range
100 Mbps 148,800 frames 14880 - 8928000 frames
1Gbps 1,488,000 frames 148,800 to 89,280,000 frames
10 Gbps 14,880,000 frames 1,488,000 to 892,800,000 frames

The frame-seconds option monitors the number of one-second intervals in which one or more frame errors occurred. The default threshold is 1 errored-second. Valid threshold values are 0 - 4294967295 errored-seconds. The default window is 60 seconds, the minimum is 10 seconds, and the maximum is 900 seconds.

The symbol-period option monitors symbol errors that occur during the reception of a given number of symbols. The default threshold is one errored-symbol. Valid threshold values are 0 - 4294967295 errored-symbol. The default window is equivalent to the maximum number of symbols that may be transmitted over the link during a one second interval, and the upper bound is the number of symbols that may be transmitted over the link during a one minute interval. Therefore, the maximum symbol-period window value can be set to 60 times the minimum window value.

The symbol-period option defines its window value based upon the line rate of the port being configured. As such, the value may not be determined until the port has achieved a valid link state. The possible symbol-period window default and range values, based upon link speed are displayed in Symbol-Period Window Values.

Click to expand in new window

Symbol-Period Window Values

Port Line Rate Default Window Value Window Value Range
100 Mbps 131,072,000 symbols 52,428,800 - 7,864,320,000
1Gbps 524,288,000 symbols 524,288,000 - 31,457,280,000
10 Gbps 5,242,880,000 symbols 5,242,880,000 - 314,572,800,000

The administrator may configure any one of three actions to be taken upon the detection of a link event:

  • The syslog option triggers a syslog message to be generated, which confers information related to the event.
  • The notify option triggers the transmission of a link event notification OAM PDU to the remote client.
  • The disable-interface option operationally disables the port in question, and the port remains in that state until the administrator restores the port to operational status.

Examples

This example shows how to set the OAM link monitor frame threshold to 1, window to 300 seconds, and action to syslog for port ge.1.3:

System(rw)->set port oam ge.1.3 link-monitor frame threshold 1
System(rw)->set port oam ge.1.3 link-monitor frame window 300
System(rw)->set port oam ge.1.3 link-monitor frame action syslog
System(rw)->

This example shows how to set the OAM link monitor frame-period threshold to 1, window to 500000, and action to disable the interface, generate a syslog message and send a link notification:

System(rw)->set port oam ge.1.3 link-monitor frame-period threshold 1
System(rw)->set port oam ge.1.3 link-monitor frame-period window 500000
System(rw)->set port oam ge.1.3 link-monitor frame-period action disable-interface syslog notify