Command Line Interface Reference, Modes A - B, StarOS Release 21.3

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents

Find Matches in This Book

Available Languages

Download Options

Book Title

Command Line Interface Reference, Modes A - B, StarOS Release 21.3

Chapter Title

ATM Port Configuration Mode Commands

PDF - Complete Book (9.61 MB) PDF - This Chapter (1.35 MB)
View with Adobe Reader on a variety of devices

Results

Updated:: July 28, 2017

Chapter: ATM Port Configuration Mode Commands

clock-source
description
end
exit
line-timing
loopback
preferred slot
pvc
shutdown
snmp trap link-status
threshold high-activity
threshold monitoring
threshold rx-utilization
threshold tx-utilization
toh-sdsf

ATM Port Configuration Mode Commands

The Asynchronous Transfer Mode (ATM) port configuration mode provides the commands to create, configure, bind, and manage the ATM ports on line cards that support ATM, such as the ATM/POS OC-3 single-mode and multi-mode optical line cards.

Important:

Before using these commands, card framing should be configured for either SDH or SONET with the framing command described in the Card Configuration Mode chapter.

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Important:

The commands or keywords/variables that are available are dependent on platform type, product version, and installed license(s).

clock-source
description
end
exit
line-timing
loopback
preferred slot
pvc
shutdown
snmp trap link-status
threshold high-activity
threshold monitoring
threshold rx-utilization
threshold tx-utilization
toh-sdsf

clock-source

This command sets the source of the port's transmit clock.

Product

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

clock-source { internal-timing | loop-timing }
default clock-source

default

Using this command combination sets the port clock source to internal timing.

internal-timing

Sets the port clock to derive timing from the recovered receive clock.

loop-timing

Sets the port clock to transmit in sync with the system timing.

Usage Guidelines

Use this command for either SONET ports on the SGSN.

Important:

This command is only available for releases 8.1 or higher.

Example

The following command resets the transmit clock source to internal timing.

default clock-source

description

Defines descriptive text that provides useful information about the port.

Product

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

description text
no description

no

Erases the port's defined description from the configuration file.

text

text must be a string of 1 to 79 alphanumeric characters with no spaces or a string within double quotes that includes printable characters. The description is case-sensitive.

Usage Guidelines

Set the description to provide helpful information, for example the port's primary function, services, end users. Define any information, the only limit is the number of characters.

Example

The following example sets a port description that will read in the configuration file:

description samplePortDescriptiveText

The following example sets a port description that will be easy to read because it retains the spaces between words:

description "This is a sample description"

end

Exits the current configuration mode and returns to the Exec mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

Syntax Description

end

Usage Guidelines

Use this command to return to the Exec mode.

exit

Exits the current mode and returns to the parent configuration mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

Syntax Description

exit

Usage Guidelines

Use this command to return to the parent configuration mode.

line-timing

This command enables the SPIO to recover transmit timing source via the line attached to the selected port. By default, line-timing is not enabled.

Important:

To employ line-timing recovery, the SPIO card(s) must be equipped with the optional Stratum 3 clock module.

Product

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

[ no ] line-timing

no

Disables line-timing as the source for the transmit clock.

Usage Guidelines

The port must be enabled (no shutdown) to enable recovery of timing source via the line. As well, the card's slot number must be entered in the recover line# command in the BITS port configuration mode.

Important:

If the SPIO is connected to an external Building Integrated Timing Supply (BITS) source, BITS timing always takes precedence over line-timing.

Example

Disable configured line-timing as the clock source for this port.

no line-timing

loopback

Enables/disables loopback and configures the type of loopback mode used for diagnostic testing.

Product

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

loopback { ds1-e1-diag | ds1-e1-line | none | sonet-sdh-diag | sonet-sdh-line }

ds1-e1-diag

Enables a system generated diagnostic lookback signal at the DS1/E1 layer.

ds1-e1-line

Loops back a network diagnostic signal at the DS1/E1 layer.

none

Stops diagnostic loopback signalling.

sonet-sdh-diag

Enables a system generated diagnostic lookback signal at the SONET/SDH layer.

sonet-sdh-line

Loops back a network diagnostic signal at the SONET/SDH layer.

Usage Guidelines

Setup diagnostic loopback signals for troubleshooting purposes.

Example

Use the following command to setup loopback diagnosis:

loopback ds1-e1-diag

Use the following command to disable loopback:

loopback none

preferred slot

This command identifies which card in a chassis assumes revertive (redundancy auto-recovery) functionality when the slot/port being configured go down.

Product

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

preferred slot slot#
[ default | no ] preferred slot

default

Default: non-revertive operation.

Sets the port for non-revertive operation for port redundancy auto-recovery; requiring an administrative user to manually issue a port switch to command to return service to the original port.

no

Disables revertive, or auto-recovery, operation for the port.

slot#

Identifies the physical slot in the chassis where the preferred line card is installed.

Usage Guidelines

This command enables or disables revertive port redundancy. So after a port failover, when the original port is restored to service (i.e. link up) the system will return service to that port automatically.

This command must be issued on a per port basis, allowing you to configure specific ports to be used on individual LCs or SPIO cards. For example, ports 1 through 4 could be configured as "preferred" on the LC in slot 17 while ports 5 through 8 are "preferred" on the LC in slot 33. In this scenario, both LCs would be in an Active operational state while still providing LC and port redundancy for the other.

Disabled, which is the default setting, causes non-revertive operation; requiring an administrative user to manually issue a port switch command to return service to the original port.

Example

The following commands sets revertive port redundancy for ports on the card in slot 17:

preferred slot 17

pvc

This command creates a Permanent Virtual Connection (PVC), including the definition of the associated Virtual Path Identifiers (VPI) and Virtual Connection Identifiers (VCI) for the PVC. By defining a PVC, this command enters into PVC configuration mode. The ATM port supports a maximum of 256 PVC definitions.

Important:

In Release 20 and later, HNBGW is not supported. This command must not be used for HNBGW in Release 20 and later. For more information, contact your Cisco account representative.

Product

HNB-GW

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

[ no ] pvc vpi vpi# vci vci# [ type { aal2 [ cps-payload-size  cps_payload_value | aal5 } ] ] [ -noconfirm ]

no

Deletes the PVC's entry from the configuration.

vpi vpi#

VPI identifies a unique path to a destination point in the ATM portion of the network. The VPI and the VCI combine to create the PVC between the MS and the destination point. vpi# must be an integer, 0 to 255.

vci vci#

VCI identifies a unique virtual circuit within the associated VPI. vci# must be an integer, 0 to 65535.

type

This keyword is used to define the type of PVC as AAL2 or AAL5 for HNB-GW service configuration within the associated VPI and VCI.

aal2

This keyword is used to define the type of PVC as AAL2 for HNB-GW service configuration within the associated VPI and VCI.

aal5

This keyword is used to define the type of PVC as AAL5 for HNB-GW service configuration within the associated VPI and VCI.

cps-payload-size cps_payload_value

This keyword configures the Common Part Sublayer (CPS) payload in Bytes for AAL2 type of PVC within the associated VPI. CPS payload is carried out by the AAL2 protocol over ATM. During the call, the payload size is negotiated between HNB-GW and MSC. Default size for payload is 64 but values may range from 1 to 64 Bytes. This command makes the operator to choose the size dynamically

The CPS payload size dynamically configured for per PVC. If user is not providing the CPS payload size then default value of 64 Bytes is considered else user provided value is taken.

cps_payload_value is the value of CPS payload in Bytes and must be an integer between 1 through 64.

-noconfirm

Specifies that the command must execute without any additional prompt and confirmation from the user.

Usage Guidelines

Creates a virtual circuit between two specific points that the carrier will use repeatedly.

This command is used to define the type of PVC as AAL2 or AAL5 for HNB-GW service configuration. It also configures the CPS payload which is carried out by the AAL2 protocol over ATM. During the call, the payload size is negotiated between HNB-GW and MSC. Default size for payload is 64 but values may range from 1 to 64 Bytes. This command makes the operator to choose the size dynamically.

This command configures the type of PVC to ATM Adaptation Layer2 (AAL2) or ATM Adaptation Layer5 (AAL5) for ATM traffic between HNB-GW and MSC. It also enables the operator to configure the Common Part Sublayer (CPS) payload for AAL2 protocol over ATM for HNB-GW session between MSC and HNB-GW.

Example

Define a PVC with VPI 2 and VCI 353.

pvc vpi 2 vci 353

The following command configures the PVC type as AAL2 with VPI as 2 and VCI as 353. It also configures the CPS payload to 45 bytes over the ATM during the call.

pvc vpi 2 vci 353 type aal2 cps-payload-size 45

shutdown

Terminates all processes supporting the port or blocks the shutting down of the port. Conversely, this command with the no keyword enables the port.

Product

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

[ no ] shutdown

no

Enables the port's administrative state. When this command is omitted from the configuration, the card is shutdown (removed from service).

Usage Guidelines

Shut down a port prior to re-cabling and/or other maintenance activities. This is the default state of each port upon installation and initial configuration.

This command with the no keyword is required to bring a port into active service.

Example

The following command enables the port for service:

no shutdown

The following command disables the port and takes it out of service:

shutdown

snmp trap link-status

Enables/disables the generation and sending of an SNMP (notification) trap when the port experiences a change of state (up or down).

Product

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

[ no ] snmp trap link-status

no

Disables the sending of traps for link-status changes.

Usage Guidelines

Enable the sending of link-status change traps for this port if there is a monitoring facility that can use the information or if there are troubleshooting activities in progress.

Example

Use the following command to send SNMP link-status traps for this port:

snmp trap link-status

Use the following command to disable the sending SNMP link-status traps for this port:

no snmp trap link-status

threshold high-activity

Configures the port's high and low activity thresholds.

Product

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

threshold high-activity high_thresh  [ clear low_thresh ]
default threshold high-activity

default

Restores both port high-activity thresholds to the system default of 50 percent.

high_thresh

Default: 50

Sets the threshold for the highest percentage of port activity that must be met or exceeded, within the polling interval, to generate an alert or alarm.

high_thresh_% can be configured to any integer value between 0 and 100.

clear low_thresh

Default: 50

Sets the threshold for the lowest percentage level of port activity that must be met to generate and send a clear alarm. If port activity does not drop to or below this threshold then the alarm is maintained.

low_thresh_% can be configured to any integer value between 0 and 100.

Important:

This value is ignored for the Alert model. In addition, if this value is not configured for the Alarm model, the system assumes it is identical to the high threshold.

Usage Guidelines

High port activity thresholds generate alerts or alarms based on the utilization percentage of each configured port during the specified polling interval. This threshold is configured on a per-port basis.

Alerts or alarms are triggered for high port activity based on the following rules:

Enter condition: Actual percent utilization of a port > High Threshold
Clear condition: Actual percent utilization of a port < Low Threshold

If a trigger condition occurs within the polling interval, the alert or alarm will not be generated until the end of the polling interval.

Refer to the threshold poll command in the Global Configuration Mode Commands chapter of this reference to configure the polling interval and the threshold monitoring command in this chapter to enable thresholding for this value.

Example

The following command configures a high port utilization threshold of 70 percent and a low threshold of 50 percent for a system using the Alarm thresholding model:

threshold high-activity 70 clear 50

threshold monitoring

Enables thresholding for port-level values.

Important:

In Release 20 and later, HNBGW is not supported. This command must not be used for HNBGW in Release 20 and later. For more information, contact your Cisco account representative.

Product

HNB-GW

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

[ default | no ] threshold monitoring

default

Restores the system default to disable threshold monitoring for port-level values.

no

Disables threshold monitoring for port-level values. This is the default setting.

Usage Guidelines

Thresholding on the system is used to monitor the system for conditions that could potentially cause errors or outage. Typically, these conditions are temporary (i.e high-activity) and are quickly resolved. However, continuous or large numbers of these error conditions within a specific time interval may be indicative of larger, more severe issues. The purpose of thresholding is to help identify potentially severe conditions so that immediate action can be taken to minimize and/or avoid system downtime.

Thresholding reports conditions using one of the following mechanisms:

SNMP traps: SNMP traps have been created that indicate the condition (high threshold crossing and/or clear) of each of the monitored values. Complete descriptions and other information pertaining to these traps is located in the starentMIB(8164).starentTraps(2) section of the SNMP MIB Reference.

The generation of specific traps can be enabled or disabled on the system allowing you to view only those traps that are most important to you.

Logs: The system provides a facility called threshold for which active and event logs can be generated. As with other system facilities, logs are generated Log messages pertaining to the condition of a monitored value are generated with a severity level of WARNING.
Alarm System: High threshold alarms generated within the specified polling interval are considered "outstanding" until a the condition no longer exists and/or a condition clear alarm is generated.

"Outstanding" alarms are reported to through the system's alarm subsystem and are viewable through the system's CLI.

The following table indicates the reporting mechanisms supported by each of the above models.

Table 1 Thresholding Reporting Mechanisms by Model
Model	SNMP Traps	Logs	Alarm System
Alert	X	X
Alarm	X	X	X

This command enables thresholding for port-level values. Refer to the sections covering threshold high-activity, threshold rx-utilization, and threshold tx-utilization commands in this chapter for information on configuring these values. In addition, refer to the threshold poll command in the Global Configuration Mode Commands chapter of this reference for information on configuring the polling interval over which these values are monitored.

threshold rx-utilization

Configures thresholds for receive-port utilization.

Important:

In Release 20 and later, HNBGW is not supported. This command must not be used for HNBGW in Release 20 and later. For more information, contact your Cisco account representative.

Product

HNB-GW

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

threshold rx-utilization high_thresh [ clear low_thresh ]
default threshold rx-utilization

default

Restores both rx-utilization thresholds to the system default of 80 percent.

high_thresh

Default: 80

The high threshold receive port utilization percentage that must be met or exceeded within the polling interval to generate an alert or alarm.

The percentage can be configured to any integer value between 0 and 100.

clear low_thresh

Allows the configuration of the low threshold.

Default: 80

The low threshold receive port utilization percentage that maintains a previously generated alarm condition. If the utilization percentage falls below the low threshold within the polling interval, a clear alarm will be generated.

The percentage can be configured to any integer value between 0 and 100.

Important:

This value is ignored for the Alert model. In addition, if this value is not configured for the Alarm model, the system assumes it is identical to the high threshold.

Usage Guidelines

Receive port utilization thresholds generate alerts or alarms based on the utilization percentage of each configured port in relation to data received during the specified polling interval. This threshold is configured on a per-port basis.

Important:

Ports configured for half-duplex do not differentiate between data received and data transmitted. Therefore, to avoid redundant alarms, it is recommended that only the receive or transmit utilization threshold be configured.

Alerts or alarms are triggered for receive port utilization based on the following rules:

Enter condition: Actual percent utilization of a port for received data > High Threshold
Clear condition: Actual percent utilization of a port for received data < Low Threshold

If a trigger condition occurs within the polling interval, the alert or alarm will not be generated until the end of the polling interval.

Example

The following command configures a receive port high utilization threshold percent of 70 and a low threshold of 50 for an system using the Alarm thresholding model:

threshold rx-utilization 70 clear 50

threshold tx-utilization

Configures thresholds for transmit port utilization.

Important:

In Release 20 and later, HNBGW is not supported. This command must not be used for HNBGW in Release 20 and later. For more information, contact your Cisco account representative.

Product

HNB-GW

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

threshold tx-utilization high_thresh [ clear low_thresh ]
default threshold tx-utilization

default

Restores the port tx-thresholds to their system defaults of 80 percent.

high_thresh

Default: 80

The high threshold transmit port utilization percentage that must be met or exceeded within the polling interval to generate an alert or alarm.

The percentage can be configured to any integer value between 0 and 100.

clear low_thresh

Allows the configuration of the low threshold.

Default: 80

The low threshold transmit port utilization percentage that maintains a previously generated alarm condition. If the utilization percentage falls below the low threshold within the polling interval, a clear alarm will be generated.

The percentage can be configured to any integer value between 0 and 100.

Important:

This value is ignored for the Alert model. In addition, if this value is not configured for the Alarm model, the system assumes it is identical to the high threshold.

Usage Guidelines

Transmit port utilization thresholds generate alerts or alarms based on the utilization percentage of each configured port in relation to data transmitted during the specified polling interval. This threshold is configured on a per-port basis.

Important:

Alerts or alarms are triggered for transmit port utilization based on the following rules:

Enter condition: Actual percent utilization of a port for transmit data > High Threshold
Clear condition: Actual percent utilization of a port for transmit data < Low Threshold

If a trigger condition occurs within the polling interval, the alert or alarm will not be generated until the end of the polling interval.

Example

The following command configures a transmit port high utilization threshold percent of 70 and a low threshold of 50 for an system using the Alarm thresholding model:

threshold tx-utilization 70 clear 50

toh-sdsf

Enable/disable line SDSF BER thresholds and configure the line transport overhead (TOH) signal degrade and signal failure (SDSF) bit error rate (BER) threshold.

Product

SGSN

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > ATM Port Configuration

configure > port atm slot_number/port_number

Entering the above command sequence results in the following prompt:

[local]host_name(config-port-slot_number/port_number)#

Syntax

Syntax Description

toh-sdsf toh_value
default toh-sdsf

default

Resets the default which disables this threshold.

toh_value

To facilitate configuration the SD and SF rates have been combined into a single setting.

0 - Disabled
1 - 1.E-04
2 - 1.E-05
3 - 1.E-06
4 - 1.E-07
5 - 1.E-08
6 - 1.E-09
7 - 1.E-10
8 - 1.E-11

Usage Guidelines

This command is typically configured in combination with configuring APS/MSP redundancy for the line card - see the aps and the redundancy commands documented in the Card Configuration Mode Commands chapter..

This command can be used to configure the line threshold whether the port is active or standby and sets a standard option for the paired values of the line's signal degrade and signal failure (SDSF) BER.

The SD is kept at a value of 100 erroredBits/sec less than the corresponding value of the SF. So if the SD threshold is configured at 1 error in every 100000 bits/sec, then the SF threshold automatically becomes 1 error in every 1000 bits/sec.

The port will go operationally down as soon as the SD threshold is crossed.

Example

Set the SD and SF rates to 1.E-04:

toh-sdsf 1

Was this Document Helpful?

Feedback

Contact Cisco

Open a Support Case
(Requires a Cisco Service Contract)